CS 2110 Homework 01 Bases and Bitwise Operations

1.1 Purpose




The goal of this assignment is for you to understand bitwise operators, and how to use them to manipulate data (including integers and ASCII codes for characters) programmatically. For this assignment you will be programming in Java, because you should already be familiar with it. The concepts of bitwise operations that you apply here will be used throughout the remainder of this course, including in machine language, assembly language, and C programs.




1.2 Tasks




The homework is split into a Java coding portion, worth 75%, and a docker checkoff, worth 25%. You will complete the Java methods in the provided files: Bases.java, Operations.java, and BitVector.java. The comments in the provided starter code describe what each method should accomplish. The restrictions on which operators you are allowed to use may change between files and sometimes within methods of the same file, so it is in your best interest to read each comment carefully. This is worth 75% of homework 1. Checking off the docker installation on your computer is the other 25%. This can be done once you show your installation to a TA during your lab times or office hours (See ‘Deliverables’ for docker checkoff expectation). Both the coding assignment and docker checkoff are due by 11:59PM on January 25th, 2022. You could also submit the assignment by January 26th, 2022 for a late penalty of 25% of your overall grade. Before you start this assignment, please read the rest of this document for more detailed instructions and hints.




1.3 Criteria




Your coding grade is based on: 1) the correct output from your methods; 2) not using any banned operators; and 3) not hardcoding a literal result from a method, or any other such workaround. The grade you see on Gradescope is the grade you receive, unless we find that you’ve hardcoded return values.




You may submit your code to Gradescope as many times as you like until the deadline. We will only grade your last submission. We have also provided a local checker that you can test your code with. Please submit your code to Gradescope at least once prior to the deadline, to ensure you are not encountering any issues submitting at the last minute.







Instructions (for Coding)



Make sure all 4 files are in the same folder:



Bases.java



Operations.java



BitVector.java



hw1checker.jar



Note: An Examples.java file is also included which shows and explains examples of two methods similar to those used in your assignment. This is just provided for reference, so there are no tasks to be completed within it.




Once you have setup docker installation, You can use the Docker container to test your code. To do this, either run ./cs2110docker.sh and open the terminal inside the graphical client, or run



./cs2110docker.sh -it to open a shell directly in your terminal. Don’t forget to put your homework files/folders in the same directory ascs2110docker.sh.

 


3. Run the following command to see your grade for BitVector.java:




java -jar hw1checker.jar -g BitVector.java




It should show all the test cases you are failing and give a 0/40 score.



Implement one of the functions in BitVector.java and re-run step 3 until you get full credit for that part of BitVector.java.



Now complete all the other methods in each of the 3 Java files (the details on how to implement each method is described in the comment above the corresponding method). Run the verifier and autograder frequently to avoid errors and to make sure you are using only the allowed operations.







Instructions (for Docker)



Please use the docker installation guide or the website to see the full instructions to download docker.



To access the pdf, go to the course page on canvas → ‘Files’ → ‘Docker Resources’ → ‘Docker Guide 2110.pdf’



Alternatively, you can use the docker website to see the same content: https://gt-cs2110. github.io/cs2110docker/



After installation, please visit a TA in your lab or office hours and show them the docker installation to be checked off (Check ‘Deliverables’ to see docker checkoff expectation).



If you face any problems during installation, please go to ed discussion and read the ‘Docker installation troubleshooting and tips’ post.



Alternatively, you can visit a TA during office hours or post on ed discussion regarding your issue









How to run the auto-grader & verifier



Make sure that the hw1checker.jar file is in the same folder as yourBases.java, BitVector.java, and Operations.java files.



Navigate to this folder in your command line.



Run the desired command (see below).



4.1 Commands




Test all methods and verify that no banned operations are being used (checks all 3 files): java -jar hw1checker.jar



Note: Your grade will be dependent on the output of the above command, as it will both test the output of your methods, and verify that you are not using banned operations. If you get stuck though, you can use some of the below commands to help you debug.




On Windows and Mac, you can also double click the hw1checker.jar in your file explorer to test and verify all 3 files. The results will be placed in a new file calledgradeLog.txt. Any errors with compilation, infinite loops, or other runtime errors will be placed in a new file callederrorLog.txt.




Test & verify all methods in a single file. Useful for when you just want to look at one file at a time. For example, using Bases.java:
 


java -jar hw1checker.jar -g Bases.java




Test all methods in a single file without running verifier. This means that this will only run the unit tests, and will not check for the use of banned operations. Useful for when you just want to try and get something that works. For example, using Bases.java:



java -jar hw1checker.jar -t Bases.java




Verify all methods in a single file without running tests. For example, usingBases.java: java -jar hw1checker.jar -v Bases.java



Any combination of files can also be graded, tested, or verified at the same time. For example grading, Bases.java and Operations.java simultaneously:



java -jar hw1checker.jar -g Bases.java Operations.java




4.2 Note for M1 Mac Users




When running the autograder, you may see some UnsatisfiedLinkErrors above the autograder output with the message starting “cannot open shared object file”. Ignore them, they will not affect your score.







Rubric



The grade the autograder gives you should be the same as the grade you get (unless you intentionally hardcode just the solutions or try to hack the autograder).







Deliverables



Please upload the following 3 files to the “Homework 1” assignment on Gradescope:



Bases.java



Operations.java



BitVector.java



The grade returned is the result of a series of test cases and may not be your final grade.



Once you have successfully completed docker installation, you should be able to access a website like this....
   







































































(See ‘Instructions (for Docker)’ for more info on docker installation and how to visit this website)







Hints



7.1 Printing numbers in different bases




Remember that all numbers are stored in your computer as binary. When you perform operations such as System.out.println(), the computer does the translation into another base for you. All you need to do is tell the computer how you are representing your numbers, and how to interpret them.




For example, you can specify 16 in decimal, octal, or hexadecimal like so:







System.out.println(16); // decimal (base 10), the default




System.out.println(020); // octal (base 8), precede the number with a zero




System.out.println(0x10); // hexadecimal (base 16), precede the number with a "0x" (zero x)




You can also tell Java to print out your number in different bases using a method called printf. printf is the GRANDFATHER of all printing functions! When we get to C programming, you will be using it a lot. It is useful if you would like to write your own tester as well.




printf takes a variable number of arguments, the first of which is a format string. After the format string come the parameters. The formatting for the numbers is controlled by the format string.




7.1.1 Example




System.out.printf("In decimal: %d", 16);




System.out.printf("In octal: %o", 16);




System.out.printf("In hexadecimal: %x", 16);




The %d, %o, or %x get replaced by the parameter passed in. printf does not support printing the number out in binary.




For more information about printf read http://en.wikipedia.org/wiki/Printf.

 7.2 Multiplication and division




You may find that there are times in which you need to use division or multiplication, but are not allowed to. Recall from lecture that you can use bitshifting to multiply or divide by powers of 2; this concept isn’t found in the book, but is in the lecture slides.




7.3 Helpful resources




Please also check out the following resources to review the concepts tested in this assignment




Lectures Slides: ‘L02 Datatypes1.pptx’, ‘L03 Datatypes2.pptx’



Lab Slides: ‘Lab 02 Slides.pdf’









Rules and Regulations



8.1 General Rules




You should write your code with useful comments that explain any algorithms you use (i.e., do not write a comment for every statement.) While comments are not graded, writing comments will make your code easier to understand, both by yourself and by any TAs that you visit during office hours.



Although you may ask TAs for clarification, you are ultimately responsible for what you submit. This means that (in the case of demos) you should come prepared to explain to the TA how any piece of code you submitted works, even if you copied it from the book or read about it on the internet.



Please read the assignment in its entirety before asking questions.



Please start assignments early, and ask for help early. Do not email us the night the assignment is due with questions.



If you find any problems with the assignment it would be greatly appreciated if you reported them to the author (which can be found at the top of the assignment). Announcements will be posted if the assignment changes.



8.2 Submission Conventions




All files you submit for assignments in this course should have your name at the top of the file as a comment for any source code file, and somewhere in the file, near the top, for other files unless otherwise noted.



When preparing your submission you should submit all three files you edited to Gradescope (either individually or in a zip archive). You can create an archive by right clicking on files and selecting the appropriate compress option on your system. Both ways (uploading raw files or an archive) are exactly equivalent, so choose whichever is most convenient for you.



Do not submit compiled files, that is .class files for Java code and .o files for C code. Only submit the files we ask for in the assignment.



Do not submit links to files. The autograder does not understand it, and we will not manually grade assignments submitted this way as it is easy to change the files after the submission period ends.
 8.3 Submission Guidelines




You are responsible for turning in assignments on time. This includes allowing for unforeseen circum-stances. If you have an emergency let us know IN ADVANCE of the due time supplying documenta-tion (i.e. note from the dean, doctor’s note, etc). Extensions will only be granted to those who contact us in advance of the deadline and no extensions will be made after the due date.



You are also responsible for ensuring that what you turned in is what you meant to turn in. After submitting you should be sure to download your submission into a brand new folder and test if it works. No excuses if you submit the wrong files, what you turn in is what we grade. In addition, your assignment must be turned in via Canvas/Gradescope. Under no circumstances whatsoever we will accept any email submission of an assignment. Note: if you were granted an extension you will still turn in the assignment over Canvas/Gradescope.



Make sure to start working on your assignments early, and keep track of all due dates. See the syllabus for information regarding late submissions; any penalties associated with unexcused late submissions are non-negotiable.



8.4 Syllabus Excerpt on Academic Misconduct




Academic misconduct is taken very seriously in this class. Quizzes, timed labs and the final examination are individual work.




Homework assignments are partially collaborative, but collaboration is limited to high-level discussion (see next section). In addition many if not all homework assignments will be evaluated via demo or code review. During this evaluation, you will be expected to be able to explain every aspect of your submission. Homework assignments will also be examined using computer programs to find evidence of unauthorized collaboration.




What is unauthorized collaboration? Each individual programming assignment should be coded by you. You may work with others, but each student should be turning in their own version of the assignment. Submissions that are essentially identical will receive a zero and will be sent to the Dean of Students’ Office of Academic Integrity. Submissions that are copies that have been superficially modified to conceal that they are copies are also considered unauthorized collaboration.




You are expressly forbidden to supply a copy of your homework to another student via elec-tronic means. This includes simply e-mailing it to them so they can look at it. If you supply an electronic copy of your homework to another student and they are charged with copying, you will also be charged. This includes storing your code on any site which would allow other parties to obtain your code such as but not limited to public repositories (Github), pastebin, etc. If you would like to use version control, use a private repository on github.gatech.edu




8.5 Is collaboration allowed?




Collaboration is allowed on a high level, meaning that you may discuss design points and concepts relevant to the homework with your peers, share algorithms and pseudo-code, as well as help each other debug code. What you shouldn’t be doing, however, is pair programming where you collaborate with each other on a single instance of the code. Furthermore, sending an electronic copy of your homework to another student for them to look at and figure out what is wrong with their code is not an acceptable way to help them, because it is frequently the case that the recipient will simply modify the code and submit it as their own.

   
























































Figure 1: Collaboration rules, explained colorfully











































































































































8