ICS 211 Homework H03: Sorting Arrays and Reading Files

Purpose

When we are dealing with data, we often want to put it in ‘order’. To do this we can sort it. In this assignment you will implement three simple sorts and analyze the sorting algorithms and your code.

In this assignment we have some specific requirements for your code. We have to satisfy the requirements of the problem in order to have correct solutions. This will give you early practice of writing code that meets some simple requirements.

The second part of this assignment is to continue exploring handling binary data in Java. You will write a class that reads in a file with a specific format.

Part 1

Create an ArraySorter class that can sort Generic Arrays.

Tasks

1. Create a package named edu.ics211.h03

This is where we will put all our classes for homework 03.

2. Create a generic class named ArraySorter that implements the SortsArray interface

public interface SortsArray<E> {
  void insertionSort(Comparator<E> compare, E[] data);
  void bubbleSort(Comparator<E> compare, E[] data);
  void selectionSort(Comparator<E> compare, E[] data);
  int getNumberOfSwaps();
  int getNumberOfComparisons();
  double getSortTime();
}

Each method should implement the named simple sort algorithm on the array data. Use the Comparator<E> to determine the order of the items in the array. Sort the arrays in ascending order. The ‘smallest’ element should be in position 0, ‘largest’ in data.length - 1.

The methods should keep track of the number of comparisons, number of swaps and the amount of time it took to sort the array. To record the time taken, your code should call System.nanoTime at the beginning of each of the methods and save the value as the start time. It should then call System.nanoTime again at the end, and print the difference between the two times. The difference may be zero if your system clock does not update the time quickly enough, but otherwise should accurately report how many nanoseconds (billionths of a second) it took to execute your code. When the sort methods complete they should report the number of comparison, swaps, and the execution time in nanoseconds.

Requirements

• Ensure that your implementation has the following characteristics:

  • The BigO for insertion and bubble sort on sorted data must be BigO(n);

  • The number of swaps for all three sorts on sorted data must be 0.

3. Create some Comparators in package edu.ics211.h02

• Create an IbuComparator that implements Comparator<Beer> deciding based upon the beers’ ibu values.

• Create an AbvComparator that implements Comparator<Beer> deciding based upon the beers’ abv values.

If you created them last week you are done. If not create them in package edu.ics211.h02.

Testing

We are going to use the FlightSorterTest.java JUnit tests to evaluate your homework for correctness.

You may add any more tests if you want to.

Algorithm Analysis

Write up a runtime analysis of each of the sorting methods, giving the big-O of each, and explaining how you got your results. Send your analysis to the TA together with your code. This part counts for 25% of the grade on this assignment. Even if your code doesn’t work, you should do this part to the best of your ability.

Part 2

Create a ReadFile class that reads in a file

We are going to continue exploring handling binary data in Java. You will write a class that reads in a file with a specific format.

The file has the following format:

• An integer, the number of bytes in the String.
• A byte, the encoding of the String.
  • 1 means the String is encoded using StandardCharsets.US_ASCII
  • 2 means the String is encoded using StandardCharsets.UTF_16LE
  • 3 means the String is encoded using StandardCharsets.UTF_8
  • 4 means the String is encoded using StandardCharsets.UTF_16
• The bytes that make up the String.

Tasks

1. Create a class named ReadFile that implements the IReadFile interface

The IReadFile interface has one method in it.

public interface IReadFile {
  /**
   * Reads in the given file and returns the contents of the file as a string.
   * <p>The file has the following format:</p>
   * <ul>
   *   <li>An integer, the number of bytes the String has.</li>
   *   <li>A byte, the encoding of the String.</li>
   *   <ol>
   *     <li>StandardCharsets.US_ASCII</li>
   *     <li>StandardCharsets.UTF_16LE</li>
   *     <li>StandardCharsets.UTF_8</li>
   *     <li>StandardCharsets.UTF_16</li>
   *   </ol>
   *   <li>The String as bytes.</li>
   * </ul>
   * @param fileName The name of the file.
   * @return The String that was encoded in the file.
   * @throws FileNotFoundException If there is a problem with the file name.
   * @throws IOException If there is a problem reading the file.
   */
  String readFile(String fileName) throws IOException;
}

2. Implement the readFile method

What are the steps you need to read in the contents of the file?

Java has a nice class DataInputStream that allows you to read in different types. I recommend you use this class. Also the String class has a nice constructor that takes an array of bytes and a Charset.

You can test your implementation using ReadFileTest. We will be using this JUnit test to grade this part of the assignment. ReadFileTest test against four files.

• data1.dat
• data2.dat
• data3.dat
• data4.dat

Download the files an place them in your project at the save level as your src directory. As shown below.

Grading Rubric

Turning in the Assignment

The assignment is due on Friday at 11:55pm. You may turn it in early.

1. Does your code follow the Java Coding Standard and pass CheckStyle?
2. Does your code pass the JUnit Tests?
3. Export your project following the instructions at the bottom of the page. Name the file H03.zip
4. Sign into Laulima, then navigate to the ICS211 site. In the left hand side of the site, there is an Assignments tab/link. Click on it and view all of the posted assignments. Select the assignment that you want to turn in and attach your H03.zip file and your algorithm analysis accept the honor pledge to submit the assignment. Don’t forget to include your analysis.