Crate rustworkx_core

rustworkx-core

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

Usage

First add this crate to your Cargo.toml:

[dependencies]
rustworkx-core = "0.11"

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

use rustworkx_core::petgraph;
use rustworkx_core::centrality::betweenness_centrality;

let g = petgraph::graph::UnGraph::<i32, ()>::from_edges(&[
    (1, 2), (2, 3), (3, 4), (1, 4)
]);
// Calculate the betweenness 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 provides the following graph algorithm modules

• centrality
• connectivity
• max_weight_matching
• shortest_path
• token_swapper
• traversal
• generators

Graph Extensions

The crate also provides traits which extend petgraph types with additional methods, when imported.

For example, the contract_nodes method becomes available for applicable graph types when the following trait is imported:

use petgraph::prelude::*;
use rustworkx_core::graph_ext::ContractNodesDirected;

let mut dag: StableDiGraph<char, usize> = StableDiGraph::default();
let m = dag.contract_nodes([], 'm', true).unwrap();

See the documentation of graph_ext for a full listing of the available extensions and their compatibility with petgraph types.

Release Notes

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

https://www.rustworkx.org/release_notes.html

Re-exports

• pub use petgraph;

Modules

• bipartite_coloring
• centrality
  Module for centrality algorithms.
• coloring
  Module for coloring algorithms.
• connectivity
  Module for connectivity and cut algorithms.
• dag_algo
  Module for algorithms that work on DAGs.
• 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.
• err
  This module contains common error types and trait impls.
• generators
  This module contains generator functions for building graphs
• graph_ext
  This module defines traits that extend PetGraph’s graph data structures.
• line_graph
• max_weight_matching
  Module for maximum weight matching algorithms.
• planar
  Module for planar graphs.
• shortest_path
  Module for shortest path algorithms.
• steiner_tree
• token_swapper
  Module for swapping tokens
• traversal
  Module for graph traversal algorithms.
• utils

Type Aliases

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