What is expected from your homework
Turning in the assignment
All written assignments must be put in my mailbox (in the CS mail room
- CSB727) before the time the assignment is due (usually 5pm). I check
my mailbox shortly after the assignment is due and take out all
assignments. I'll let you know immediately if I haven't gotten yours,
so you'll have a chance to submit it before I publish the answers. The
room is usually open until 5, after that you can always knock on the
door.
All programming assignments should be submitted using my TURN_IN
script. If you care to type your written assignments, you can submit
them using the script, too.
To submit an assignment, you should execute
/u/myros/commands/TURN_IN your_directory_name
The script requires that you have a file called README in your
directory. You should put your writeup or a reference to it in the README
file.
You can also e-mail your assignments to me. In this case you have to tar and gzip your
files and send them as an attachment, but I much prefer that you use
the TURN_IN script.
Requirements for the writeup
The idea behind the writeup is to let anyone who may want to use the
program see quickly how it works and what to do to run it. My life
will be a lot easier if you included the following thing in it ;-)
- the names of all your program and data files, with short descriptions
of contents, if this is not evident from the names
- the names and types of arguments for functions I have to call to
test your program. You do not have to include the descriptions of all
the functions in your program, the comments in the code are enough,
but I'd like to be able to see that your program works without going
through the code to figure out which functions to call
- some test examples to demonstrate that your program works. I have to
be able to answer the question "If the program does not work properly
on my test data, in which cases it does work?"
You also need a description in general terms of how your algorithm
works, descriptions of any existing problems(you'll get higher score
if you point them out rather than when I discover them myself),
answers to any questions that may have been asked in connections with
the programming assignment.
If you're running out of time and cannot implement something, describe
in more detail how you would have done it - you can get credit for
this, too.
Please, don't forget to comment your code. I look over it to see how
it works, and you'll loose points if I cannot figure it out. You do
not need to comment things evident from other sources, like names of
variables, but you should add enough comments so that your code is
easily readable.