Homework 5: Heaps Solution

For this assignment, you will be coding a max heap that is backed by an array. A max heap is a type of binary tree with two main properties.




Shape Property: The tree must be complete, meaning that all levels of the tree must be full except the bottommost level, which if not full must be lled from left to right.




Order Property: Each node’s data is larger than the data in its two children. There is no explicit relationship between sibling nodes.




These properties imply that the largest element in the heap will be at the root of the heap.




Although heaps are usually classi ed as a type of tree, they are commonly implemented using an array due to their completeness. In your implementation, you should leave index 0 empty and begin your heap at index 1. There are two constructors that are provided to you. One initializes the heap to a capacity speci ed as a constant in MaxHeap.java. The other constructor should implement the BuildHeap algorithm that was taught in lecture, which is an algorithm that creates a heap in O(n) time. Simply adding the elements one by one will not receive credit since it would be O(n log(n)) in the worst case; see the javadocs for this constructor for more speci cations.




You may assume that your implementation does not need to handle duplicate elements. That is, the add method will never be passed duplicates and the remove method will never have to deal with the heap having duplicates. To be clear, your implementation would most likely work even if we were to test for duplicates; it’s just to help remove ambiguity surrounding grading and testing your implementation.




You may use both recursion and iteration for this assignment unlike your BST homework; use whichever you nd more intuitive.







1
Homework 5: Heaps Due: See Canvas










Grading




Here is the grading breakdown for the assignment. There are various deductions not listed that are incurred when breaking the rules listed in this PDF, and in other various circumstances.




Methods:






add
20pts




remove
20pts




getMax
5pts




isEmpty
5pts




clear
5pts




BuildHeap
20pts




Other:






Checkstyle
10pts




E ciency
15pts




Total:
100pts










A note on JUnits




We have provided a very basic set of tests for your code, in MaxHeapStudentTests.java. These tests do not guarantee the correctness of your code (by any measure), nor do they guarantee you any grade. You may additionally post your own set of tests for others to use on the Georgia Tech GitHub as a gist. Do NOT post your tests on the public GitHub. There will be a link to the Georgia Tech GitHub as well as a list of JUnits other students have posted on the class Piazza.




If you need help on running JUnits, there is a guide, available on Canvas under Files, to help you run JUnits on the command line or in IntelliJ.




Style and Formatting




It is important that your code is not only functional but is also written clearly and with good style. We will be checking your code against a style checker that we are providing. It is located on Canvas, under Files, along with instructions on how to use it. We will take o a point for every style error that occurs. If you feel like what you wrote is in accordance with good style but still sets o the style checker please email Tim Aveni (tja@gatech.edu) with the subject header of \[CS 1332] CheckStyle XML".




Javadocs




Javadoc any helper methods you create in a style similar to the existing Javadocs. If a method is overridden or implemented from a superclass or an interface, you may use @Override instead of writing Javadocs. Any Javadocs you write must be useful and describe the contract, parameters, and return value of the method; random or useless javadocs added only to appease Checkstyle will lose points.




Vulgar/Obscene Language




Any submission that contains profanity, vulgar, or obscene language will receive an automatic zero on the assignment. This policy applies not only to comments/javadocs but also things like variable names.




Exceptions




When throwing exceptions, you must include a message by passing in a String as a parameter. The mes-sage must be useful and tell the user what went wrong. \Error", \BAD THING HAPPENED",







2
Homework 5: Heaps Due: See Canvas










and \fail" are not good messages. The name of the exception itself is not a good message.




For example:




Bad: throw new IndexOutOfBoundsException(‘‘Index is out of bounds.’’);




Good: throw new IllegalArgumentException(‘‘Cannot insert null data into data structure.’’);







Generics




If available, use the generic type of the class; do not use the raw type of the class. For example, use new LinkedList<Integer() instead of new LinkedList(). Using the raw type of the class will result in a penalty.




Forbidden Statements




You may not use these in your code at any time in CS 1332.




package




System.arraycopy() clone()




assert()




Arrays class Array class Thread class




Collections class




Collection.toArray()




Re ection APIs




Inner or nested classes Lambda Expressions

Method References (using the :: operator to obtain a reference to a method)







If you’re not sure on whether you can use something, and it’s not mentioned here or anywhere else in the homework les, just ask.




Debug print statements are ne, but nothing should be printed when we run your code. We expect clean runs - printing to the console when we’re grading will result in a penalty. If you submit these, we will take o points.




Provided




The following le(s) have been provided to you. There are several, but we’ve noted the ones to edit.













3
Homework 5: Heaps Due: See Canvas










 
MaxHeap.java




This is the class in which you will implement your max heap. Feel free to add private helper methods but do not add any new public methods, inner/nested classes, instance variables, or static variables.




 
MaxHeapStudentTests.java




This is the test class that contains a set of tests covering the basic operations on the MaxHeap class. It is not intended to be exhaustive and does not guarantee any type of grade. Write your own tests to ensure you cover all edge cases.







Deliverables




You must submit all of the following le(s). Please make sure the lename matches the lename(s) below, and that only the following le(s) are present. If you make resubmit, make sure only one copy of the le is present in the submission.




After submitting, double check to make sure it has been submitted on Canvas and then download your uploaded les to a new folder, copy over the support les, recompile, and run. It is your responsibility to re-test your submission and discover editing oddities, upload issues, etc.




 
MaxHeap.java

























































































































4