oxicuda-cs 0.3.0

OxiCUDA: Compressed Sensing, Sparse Recovery, and Low-Rank Matrix Completion
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

//! Error types for `oxicuda-cs`.

use thiserror::Error;

/// Top-level error type for compressed-sensing operations.
#[derive(Debug, Error)]
pub enum CsError {
    #[error("shape mismatch: expected {expected:?}, got {got:?}")]
    ShapeMismatch {
        expected: Vec<usize>,
        got: Vec<usize>,
    },
    #[error("dimension mismatch: a={a}, b={b}")]
    DimensionMismatch { a: usize, b: usize },
    #[error("algorithm did not converge after {iter} iterations (residual={residual})")]
    NotConverged { iter: usize, residual: f64 },
    #[error("invalid parameter: {0}")]
    InvalidParameter(String),
    #[error("numerical instability: {0}")]
    NumericalInstability(String),
    #[error("unsupported SM version: {0}")]
    UnsupportedSmVersion(u32),
    #[error("singular matrix encountered: {0}")]
    SingularMatrix(String),
    #[error("index {index} out of bounds for length {len}")]
    IndexOutOfBounds { index: usize, len: usize },
    #[error("empty input")]
    EmptyInput,
    #[error("support too large: requested {requested}, max {max}")]
    SupportTooLarge { requested: usize, max: usize },
    #[error("invalid sparsity level: {0}")]
    InvalidSparsity(usize),
    #[error("invalid rank: {0}")]
    InvalidRank(usize),
    #[error("invalid configuration: {0}")]
    InvalidConfiguration(String),
    #[error("recovery failed: {0}")]
    RecoveryFailed(String),
}

/// Result alias for compressed-sensing operations.
pub type CsResult<T> = Result<T, CsError>;