graphs tools : refactor

Author: Wandalen

module/move/graphs_tools/src/search.rs

@@ -38,6 +38,7 @@ mod private
     Visit : FnMut( &'a Graph::Node ),
     Method : super::Method,
   {
+    /// Search traversing each node in an order specified by method.
     pub fn search( self, graph : &'a Graph )
     {
       graph.search( self )
@@ -104,91 +105,20 @@ mod private
       Self : Sized;
   }
 
-  /// Depth-first search strategy.
-  #[ derive( Debug, Default ) ]
-  pub struct Dfs;
-
-  impl Method for Dfs
-  {
-    type ExtraOptions = ();
-
-    /// Perform depth-first search on a graph.
-    fn _search< 'a, Graph, Visit >
-    (
-      graph : &'a Graph,
-      mut o : Options< 'a, Self, Graph, Visit >,
-    )
-    where
-      Visit : FnMut( &'a Graph::Node ),
-      Graph : ForGraphDirected< 'a > + ?Sized,
-    {
-      let mut visited = collection_tools::HashSet::new();
-      let mut stack = collection_tools::Vec::new();
-      stack.push( o.start_id );
-
-      while let Some( node_id ) = stack.pop()
-      {
-        let node = graph.node_ref( node_id );
-        if visited.insert( node_id )
-        {
-          ( o.visit )( node );
-          for child_id in graph.node_out_nodes( node_id )
-          {
-            stack.push( child_id );
-          }
-        }
-      }
-    }
-  }
-
-  /// Breadth-first search strategy.
-  #[ derive( Debug, Default ) ]
-  pub struct Bfs;
-
-  impl Method for Bfs
-  {
-    type ExtraOptions = ();
-
-    /// Perform breadth-first search on a graph.
-    fn _search< 'a, Graph, Visit >
-    (
-      graph : &'a Graph,
-      mut o : Options< 'a, Self, Graph, Visit >,
-    )
-    where
-      Visit : FnMut( &'a Graph::Node ),
-      Graph : ForGraphDirected< 'a > + ?Sized,
-    {
-      let mut visited = collection_tools::HashSet::new();
-      let mut queue = collection_tools::VecDeque::new();
-      queue.push_back( o.start_id );
-
-      while let Some( node_id ) = queue.pop_front()
-      {
-        let node = graph.node_ref( node_id );
-        if visited.insert( node_id )
-        {
-          ( o.visit )( node );
-          for child_id in graph.node_out_nodes( node_id )
-          {
-            queue.push_back( child_id );
-          }
-        }
-      }
-    }
-  }
-
 }
 
 crate::mod_interface!
 {
+  layer
+  {
+    dfs,
+    bfs,
+  };
   own use
   {
     options,
     Method,
     Options,
     ForGraphDirected,
-    Dfs,
-    Bfs,
   };
 }

module/move/graphs_tools/src/search/bfs.rs

@@ -0,0 +1,53 @@
+//! Breadth  first search method.
+
+mod private
+{
+  use crate::*;
+  use search::{ Method, ForGraphDirected, Options };
+
+  /// Breadth-first search strategy.
+  #[ derive( Debug, Default ) ]
+  pub struct Bfs;
+
+  impl Method for Bfs
+  {
+    type ExtraOptions = ();
+
+    /// Perform breadth-first search on a graph.
+    fn _search< 'a, Graph, Visit >
+    (
+      graph : &'a Graph,
+      mut o : Options< 'a, Self, Graph, Visit >,
+    )
+    where
+      Visit : FnMut( &'a Graph::Node ),
+      Graph : ForGraphDirected< 'a > + ?Sized,
+    {
+      let mut visited = collection_tools::HashSet::new();
+      let mut queue = collection_tools::VecDeque::new();
+      queue.push_back( o.start_id );
+
+      while let Some( node_id ) = queue.pop_front()
+      {
+        let node = graph.node_ref( node_id );
+        if visited.insert( node_id )
+        {
+          ( o.visit )( node );
+          for child_id in graph.node_out_nodes( node_id )
+          {
+            queue.push_back( child_id );
+          }
+        }
+      }
+    }
+  }
+
+}
+
+crate::mod_interface!
+{
+  orphan use
+  {
+    Bfs,
+  };
+}

module/move/graphs_tools/src/search/dfs.rs

@@ -0,0 +1,54 @@
+//! Depth first search method.
+
+mod private
+{
+  use crate::*;
+  use search::{ Method, ForGraphDirected, Options };
+
+  /// Depth-first search method.
+  #[ derive( Debug, Default ) ]
+  pub struct Dfs;
+
+  impl Method for Dfs
+  {
+    type ExtraOptions = ();
+
+    /// Perform depth-first search on a graph.
+    fn _search< 'a, Graph, Visit >
+    (
+      graph : &'a Graph,
+      mut o : Options< 'a, Self, Graph, Visit >,
+    )
+    where
+      Visit : FnMut( &'a Graph::Node ),
+      Graph : ForGraphDirected< 'a > + ?Sized,
+    {
+      let mut visited = collection_tools::HashSet::new();
+      let mut stack = collection_tools::Vec::new();
+      stack.push( o.start_id );
+
+      while let Some( node_id ) = stack.pop()
+      {
+        let node = graph.node_ref( node_id );
+        if visited.insert( node_id )
+        {
+          ( o.visit )( node );
+          for child_id in graph.node_out_nodes( node_id )
+          {
+            stack.push( child_id );
+          }
+        }
+      }
+    }
+
+  }
+
+}
+
+crate::mod_interface!
+{
+  orphan use
+  {
+    Dfs,
+  };
+}

module/move/graphs_tools/tests/inc/graph.rs

@@ -0,0 +1,3 @@
+use super::*;
+
+pub mod map_of_nodes;

module/move/graphs_tools/tests/inc/graph/map_of_nodes.rs

@@ -0,0 +1,82 @@
+use super::*;
+
+use derive_tools::From;
+use the_module::abs;
+use iter_tools::{ _IterTrait, IterTrait, BoxedIter };
+
+#[ derive( Debug ) ]
+pub struct Node< 'a >
+{
+  pub id : NodeId,
+  pub children : Vec< &'a Node< 'a > >,
+}
+
+impl< 'a > the_module::abs::Node for Node< 'a > {}
+
+impl< 'a > Node< 'a >
+{
+  pub fn new< IntoId : Into< NodeId > >( id : IntoId ) -> Node< 'a >
+  {
+    Node
+    {
+      id : id.into(),
+      children : Vec::new(),
+    }
+  }
+
+  pub fn add_child( &mut self, child : &'a Node< 'a > ) -> &mut Self
+  {
+    self.children.push( child );
+    self
+  }
+}
+
+#[ derive( Default ) ]
+pub struct Graph< 'a >
+{
+  nodes : HashMap< NodeId, &'a Node< 'a > >,
+}
+
+impl< 'a > Graph< 'a >
+{
+
+  pub fn add_node( &mut self, node : &'a Node< 'a > )
+  {
+    self.nodes.insert( node.id, node );
+  }
+
+}
+
+impl< 'a > abs::GraphDirected< 'a > for Graph< 'a >
+{
+
+  type NodeId = NodeId;
+  type Node = Node< 'a >;
+
+  fn node_ref( &self, node_id : NodeId ) -> &'a Node< 'a >
+  {
+    self.nodes.get( &node_id ).expect( "If id exist then node shoudl also exist" )
+  }
+
+  fn node_id( &self, node : &'a Node< 'a > ) -> NodeId
+  {
+    node.id
+  }
+
+  fn node_out_nodes( &self, node_id : NodeId ) -> BoxedIter< 'a, Self::NodeId >
+  {
+    if let Some( node ) = self.nodes.get( &node_id )
+    {
+      Box::new( node.children.iter().map( | child | child.id ) )
+    }
+    else
+    {
+      Box::new( std::iter::empty() )
+    }
+  }
+}
+
+#[ derive( Debug, Copy, Clone, Hash, PartialEq, Eq, From ) ]
+pub struct NodeId( usize );
+
+impl the_module::abs::NodeId for NodeId {}

module/move/graphs_tools/tests/inc/mod.rs

@@ -2,6 +2,8 @@
 
 use super::*;
 
+pub mod graph;
+
 mod basic_test;
-mod nodes;
-mod search;
+mod nodes_test;
+mod search_test;