differt-core 0.0.15__tar.gz → 0.0.17__tar.gz

{differt_core-0.0.15 → differt_core-0.0.17}/Cargo.lock

@@ -238,7 +238,7 @@ checksum = "7a81dae078cea95a014a339291cec439d2f232ebe854a9d672b796c6afafa9b7"
 
 [[package]]
 name = "differt-core"
-version = "0.0.15"
+version = "0.0.17"
 dependencies = [
  "criterion",
  "log",

{differt_core-0.0.15 → differt_core-0.0.17}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: differt-core
-Version: 0.0.15
+Version: 0.0.17
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10

{differt_core-0.0.15 → differt_core-0.0.17}/differt-core/Cargo.toml

@@ -32,4 +32,4 @@ name = "differt_core"
 edition = "2021"
 name = "differt-core"
 rust-version = "1.75.0"
-version = "0.0.15"
+version = "0.0.17"

{differt_core-0.0.15 → differt_core-0.0.17/differt-core}/python/differt_core/_lowlevel/rt/graph.pyi

@@ -31,6 +31,7 @@ class DiGraph:
     def insert_from_and_to_nodes(
         self, *, direct_path: bool = True
     ) -> tuple[int, int]: ...
+    def disconnect_nodes(self, *nodes: int, fast_mode: bool = True) -> None: ...
     def all_paths(
         self, from_: int, to: int, depth: int, *, include_from_and_to: bool = True
     ) -> AllPathsFromDiGraphIter: ...

{differt_core-0.0.15 → differt_core-0.0.17/differt-core}/python/differt_core/rt/graph.py

@@ -1,4 +1,4 @@
-"""TODO."""
+"""Graph utilities to generate path candidates, as used by exhaustive Ray Tracing methods, e.g., the Image Method."""
 
 __all__ = (
     "CompleteGraph",

{differt_core-0.0.15 → differt_core-0.0.17}/differt-core/src/rt/graph.rs

@@ -117,6 +117,9 @@ pub mod complete {
     /// A complete graph, i.e.,
     /// a simple undirected graph in which every pair of
     /// distinc nodes is connected by a unique edge.
+    ///
+    /// Args:
+    ///     num_nodes (int): The number of nodes.
     #[pyclass]
     #[derive(Clone, Debug)]
     pub struct CompleteGraph {
@@ -547,6 +550,12 @@ pub mod directed {
     }
 
     impl DiGraph {
+        #[inline]
+        pub fn empty(num_nodes: usize) -> Self {
+            Self {
+                edges_list: vec![vec![]; num_nodes],
+            }
+        }
         #[inline]
         pub fn get_adjacent_nodes(&self, node: NodeId) -> &[NodeId] {
             self.edges_list[node].as_ref()
@@ -574,6 +583,23 @@ pub mod directed {
 
     #[pymethods]
     impl DiGraph {
+        /// Create an edgeless directed graph with ``num_nodes`` nodes.
+        ///
+        /// This is equivalent to creating a directed graph from
+        /// an adjacency matrix will all entries equal to :py:data:`False`.
+        ///
+        /// Args:
+        ///     num\_nodes (int): The number of nodes.
+        ///
+        /// Return:
+        ///     DiGraph: A directed graph.
+        #[classmethod]
+        #[pyo3(name = "empty")]
+        #[pyo3(text_signature = "(cls, num_nodes)")]
+        fn py_empty(_: Bound<'_, PyType>, num_nodes: usize) -> Self {
+            Self::empty(num_nodes)
+        }
+
         /// Create a directed graph from an adjacency matrix.
         ///
         /// Each row of the adjacency matrix ``M`` contains boolean
@@ -659,6 +685,36 @@ pub mod directed {
             (from, to)
         }
 
+        /// Disconnect one or more nodes from the graph.
+        ///
+        /// This has two effects:
+        ///
+        /// - all paths from any of the specified nodes will be removed;
+        /// - and all paths to any of the specified nodes will be removed.
+        ///
+        /// Args:
+        ///     nodes (int): The nodes to be disconnected.
+        ///     fast\_mode (bool): Whether to skip removing the path to any
+        ///         of the specified nodes. In practice, removing paths
+        ///         from the nodes is sufficient, and faster to perform,
+        ///         but can lead to a slower graph traversal when
+        ///         generating all possible paths.
+        #[pyo3(signature = (*nodes, fast_mode=true))]
+        #[pyo3(text_signature = "(self, *nodes, fast_mode=True)")]
+        pub fn disconnect_nodes(&mut self, mut nodes: Vec<usize>, fast_mode: bool) {
+            for i in nodes.iter() {
+                self.edges_list[*i].clear();
+            }
+
+            if !fast_mode {
+                nodes.sort();
+
+                for edge in self.edges_list.iter_mut() {
+                    edge.retain(|node| nodes.binary_search(node).is_err());
+                }
+            }
+        }
+
         /// Return an iterator over all paths of length ``depth``
         /// from node ``from_`` to node ``to``.
         ///
@@ -1111,6 +1167,16 @@ mod tests {
         assert_eq!(got, expected);
     }
 
+    #[rstest]
+    #[case(9, 2)]
+    #[case(3, 3)]
+    fn test_empty_di_graph_returns_all_paths(#[case] num_nodes: usize, #[case] depth: usize) {
+        let mut graph = DiGraph::empty(num_nodes);
+        let (from, to) = graph.insert_from_and_to_nodes(false);
+
+        assert_eq!(graph.all_paths(from, to, depth + 2, true).count(), 0);
+    }
+
     #[rstest]
     #[case(9, 2)]
     #[case(3, 3)]

{differt_core-0.0.15 → differt_core-0.0.17}/differt-core/tests/rt/test_graph.py

@@ -1,3 +1,4 @@
+import numpy as np
 import pytest
 
 from differt_core.rt.graph import (
@@ -24,6 +25,39 @@ class TestDiGraph:
         ):
             _ = graph.insert_from_and_to_nodes(True)  # type: ignore
 
+    @pytest.mark.parametrize("fast_mode", (True, False))
+    def test_disconnect_nodes(self, fast_mode: bool) -> None:
+        graph = DiGraph.from_complete_graph(CompleteGraph(6))
+        from_, to = graph.insert_from_and_to_nodes()
+
+        nodes = (0, 1, 2, 5)
+        graph.disconnect_nodes(*nodes, fast_mode=fast_mode)
+
+        for depth in range(0, 3):
+            for path in graph.all_paths(
+                from_, to, depth + 2, include_from_and_to=False
+            ):
+                for node in nodes:
+                    assert node not in path
+
+    @pytest.mark.parametrize("fast_mode", (True, False))
+    def test_disconnect_nodes_equivalence(self, fast_mode: bool) -> None:
+        complete_graph = CompleteGraph(3)
+        di_graph = DiGraph.from_complete_graph(CompleteGraph(6))
+        from_, to = di_graph.insert_from_and_to_nodes()
+
+        nodes = (3, 4, 5)
+        di_graph.disconnect_nodes(*nodes, fast_mode=fast_mode)
+
+        for depth in range(0, 3):
+            complete_paths = complete_graph.all_paths_array(
+                from_, to, depth + 2, include_from_and_to=False
+            )
+            di_paths = di_graph.all_paths_array(
+                from_, to, depth + 2, include_from_and_to=False
+            )
+            np.testing.assert_equal(complete_paths, di_paths)
+
     def test_from_graph(self) -> None:
         graph = CompleteGraph(10)
         assert isinstance(graph, CompleteGraph)

{differt_core-0.0.15/differt-core → differt_core-0.0.17}/python/differt_core/_lowlevel/rt/graph.pyi

@@ -31,6 +31,7 @@ class DiGraph:
     def insert_from_and_to_nodes(
         self, *, direct_path: bool = True
     ) -> tuple[int, int]: ...
+    def disconnect_nodes(self, *nodes: int, fast_mode: bool = True) -> None: ...
     def all_paths(
         self, from_: int, to: int, depth: int, *, include_from_and_to: bool = True
     ) -> AllPathsFromDiGraphIter: ...

{differt_core-0.0.15/differt-core → differt_core-0.0.17}/python/differt_core/rt/graph.py

@@ -1,4 +1,4 @@
-"""TODO."""
+"""Graph utilities to generate path candidates, as used by exhaustive Ray Tracing methods, e.g., the Image Method."""
 
 __all__ = (
     "CompleteGraph",