graphs_tools : reimplementing

Author: Wandalen

module/move/graphs_tools/Cargo.toml

@@ -23,24 +23,30 @@ workspace = true
 features = [ "full" ]
 all-features = false
 
-
 [features]
 default = [
-  "enabled"
+  "enabled",
+  "debug",
 ]
 full = [
-  "enabled",
+  "default",
+]
+enabled = [
+  "meta_tools/enabled",
+  "iter_tools/enabled",
+  # "data_type/enabled",
+  # "strs_tools/enabled",
+  "collection_tools/enabled",
 ]
-no_std = []
-use_alloc = [ "no_std" ]
-enabled = [ "meta_tools/enabled", "iter_tools/enabled", "data_type/enabled", "strs_tools/enabled" ]
+debug = []
 
 [dependencies]
-indexmap = "~1.8"
+# indexmap = "~1.8"
 meta_tools = { workspace = true, features = [ "default" ] }
 iter_tools = { workspace = true, features = [ "default" ] }
-data_type = { workspace = true, features = [ "default" ] }
-strs_tools = { workspace = true, features = [ "default" ] }
+# data_type = { workspace = true, features = [ "default" ] }
+collection_tools = { workspace = true, features = [ "default" ] }
+# strs_tools = { workspace = true, features = [ "default" ] }
 derive_tools = { workspace = true, features = [ "default" ] }
 # type_constructor ={ workspace = true, features = [ "default" ] }
 

module/move/graphs_tools/src/abs.rs

@@ -3,6 +3,8 @@
 mod private
 {
 
+  pub use iter_tools::{ _IterTrait, IterTrait, BoxedIter };
+
   use std::
   {
     hash::Hash,
@@ -39,14 +41,46 @@ mod private
   {
   }
 
-  /// Uniquely identify the node.
+  /// Uniquely identify a node.
   pub trait NodeId : IdentityInterface
   {
   }
 
+  /// Node itsef.
+  pub trait Node
+  {
+  }
+
+  /// Represent directed graph. Can be zero-sized structure if nodes own all the information.
+  pub trait GraphDirected< 'a >
+  {
+    /// Uniquely identify a node.
+    type NodeId : NodeId;
+    /// Node itself.
+    type Node : Node + 'a;
+
+    /// Get a reference on a node by its id.
+    fn node_ref( &self, node_id : Self::NodeId ) -> &'a Self::Node;
+    /// Get id by its node reference.
+    fn node_id( &self, node_id : &'a Self::Node ) -> Self::NodeId;
+
+    /// Iterate over out nodes of
+    fn node_out_nodes( &self, node_id : Self::NodeId ) -> BoxedIter< 'a, Self::NodeId >;
+    // fn node_out_nodes( &self, node_id : Self::NodeId ) -> impl _IterTrait< 'a, Self::NodeId >;
+
+  }
+
 }
 
 crate::mod_interface!
 {
-  own use { IdentityInterface, NodeId };
+  own use
+  {
+    _IterTrait,
+    IdentityInterface,
+    NodeId,
+    Node,
+    GraphDirected,
+
+  };
 }

module/move/graphs_tools/src/canonical.rs

@@ -2,8 +2,10 @@
 /// Define a private namespace for all its items.
 mod private
 {
+
 }
 
 crate::mod_interface!
 {
+
 }

module/move/graphs_tools/src/debug.rs

@@ -0,0 +1,11 @@
+
+/// Define a private namespace for all its items.
+mod private
+{
+
+}
+
+crate::mod_interface!
+{
+
+}

module/move/graphs_tools/src/lib.rs

@@ -1,4 +1,4 @@
-#![ cfg_attr( feature = "no_std", no_std ) ]
+// #![ cfg_attr( feature = "no_std", no_std ) ]
 #![ doc( html_logo_url = "https://raw.githubusercontent.com/Wandalen/wTools/alpha/asset/img/graph_logo_v1_trans.png" ) ]
 #![ doc( html_favicon_url = "https://raw.githubusercontent.com/Wandalen/wTools/alpha/asset/img/graph_logo_v1_trans.ico" ) ]
 #![ doc( html_root_url = "https://docs.rs/graphs_tools/latest/graphs_tools/" ) ]
@@ -13,8 +13,8 @@
 #![ allow( unused_imports ) ]
 use iter_tools::iter;
 // use data_type::dt;
-use meta_tools::meta;
-use strs_tools::string;
+// use meta_tools::meta;
+// use strs_tools::string;
 use meta_tools::mod_interface;
 
 /// Define a private namespace for all its items.
@@ -26,13 +26,18 @@ mod_interface!
 {
 
   /// Abstract layer.
-  #[ cfg( not( feature = "no_std" ) ) ]
   layer abs;
 
+  /// Search algorithms.
+  layer search;
+
   /// Canonical representation.
-  #[ cfg( not( feature = "no_std" ) ) ]
   layer canonical;
 
+  /// For diagnostics only.
+  #[ cfg( feature = "debug" ) ]
+  layer debug;
+
   // /// Algorithms.
   // #[ cfg( not( feature = "no_std" ) ) ]
   // layer algo;

module/move/graphs_tools/src/search.rs

@@ -0,0 +1,148 @@
+mod private
+{
+  /// Options for configuring a graph search.
+  #[ derive( Debug ) ]
+  pub struct Options< 'a, Method, NodeId, Node, Visit >
+  where
+    NodeId : crate::abs::NodeId,
+    Node : crate::abs::Node + 'a,
+    Visit : FnMut( &'a Node ),
+    Method : super::Method,
+  {
+    /// Starting node ID for the search.
+    pub start_id : NodeId,
+    /// Function to call on each visited node.
+    pub visit : Visit,
+    /// Additional options specific to the search method.
+    pub _extra : Method::ExtraOptions,
+    /// Phantom data to associate types and lifetimes.
+    pub _phantom : std::marker::PhantomData< ( Method, Node, &'a () ) >,
+  }
+
+  /// Trait for performing searches on directed graphs.
+  pub trait ForGraphDirected< 'a > : crate::abs::GraphDirected< 'a >
+  {
+    /// Perform a search using specified options and method.
+    fn search< Visit, Method >
+    (
+      &'a self,
+      o : Options< 'a, Method, Self::NodeId, Self::Node, Visit >,
+    )
+    where
+      Visit : FnMut( &'a Self::Node ),
+      Method : super::Method,
+    {
+      Method::_search( self, o )
+    }
+  }
+
+  impl< 'a, T > ForGraphDirected< 'a > for T
+  where
+    T : crate::abs::GraphDirected< 'a >,
+  {
+  }
+
+  /// Trait for defining specific search strategies like DFS or BFS.
+  pub trait Method
+  {
+    /// Additional options for the search method.
+    type ExtraOptions;
+
+    /// Execute the search on a graph.
+    fn _search< 'a, Graph, Visit >
+    (
+      graph : &'a Graph,
+      o : Options< 'a, Self, Graph::NodeId, Graph::Node, Visit >,
+    )
+    where
+      Visit : FnMut( &'a Graph::Node ),
+      Graph : crate::abs::GraphDirected< 'a > + ?Sized,
+      Self : Sized;
+  }
+
+  /// Depth-first search strategy.
+  #[ derive( Debug ) ]
+  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::NodeId, Graph::Node, Visit >,
+    )
+    where
+      Visit : FnMut( &'a Graph::Node ),
+      Graph : crate::abs::GraphDirected< '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 ) ]
+  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::NodeId, Graph::Node, Visit >,
+    )
+    where
+      Visit : FnMut( &'a Graph::Node ),
+      Graph : crate::abs::GraphDirected< '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!
+{
+  own use
+  {
+    Method,
+    Options,
+    ForGraphDirected,
+    Dfs,
+    Bfs,
+  };
+}

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

@@ -1,7 +1,7 @@
 #![ allow( unused_imports ) ]
 
 use super::*;
-// use std::collections::HashSet;
-// use wtools::prelude::*;
 
 mod basic_test;
+mod nodes;
+mod search;