Implement petgraph traits (#70)

* Implement petgraph traits * Add new feature to the README
CQCL · Jun 14, 2023 · ea13161 · ea13161
1 parent e52e441
commit ea13161
Show file tree

Hide file tree

Showing 4 changed files with 390 additions and 0 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -28,11 +28,13 @@ bitvec = "1.0.1"
 serde = { version = "1.0.152", features = ["derive"], optional = true}
 proptest = { version = "1.1.0", optional = true }
 rand = { version = "0.8.5", optional = true }
+petgraph = { version = "0.6.3", optional = true }
 
 [features]
 pyo3 = ["dep:pyo3"]
 serde = ["dep:serde", "bitvec/serde"]
 proptest = ["dep:proptest", "dep:rand"]
+petgraph = ["dep:petgraph"]
 
 [dev-dependencies]
 criterion = { version = "0.5.1", features = ["html_reports"] }

diff --git a/README.md b/README.md
@@ -14,6 +14,8 @@ Please read the [API documentation here][].
 
 -   `pyo3`: Enable Python bindings via pyo3.
 -   `serde`: Enable serialization and deserialization via serde.
+-   `petgraph`: Enable petgraph interoperability by implementing the
+    `petgraph::visit` traits for `PortGraph` and `MultiPortGraph`.
 
 ## Recent Changes
 

diff --git a/src/view.rs b/src/view.rs
@@ -1,5 +1,8 @@
 //! Abstractions over portgraph representations.
 
+#[cfg(feature = "petgraph")]
+pub mod petgraph;
+
 use crate::{portgraph::PortOperation, Direction, LinkError, NodeIndex, PortIndex, PortOffset};
 
 /// Core capabilities of a graph containing nodes and ports.