rucrf 0.3.3

Conditional Random Fields implemented in pure Rust
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
63
64
65
66
67
68
69
70
71
72
73

//! Definition of errors.

use core::fmt;

#[cfg(feature = "std")]
use std::error::Error;

/// Error used when the argument is invalid.
#[derive(Debug)]
pub struct InvalidArgumentError {
    msg: &'static str,
}

impl fmt::Display for InvalidArgumentError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "InvalidArgumentError: {}", self.msg)
    }
}

#[cfg(feature = "std")]
impl Error for InvalidArgumentError {}

/// Error used when the model becomes too large.
#[derive(Debug)]
pub struct ModelScaleError {
    msg: &'static str,
}

impl fmt::Display for ModelScaleError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "ModelScaleError: {}", self.msg)
    }
}

#[cfg(feature = "std")]
impl Error for ModelScaleError {}

/// The error type for Rucrf.
#[derive(Debug)]
pub enum RucrfError {
    /// Error variant for [`InvalidArgumentError`].
    InvalidArgument(InvalidArgumentError),

    /// Error variant for [`ModelScaleError`].
    ModelScale(ModelScaleError),
}

impl RucrfError {
    /// Creates a new [`InvalidArgumentError`].
    pub(crate) const fn invalid_argument(msg: &'static str) -> Self {
        Self::InvalidArgument(InvalidArgumentError { msg })
    }

    /// Creates a new [`ModelScaleError`].
    pub(crate) const fn model_scale(msg: &'static str) -> Self {
        Self::ModelScale(ModelScaleError { msg })
    }
}

impl fmt::Display for RucrfError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            Self::InvalidArgument(e) => e.fmt(f),
            Self::ModelScale(e) => e.fmt(f),
        }
    }
}

#[cfg(feature = "std")]
impl Error for RucrfError {}

/// A specialized Result type.
pub type Result<T, E = RucrfError> = core::result::Result<T, E>;