From af2bbb9a956c6433f0a961fb7cd1b8df9b6dbbb4 Mon Sep 17 00:00:00 2001
From: Samuel Tardieu <sam@rfc1149.net>
Date: Sun, 24 Mar 2024 11:45:22 +0100
Subject: [PATCH] feat(dfs): make DFS more efficient by using IndexSet
 internally

This requires an API change as using an `IndexSet` requires the type to
implement `Hash`.
---
 src/directed/dfs.rs | 15 +++++++++------
 1 file changed, 9 insertions(+), 6 deletions(-)

diff --git a/src/directed/dfs.rs b/src/directed/dfs.rs
index 942b9bba..9cca6f50 100644
--- a/src/directed/dfs.rs
+++ b/src/directed/dfs.rs
@@ -5,6 +5,8 @@ use std::collections::HashSet;
 use std::hash::Hash;
 use std::iter::FusedIterator;
 
+use crate::FxIndexSet;
+
 /// Compute a path using the [depth-first search
 /// algorithm](https://en.wikipedia.org/wiki/Depth-first_search).
 /// The path starts from `start` up to a node for which `success` returns `true` is computed and
@@ -45,18 +47,19 @@ use std::iter::FusedIterator;
 /// ```
 pub fn dfs<N, FN, IN, FS>(start: N, mut successors: FN, mut success: FS) -> Option<Vec<N>>
 where
-    N: Eq,
+    N: Eq + Hash,
     FN: FnMut(&N) -> IN,
     IN: IntoIterator<Item = N>,
     FS: FnMut(&N) -> bool,
 {
-    let mut path = vec![start];
-    step(&mut path, &mut successors, &mut success).then_some(path)
+    let mut path = FxIndexSet::default();
+    path.insert(start);
+    step(&mut path, &mut successors, &mut success).then_some(Vec::from_iter(path))
 }
 
-fn step<N, FN, IN, FS>(path: &mut Vec<N>, successors: &mut FN, success: &mut FS) -> bool
+fn step<N, FN, IN, FS>(path: &mut FxIndexSet<N>, successors: &mut FN, success: &mut FS) -> bool
 where
-    N: Eq,
+    N: Eq + Hash,
     FN: FnMut(&N) -> IN,
     IN: IntoIterator<Item = N>,
     FS: FnMut(&N) -> bool,
@@ -67,7 +70,7 @@ where
         let successors_it = successors(path.last().unwrap());
         for n in successors_it {
             if !path.contains(&n) {
-                path.push(n);
+                path.insert(n);
                 if step(path, successors, success) {
                     return true;
                 }