eunomia 0.8.0

Atlas datatype law: the Single Source of Truth for numeric/scalar datatype vocabulary (scalars, complex, packed formats, conversions)
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

//! Additive and multiplicative identity constants for [`Complex`].
//!
//! Generic code uses these constants directly, or the corresponding
//! [`ComplexField`](crate::ComplexField) identity methods when the concrete
//! scalar field is abstract.

use super::Complex;
use crate::traits::NumericElement;

impl<T: NumericElement> Complex<T> {
    /// The additive identity `0 + 0i`.
    pub const ZERO: Self = Self {
        re: <T as NumericElement>::ZERO,
        im: <T as NumericElement>::ZERO,
    };

    /// The multiplicative identity `1 + 0i`.
    pub const ONE: Self = Self {
        re: <T as NumericElement>::ONE,
        im: <T as NumericElement>::ZERO,
    };
}

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

    #[test]
    fn identity_constants() {
        assert_eq!(Complex::<f64>::ZERO, Complex::new(0.0, 0.0));
        assert_eq!(Complex::<f32>::ONE, Complex::new(1.0, 0.0));
        // additive / multiplicative identity behaviour
        let z = Complex::new(3.0_f64, -2.0);
        assert_eq!(z + Complex::ZERO, z);
        assert_eq!(z * Complex::ONE, z);
    }
}