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

/// Algebraic and geometric multiplicity for one eigenvalue.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct EigenMultiplicity {
    algebraic: usize,
    geometric: usize,
}

impl EigenMultiplicity {
    /// Creates a new multiplicity pair.
    #[must_use]
    pub const fn new(algebraic: usize, geometric: usize) -> Self {
        Self {
            algebraic,
            geometric,
        }
    }

    /// Returns the algebraic multiplicity.
    #[must_use]
    pub const fn algebraic(self) -> usize {
        self.algebraic
    }

    /// Returns the geometric multiplicity.
    #[must_use]
    pub const fn geometric(self) -> usize {
        self.geometric
    }

    /// Returns whether both multiplicities are equal to one.
    #[must_use]
    pub const fn is_simple(self) -> bool {
        self.algebraic == 1 && self.geometric == 1
    }
}

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

    #[test]
    fn exposes_algebraic_and_geometric_multiplicity() {
        let multiplicity = EigenMultiplicity::new(3, 2);

        assert_eq!(multiplicity.algebraic(), 3);
        assert_eq!(multiplicity.geometric(), 2);
        assert!(!multiplicity.is_simple());
        assert!(EigenMultiplicity::new(1, 1).is_simple());
    }
}