rscopulas 0.2.2

Core Rust library for fitting, evaluating, and sampling copula models and vine copulas
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
53
54
55
56
57
58
59
60
61
62

use thiserror::Error;

#[derive(Debug, Error)]
pub enum CopulaError {
    #[error(transparent)]
    InvalidInput(#[from] InputError),
    #[error(transparent)]
    FitFailed(#[from] FitError),
    #[error(transparent)]
    Numerical(#[from] NumericalError),
    #[error(transparent)]
    Backend(#[from] BackendError),
}

#[derive(Debug, Error)]
pub enum InputError {
    #[error("expected a 2D array of pseudo-observations")]
    ExpectedMatrix,
    #[error("expected at least one observation")]
    EmptyObservations,
    #[error("expected at least two dimensions, got {0}")]
    DimensionTooSmall(usize),
    #[error("all values must be finite")]
    NonFiniteValue,
    #[error(
        "pseudo-observations must lie strictly inside (0, 1); found {value} at row {row}, col {col}"
    )]
    OutOfUnitInterval { row: usize, col: usize, value: f64 },
}

#[derive(Debug, Error)]
pub enum FitError {
    #[error("family {family} does not support dimension {dim}")]
    UnsupportedDimension { family: &'static str, dim: usize },
    #[error("fit failed: {reason}")]
    Failed { reason: &'static str },
    #[error("optimization is not implemented yet")]
    NotImplemented,
}

#[derive(Debug, Error)]
pub enum NumericalError {
    #[error("matrix is not a valid correlation matrix")]
    InvalidCorrelationMatrix,
    #[error("matrix decomposition failed")]
    DecompositionFailed,
    #[error("numerical routine not implemented yet")]
    NotImplemented,
}

#[derive(Debug, Error)]
pub enum BackendError {
    #[error("requested backend {backend} is unavailable")]
    Unavailable { backend: &'static str },
    #[error("requested operation is not supported on backend {backend}")]
    Unsupported { backend: &'static str },
    #[error("backend {backend} failed: {reason}")]
    Failed {
        backend: &'static str,
        reason: String,
    },
}