Merge branch 'main' of github.com:MarcoBackman/RangeSearchAnalysis in…

…to main

README.md

@@ -1,24 +1,57 @@
 # <p align="center"> RangeSearchAnalysis </p>
-## <p align="center"> Algorithm of Analysis individual project #1 - Range searching algorithm </p>
+## <p align="center"> Algorithm of Analysis - KD-Tree/KNN algorithm.</p><p align="center"> Florida Tech 2021 Individual Project</p> 
 
 
-This project is comprised of three major sections.
+## Executable main classes.
+ * Main.java
+      * Takes integer input based on the input files. If input files are in three dimension, user has to put, for example, [5 10 25] separated by the space(exclude brackets). 
+      * Executes sequential construction and KD-KNN-tree construction based on the input files in data with specified file name.
+      * If data file for input is empty, CoordinateGen.java execution is required before running Main.java program in order to make arbitrary input files.
+
+ * CoordinateGen.java
+      * Prompts user to type in the dimension. This will be the initial dimension setup.
+      * Prompts user to select a file type - Large points, Small points.
+
+## This project is comprised of three major sections.
 
-### 1. Point Generator.
-  * Generates arbiturary points in incremental order.
-      * Matrix dimesion determined by users input.
-      * Matrix starting from 100 * 2 ^ n, where n = 1, 2, 3, 4... (Each of the matrix length is identical)
-      * Experimental number of points generated 600 * n, where n = 1, 2, 3, 4...
-      * Each generated points are save in .dat file named like: "POINTS_*MATRIX LENGTH*_*NUMBER OF POINTS*.dat
+For every distance calcuation, Euclidean distance is used.
+
+### 1. Point Generator(**CoordinateGen.java**).
+  * Generates arbiturary points in random order.
+      * Matrix dimesion determined by getting users input.
+      * Matrix point range and number of points grow larger.
+      * When generated input file name is BIG_DATA_CASE10_20, this means the generated random points have maximum point range from 1 to 10 with number of points of 20. 
 
 ### 2. Data structures.
-  * Sequential structure.
-    * insert()
-    * find()
-
-  * KD-Tree Structure.
-    * insert()
-    * find()
+  * Linked List (**SequentialAlgorithm.java**).
+    * insert(list)
+      > Append additional coordinate points to the end </br>
+    * findClosestDistance(targetPoints)
+      > Visit every node to verify the shortest distance </br>
+ 
+  * KD-Tree (**KDTreeIntegers.java**).
+    * Class.AxisSort
+      > comparator that sorts an ArrayList by axis index
+    * insert(depth, listOfPoints, currentNode, parentNode)
+      > Builds a binaray-tree like data structure.
+    * findKDTreeNormal(targetPoints)
+      > finds a approximately close distance to the targetPoints
+  
+  * KNN-Search (method in **KDTreeIntegers.java**).
+    * findKNNAlgorithm(targetPoints, node)
+      > find closest distance from the targetPoints with the result node from KD-Tree search
 
 ### 3. Result exportation.
+   * All summary data are exported into .cell file. Data contains:
+      > General cell 
+      >> Numeric value range. </br>
+      >> Number of points. </br>
+      >> Desired coordinationto look up. </br>
+
+      > Each cell contains
+      >> Closest coordinate points found </br>
+      >> Distance value in double </br>
+      >> Construction time consumption in nano seconds </br>
+      >> Search time consumption in nano seconds </br>
 
+Time is measured by using ProcessTimeRecorder(System.nanoTime).