# complex.rs - source
Source of the Rust file `/home/runner/.cargo/registry/src/github.com-1ecc6299db9ec823/pyo3-0.13.2/src/types/complex.rs`.
Keywords: rust, rustlang, rust-lang

      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
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310

    #[cfg(all(not(PyPy), not(Py_LIMITED_API)))]
    use crate::instance::PyNativeType;
    use crate::{ffi, AsPyPointer, PyAny, Python};
    #[cfg(all(not(PyPy), not(Py_LIMITED_API)))]
    use std::ops::*;
    use std::os::raw::c_double;

    /// Represents a Python `complex`.
    #[repr(transparent)]
    pub struct PyComplex(PyAny);

    pyobject_native_type!(
        PyComplex,
        ffi::PyComplexObject,
        ffi::PyComplex_Type,
        ffi::PyComplex_Check
    );

    impl PyComplex {
        /// Creates a new Python `complex` object, from its real and imaginary values.
        pub fn from_doubles(py: Python, real: c_double, imag: c_double) -> &PyComplex {
            unsafe {
                let ptr = ffi::PyComplex_FromDoubles(real, imag);
                py.from_owned_ptr(ptr)
            }
        }
        /// Returns the real part of the complex number.
        pub fn real(&self) -> c_double {
            unsafe { ffi::PyComplex_RealAsDouble(self.as_ptr()) }
        }
        /// Returns the imaginary part the complex number.
        pub fn imag(&self) -> c_double {
            unsafe { ffi::PyComplex_ImagAsDouble(self.as_ptr()) }
        }
        /// Returns `|self|`.
        #[cfg(not(any(Py_LIMITED_API, PyPy)))]
        pub fn abs(&self) -> c_double {
            unsafe {
                let val = (*(self.as_ptr() as *mut ffi::PyComplexObject)).cval;
                ffi::_Py_c_abs(val)
            }
        }
        /// Returns `self ** other`
        #[cfg(not(any(Py_LIMITED_API, PyPy)))]
        pub fn pow(&self, other: &PyComplex) -> &PyComplex {
            unsafe {
                self.py()
                    .from_owned_ptr(complex_operation(self, other, ffi::_Py_c_pow))
            }
        }
    }

    #[cfg(not(any(Py_LIMITED_API, PyPy)))]
    #[inline(always)]
    unsafe fn complex_operation(
        l: &PyComplex,
        r: &PyComplex,
        operation: unsafe extern "C" fn(ffi::Py_complex, ffi::Py_complex) -> ffi::Py_complex,
    ) -> *mut ffi::PyObject {
        let l_val = (*(l.as_ptr() as *mut ffi::PyComplexObject)).cval;
        let r_val = (*(r.as_ptr() as *mut ffi::PyComplexObject)).cval;
        ffi::PyComplex_FromCComplex(operation(l_val, r_val))
    }

    #[cfg(not(any(Py_LIMITED_API, PyPy)))]
    impl<'py> Add for &'py PyComplex {
        type Output = &'py PyComplex;
        fn add(self, other: &'py PyComplex) -> &'py PyComplex {
            unsafe {
                self.py()
                    .from_owned_ptr(complex_operation(self, other, ffi::_Py_c_sum))
            }
        }
    }

    #[cfg(not(any(Py_LIMITED_API, PyPy)))]
    impl<'py> Sub for &'py PyComplex {
        type Output = &'py PyComplex;
        fn sub(self, other: &'py PyComplex) -> &'py PyComplex {
            unsafe {
                self.py()
                    .from_owned_ptr(complex_operation(self, other, ffi::_Py_c_diff))
            }
        }
    }

    #[cfg(not(any(Py_LIMITED_API, PyPy)))]
    impl<'py> Mul for &'py PyComplex {
        type Output = &'py PyComplex;
        fn mul(self, other: &'py PyComplex) -> &'py PyComplex {
            unsafe {
                self.py()
                    .from_owned_ptr(complex_operation(self, other, ffi::_Py_c_prod))
            }
        }
    }

    #[cfg(not(any(Py_LIMITED_API, PyPy)))]
    impl<'py> Div for &'py PyComplex {
        type Output = &'py PyComplex;
        fn div(self, other: &'py PyComplex) -> &'py PyComplex {
            unsafe {
                self.py()
                    .from_owned_ptr(complex_operation(self, other, ffi::_Py_c_quot))
            }
        }
    }

    #[cfg(not(any(Py_LIMITED_API, PyPy)))]
    impl<'py> Neg for &'py PyComplex {
        type Output = &'py PyComplex;
        fn neg(self) -> &'py PyComplex {
            unsafe {
                let val = (*(self.as_ptr() as *mut ffi::PyComplexObject)).cval;
                self.py()
                    .from_owned_ptr(ffi::PyComplex_FromCComplex(ffi::_Py_c_neg(val)))
            }
        }
    }

    #[cfg(feature = "num-complex")]
    mod complex_conversion {
        use super::*;
        use crate::{FromPyObject, PyErr, PyNativeType, PyObject, PyResult, ToPyObject};
        use num_complex::Complex;

        impl PyComplex {
            /// Creates a new Python `PyComplex` object from num_complex::Complex.
            pub fn from_complex<F: Into<c_double>>(py: Python, complex: Complex<F>) -> &PyComplex {
                unsafe {
                    let ptr = ffi::PyComplex_FromDoubles(complex.re.into(), complex.im.into());
                    py.from_owned_ptr(ptr)
                }
            }
        }
        macro_rules! complex_conversion {
            ($float: ty) => {
                impl ToPyObject for Complex<$float> {
                    #[inline]
                    fn to_object(&self, py: Python) -> PyObject {
                        crate::IntoPy::<PyObject>::into_py(self.to_owned(), py)
                    }
                }
                impl crate::IntoPy<PyObject> for Complex<$float> {
                    fn into_py(self, py: Python) -> PyObject {
                        unsafe {
                            let raw_obj =
                                ffi::PyComplex_FromDoubles(self.re as c_double, self.im as c_double);
                            PyObject::from_owned_ptr(py, raw_obj)
                        }
                    }
                }
                #[cfg(not(any(Py_LIMITED_API, PyPy)))]
                #[allow(clippy::float_cmp)] // The comparison is for an error value
                impl<'source> FromPyObject<'source> for Complex<$float> {
                    fn extract(obj: &'source PyAny) -> PyResult<Complex<$float>> {
                        unsafe {
                            let val = ffi::PyComplex_AsCComplex(obj.as_ptr());
                            if val.real == -1.0 && PyErr::occurred(obj.py()) {
                                Err(PyErr::fetch(obj.py()))
                            } else {
                                Ok(Complex::new(val.real as $float, val.imag as $float))
                            }
                        }
                    }
                }
                #[cfg(any(Py_LIMITED_API, PyPy))]
                #[allow(clippy::float_cmp)] // The comparison is for an error value
                impl<'source> FromPyObject<'source> for Complex<$float> {
                    fn extract(obj: &'source PyAny) -> PyResult<Complex<$float>> {
                        unsafe {
                            let ptr = obj.as_ptr();
                            let real = ffi::PyComplex_RealAsDouble(ptr);
                            if real == -1.0 && PyErr::occurred(obj.py()) {
                                return Err(PyErr::fetch(obj.py()));
                            }
                            let imag = ffi::PyComplex_ImagAsDouble(ptr);
                            Ok(Complex::new(real as $float, imag as $float))
                        }
                    }
                }
            };
        }
        complex_conversion!(f32);
        complex_conversion!(f64);

        #[allow(clippy::float_cmp)] // The test wants to ensure that no precision was lost on the Python round-trip
        #[test]
        fn from_complex() {
            let gil = Python::acquire_gil();
            let py = gil.python();
            let complex = Complex::new(3.0, 1.2);
            let py_c = PyComplex::from_complex(py, complex);
            assert_eq!(py_c.real(), 3.0);
            assert_eq!(py_c.imag(), 1.2);
        }
        #[test]
        fn to_from_complex() {
            let gil = Python::acquire_gil();
            let py = gil.python();
            let val = Complex::new(3.0, 1.2);
            let obj = val.to_object(py);
            assert_eq!(obj.extract::<Complex<f64>>(py).unwrap(), val);
        }
        #[test]
        fn from_complex_err() {
            let gil = Python::acquire_gil();
            let py = gil.python();
            let obj = vec![1].to_object(py);
            assert!(obj.extract::<Complex<f64>>(py).is_err());
        }
    }

    #[cfg(test)]
    mod test {
        use super::PyComplex;
        use crate::Python;
        use assert_approx_eq::assert_approx_eq;

        #[test]
        fn test_from_double() {
            use assert_approx_eq::assert_approx_eq;

            let gil = Python::acquire_gil();
            let py = gil.python();
            let complex = PyComplex::from_doubles(py, 3.0, 1.2);
            assert_approx_eq!(complex.real(), 3.0);
            assert_approx_eq!(complex.imag(), 1.2);
        }

        #[cfg(not(any(Py_LIMITED_API, PyPy)))]
        #[test]
        fn test_add() {
            let gil = Python::acquire_gil();
            let py = gil.python();
            let l = PyComplex::from_doubles(py, 3.0, 1.2);
            let r = PyComplex::from_doubles(py, 1.0, 2.6);
            let res = l + r;
            assert_approx_eq!(res.real(), 4.0);
            assert_approx_eq!(res.imag(), 3.8);
        }

        #[cfg(not(any(Py_LIMITED_API, PyPy)))]
        #[test]
        fn test_sub() {
            let gil = Python::acquire_gil();
            let py = gil.python();
            let l = PyComplex::from_doubles(py, 3.0, 1.2);
            let r = PyComplex::from_doubles(py, 1.0, 2.6);
            let res = l - r;
            assert_approx_eq!(res.real(), 2.0);
            assert_approx_eq!(res.imag(), -1.4);
        }

        #[cfg(not(any(Py_LIMITED_API, PyPy)))]
        #[test]
        fn test_mul() {
            let gil = Python::acquire_gil();
            let py = gil.python();
            let l = PyComplex::from_doubles(py, 3.0, 1.2);
            let r = PyComplex::from_doubles(py, 1.0, 2.6);
            let res = l * r;
            assert_approx_eq!(res.real(), -0.12);
            assert_approx_eq!(res.imag(), 9.0);
        }

        #[cfg(not(any(Py_LIMITED_API, PyPy)))]
        #[test]
        fn test_div() {
            let gil = Python::acquire_gil();
            let py = gil.python();
            let l = PyComplex::from_doubles(py, 3.0, 1.2);
            let r = PyComplex::from_doubles(py, 1.0, 2.6);
            let res = l / r;
            assert_approx_eq!(res.real(), 0.788_659_793_814_432_9);
            assert_approx_eq!(res.imag(), -0.850_515_463_917_525_7);
        }

        #[cfg(not(any(Py_LIMITED_API, PyPy)))]
        #[test]
        fn test_neg() {
            let gil = Python::acquire_gil();
            let py = gil.python();
            let val = PyComplex::from_doubles(py, 3.0, 1.2);
            let res = -val;
            assert_approx_eq!(res.real(), -3.0);
            assert_approx_eq!(res.imag(), -1.2);
        }

        #[cfg(not(any(Py_LIMITED_API, PyPy)))]
        #[test]
        fn test_abs() {
            let gil = Python::acquire_gil();
            let py = gil.python();
            let val = PyComplex::from_doubles(py, 3.0, 1.2);
            assert_approx_eq!(val.abs(), 3.231_098_884_280_702_2);
        }

        #[cfg(not(any(Py_LIMITED_API, PyPy)))]
        #[test]
        fn test_pow() {
            let gil = Python::acquire_gil();
            let py = gil.python();
            let l = PyComplex::from_doubles(py, 3.0, 1.2);
            let r = PyComplex::from_doubles(py, 1.2, 2.6);
            let val = l.pow(r);
            assert_approx_eq!(val.real(), -1.419_309_997_016_603_7);
            assert_approx_eq!(val.imag(), -0.541_297_466_033_544_6);
        }
    }