Crate retworkx_core

retworkx-core

retworkx-core is a graph algorithm crate built on top of petgraph. It offers a set of functions that are used in the larger retworkx project but implemented in a generic manner for use by downstream rust projects.

Usage

First add this crate to your Cargo.toml:

[dependencies]
retworkx-core = "0.11"

Then in your code, it may be used something like this:

use retworkx_core::petgraph;
use retworkx_core::centrality::betweenness_centrality;

let g = petgraph::graph::UnGraph::<i32, ()>::from_edges(&[
    (1, 2), (2, 3), (3, 4), (1, 4)
]);
// Calculate the betweeness centrality
let output = betweenness_centrality(&g, false, false, 200);
assert_eq!(
    vec![Some(0.0), Some(0.5), Some(0.5), Some(0.5), Some(0.5)],
    output
);

Algorithm Modules

The crate is organized into

• centrality
• connectivity
• max_weight_matching
• shortest_path

Release Notes

The release notes for retworkx-core are included as part of the retworkx documentation which is hosted at:

https://qiskit.org/documentation/retworkx/release_notes.html

Re-exports

pub use petgraph;

Modules

centrality

Module for centrality algorithms

connectivity

Module for connectivity and cut algorithms.

dictmap

This module contains the DictMap type alias which is a combination of IndexMap and AHash.

distancemap

This module contains the DistanceMap trait which is used in shortest_path.

max_weight_matching

Module for maximum weight matching algorithmss

shortest_path

Module for shortest path algorithms.

traversal

Module for graph traversal algorithms.

Type Definitions

Result

A convenient type alias that by default assumes no error can happen.