Milestone 1: MondoHashMap
The first project component due is the MondoHashMap
implementation. The deliverables for this milestone are:
- MondoHashMap.java
- The main class file for the
MondoHashMap implementation.
- Other Java source files
- Any other supporting code files
necessary to compile, load, and use the MondoHashMap
module.
- API documentation
- The handin MUST also include the full,
compiled JavaDoc documentation for the MondoHashMap
implementation. This documentation MUST include full descriptions of
every public or protected method, field, sub-class, enclosed class, or
constructor employed by MondoHashMap. This documentation
hierarchy MUST be included in a sub-directory named
documentation/ within the submission tarball package.
- Test cases
- The submission tarball MUST include a subdirectory
named tests/ that includes all of the test data used to
demonstrate the correctness of the hashtable implementation. The test
files MAY be JUnit files, shell scripts, or other Java programs.
At the designer's option, this submission MAY also include:
- BUGS.TXT
- This file documents any known outstanding
bugs, missing features, performance 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.
- README.TXT
- This file includes any other notes or
documentation necessary to use or understand the submission that are
not already included in other documentation.
- Performance documentation (optional; extra credit)
- The handin submission MAY 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 6
of this document. The designer MAY choose any tests that he or she
desires to establish the performance of his/her
MondoHashMap, 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.
The submission directory MUST be named lastname_p1m1 and the
submission tarball MUST be named lastname_p1m1.tar.gz.
Terran Lane
2005-09-21