Milestone 1: MondoHashTable

The first project component due is the MondoHashTable implementation. The deliverables for this milestone are:

MondoHashTable.java

The main class file for the MondoHashTable implementation.

Other Java source files

Any other supporting code files necessary to compile, load, and use the MondoHashTable module.

API documentation

The handin MUST also include the full, compiled JavaDoc documentation for the MondoHashTable implementation. This documentation MUST include full descriptions of every public or protected method, field, sub-class, enclosed class, or constructor employed by MondoHashTable. This documentation hierarchy MUST be included in a sub-directory named documentation/ within the submission tarball package.

Performance documentation

The handin submission MUST include a document describing the performance of the hashtable implementation and demonstrating (via empirical experiments) that it meets the quantitative performance goals established in Section 4 of this document. The designer MAY choose any tests that he or she desires to establish the performance of his/her MondoHashTable, but MUST describe all tests and why they lead to the stated conclusions about performance. This document MUST be named PERFORMANCE.extension, but it MAY be a plain text, HTML, PDF, or PostScript document (with the appropriate extension). It MUST NOT be a Microsoft Word or other nonportable format document.

Test cases

The submission tarball MUST include a subdirectory named tests/ that includes all of the test data used to demonstrate the performance of the hashtable implementation.

CVS log file(s)

For each Java source file, the submission tarball MUST include a corresponding .log file including the CVS log for that sourcecode. E.g., for the file MondoHashTable.java, the following CVS command will produce the appropriate log output:

        cvs log MondoHashTable.java > MondoHashTable.log

At the programmer's option, this submission MAY also include:

BUGS.TXT

This file documents any known outstanding bugs, missing features, peformance problems, or failures to meet specifications of your submission. Note that the penalty for such problems will be smaller if they're fully documented here than if the instructors discover them independently.

The submission directory MUST be named lastname_p1m1 and the submission tarball MUST be named lastname_p1m1.tar.gz.