rustworkx-core
| Crates.io | rustworkx-core |
| lib.rs | rustworkx-core |
| version | |
| source | src |
| created_at | 2022-10-07 18:27:24.318396 |
| updated_at | 2025-01-24 00:45:50.16088 |
| description | Rust APIs used for rustworkx algorithms |
| homepage | https://github.com/Qiskit/rustworkx/tree/main/rustworkx-core |
| repository | https://github.com/Qiskit/rustworkx |
| max_upload_size | |
| id | 683015 |
| Cargo.toml error: | TOML parse error at line 19, column 1 | 19 | autolib = false | ^^^^^^^ unknown field `autolib`, expected one of `name`, `version`, `edition`, `authors`, `description`, `readme`, `license`, `repository`, `homepage`, `documentation`, `build`, `resolver`, `links`, `default-run`, `default_dash_run`, `rust-version`, `rust_dash_version`, `rust_version`, `license-file`, `license_dash_file`, `license_file`, `licenseFile`, `license_capital_file`, `forced-target`, `forced_dash_target`, `autobins`, `autotests`, `autoexamples`, `autobenches`, `publish`, `metadata`, `keywords`, `categories`, `exclude`, `include` |
| size | 0 |
Matthew Treinish (mtreinish)
documentation
README
rustworkx-core
:warning: The retworkx-core project has been renamed to rustworkx-core. If you're using retworkx-core 0.11.0 you will need to change your requirement and use statements to use the new crate name
rustworkx-core is a graph algorithm library that is built on top of petgraph. It offers additional algorithms and functionality on top of the core data structures offered in the petgraph library.
This crate contains the Rust library rustworkx-core. This library is part of the rustworkx project. However while the larger rustworkx project is a Python library that offers a general purpose high performance graph library written in Rust, rustworkx-core is a pure rust library that offers a stable rust API for any downstream crate that need it.
At it's core rustworkx 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 rustworkx are not available in petgraph. For places where these algorithms are implemented in a generic way the rustworkx-core crate exposes it for Rust users.
Usage
Add this to your Cargo.toml:
[dependencies]
rustworkx-core = "0.11"
Then:
use rustworkx_core;
Note there is a strong version dependency between petgraph and rustworkx-core
as the functionality exposed by rustworkx-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.
License
Just as with the rest of the rustworkx project rustworkx-core is licensed under the Apache License, Version 2.0: https://www.apache.org/licenses/LICENSE-2.0