geometric-traits 0.1.0

Trait-based algebraic and graph algorithms for Rust, supporting no_std environments
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

//! Submodule providing `Information Content` Errors for working with IC based
//! Algorithms
use crate::traits::KahnError;

/// Information Content Enum for Errors that may occur during IC calculation
/// process
#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
pub enum InformationContentError {
    /// Error for when a graph is not a DAG / contains a cycle
    #[error("The graph is not a DAG")]
    NotDag,
    /// Error for unexpected occurrence size
    #[error("Received an occurrence vector with {found} entries but expected {expected} entries")]
    UnequalOccurrenceSize {
        /// The expected size for the occurrence
        expected: usize,
        /// The actual size found for the occurrence
        found: usize,
    },
    /// Sink Node found with 0 occurrence count
    #[error("Found a Sink Node with a 0 Occurrence")]
    SinkNodeZeroOccurrence,
}

impl From<KahnError> for InformationContentError {
    #[inline]
    fn from(value: KahnError) -> Self {
        match value {
            KahnError::Cycle => Self::NotDag,
        }
    }
}