Crates.io | retworkx-core |
lib.rs | retworkx-core |
version | 0.11.0 |
source | src |
created_at | 2022-01-19 21:49:55.189365 |
updated_at | 2022-01-19 21:49:55.189365 |
description | Rust APIs used for retworkx algorithms |
homepage | https://github.com/Qiskit/retworkx/tree/main/retworkx-core |
repository | https://github.com/Qiskit/retworkx |
max_upload_size | |
id | 517094 |
size | 153,909 |
This crate contains the rust library retworkx-core. This library is part of the retworkx project. However while the larger retworkx project is a Python library that offers a general purpose high performance graph library written in Rust, retworkx-core is a pure rust library that offers a stable rust API for any downstream crate that need it.
At it's core retworkx is built on top of the petgraph library and wraps it in a Python layer. However, many of the algorithms (and to a lesser extent data structures) needed for retworkx are not available in petgraph. For places where these algorithms are implemented in a generic way the retworkx-core crate exposes it for rust users.
Add this to your Cargo.toml
:
[dependencies]
retworkx-core = "0.11"
Then:
use retworkx_core;
Note there is a strong version dependency between petgraph
and retworkx-core
as the functionality exposed by retworkx-core is built on top of petgraph. For
convenience we re-export petgraph
in the root of this crate so you can use
petgraph without explicitly needing it at the same exact version in your crate.
Just as with the rest of the retworkx project retworkx-core is licensed under the Apache License, Version 2.0: https://www.apache.org/licenses/LICENSE-2.0