Homework 5: Heaps 

Homework 5: Heaps 
Important
There are general homework guidelines you must always follow. If you fail to follow any of the following
guidelines you risk receiving a 0 for the entire assignment.
1. All submitted code must compile under JDK 8. This includes unused code, so don’t submit extra
files that don’t compile. Any compile errors will result in a 0.
2. Do not include any package declarations in your classes.
3. Do not change any existing class headers, constructors, instance/global variables, or method signatures.
4. Do not add additional public methods.
5. Do not use anything that would trivialize the assignment. (e.g. don’t import/use java.util.ArrayList
for an Array List assignment. Ask if you are unsure.)
6. Always be very conscious of efficiency. Even if your method is to be O(n), traversing the structure
multiple times is considered inefficient unless that is absolutely required (and that case is extremely
rare).
7. You must submit your source code, the .java files, not the compiled .class files.
8. After you submit your files, redownload them and run them to make sure they are what you
intended to submit. You are responsible if you submit the wrong files.
Heaps
For this assignment, you will be coding a min heap that is backed by an array. A min 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 filled from left to right.
• Order Property: Each node’s data is less than the data in its two children. There is not
necessarily any relation between sibling nodes.
These properties imply that the smallest element in the heap will be at the root of the heap.
Although heaps are usually classified 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 specified as a constant in MinHeap.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; see the javadocs for this constructor for
more specifications.
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.
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
getMin 5pts
isEmpty 5pts
clear 5pts
BuildHeap 20pts
Other:
Checkstyle 10pts
Efficiency 15pts
Total: 100pts
Keep in mind that add functions are necessary to test other functions, so if an add doesn’t work, remove
tests might fail as the items to be removed were not added correctly. Additionally, the size function is
used many times throughout the tests, so if the size isn’t updated correctly or the method itself doesn’t
work, many tests can fail.
A note on JUnits
We have provided a very basic set of tests for your code, in MinHeapStudentTests.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 off a point for every style error that occurs.
If you feel like what you wrote is in accordance with good style but still sets off 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.
2
Homework 5: Heaps Due: See Canvas
Exceptions
When throwing exceptions, you must include a message by passing in a String as a parameter. The message must be useful and tell the user what went wrong. “Error”, “BAD THING HAPPENED”,
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
LinkedNode<Integer() instead of new LinkedNode(). 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()
• Reflection 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 files, just ask.
Debug print statements are fine, 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 off points.
3
Homework 5: Heaps Due: See Canvas
Provided
The following file(s) have been provided to you. There are several, but we’ve noted the ones to edit.
1. MinHeap.java
This is the class in which you will implement your min heap. Feel free to add private helper methods
but do not add any new public methods, inner/nested classes, instance variables, or
static variables.
2. MinHeapStudentTests.java
This is the test class that contains a set of tests covering the basic operations on the MinHeap 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 file(s). Please make sure the filename matches the filename(s)
below, and that only the following file(s) are present. If you make resubmit, make sure only one copy of
the file is present in the submission.
After submitting, double check to make sure it has been submitted on Canvas and then download your
uploaded files to a new folder, copy over the support files, recompile, and run. It is your responsibility
to re-test your submission and discover editing oddities, upload issues, etc.
1. MinHeap.java
4