dekoder 0.15.3

Evolution Kernel Operators
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

//! Reading and writing eko outputs.
use ndarray::Array4;
use std::path::PathBuf;
use thiserror::Error;

pub mod eko;
mod inventory;

/// The EKO errors.
#[derive(Error, Debug)]
pub enum EKOError {
    /// Working directory is not usable.
    #[error("No working directory")]
    NoWorkingDir,
    /// Underlying I/O error.
    #[error("I/O error")]
    IOError(#[from] std::io::Error),
    /// 4D operator is not readable.
    #[error("Loading operator from `{0}` failed")]
    OperatorLoadError(PathBuf),
    /// Lookup error in an inventory.
    #[error("Failed to read key(s) `{0}`")]
    KeyError(String),
}

/// A specialized [`Result`] type for EKO manipulation.
///
/// [`Result`]: std::result::Result
pub type Result<T> = std::result::Result<T, EKOError>;

/// 4D evolution operator.
pub struct Operator {
    /// The actual rank 4 tensor.
    pub op: Option<Array4<f64>>,
    /// The associated element-by-element error.
    pub err: Option<Array4<f64>>,
}

impl Default for Operator {
    /// Empty initializer.
    fn default() -> Self {
        Self {
            op: None,
            err: None,
        }
    }
}