rustkernel_graph/
lib.rs

1//! # RustKernel Graph Analytics
2//!
3//! GPU-accelerated graph analytics kernels including centrality measures,
4//! community detection, motif analysis, similarity metrics, and AML-focused analytics.
5//!
6//! ## Kernels
7//!
8//! ### Centrality (6 kernels)
9//! - `DegreeCentrality` - Ring kernel, O(1) query
10//! - `BetweennessCentrality` - Ring kernel, Brandes algorithm
11//! - `ClosenessCentrality` - Ring kernel, BFS-based
12//! - `EigenvectorCentrality` - Ring kernel, power iteration
13//! - `PageRank` - Ring kernel, power iteration with teleport
14//! - `KatzCentrality` - Ring kernel, attenuated paths
15//!
16//! ### Community Detection (3 kernels)
17//! - `ModularityScore` - Batch kernel
18//! - `LouvainCommunity` - Batch kernel, multi-level optimization
19//! - `LabelPropagation` - Batch kernel
20//!
21//! ### Motif Detection (3 kernels)
22//! - `TriangleCounting` - Ring kernel
23//! - `MotifDetection` - Batch kernel, k-node subgraph census
24//! - `KCliqueDetection` - Batch kernel
25//!
26//! ### Similarity (5 kernels)
27//! - `JaccardSimilarity` - Batch kernel
28//! - `CosineSimilarity` - Batch kernel
29//! - `AdamicAdarIndex` - Batch kernel
30//! - `CommonNeighbors` - Batch kernel
31//! - `ValueSimilarity` - Batch kernel (JSD/Wasserstein)
32//!
33//! ### Metrics (5 kernels)
34//! - `GraphDensity` - Batch kernel
35//! - `AveragePathLength` - Batch kernel
36//! - `ClusteringCoefficient` - Batch kernel
37//! - `ConnectedComponents` - Batch kernel
38//! - `FullGraphMetrics` - Batch kernel
39//!
40//! ### Topology (2 kernels)
41//! - `DegreeRatio` - Ring kernel, source/sink classification
42//! - `StarTopologyScore` - Batch kernel, hub-and-spoke detection
43//!
44//! ### Cycles (1 kernel)
45//! - `ShortCycleParticipation` - Batch kernel, 2-4 hop cycle detection (AML)
46//!
47//! ### Paths (1 kernel)
48//! - `ShortestPath` - Batch kernel, BFS/Delta-Stepping SSSP/APSP
49//!
50//! ### Graph Neural Networks (2 kernels)
51//! - `GNNInference` - Message passing neural network inference
52//! - `GraphAttention` - Graph Attention Network (GAT) with multi-head attention
53
54#![warn(missing_docs)]
55#![warn(clippy::all)]
56
57pub mod centrality;
58pub mod community;
59pub mod cycles;
60pub mod gnn;
61pub mod messages;
62pub mod metrics;
63pub mod motif;
64pub mod paths;
65pub mod ring_messages;
66pub mod similarity;
67pub mod topology;
68
69// Common graph types
70pub mod types;
71
72/// Prelude for convenient imports.
73pub mod prelude {
74    pub use crate::centrality::*;
75    pub use crate::community::*;
76    pub use crate::cycles::*;
77    pub use crate::gnn::*;
78    pub use crate::messages::*;
79    pub use crate::metrics::*;
80    pub use crate::motif::*;
81    pub use crate::paths::*;
82    pub use crate::ring_messages::*;
83    pub use crate::similarity::*;
84    pub use crate::topology::*;
85    pub use crate::types::*;
86}
87
88/// Register all graph kernels with a registry.
89///
90/// Batch kernels are registered with factories for direct execution via REST/gRPC.
91/// Ring kernels are registered as metadata for discovery (require Ring runtime for execution).
92pub fn register_all(
93    registry: &rustkernel_core::registry::KernelRegistry,
94) -> rustkernel_core::error::Result<()> {
95    tracing::info!("Registering graph analytics kernels");
96
97    // Centrality kernels (6) — Ring: PageRank, DegreeCentrality; Batch: rest
98    registry.register_ring_metadata_from(centrality::PageRank::new)?;
99    registry.register_ring_metadata_from(centrality::DegreeCentrality::new)?;
100    registry.register_batch_typed(centrality::BetweennessCentrality::new)?;
101    registry.register_batch_typed(centrality::ClosenessCentrality::new)?;
102    registry.register_batch_typed(centrality::EigenvectorCentrality::new)?;
103    registry.register_batch_typed(centrality::KatzCentrality::new)?;
104
105    // Community detection kernels (3) — Batch (GpuKernel only)
106    registry.register_batch_metadata_from(community::ModularityScore::new)?;
107    registry.register_batch_metadata_from(community::LouvainCommunity::new)?;
108    registry.register_batch_metadata_from(community::LabelPropagation::new)?;
109
110    // Similarity kernels (5) — Batch (GpuKernel only)
111    registry.register_batch_metadata_from(similarity::JaccardSimilarity::new)?;
112    registry.register_batch_metadata_from(similarity::CosineSimilarity::new)?;
113    registry.register_batch_metadata_from(similarity::AdamicAdarIndex::new)?;
114    registry.register_batch_metadata_from(similarity::CommonNeighbors::new)?;
115    registry.register_batch_metadata_from(similarity::ValueSimilarity::new)?;
116
117    // Metrics kernels (5) — Batch (GpuKernel only)
118    registry.register_batch_metadata_from(metrics::GraphDensity::new)?;
119    registry.register_batch_metadata_from(metrics::AveragePathLength::new)?;
120    registry.register_batch_metadata_from(metrics::ClusteringCoefficient::new)?;
121    registry.register_batch_metadata_from(metrics::ConnectedComponents::new)?;
122    registry.register_batch_metadata_from(metrics::FullGraphMetrics::new)?;
123
124    // Motif detection kernels (3) — Ring: TriangleCounting; Batch: rest
125    registry.register_ring_metadata_from(motif::TriangleCounting::new)?;
126    registry.register_batch_metadata_from(motif::MotifDetection::new)?;
127    registry.register_batch_metadata_from(motif::KCliqueDetection::new)?;
128
129    // Topology kernels (2) — Ring: DegreeRatio; Batch: StarTopologyScore
130    registry.register_ring_metadata_from(topology::DegreeRatio::new)?;
131    registry.register_batch_metadata_from(topology::StarTopologyScore::new)?;
132
133    // Cycle detection kernels (1) — Batch
134    registry.register_batch_metadata_from(cycles::ShortCycleParticipation::new)?;
135
136    // Path kernels (1) — Batch
137    registry.register_batch_metadata_from(paths::ShortestPath::new)?;
138
139    // GNN kernels (2) — Batch (GpuKernel only)
140    registry.register_batch_metadata_from(gnn::GNNInference::new)?;
141    registry.register_batch_metadata_from(gnn::GraphAttention::new)?;
142
143    tracing::info!("Registered 28 graph analytics kernels");
144    Ok(())
145}
146
147#[cfg(test)]
148mod tests {
149    use super::*;
150    use rustkernel_core::registry::KernelRegistry;
151
152    #[test]
153    fn test_register_all() {
154        let registry = KernelRegistry::new();
155        register_all(&registry).expect("Failed to register graph kernels");
156        assert_eq!(registry.total_count(), 28);
157    }
158
159    #[test]
160    fn test_register_all_by_domain() {
161        use rustkernel_core::domain::Domain;
162
163        let registry = KernelRegistry::new();
164        register_all(&registry).expect("Failed to register graph kernels");
165
166        let graph_kernels = registry.by_domain(Domain::GraphAnalytics);
167        assert_eq!(graph_kernels.len(), 28);
168    }
169}
rustkernel_graph/lib.rs

rustkernel_graph/
lib.rs
