Trait faer_core::ComplexField

pub trait ComplexField: Copy + Num + Neg<Output = Self> + Conjugate<Num = Self> + Send + Sync + Debug + 'static {
    type Real: RealField;

    // Required methods
    fn from_real(real: Self::Real) -> Self;
    fn into_real_imag(self) -> (Self::Real, Self::Real);
    fn inv(self) -> Self;
    fn conj(self) -> Self;
    fn score(self) -> Self::Real;
    fn nan() -> Self;

    // Provided methods
    fn real(self) -> Self::Real { ... }
    fn imag(self) -> Self::Real { ... }
    fn scale_real(self, factor: Self::Real) -> Self { ... }
    fn abs(self) -> Self::Real { ... }
}

Trait that describes a complex number field.

Real numbers can also be seen as complex numbers, where the imaginary part is always zero.

Note

The implementation currently implies Copy, but this may be replaced by Clone in a future version of this library.

Required Associated Types

type Real: RealField

Required Methods

fn from_real(real: Self::Real) -> Self

Returns a complex number whose real part is equal to real, and a zero imaginary part.

fn into_real_imag(self) -> (Self::Real, Self::Real)

Returns the real and imaginary part.

fn inv(self) -> Self

fn conj(self) -> Self

Returns the conjugate of the number.

fn score(self) -> Self::Real

Returns either the norm or squared norm of the number.

An implementation may choose either, so long as it chooses consistently.

fn nan() -> Self

Provided Methods

fn real(self) -> Self::Real

Returns the real part.

fn imag(self) -> Self::Real

Returns the imaginary part.

fn scale_real(self, factor: Self::Real) -> Self

Returns the input, scaled by factor.

fn abs(self) -> Self::Real

Implementations on Foreign Types

impl ComplexField for f32

type Real = f32

fn from_real(real: Self::Real) -> Self

fn into_real_imag(self) -> (Self::Real, Self::Real)

fn conj(self) -> Self

fn score(self) -> Self::Real

fn abs(self) -> Self::Real

fn nan() -> Self

fn inv(self) -> Self

impl ComplexField for f64

type Real = f64

fn from_real(real: Self::Real) -> Self

fn into_real_imag(self) -> (Self::Real, Self::Real)

fn conj(self) -> Self

fn score(self) -> Self::Real

fn abs(self) -> Self::Real

fn nan() -> Self

fn inv(self) -> Self

impl<T: RealField> ComplexField for Complex<T>

type Real = T

fn from_real(real: Self::Real) -> Self

fn into_real_imag(self) -> (Self::Real, Self::Real)

fn conj(self) -> Self

fn score(self) -> Self::Real

fn nan() -> Self

fn inv(self) -> Self

Implementors