Description

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 11. 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. For example, do not add throws to the method headers since they are not necessary.
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 ArrayList 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. Only the last submission will be graded. Make sure your last submission has all required files. Resubmitting will void all previous submissions.
9. 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.
Style and Formatting
Javadocs
Javadoc any helper methods you create in a style similar to the existing 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 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.’’);
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
• 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.
JUnits
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.
HashMap
You are to code a LinearProbingHashMap, a key-value hash map with a linear probing collision resolution strategy. A HashMap maps unique keys to values and allows O(1) average case lookup of a value when the key is known.
The table should not contain duplicate keys, but can contain duplicate values. In the event of trying to add a duplicate key, replace the value in the existing (key, value) pair with the new value and return the old value.
You should implement two constructors for this HashMap. As per the javadocs, you should use constructor chaining to implement the no-arg constructor.
Do not use magic numbers in your code. That is, use the provided INITIAL CAPACITY in your code rather than hardcoding its values.
Hash and Compression Functions
You should not write your own hash functions for this assignment. Instead, use the hashCode() method that every Object has. For the compression function, mod by table length first, then take the absolute value (it must be done in this order to prevent overflow in certain cases). As a reminder, you should be using the hashCode() method on only the keys (and not the LinearProbingMapEntry object itself) since that is what is used to look up the values. After converting a key to an integer with a hash function, it must be compressed to fit in the array backing the HashMap.
Linear Probing
Your hash map must implement a linear probing collision policy. If the index corresponding to the hash value of the key is occupied, probe in linear increments. For example, if the hash value of your key is 7 with a backing array of capacity 9, and index 7 mod 9 in the array is occupied, check index (7 + 1) mod 9, then (7 + 2) mod 9, then (7 + 3) mod 9, etc. until you hit a null spot in the array or after you have encountered size non-removed (key, value) pairs.
To maintain optimal efficiency, avoid doing more probes than necessary in any probing operation. For example, as soon as a null spot is found during a probe, you should not do any additional probes. If a removed map entry contains the key for which you are searching, you can avoid additional probes, since it is guaranteed that the key is not currently contained in the map. Once size non-removed entries have been seen, you should stop probing since this will always result in less than table.length iterations.
Adding Items
When adding a key/value pair to a HashMap, add the pair to the array in the correct position. Also remember that keys are unique in a hash map, so you must ensure that duplicate keys are not added. When searching for a spot to add, after ensuring no duplicates, you should add at the first encountered removed spot (if there are any). If no removed spots were encountered, add at the null spot that terminated your search.
Load Factor and Resizing
A HashMap will lose efficiency if it becomes too full. To combat this, if adding to the table would cause the load factor (LF) to exceed (greater than, not greater than or equal to) the MAX LOAD FACTOR constant provided in the .java file, the table should be resized to have a capacity of 2n+1, where n is the current capacity before adding the parameterized element. See the javadocs for specific instructions on how to resize.
Removing Items
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:
constructors 3pts
put 17pts
remove 10pts
get 10pts
containsKey 10pts
keySet 5pts
values 5pts
resizeBackingTable 10pts
clear 5pts
Other:
Checkstyle 10pts
Efficiency 15pts
Total: 100pts
Provided
The following file(s) have been provided to you. There are several, but we’ve noted the ones to edit.
1. LinearProbingHashMap.java
This is the class in which you will implement the LinearProbingHashMap. Feel free to add private helper methods but do not add any new public methods, inner/nested classes, instance variables, or static variables.
2. LinearProbingMapEntry.java
This class stores a key-value pair and a removed flag for your hash map. Do not alter this file.
3. LinearProbingHashMapStudentTest.java
This is the test class that contains a set of tests covering the basic operations on the LinearProbingHashMap 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). Make sure all file(s) listed below are in each submission, as only the last submission will be graded. Make sure the filename(s) matches the filename(s) below, and that only the following file(s) are present. Do NOT submit LinearProbingMapEntry.java; if you do, your code will not compile on Gradescope. If you resubmit, be sure only one copy of each file is present in the submission. If there are multiple files, do not zip up the files before submitting; submit them all as separate files.
Once submitted, double check that it has uploaded properly on Canvas. To do this, download your uploaded file(s) to a new folder, copy over the support file(s), recompile, and run. It is your sole responsibility to re-test your submission and discover editing oddities, upload issues, etc.
1. LinearProbingHashMap.java