Homework 4 Binary Search Trees

Nodes




The binary search tree consists of nodes. The BSTNode class will be given to you; do not modify it.




Methods




You will implement all standard methods for a Java data structure (add, remove, etc.) in addition to a few other methods. Some of these methods are functions that you’d expect from a BST (such as the traversals) while some of the other ones serve more as practice BST recursion problems for you.




Traversals




You will implement 4 di erent ways of traversing a tree: pre-order traversal, in-order traversal, post-order traversal, and level-order traversal. The rst 3 MUST be implemented recursively; level-order is best implemented iteratively. For a level-order traversal, you may use Java’s Queue interface (and an implementing class for it such as LinkedList).




Height




You will implement a method to calculate the height of the tree. The height of any given node is max(left node’s height, right node’s height) + 1. A leaf node has a height of 0. Based on this recursive de nition, this means that null nodes would have a height of -1.




Comparable




As stated, the data in the BST must implement the Comparable interface. As you’ll see in the java les, the generic typing has been speci ed to require that it implements the Comparable interface. You use the interface by making a method call like data1.compareTo(data2). This will return an int, and the value tells you how data1 and data2 are in relation to each other.




If positive, then data1 data2. If negative, then data1 < data2. If zero, then data1 equals data2.




Do note that the returned value can be any integer in Java’s int range, not just -1, 0, 1 as you may have seen in some examples.



































































2
Homework 4 Binary Search Trees 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
15pts




remove
19pts




get
6pts




contains
6pts




traversals
8pts




isBST
10pts




height
3pts




clear
3pts




constructor
5pts




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 BSTStudentTests.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.













3
Homework 4 Binary Search Trees Due: See Canvas










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", 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.
















4
Homework 4 Binary Search Trees Due: See Canvas










Provided




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




 
BST.java




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




 
BSTNode.java




This class represents a single node in the BST. It encapsulates the data, left, and right reference. Do not alter this le.




 
BSTStudentTests.java




This is the test class that contains a set of tests covering the basic operations on the BST 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.




 
BST.java
























































































5