use-eigen 0.0.6

Utility-first eigenvalue and eigensystem primitives for RustUse
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

/// A scalar eigenvalue wrapper.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct Eigenvalue<T> {
    value: T,
}

impl<T> Eigenvalue<T> {
    /// Creates a new eigenvalue.
    #[must_use]
    pub const fn new(value: T) -> Self {
        Self { value }
    }

    /// Creates a new eigenvalue from a scalar value.
    #[must_use]
    pub const fn from_value(value: T) -> Self {
        Self::new(value)
    }

    /// Returns the stored scalar value by reference.
    #[must_use]
    pub const fn as_ref(&self) -> &T {
        &self.value
    }

    /// Returns the stored scalar value.
    #[must_use]
    pub fn into_inner(self) -> T {
        self.value
    }
}

impl<T> AsRef<T> for Eigenvalue<T> {
    fn as_ref(&self) -> &T {
        self.as_ref()
    }
}

#[cfg(test)]
mod tests {
    use super::Eigenvalue;

    #[test]
    fn constructs_and_exposes_an_eigenvalue() {
        let value = Eigenvalue::from_value(7_i32);

        assert_eq!(*value.as_ref(), 7);
        assert_eq!(value.into_inner(), 7);
    }
}