Merge pull request #204 from TurtIeSocks/algorithm-docs

Algorithm notes & docs
TurtIeSocks · Nov 16, 2023 · 5052c52 · 5052c52 · vercel · Nov 16, 2023
2 parents c69cc3c + 17bf902
commit 5052c52
Show file tree

Hide file tree

Showing 9 changed files with 575 additions and 10 deletions.
diff --git a/docs/pages/_meta.json b/docs/pages/_meta.json
@@ -3,6 +3,7 @@
   "setup": "Setup",
   "client": "Client",
   "api-reference": "API Reference",
+  "algorithms": "Algorithms",
   "integrations": "Integrations",
   "development": "Development"
 }
diff --git a/docs/pages/algorithms/clustering.mdx b/docs/pages/algorithms/clustering.mdx
diff --git a/docs/public/images/clustering/balanced-legacy.png b/docs/public/images/clustering/balanced-legacy.png
diff --git a/docs/public/images/clustering/balanced.png b/docs/public/images/clustering/balanced.png
diff --git a/docs/public/images/clustering/better.png b/docs/public/images/clustering/better.png
diff --git a/docs/public/images/clustering/brute-force-legacy.png b/docs/public/images/clustering/brute-force-legacy.png
diff --git a/docs/public/images/clustering/fast.png b/docs/public/images/clustering/fast.png
diff --git a/docs/public/images/clustering/fastest.png b/docs/public/images/clustering/fastest.png
diff --git a/server/algorithms/src/clustering/greedy.rs b/server/algorithms/src/clustering/greedy.rs
@@ -280,8 +280,8 @@ impl<'a> Greedy {
         let mut new_clusters = HashSet::<Cluster>::new();
         let mut blocked_points = HashSet::<&Point>::new();
 
-        let mut highest = clusters_with_data.len() - 1;
-        let total_iterations = highest - self.min_points + 1;
+        let mut current = clusters_with_data.len() - 1;
+        let total_iterations = current - self.min_points + 1;
         let mut current_iteration = 0;
         let mut stdout = std::io::stdout();
 
@@ -291,12 +291,12 @@ impl<'a> Greedy {
         let mut iterating_local_time = 0.;
         let mut logging_time = 0.;
 
-        'greedy: while highest >= self.min_points && new_clusters.len() < self.max_clusters {
+        'greedy: while current >= self.min_points && new_clusters.len() < self.max_clusters {
             let mut clusters_of_interest: Vec<&Cluster<'_>> = vec![];
             current_iteration += 1;
             let time = Instant::now();
-            for (max, clusters) in clusters_with_data.iter().enumerate() {
-                if max < highest {
+            for (index, clusters) in clusters_with_data.iter().enumerate() {
+                if index < current {
                     continue;
                 }
                 clusters_of_interest.extend(clusters);
@@ -318,7 +318,7 @@ impl<'a> Greedy {
                             }
                         })
                         .collect();
-                    if points.len() < highest {
+                    if points.len() < current {
                         None
                     } else {
                         points.sort_dedupe();
@@ -334,7 +334,7 @@ impl<'a> Greedy {
             local_clusters_time += time.elapsed().as_secs_f32();
 
             if local_clusters.is_empty() {
-                highest -= 1;
+                current -= 1;
                 continue;
             }
 
@@ -353,7 +353,7 @@ impl<'a> Greedy {
                 if new_clusters.len() >= self.max_clusters {
                     break 'greedy;
                 }
-                if cluster.points.len() >= highest {
+                if cluster.points.len() >= current {
                     for point in cluster.points.iter() {
                         if blocked_points.contains(point) {
                             continue 'cluster;
@@ -368,7 +368,7 @@ impl<'a> Greedy {
             iterating_local_time += time.elapsed().as_secs_f32();
 
             let time = Instant::now();
-            if highest >= self.min_points {
+            if current >= self.min_points {
                 stdout
                     .write(
                         info_log(
@@ -386,7 +386,7 @@ impl<'a> Greedy {
             }
             logging_time += time.elapsed().as_secs_f32();
 
-            highest -= 1;
+            current -= 1;
         }
         stdout.write(format!("\n",).as_bytes()).unwrap();