rust-igraph 0.0.1-alpha.2

Pure-Rust port of the igraph network analysis library (alpha — Phase 1 complete).
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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180

//! # rust-igraph
//!
//! Pure-Rust port of the [igraph](https://igraph.org) network analysis
//! library. Targets full API parity with igraph C v1.0.x (~850 public
//! functions), validated continuously against the three official
//! implementations (igraph C, python-igraph, R-igraph).
//!
//! > **Status**: alpha — only the Phase 0 walking-skeleton API is shipped
//! > (`Graph`, `read_edgelist`, `bfs`). The catalog grows
//! > algorithm-by-algorithm through Phase 1-10. See the project's
//! > [master plan](https://github.com/Totoro-jam/rust-igraph/blob/main/docs/plans/MASTER_PLAN.md).
//!
//! ## Quick start
//!
//! ```
//! use rust_igraph::{Graph, bfs};
//!
//! let mut g = Graph::with_vertices(4);
//! g.add_edge(0, 1).unwrap();
//! g.add_edge(0, 2).unwrap();
//! g.add_edge(1, 3).unwrap();
//!
//! let order = bfs(&g, 0).unwrap();
//! assert_eq!(order, vec![0, 1, 2, 3]);
//! ```
//!
//! ## License
//!
//! GPL-2.0-or-later, matching upstream igraph.

pub mod algorithms;
pub mod core;

// Top-level re-exports for the common case.
// IMPORTANT: when a function name collides with the file/module it
// lives in (e.g. `is_simple` in `is_simple.rs`), `pub use
// crate::algorithms::properties::is_simple` resolves ambiguously to
// **both** the module and the function, and rustdoc renders the
// re-export twice on the crate-root page. To suppress that, every
// re-export below points at the inner module path explicitly so the
// resolution is unambiguously the function. The submodules
// themselves are `pub(crate)` (see each algorithm-group `mod.rs`),
// so the deep paths stay crate-internal at the type-checker level
// while rustdoc only renders the function entry.
pub use crate::algorithms::community::edge_betweenness_community::{
    EdgeBetweennessResult, edge_betweenness_community,
};
pub use crate::algorithms::community::edge_betweenness_community_weighted::edge_betweenness_community_weighted;
pub use crate::algorithms::community::fast_greedy_modularity::{
    FastGreedyResult, fast_greedy_modularity, fast_greedy_modularity_weighted,
};
pub use crate::algorithms::community::fluid_communities::{
    FLUID_DEFAULT_MAX_ITERATIONS, FluidOptions, FluidResult, fluid_communities,
    fluid_communities_with_options,
};
pub use crate::algorithms::community::label_propagation::{
    LpaOptions, LpaResult, LpaVariant, label_propagation, label_propagation_weighted,
    label_propagation_with_options,
};
pub use crate::algorithms::community::leiden::{
    LEIDEN_DEFAULT_BETA, LEIDEN_DEFAULT_ITERATIONS, LeidenObjective, LeidenOptions, LeidenResult,
    leiden, leiden_weighted, leiden_with_options,
};
pub use crate::algorithms::community::louvain::{
    LouvainResult, louvain, louvain_weighted, louvain_with_options,
};
pub use crate::algorithms::community::modularity::{
    modularity, modularity_directed, modularity_weighted, modularity_weighted_directed,
};
pub use crate::algorithms::connectivity::articulation::articulation_points;
pub use crate::algorithms::connectivity::biconnected::{
    BiconnectedComponents, biconnected_components,
};
pub use crate::algorithms::connectivity::bridges::bridges;
pub use crate::algorithms::connectivity::components::{ConnectedComponents, connected_components};
pub use crate::algorithms::connectivity::decompose::decompose;
pub use crate::algorithms::connectivity::is_biconnected::is_biconnected;
pub use crate::algorithms::connectivity::percolation::{
    EdgelistPercolation, SitePercolation, bond_percolation, edgelist_percolation, site_percolation,
};
pub use crate::algorithms::connectivity::reachability::count_reachable;
pub use crate::algorithms::connectivity::reachability_matrix::reachability_matrix;
pub use crate::algorithms::connectivity::strong::strongly_connected_components;
pub use crate::algorithms::connectivity::transitive_closure::transitive_closure;
pub use crate::algorithms::io::edgelist::read_edgelist;
pub use crate::algorithms::operators::complementer::complementer;
pub use crate::algorithms::operators::difference::difference;
pub use crate::algorithms::operators::disjoint_union::{disjoint_union, disjoint_union_many};
pub use crate::algorithms::operators::intersection::intersection;
pub use crate::algorithms::operators::is_same_graph::is_same_graph;
pub use crate::algorithms::operators::simplify::simplify;
pub use crate::algorithms::operators::union::union;
pub use crate::algorithms::paths::astar::a_star_path;
pub use crate::algorithms::paths::bellman_ford::{
    bellman_ford_distances, bellman_ford_distances_with_mode,
};
pub use crate::algorithms::paths::dijkstra::{
    DijkstraAllPaths, DijkstraMode, DijkstraPaths, dijkstra_all_shortest_paths, dijkstra_distances,
    dijkstra_distances_cutoff, dijkstra_distances_cutoff_with_mode, dijkstra_distances_multi,
    dijkstra_distances_multi_with_mode, dijkstra_distances_with_mode, dijkstra_path_to,
    dijkstra_path_to_with_mode, dijkstra_paths, dijkstra_paths_with_mode,
};
pub use crate::algorithms::paths::distances::distances;
pub use crate::algorithms::paths::eulerian::{EulerianClassification, is_eulerian};
pub use crate::algorithms::paths::eulerian_construct::eulerian_path;
pub use crate::algorithms::paths::floyd_warshall::floyd_warshall_distances;
pub use crate::algorithms::paths::johnson::johnson_distances;
pub use crate::algorithms::paths::radii::{
    EccMode, diameter, diameter_weighted, diameter_weighted_with_mode, diameter_with_mode,
    eccentricity, eccentricity_weighted, eccentricity_weighted_with_mode, eccentricity_with_mode,
    radius, radius_weighted, radius_weighted_with_mode, radius_with_mode,
};
pub use crate::algorithms::paths::random_walk::random_walk;
pub use crate::algorithms::paths::widest_path::{
    WidestPathResult, WidestPaths, widest_path, widest_path_widths,
    widest_path_widths_floyd_warshall, widest_path_widths_floyd_warshall_with_mode,
    widest_path_widths_with_mode, widest_path_with_mode, widest_paths, widest_paths_to,
    widest_paths_to_with_mode, widest_paths_with_mode,
};
pub use crate::algorithms::properties::assortativity::{
    assortativity_degree, assortativity_degree_directed,
};
pub use crate::algorithms::properties::assortativity_weighted::{
    assortativity_degree_directed_weighted, assortativity_degree_weighted,
};
pub use crate::algorithms::properties::basic::{density, mean_distance};
pub use crate::algorithms::properties::betweenness::betweenness;
pub use crate::algorithms::properties::betweenness_weighted::betweenness_weighted;
pub use crate::algorithms::properties::closeness::closeness;
pub use crate::algorithms::properties::closeness_weighted::closeness_weighted;
pub use crate::algorithms::properties::convergence_degree::{
    convergence_degree, convergence_degree_full,
};
pub use crate::algorithms::properties::coreness::{CorenessMode, coreness, coreness_with_mode};
pub use crate::algorithms::properties::edge_betweenness::edge_betweenness;
pub use crate::algorithms::properties::edge_betweenness_weighted::edge_betweenness_weighted;
pub use crate::algorithms::properties::efficiency::{
    average_local_efficiency, global_efficiency, local_efficiency,
};
pub use crate::algorithms::properties::eigenvector::{
    EigenvectorMode, EigenvectorScores, eigenvector_centrality, eigenvector_centrality_directed,
    eigenvector_centrality_directed_weighted, eigenvector_centrality_full,
    eigenvector_centrality_weighted,
};
pub use crate::algorithms::properties::girth::girth;
pub use crate::algorithms::properties::harmonic::harmonic_centrality;
pub use crate::algorithms::properties::harmonic_weighted::harmonic_centrality_weighted;
pub use crate::algorithms::properties::hits::{
    HitsScores, hub_and_authority_scores, hub_and_authority_scores_weighted,
};
pub use crate::algorithms::properties::is_acyclic::is_acyclic;
pub use crate::algorithms::properties::is_complete::is_complete;
pub use crate::algorithms::properties::is_dag::is_dag;
pub use crate::algorithms::properties::is_forest::is_forest;
pub use crate::algorithms::properties::is_simple::{SimpleMode, is_simple, is_simple_with_mode};
pub use crate::algorithms::properties::is_tree::is_tree;
pub use crate::algorithms::properties::knn::{
    avg_nearest_neighbor_degree, avg_nearest_neighbor_degree_weighted, knnk, knnk_weighted,
};
pub use crate::algorithms::properties::multiplicity::{
    count_loops, count_multiple, has_loop, has_multiple, is_loop, is_multiple,
};
pub use crate::algorithms::properties::neighborhood::{
    NeighborhoodMode, neighborhood, neighborhood_size, neighborhood_size_with_mode,
    neighborhood_with_mode,
};
pub use crate::algorithms::properties::pagerank::pagerank;
pub use crate::algorithms::properties::pagerank_weighted::pagerank_weighted;
pub use crate::algorithms::properties::reciprocity::{
    ReciprocityMode, reciprocity, reciprocity_with_mode,
};
pub use crate::algorithms::properties::topological_sorting::topological_sorting;
pub use crate::algorithms::properties::triangles::{
    count_adjacent_triangles, count_triangles, transitivity_barrat, transitivity_local_undirected,
    transitivity_undirected,
};
pub use crate::algorithms::traversal::bfs::{BfsTree, bfs, bfs_tree};
pub use crate::algorithms::traversal::dfs::dfs;
pub use crate::core::error::{IgraphError, IgraphResult};
pub use crate::core::graph::{Graph, VertexId};