Clarify that weights are capacities in Edmonds-Karp

AloizioMacedo · Jan 7, 2024 · 4956bd7 · 4956bd7
1 parent 089d98a
commit 4956bd7
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/src/graph.rs b/src/graph.rs
@@ -788,6 +788,8 @@ where
 {
     /// Runs the Edmonds-Karp algorithm on the graph to find max flow.
     ///
+    /// Assumes the edge weights are the capacities.
+    ///
     /// Returns a HashMap with the flow values for each edge.
     ///
     /// Please select a number type for W which allows for subtraction
@@ -1080,6 +1082,8 @@ where
 {
     /// Runs the Edmonds-Karp algorithm on the graph to find max flow.
     ///
+    /// Assumes the edge weights are the capacities.
+    ///
     /// Returns a HashMap with the flow values for each edge.
     ///
     /// Please select a number type for W which allows for subtraction

diff --git a/src/graph/traits.rs b/src/graph/traits.rs
@@ -1044,6 +1044,8 @@ where
 
     /// Runs the Edmonds-Karp algorithm on the graph to find max flow.
     ///
+    /// Assumes the edge weights are the capacities.
+    ///
     /// Returns a HashMap with the flow values for each edge.
     ///
     /// Please select a number type for W which allows for subtraction