CS 1332 HW1 Spring 2023, Assignments of Computer Science

Download CS 1332 HW1 Spring 2023 and more Assignments Computer Science in PDF only on Docsity! Homework 1: ArrayList Due: See Canvas 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 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 sig- natures. 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 are expected to implement all methods on the homework. 8. You must submit your source code, the .java files, not the compiled .class files. 9. Only the last submission will be graded. Make sure your last submission has all required files. Resubmitting will void all previous submissions. 10. 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. Collaboration Policy Every student is expected to read, understand and abide by the Georgia Tech Academic Honor Code. When working on homework assignments, you may not directly copy code from any source (other than your own past submissions). You are welcome to collaborate with peers and consult external re- sources, but you must personally write all of the code you submit. You must list, at the top of each file in your submission, every student with whom you collaborated and every resource you consulted while completing the assignment. You may not directly share any files containing assignment code with other students or post your code publicly online. If you wish to store your code online in a personal private repository, you can use Github Enterprise to do this for free. The only code you may share is JUnit test code on a pinned post on the official course Piazza. Use JUnits from other students at your own risk; we do not endorse them. See each assignment’s PDF for more details. If you share JUnits, they must be shared on the site specified in the Piazza post, and not anywhere else (including a personal GitHub account). Violators of the collaboration policy for this course will be turned into the Office of Student Integrity. 1 Homework 1: ArrayList Due: See Canvas Style and Formatting It is important that your code is not only functional, but written clearly and with good programming style. Your code will be checked against a style checker. The style checker is provided to you, and is located on Canvas. It can be found under Files, along with instructions on how to use it. A point is deducted for every style error that occurs. If there is a discrepancy between what you wrote in accordance with good style and the style checker, then address your concerns with the Head TA. 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 HAP- PENED”, 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.’’); In addition, you may not use try catch blocks to catch an exception unless you catching an exception you have explicitly thrown yourself with the throw new ExceptionName(‘‘Exception Message’’); syn- tax (replacing ExceptionName and Exception Message with the actual exception name and message respectively). 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 2 Homework 1: ArrayList Due: See Canvas made for the object. For example, in that Person example above, we may want two objects to be con- sidered equal if they have the same name and id. Keep in mind which makes more sense to use while you are coding. You will want to use value equality in most cases in this course when comparing objects. Notable cases where you’d use reference equality include checking for null or comparing primitives (in this case, it’s just the == operator being overloaded). Differences between Java API and This Assignment Some of the methods in this assignment are called different things or don’t exist in Java’s ArrayList class. This won’t matter until you tackle coding questions on the first exam, but it’s something to be aware of. The list below shows all methods with a different name and their Java API equivalent if it exists. The format is assignment method name ⇒ Java API name. • addAtIndex(int index, T data) ⇒ add(int index, T data) • addToFront(T data) ⇒ no explicit method • addToBack(T data) ⇒ add(T data) • removeAtIndex(int index) ⇒ remove(int index) • removeFromFront() ⇒ no explicit method • removeFromBack() ⇒ no explicit method 5 Homework 1: ArrayList 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: constructor 1pts addAtIndex 15pts addToFront 11pts addToBack 11pts removeAtIndex 11pts removeFromFront 7pts removeFromBack 7pts get 6pts isEmpty 3pts clear 3pts 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. ArrayList.java This is the class in which you will implement the ArrayList. Feel free to add private helper methods but do not add any new public methods, inner/nested classes, instance vari- ables, or static variables. 2. ArrayListStudentTest.java This is the test class that contains a set of tests covering the basic operations on the ArrayList 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. 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 Gradescope. 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. ArrayList.java 6