Skip to main content

rust_igraph/
lib.rs

1//! # rust-igraph
2//!
3//! Pure-Rust port of the [igraph](https://igraph.org) network analysis
4//! library. Targets full API parity with igraph C v1.0.x (~850 public
5//! functions), validated continuously against the three official
6//! implementations (igraph C, python-igraph, R-igraph).
7//!
8//! > **Status**: alpha — only the Phase 0 walking-skeleton API is shipped
9//! > (`Graph`, `read_edgelist`, `bfs`). The catalog grows
10//! > algorithm-by-algorithm through Phase 1-10. See the project's
11//! > [master plan](https://github.com/Totoro-jam/rust-igraph/blob/main/docs/plans/MASTER_PLAN.md).
12//!
13//! ## Quick start
14//!
15//! ```
16//! use rust_igraph::{Graph, bfs};
17//!
18//! let mut g = Graph::with_vertices(4);
19//! g.add_edge(0, 1).unwrap();
20//! g.add_edge(0, 2).unwrap();
21//! g.add_edge(1, 3).unwrap();
22//!
23//! let order = bfs(&g, 0).unwrap();
24//! assert_eq!(order, vec![0, 1, 2, 3]);
25//! ```
26//!
27//! ## License
28//!
29//! GPL-2.0-or-later, matching upstream igraph.
30
31pub mod algorithms;
32pub mod core;
33
34// Top-level re-exports for the common case.
35// IMPORTANT: when a function name collides with the file/module it
36// lives in (e.g. `is_simple` in `is_simple.rs`), `pub use
37// crate::algorithms::properties::is_simple` resolves ambiguously to
38// **both** the module and the function, and rustdoc renders the
39// re-export twice on the crate-root page. To suppress that, every
40// re-export below points at the inner module path explicitly so the
41// resolution is unambiguously the function. The submodules
42// themselves are `pub(crate)` (see each algorithm-group `mod.rs`),
43// so the deep paths stay crate-internal at the type-checker level
44// while rustdoc only renders the function entry.
45pub use crate::algorithms::community::edge_betweenness_community::{
46    EdgeBetweennessResult, edge_betweenness_community,
47};
48pub use crate::algorithms::community::edge_betweenness_community_weighted::edge_betweenness_community_weighted;
49pub use crate::algorithms::community::fast_greedy_modularity::{
50    FastGreedyResult, fast_greedy_modularity, fast_greedy_modularity_weighted,
51};
52pub use crate::algorithms::community::fluid_communities::{
53    FLUID_DEFAULT_MAX_ITERATIONS, FluidOptions, FluidResult, fluid_communities,
54    fluid_communities_with_options,
55};
56pub use crate::algorithms::community::label_propagation::{
57    LpaOptions, LpaResult, LpaVariant, label_propagation, label_propagation_weighted,
58    label_propagation_with_options,
59};
60pub use crate::algorithms::community::leiden::{
61    LEIDEN_DEFAULT_BETA, LEIDEN_DEFAULT_ITERATIONS, LeidenObjective, LeidenOptions, LeidenResult,
62    leiden, leiden_weighted, leiden_with_options,
63};
64pub use crate::algorithms::community::louvain::{
65    LouvainResult, louvain, louvain_weighted, louvain_with_options,
66};
67pub use crate::algorithms::community::modularity::{
68    modularity, modularity_directed, modularity_weighted, modularity_weighted_directed,
69};
70pub use crate::algorithms::connectivity::articulation::articulation_points;
71pub use crate::algorithms::connectivity::biconnected::{
72    BiconnectedComponents, biconnected_components,
73};
74pub use crate::algorithms::connectivity::bridges::bridges;
75pub use crate::algorithms::connectivity::components::{ConnectedComponents, connected_components};
76pub use crate::algorithms::connectivity::decompose::decompose;
77pub use crate::algorithms::connectivity::is_biconnected::is_biconnected;
78pub use crate::algorithms::connectivity::percolation::{
79    EdgelistPercolation, SitePercolation, bond_percolation, edgelist_percolation, site_percolation,
80};
81pub use crate::algorithms::connectivity::reachability::count_reachable;
82pub use crate::algorithms::connectivity::reachability_matrix::reachability_matrix;
83pub use crate::algorithms::connectivity::strong::strongly_connected_components;
84pub use crate::algorithms::connectivity::transitive_closure::transitive_closure;
85pub use crate::algorithms::io::edgelist::read_edgelist;
86pub use crate::algorithms::operators::complementer::complementer;
87pub use crate::algorithms::operators::difference::difference;
88pub use crate::algorithms::operators::disjoint_union::{disjoint_union, disjoint_union_many};
89pub use crate::algorithms::operators::intersection::intersection;
90pub use crate::algorithms::operators::is_same_graph::is_same_graph;
91pub use crate::algorithms::operators::simplify::simplify;
92pub use crate::algorithms::operators::union::union;
93pub use crate::algorithms::paths::astar::a_star_path;
94pub use crate::algorithms::paths::bellman_ford::{
95    bellman_ford_distances, bellman_ford_distances_with_mode,
96};
97pub use crate::algorithms::paths::dijkstra::{
98    DijkstraAllPaths, DijkstraMode, DijkstraPaths, dijkstra_all_shortest_paths, dijkstra_distances,
99    dijkstra_distances_cutoff, dijkstra_distances_cutoff_with_mode, dijkstra_distances_multi,
100    dijkstra_distances_multi_with_mode, dijkstra_distances_with_mode, dijkstra_path_to,
101    dijkstra_path_to_with_mode, dijkstra_paths, dijkstra_paths_with_mode,
102};
103pub use crate::algorithms::paths::distances::distances;
104pub use crate::algorithms::paths::eulerian::{EulerianClassification, is_eulerian};
105pub use crate::algorithms::paths::eulerian_construct::eulerian_path;
106pub use crate::algorithms::paths::floyd_warshall::floyd_warshall_distances;
107pub use crate::algorithms::paths::johnson::johnson_distances;
108pub use crate::algorithms::paths::radii::{
109    EccMode, diameter, diameter_weighted, diameter_weighted_with_mode, diameter_with_mode,
110    eccentricity, eccentricity_weighted, eccentricity_weighted_with_mode, eccentricity_with_mode,
111    radius, radius_weighted, radius_weighted_with_mode, radius_with_mode,
112};
113pub use crate::algorithms::paths::random_walk::random_walk;
114pub use crate::algorithms::paths::widest_path::{
115    WidestPathResult, WidestPaths, widest_path, widest_path_widths,
116    widest_path_widths_floyd_warshall, widest_path_widths_floyd_warshall_with_mode,
117    widest_path_widths_with_mode, widest_path_with_mode, widest_paths, widest_paths_to,
118    widest_paths_to_with_mode, widest_paths_with_mode,
119};
120pub use crate::algorithms::properties::assortativity::{
121    assortativity_degree, assortativity_degree_directed,
122};
123pub use crate::algorithms::properties::assortativity_weighted::{
124    assortativity_degree_directed_weighted, assortativity_degree_weighted,
125};
126pub use crate::algorithms::properties::basic::{density, mean_distance};
127pub use crate::algorithms::properties::betweenness::betweenness;
128pub use crate::algorithms::properties::betweenness_weighted::betweenness_weighted;
129pub use crate::algorithms::properties::closeness::closeness;
130pub use crate::algorithms::properties::closeness_weighted::closeness_weighted;
131pub use crate::algorithms::properties::convergence_degree::{
132    convergence_degree, convergence_degree_full,
133};
134pub use crate::algorithms::properties::coreness::{CorenessMode, coreness, coreness_with_mode};
135pub use crate::algorithms::properties::edge_betweenness::edge_betweenness;
136pub use crate::algorithms::properties::edge_betweenness_weighted::edge_betweenness_weighted;
137pub use crate::algorithms::properties::efficiency::{
138    average_local_efficiency, global_efficiency, local_efficiency,
139};
140pub use crate::algorithms::properties::eigenvector::{
141    EigenvectorMode, EigenvectorScores, eigenvector_centrality, eigenvector_centrality_directed,
142    eigenvector_centrality_directed_weighted, eigenvector_centrality_full,
143    eigenvector_centrality_weighted,
144};
145pub use crate::algorithms::properties::girth::girth;
146pub use crate::algorithms::properties::harmonic::harmonic_centrality;
147pub use crate::algorithms::properties::harmonic_weighted::harmonic_centrality_weighted;
148pub use crate::algorithms::properties::hits::{
149    HitsScores, hub_and_authority_scores, hub_and_authority_scores_weighted,
150};
151pub use crate::algorithms::properties::is_acyclic::is_acyclic;
152pub use crate::algorithms::properties::is_complete::is_complete;
153pub use crate::algorithms::properties::is_dag::is_dag;
154pub use crate::algorithms::properties::is_forest::is_forest;
155pub use crate::algorithms::properties::is_simple::{SimpleMode, is_simple, is_simple_with_mode};
156pub use crate::algorithms::properties::is_tree::is_tree;
157pub use crate::algorithms::properties::knn::{
158    avg_nearest_neighbor_degree, avg_nearest_neighbor_degree_weighted, knnk, knnk_weighted,
159};
160pub use crate::algorithms::properties::multiplicity::{
161    count_loops, count_multiple, has_loop, has_multiple, is_loop, is_multiple,
162};
163pub use crate::algorithms::properties::neighborhood::{
164    NeighborhoodMode, neighborhood, neighborhood_size, neighborhood_size_with_mode,
165    neighborhood_with_mode,
166};
167pub use crate::algorithms::properties::pagerank::pagerank;
168pub use crate::algorithms::properties::pagerank_weighted::pagerank_weighted;
169pub use crate::algorithms::properties::reciprocity::{
170    ReciprocityMode, reciprocity, reciprocity_with_mode,
171};
172pub use crate::algorithms::properties::topological_sorting::topological_sorting;
173pub use crate::algorithms::properties::triangles::{
174    count_adjacent_triangles, count_triangles, transitivity_barrat, transitivity_local_undirected,
175    transitivity_undirected,
176};
177pub use crate::algorithms::traversal::bfs::{BfsTree, bfs, bfs_tree};
178pub use crate::algorithms::traversal::dfs::dfs;
179pub use crate::core::error::{IgraphError, IgraphResult};
180pub use crate::core::graph::{Graph, VertexId};