interstellar 0.2.0

A high-performance graph database with Gremlin-style traversals and GQL query language
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

//! Graph algorithms: traversal and pathfinding.
//!
//! This module provides graph traversal algorithms (BFS, DFS, bidirectional BFS, IDDFS)
//! and pathfinding algorithms (shortest path, Dijkstra, A*, Yen's k-shortest paths).
//!
//! All algorithms are generic over [`GraphAccess`](crate::graph_access::GraphAccess)
//! and work with both in-memory and memory-mapped storage backends.
//!
//! # Example
//!
//! ```rust
//! use interstellar::prelude::*;
//! use interstellar::algorithms::traversal::Bfs;
//! use interstellar::algorithms::common::Direction;
//! use std::sync::Arc;
//! use std::collections::HashMap;
//!
//! let graph = Arc::new(Graph::new());
//! let a = graph.add_vertex("person", HashMap::new());
//! let b = graph.add_vertex("person", HashMap::new());
//! graph.add_edge(a, b, "knows", HashMap::new()).unwrap();
//!
//! let visited: Vec<_> = Bfs::new(graph.clone(), a).collect();
//! assert_eq!(visited.len(), 2);
//! ```

pub mod common;
pub mod pathfinding;
pub mod traversal;

pub use common::{
    property_weight, unit_weight, AlgorithmError, Direction, NoopVisitor, PathResult, Visitor,
    WeightFn,
};
pub use pathfinding::{astar, dijkstra, dijkstra_all, k_shortest_paths, shortest_path_unweighted};
pub use traversal::{bidirectional_bfs, iddfs, Bfs, Dfs};