leiden-rs 0.8.0

High-performance Leiden community detection algorithm for graphs in Rust
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

//! Error types for the Leiden algorithm.

/// Errors that can occur during Leiden algorithm execution.
#[derive(Debug, thiserror::Error)]
pub enum LeidenError {
    /// An edge weight is not finite or is negative.
    #[error("invalid edge weight: {weight} (must be finite and non-negative)")]
    InvalidEdgeWeight {
        /// The invalid weight value.
        weight: f64,
    },
    /// CSR structure components have inconsistent lengths.
    #[error("inconsistent CSR structure: {message}")]
    InconsistentStructure {
        /// Description of the inconsistency.
        message: String,
    },
    /// An algorithm parameter is invalid.
    #[error("invalid parameter: {message}")]
    InvalidParameter {
        /// Description of the invalid parameter.
        message: String,
    },
    /// The initial partition does not match the graph.
    #[error("invalid partition: {message}")]
    InvalidPartition {
        /// Description of the mismatch.
        message: String,
    },
}

/// A specialized `Result` type for Leiden algorithm operations.
pub type Result<T> = std::result::Result<T, LeidenError>;