aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md40
1 files changed, 26 insertions, 14 deletions
diff --git a/README.md b/README.md
index 394e551..faef33d 100644
--- a/README.md
+++ b/README.md
@@ -1,25 +1,37 @@
-# CS 456 Design and Analysis of Algorithms
+# ClosestPair
-## Project2: Fast Closest Pairs (75 points)
+## Building the project
-### Description
-You are to implement the divide-and-conquer based closest pair algorithm given in section 5.4 of K\&T. Your algorithm must run correctly and take O(n log n) time
+Provided you have dotnet installed, the project can be built in one of the following ways:
-### Input and Output
-Format You will read the input points from a file named points.txt which contains a line for each point, where each point is given by its x-coordinate then a space followed by the y-coordinate. E.g., point set { (12, 45), (67, 32), (43, 93) } would look as follows:
+- Running the [`release`](.vscode/tasks.json) task in VS Code.
+- Executing the following command in any shell
+
+ ```sh
+ dotnet publish ClosestPairs.sln -c release -o ./release
+ ```
+
+## Running the program
+
+Project can be run from the command line using:
```
-12 45
+Usage:
+ ./release/Program[.exe] TEXTFILE
-67 32
+ TEXTFILE Path to text file containing a point on each line seperated by a space.
-43 93
```
-Your output should just be displayed to the user.
+### Example
-### Specifications
-This is an “all or nothing” project. There is no report for this project. You must simply correctly implement the O(n log n) time closest pair algorithm outlined in section 5.4 of your textbook, with appropriate and comprehensive documentation as to where you are performing what operations on the points. Incorrect implementation, (e.g. implementation that does not run in O(n log n) total time, or implementation that does not return the correct closest pair), will receive no credit. Non-compiling code will also receive no credit.
+Find the closest points in the file 'points1.txt'
-### What to turn in
-You must turn in a single zipped file containing your C++, C\# or Java code. If your program cannot be compiled and/or run you will have to demonstrate your code running in office hours.
+Linux
+ ```
+ ./release/Program ../points1.txt
+ ```
+Windows
+ ```
+ .\release\Program.exe ..\points1.txt
+ ```