Class Notes: COP3530

Class Notes: Data Structures and Algorithms

Summer-C 1999 - M WRF 2nd Period CSE/E119

Instructor: M.S. Schmalz -- TAs: TA Mailing List

Project 3 Assignment

Project 3 consists of writing a Java application that sorts input data read from a file piped into the command line.

Goal. The purpose of this project is to provide intermediate hands-on experience with Java programming using sorting.
The program you develop as Project 3 will (a) read a sequence of integers from stdin as in Project 1, (b) store the sequence in an array or doubly-linked list, (c) sort the input sequence using one of three algorithms, and (d) output a header (shown in the example below) and the sorted sequence to the screen. An example of input and output is shown below.
When the TAs test the program, the numbers will be read in from a text file (inFile), and the command line will be as follows:
java Proj3 dswitch aswitch < inFile
where dswitch is one of the following switches: -a for array or -d for doubly-linked list, and aswitch is one of the following switches: -h for histogram-sort, -i for insertion-sort, or -m for merge-sort. Also, inFile, a text file that you enter using a word processor will be stored on disk. Your program will read the input sequence by command-line piping of that file to stdin.
More information about the test procedure is posted below under Example Test Procedure.
Features. We will be making a modular program with object-oriented design and implementation, as well as resuable Java code, as follows.
Functionality. The program implemented as a Java Class called Proj3 will perform the following steps:
Example Test Procedure. Type up a text file "inFile" in either Dos or Unix with one value per line, like this:
```
22
36
54
14
17
65
```
Now run your program this way:
java Proj3 dswitch aswitch < inFile

where dswitch and aswitch were described previously.
If the dswitch = -a and aswitch = -i, your output would look like this:
```
         John Smith         SSN: 123-345-6789
         02 July 1999       COP3530-C99-Proj3

         Numbers read in:   6

         Data Structure:    Array
         Sorting Algorithm: Insertion-sort

         Input Sequence:
         22  36  54  14  17  65

         Sorted Sequence:
         65  54  36  22  17  14
```
For the dswitch -d, the Data Structure line should read Doubly-Linked List. The legend to put on the Sorting Technique line for aswitch = -i is Histogram-sort or for aswitch = -m is Merge-sort.
Required Programming Procedure. Define each class in a separate .java file, with your master file as Proj3.java, where Proj3, which has a main method, is the class name that the TAs will use to run your program. (It is o.k. to have a main method in each class - the TAs are primarily interested in the main method in the Proj3 class.)
Other Hints on Programming Procedure. Use the following steps to guide your implementation of the Java version of the preceding program.
Documentation. Illustrate your program with in-line comments, so the TAs know what you are doing. Consult your textbook and other Java programming references provided on the course Web page and elsewhere (e.g., Java books in library) for style guides.

Evaluation. Maximum score = 100 points, as follows:

  CODE PRESENT & CLEAR                              10 points max.
  For each of Insertion-, Histogram-, and Merge-sort classes:
    In-line Comments & Documentation   5 points max.
    Code compiles correctly            5 points max.
    File I/O works correctly           5 points max.
    Cmd-line switches work correctly   5 points max.
    Array sorted correctly             5 points max.
    DLL sorted correctly               5 points max.
  TOTAL POINTS PER CLASS = 30 x 3 SORTING CLASSES   90 points max.
  ----------------------------------------------------------------
  TOTAL POINTS                                     100 points max.

For example, if you have only 60 percent the code needed, and it doesn't compile and isn't documented, you would get three of the five points allocated for the code being present. If the code is present, well documented, compiles, reads in data, and reverses the sequence correctly with correct output (but doesn't do anything else), then you could get as many as 20 points per class that had the preceding characteristics.

Submission Procedure. Please submit only your *.java files. You must be logged in to your CISE account to perform the submission procedure, which is described in detail at this link.
In summary, type in the following commands within your directory to submit all the java files for Project-2:
turnin -c cop3530 -p proj3 *.java {Return}
where {Return} denotes the carriage return key.
Important Note: In case you have developed your programs on any environment other than the CISE Unix system, please test your program on a CISE Unix machine before submission. We will only be testing programs for grading purposes on the CISE Unix machines.
Special Note from Lloyd Noronha:
Before starting any programming project, please make sure that there are no unnecessary files in your "dev" directory. Make sure you only submit the files necessary for compiling and running your project. You will lose points for compilation errors in any file you submit, even if it is not relevant. We will compile and run your project as follows :
```
javac *.java
java Proj3 -a -i < inFile
```
So please make sure that you test run your project as above in your directory just before your submission.
Due Date. Submit the completed project by MIDNIGHT on Friday 02 July 1999. Projects submitted a day late will be penalized -10%; two days late: -20%, three days late: -30%, and four days late: -40% . Projects turned in more than four days late will not be accepted unless accompanied by a documented excuse (e.g., note from your physician or advisor).

This concludes the description of Project #3. Use the E-mail link at the top of this Web page to ask the TAs, if you have any questions about programming or grading.