============================================
Your CS3230R Report & Software Deliverables
============================================
  (by LeongHW, Apr 2014)


Your deliverable for the CS3230R project will include
 * project report
 * project software: (code, scripts, data, experiment results, README.txt)

First of all, choose a project title that best describes
the actual work that you did for your project. 
If you are not sure, you can just email me your suggestions
of your actual project title.


==================
Project Software:
==================
 includes 
 * code (including those from others and those you coded up),
 * scripts that you write to run things, to track things, plot stuffs, etc.
 * datasets (including write-ups on where they come from, how they are generated)
 * result files (from running the algorithms)

 * README.txt file that documents all the above 
    - list out all the files in this software 
    - list out all external dependencies (software libraries that 
      you use, programming languages, compilers, interpreters needed, 
      particular software environment that you install and is necessary
      to run your program; etc;

    - with proper acknowledgement of contribution from others
      (like code/data you downloaded from where, timestamp, 
      or data generated by a friend [who?].) 


 * HOWTO.txt file that gives DETAILED step-by-step guide on
     how to install the software (if applicable),
     how to compile your program, include any ENV variable settings,
     how to run your program and with sample commands (for different use cases), 
     where to see the results of running your program.
     And any other things.



================
Project Report:
================
This should be about about 10-20 pages, including references 
and appendices, in applicable. (At least 12point font size at
1.5 spacing, or thereabouts.)

While the format and organization of the report can vary due
to different subject matter, project content and emphasis,
and different personal style of writing, it should contain
the following (or its equivalent):

A Nice and Proper Title Page:
=============================
  Should include "CS3230R Project Report", 
  project title, your name, Matric, the semester, 
  project supervisor, etc.
  (Can follow sample from UROP/HYP reports)

Introduction
============
  General introduction of the general area, and application/use.
  Introduction to the problem and statement of goal(s) and scope
  of the project.

Problem Statement
=================
  More precise statement of the problem. And, if relevant, a
  quick 

Description of Your Algorithm Studied / Proposed
=================================================
  Should include the specific algorithm you chose to study
  or to propose / modify. 
  If applicable, give possible reason for your choice of 
  the algorithm(s) -- which may be personal familiarity, liking,
  perceived superior performance, perceived simplicity, 
  easier/smoother project execution, etc).

  Give the technical details of your algorithm here. (Can just
  "copy and paste" the algorithm from the original paper, with
  proper credit --- like, 
  "The algorithm XXX, as presented by [27] is given in Figure 4."

  State parameters that the algorithm have and describe briefly
  how you choose the values of these parameters for your own
  evaluation. If you only use the "default" parameters, without
  adjustment, you can also say so.

Complexity Analysis
===================
  State the time complexity of your algorithm. (Usually already
  given in the original paper. If you can, you can give a high
  level (rough overview) of the analysis of the running time.
  If you can't, you can just state the running time, as given 
  in the original paper. 

Experiment Setup, Result and Observations
=========================================
  Explain in some detail the datasets used for your evaluation
  (comparative analysis) of your algorithm. 
  State the computer systems (HW/SW) that is used to run the
  experiments, and parameters, if relevant.

  Next, the important part, learn how to properly present the
  results and learn how to draw observations from them. 
  Observations can range from easy (obvious) ones [state them
  anyway], to more intricate ones, if you are able to observe them.
  Present your results in such a way that it is easy or obvious
  to support any observation(s) you make about the algorithm(s)
  that you are studying.

Conclusion
==========
  Some general conclusion from this research. 
  Some recommendations on additional future work that can be 
  done if you have more time.  

Lessons Learnt
==============
  Your personal description of the lesson(s) you have learnt
  from doing this project. This could include lesson on 
  academic learning, research methods, software development, 
  or other non-academic skills.
  And maybe state, if you can restart this project, 
  what, if any, would you have done differently.
 
Acknowledgement
===============
  Who you like to thanks (your parents, boy/girl friends, 
  your dog, whatever). KEEP IT SHORT.

References
==========

Appendix (if applicable)
========