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
51

use crate::{Eigenvalue, Eigenvector};

/// An eigenvalue paired with one eigenvector.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Eigenpair<T> {
    value: Eigenvalue<T>,
    vector: Eigenvector<T>,
}

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

    /// Returns the stored eigenvalue.
    #[must_use]
    pub const fn value(&self) -> &Eigenvalue<T> {
        &self.value
    }

    /// Returns the stored eigenvector.
    #[must_use]
    pub const fn vector(&self) -> &Eigenvector<T> {
        &self.vector
    }

    /// Returns the stored eigenvalue and eigenvector.
    #[must_use]
    pub fn into_inner(self) -> (Eigenvalue<T>, Eigenvector<T>) {
        (self.value, self.vector)
    }
}

#[cfg(test)]
mod tests {
    use super::Eigenpair;
    use crate::{Eigenvalue, Eigenvector};

    #[test]
    fn pairs_an_eigenvalue_with_an_eigenvector() {
        let pair = Eigenpair::new(
            Eigenvalue::new(3_i32),
            Eigenvector::new(vec![1_i32, 0]).expect("valid eigenvector"),
        );

        assert_eq!(*pair.value().as_ref(), 3);
        assert_eq!(pair.vector().coordinates(), &[1, 0]);
    }
}