berkus
/
vf2
mirror of https://github.com/OwenTrokeBillard/vf2.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update documentation

This commit is contained in:
Owen Troke-Billard 2024-09-17 12:32:33 -06:00
parent 54997dd7b3
commit 9b9232dbc9
2 changed files with 24 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -61,15 +61,22 @@ the data subgraph must also exist in the query graph.
# Usage
Add `vf2` to your dependencies in **Cargo.toml**.
```toml
[dependencies]
vf2 = "1.0"
```
Create your query and data graphs with [petgraph](https://github.com/petgraph/petgraph)
or any library that implements the `Graph` trait. Then, call one of the following
functions based on the problem type.
| Problem type | Call |
|-------------------------------|---------------------------------|
| Graph isomorphisms | `isomorphisms` |
| Subgraph isomorphisms | `subgraph_isomorphisms` |
| Induced subgraph isomorphisms | `induced_subgraph_isomorphisms` |
| Problem type | Call |
|-------------------------------|--------------------------------------|
| Graph isomorphisms | `vf2::isomorphisms` |
| Subgraph isomorphisms | `vf2::subgraph_isomorphisms` |
| Induced subgraph isomorphisms | `vf2::induced_subgraph_isomorphisms` |
These return a `Vf2Builder` with the algorithm configured.
Next, call one of the following on the builder to enumerate the isomorphisms.

17
src/lib.rs
View File

@ -9,15 +9,22 @@
//!
//! # Usage
//!
//! Add `vf2` to your dependencies in **Cargo.toml**.
//!
//! ```toml
//! [dependencies]
//! vf2 = "1.0"
//! ```
//!
//! Create your query and data graphs with [petgraph](https://github.com/petgraph/petgraph)
//! or any library that implements the [`Graph`] trait. Then, call one of the following
//! functions based on the problem type.
//!
//! | Problem type | Call |
//! |-------------------------------|-----------------------------------|
//! | Graph isomorphisms | [`isomorphisms`] |
//! | Subgraph isomorphisms | [`subgraph_isomorphisms`] |
//! | Induced subgraph isomorphisms | [`induced_subgraph_isomorphisms`] |
//! | Problem type | Call |
//! |-------------------------------|-----------------------------------------------------------------------|
//! | Graph isomorphisms | [`vf2::isomorphisms`](isomorphisms) |
//! | Subgraph isomorphisms | [`vf2::subgraph_isomorphisms`](subgraph_isomorphisms) |
//! | Induced subgraph isomorphisms | [`vf2::induced_subgraph_isomorphisms`](induced_subgraph_isomorphisms) |
//!
//! \
//! These return a [`Vf2Builder`] with the algorithm configured.