Rename CycleDetector to SimilarPathDetector

Author: Hendrik van Antwerpen

stack-graphs/src/cycles.rs

@@ -45,8 +45,8 @@ use crate::paths::Path;
 use crate::stitching::Database;
 use crate::stitching::OwnedOrDatabasePath;
 
-/// Helps detect cycles in the path-finding algorithm.
-pub struct CycleDetector<P> {
+/// Helps detect similar paths in the path-finding algorithm.
+pub struct SimilarPathDetector<P> {
     paths: HashMap<PathKey, SmallVec<[P; 8]>>,
 }
 
@@ -93,13 +93,13 @@ impl HasPathKey for PartialPath {
 
 const MAX_SIMILAR_PATH_COUNT: usize = 7;
 
-impl<P> CycleDetector<P>
+impl<P> SimilarPathDetector<P>
 where
     P: HasPathKey,
 {
     /// Creates a new, empty cycle detector.
-    pub fn new() -> CycleDetector<P> {
-        CycleDetector {
+    pub fn new() -> SimilarPathDetector<P> {
+        SimilarPathDetector {
             paths: HashMap::new(),
         }
     }

stack-graphs/src/partial.rs

@@ -45,8 +45,8 @@ use smallvec::SmallVec;
 use crate::arena::Deque;
 use crate::arena::DequeArena;
 use crate::arena::Handle;
-use crate::cycles::CycleDetector;
 use crate::cycles::EdgeAppendingCycleDetector;
+use crate::cycles::SimilarPathDetector;
 use crate::graph::Edge;
 use crate::graph::File;
 use crate::graph::Node;
@@ -2696,7 +2696,7 @@ impl PartialPaths {
         }
 
         copious_debugging!("Find all partial paths in {}", graph[file]);
-        let mut similar_path_detector = CycleDetector::new();
+        let mut similar_path_detector = SimilarPathDetector::new();
         let mut queue = VecDeque::new();
         queue.extend(
             graph

stack-graphs/src/paths.rs

@@ -26,7 +26,7 @@ use crate::arena::DequeArena;
 use crate::arena::Handle;
 use crate::arena::List;
 use crate::arena::ListArena;
-use crate::cycles::CycleDetector;
+use crate::cycles::SimilarPathDetector;
 use crate::graph::Edge;
 use crate::graph::Node;
 use crate::graph::NodeID;
@@ -901,7 +901,7 @@ impl Paths {
         I: IntoIterator<Item = Handle<Node>>,
         F: FnMut(&StackGraph, &mut Paths, Path),
     {
-        let mut cycle_detector = CycleDetector::new();
+        let mut cycle_detector = SimilarPathDetector::new();
         let mut queue = starting_nodes
             .into_iter()
             .filter_map(|node| Path::from_node(graph, self, node))

stack-graphs/src/stitching.rs

@@ -48,8 +48,8 @@ use crate::arena::List;
 use crate::arena::ListArena;
 use crate::arena::ListCell;
 use crate::arena::SupplementalArena;
-use crate::cycles::CycleDetector;
 use crate::cycles::PartialPathAppendingCycleDetector;
+use crate::cycles::SimilarPathDetector;
 use crate::graph::Node;
 use crate::graph::StackGraph;
 use crate::graph::Symbol;
@@ -477,7 +477,7 @@ pub struct PathStitcher {
     candidate_paths: Vec<Handle<PartialPath>>,
     queue: VecDeque<Path>,
     next_iteration: VecDeque<Path>,
-    cycle_detector: CycleDetector<Path>,
+    cycle_detector: SimilarPathDetector<Path>,
     max_work_per_phase: usize,
     #[cfg(feature = "copious-debugging")]
     phase_number: usize,
@@ -522,7 +522,7 @@ impl PathStitcher {
             candidate_paths,
             queue: VecDeque::new(),
             next_iteration,
-            cycle_detector: CycleDetector::new(),
+            cycle_detector: SimilarPathDetector::new(),
             // By default, there's no artificial bound on the amount of work done per phase
             max_work_per_phase: usize::MAX,
             #[cfg(feature = "copious-debugging")]
@@ -725,7 +725,7 @@ pub struct ForwardPartialPathStitcher {
         VecDeque<PartialPath>,
         VecDeque<PartialPathAppendingCycleDetector>,
     ),
-    similar_path_detector: CycleDetector<PartialPath>,
+    similar_path_detector: SimilarPathDetector<PartialPath>,
     max_work_per_phase: usize,
     #[cfg(feature = "copious-debugging")]
     phase_number: usize,
@@ -794,7 +794,7 @@ impl ForwardPartialPathStitcher {
             candidate_partial_paths,
             queue: VecDeque::new(),
             next_iteration,
-            similar_path_detector: CycleDetector::new(),
+            similar_path_detector: SimilarPathDetector::new(),
             // By default, there's no artificial bound on the amount of work done per phase
             max_work_per_phase: usize::MAX,
             #[cfg(feature = "copious-debugging")]
@@ -834,7 +834,7 @@ impl ForwardPartialPathStitcher {
             candidate_partial_paths: Vec::new(),
             queue: VecDeque::new(),
             next_iteration,
-            similar_path_detector: CycleDetector::new(),
+            similar_path_detector: SimilarPathDetector::new(),
             // By default, there's no artificial bound on the amount of work done per phase
             max_work_per_phase: usize::MAX,
             #[cfg(feature = "copious-debugging")]