linfa-ica 0.3.0

A collection of Independent Component Analysis (ICA) algorithms
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

use ndarray_linalg::error::LinalgError;
use std::error::Error;
use std::fmt::{self, Display};

pub type Result<T> = std::result::Result<T, FastIcaError>;

/// An error when modeling FastICA algorithm
#[derive(Debug)]
pub enum FastIcaError {
    /// When any of the hyperparameters are set the wrong value
    InvalidValue(String),
    /// If we fail to compute any components of the SVD decomposition
    /// due to an Ill-Conditioned matrix
    SvdDecomposition,
    /// Errors encountered during linear algebra operations
    Linalg(LinalgError),
}

impl Display for FastIcaError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            Self::InvalidValue(message) => write!(f, "Invalid value encountered: {}", message),
            Self::SvdDecomposition => write!(
                f,
                "SVD Decomposition failed, X could be an Ill-Conditioned matrix",
            ),
            Self::Linalg(error) => write!(f, "Linalg Error: {}", error),
        }
    }
}

impl Error for FastIcaError {}

impl From<LinalgError> for FastIcaError {
    fn from(error: LinalgError) -> FastIcaError {
        FastIcaError::Linalg(error)
    }
}