nabled-core 0.0.8

Core ndarray-native types and shared utilities for nabled
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

//! Shared error types for ndarray-native kernels.

use thiserror::Error;

/// Common shape and dimensional validation errors.
#[derive(Debug, Error, Clone, Copy, PartialEq, Eq)]
pub enum ShapeError {
    /// Matrix or vector input is empty.
    #[error("input cannot be empty")]
    EmptyInput,
    /// Matrix is expected to be square.
    #[error("matrix must be square")]
    NotSquare,
    /// Matrix and vector dimensions do not match.
    #[error("dimension mismatch")]
    DimensionMismatch,
}

/// Cross-domain top-level error taxonomy for `nabled` crates.
#[derive(Debug, Error, Clone, PartialEq)]
pub enum NabledError {
    /// Shape or dimensional validation failure.
    #[error(transparent)]
    Shape(#[from] ShapeError),
    /// Matrix/vector is singular.
    #[error("matrix is singular")]
    SingularMatrix,
    /// Matrix symmetry requirement failed.
    #[error("matrix must be symmetric")]
    NotSymmetric,
    /// Matrix positive-definiteness requirement failed.
    #[error("matrix must be positive definite")]
    NotPositiveDefinite,
    /// Numerical method failed to converge.
    #[error("algorithm failed to converge")]
    ConvergenceFailed,
    /// Non-finite or unstable numerical state observed.
    #[error("numerical instability detected")]
    NumericalInstability,
    /// Invalid user input.
    #[error("invalid input: {0}")]
    InvalidInput(String),
    /// Domain-specific catch-all.
    #[error("{0}")]
    Other(String),
}

/// Trait for domain errors that can be normalized into [`NabledError`].
pub trait IntoNabledError {
    /// Convert domain-specific error into shared taxonomy.
    fn into_nabled_error(self) -> NabledError;
}