physics_in_parallel 3.0.0

High-performance infrastructure for numerical simulations in physics
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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

//! Scalar implementations for complex primitive numeric types.
//!
//! Complex values use the associated real type as their projection domain:
//!	- `Complex<f32>::Real = f32`;
//!	- `Complex<f64>::Real = f64`.
//!
//! Type-preserving helpers inherited from `Scalar`, such as `abs()` and
//! `norm_sqr()`, return complex values with the result in the real component
//! and zero in the imaginary component. Use `abs_real()` and `norm_sqr_real()`
//! when the real-valued mathematical result is desired directly.

use num_complex::Complex;

use super::scalar_trait::{Scalar, scalar_sealed::Sealed};

impl Sealed for Complex<f32> {}
impl Sealed for Complex<f64> {}

impl Scalar for Complex<f32> {
    type Real = f32;

    #[inline]
    fn conj(self) -> Self {
        Complex::conj(&self)
    }

    #[inline]
    fn re(self) -> Self::Real {
        self.re
    }

    #[inline]
    fn im(self) -> Self::Real {
        self.im
    }

    #[inline]
    fn from_re_im(re: Self::Real, im: Self::Real) -> Self {
        Complex::new(re, im)
    }

    #[inline]
    fn abs_real(self) -> Self::Real {
        self.norm()
    }

    #[inline]
    fn norm_sqr_real(self) -> Self::Real {
        self.re * self.re + self.im * self.im
    }

    #[inline]
    fn sqrt(self) -> Self {
        Complex::sqrt(self)
    }

    #[inline]
    fn is_finite(self) -> bool {
        self.re.is_finite() && self.im.is_finite()
    }
}

impl Scalar for Complex<f64> {
    type Real = f64;

    #[inline]
    fn conj(self) -> Self {
        Complex::conj(&self)
    }

    #[inline]
    fn re(self) -> Self::Real {
        self.re
    }

    #[inline]
    fn im(self) -> Self::Real {
        self.im
    }

    #[inline]
    fn from_re_im(re: Self::Real, im: Self::Real) -> Self {
        Complex::new(re, im)
    }

    #[inline]
    fn abs_real(self) -> Self::Real {
        self.norm()
    }

    #[inline]
    fn norm_sqr_real(self) -> Self::Real {
        self.re * self.re + self.im * self.im
    }

    #[inline]
    fn sqrt(self) -> Self {
        Complex::sqrt(self)
    }

    #[inline]
    fn is_finite(self) -> bool {
        self.re.is_finite() && self.im.is_finite()
    }
}