CompSci 165 Project Protocols

Project Policy

• Each project must be worked on individually and independently
• No assistance is permitted from anyone besides the class instructor
• Code must be original, and may not be copied or shared from any other source, except as provided by the class instructor

Project Submissions

• Each project has associated with it a deadline due date.
• The project will be collected electronically just after 9am on the morning of the due date using the checkmate system.
• For each project, you should submit via the checkmate system a zip file containing the following:
  • makefile, enabling automatic compilation
  • All source files
  • README.txt, containing documentation, analysis and other comments.
    (This must be a plaintext file. Do not create a Word file.)
  • If you have any, sample run outputs should be in a file named OUTPUT.txt

Project Grading

• Correctness -- the program system works according to project requirements
  • C/C++ source compiled (using the make utility) using gcc/g++ on Solaris (or using gcc/gxx on the djgpp system on PC's)
  • no syntax errors, no run-time errors, and the correct output must be produced
  • improper input gracefully handled, allocated space returned after it no longer is needed, and error-checking performed after calling any system or library function
• Testing, timing -- correct implementation of ancillary functions needed for the complete project but not part of the project specifications
  • code needed for I/O
  • code needed for testing
  • code needed for timing
• Program structure -- well modularized, no gross inefficiencies (space or time)
• Internal documentation -- concise comments, indentation, descriptive variable names, explain "magic" numbers
• README.txt -- keep this short please
  • how to use the program
  • description of data structure implementation (some of this may be internal)
  • theoretical time analysis of the underlying algorithms
  • production of a function (based on your timing and analysis) to predict the time required by your system for larger instances of the problem
  • accurate analysis of the space requirements