Struct Complex 

#[repr(C)]
pub struct Complex<FT> {
    pub re: FT,
    pub im: FT,
}

A complex number in rectangular form.

Fields

re: FT

im: FT

Implementations

impl Complex<f32>

pub const ZERO: Self

pub const ONE: Self

pub const NEG_ONE: Self

pub const I: Self

pub const NEG_I: Self

pub const fn conjugate(self) -> Self

Computes the conjugate.

pub fn abs(self) -> f32

Computes the absolute value.

pub fn abs_sq(self) -> f32

Computes the squared absolute value.

This is faster than abs() as it avoids a square root operation.

pub fn arg(self) -> f32

Computes the argument in the range (-π, +π].

pub fn recip(self) -> Self

Computes the reciprocal.

pub fn sqrt(self) -> Self

Computes the principle square root.

pub fn to_polar(self) -> ComplexPolar<f32>

Convert to polar form.

pub fn exp(self) -> ComplexPolar<f32>

Computes e^self where e is the base of the natural logarithm.

pub fn ln(self) -> Self

Computes the principle natural logarithm.

pub fn log2(self) -> Self

Computes the principle logarithm in base 2.

pub fn log10(self) -> Self

Computes the principle logarithm in base 10.

pub fn powi(self, n: i32) -> ComplexPolar<f32>

Raises self to an integer power.

pub fn powf(self, x: f32) -> ComplexPolar<f32>

Raises self to a floating point power.

pub fn distance(self, other: Self) -> f32

Computes the euclidian distance between two points.

pub fn distance_squared(self, other: Self) -> f32

Computes the squared euclidian distance between two points.

pub fn as_vec2(self) -> Vec2

Casts to a glam::Vec2.

impl Complex<f64>

pub const ZERO: Self

pub const ONE: Self

pub const NEG_ONE: Self

pub const I: Self

pub const NEG_I: Self

pub const fn conjugate(self) -> Self

Computes the conjugate.

pub fn abs(self) -> f64

Computes the absolute value.

pub fn abs_sq(self) -> f64

Computes the squared absolute value.

This is faster than abs() as it avoids a square root operation.

pub fn arg(self) -> f64

Computes the argument in the range (-π, +π].

pub fn recip(self) -> Self

Computes the reciprocal.

pub fn sqrt(self) -> Self

Computes the principle square root.

pub fn to_polar(self) -> ComplexPolar<f64>

Convert to polar form.

pub fn exp(self) -> ComplexPolar<f64>

Computes e^self where e is the base of the natural logarithm.

pub fn ln(self) -> Self

Computes the principle natural logarithm.

pub fn log2(self) -> Self

Computes the principle logarithm in base 2.

pub fn log10(self) -> Self

Computes the principle logarithm in base 10.

pub fn powi(self, n: i32) -> ComplexPolar<f64>

Raises self to an integer power.

pub fn powf(self, x: f64) -> ComplexPolar<f64>

Raises self to a floating point power.

pub fn distance(self, other: Self) -> f64

Computes the euclidian distance between two points.

pub fn distance_squared(self, other: Self) -> f64

Computes the squared euclidian distance between two points.

pub fn as_vec2(self) -> Vec2

Casts to a glam::Vec2.

pub fn as_dvec2(self) -> DVec2

Casts to a glam::DVec2.

impl<FT> Complex<FT>

pub const fn new(re: FT, im: FT) -> Self

Creates a complex number.

Trait Implementations

impl AbsDiffEq for Complex<f32>

Available on crate feature approx only.

type Epsilon = <f32 as AbsDiffEq>::Epsilon

Used for specifying relative comparisons.

fn default_epsilon() -> Self::Epsilon

The default tolerance to use when testing values that are close together.

fn abs_diff_eq(&self, other: &Self, epsilon: Self::Epsilon) -> bool

A test for equality that uses the absolute difference to compute the approximate equality of two numbers.

fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool

The inverse of AbsDiffEq::abs_diff_eq.

impl AbsDiffEq for Complex<f64>

Available on crate feature approx only.

type Epsilon = <f64 as AbsDiffEq>::Epsilon

Used for specifying relative comparisons.

fn default_epsilon() -> Self::Epsilon

The default tolerance to use when testing values that are close together.

fn abs_diff_eq(&self, other: &Self, epsilon: Self::Epsilon) -> bool

A test for equality that uses the absolute difference to compute the approximate equality of two numbers.

fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool

The inverse of AbsDiffEq::abs_diff_eq.

impl Add<Complex<f32>> for f32

type Output = Complex<f32>

The resulting type after applying the + operator.

fn add(self, z: Self::Output) -> Self::Output

Performs the + operation.

impl Add<Complex<f64>> for f64

type Output = Complex<f64>

The resulting type after applying the + operator.

fn add(self, z: Self::Output) -> Self::Output

Performs the + operation.

impl Add<f32> for Complex<f32>

type Output = Complex<f32>

The resulting type after applying the + operator.

fn add(self, re: f32) -> Self::Output

Performs the + operation.

impl Add<f64> for Complex<f64>

type Output = Complex<f64>

The resulting type after applying the + operator.

fn add(self, re: f64) -> Self::Output

Performs the + operation.

impl Add for Complex<f32>

type Output = Complex<f32>

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self::Output

Performs the + operation.

impl Add for Complex<f64>

type Output = Complex<f64>

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self::Output

Performs the + operation.

impl AddAssign<f32> for Complex<f32>

fn add_assign(&mut self, re: f32)

Performs the += operation.

impl AddAssign<f64> for Complex<f64>

fn add_assign(&mut self, re: f64)

Performs the += operation.

impl AddAssign for Complex<f32>

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl AddAssign for Complex<f64>

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl<FT: Clone> Clone for Complex<FT>

fn clone(&self) -> Complex<FT>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<FT: Debug> Debug for Complex<FT>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for Complex<f32>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for Complex<f64>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Distribution<Complex<f32>> for StandardUniform

Available on crate feature rand only.

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> Complex<f32>

Generate a random value of T, using rng as the source of randomness.

fn sample_iter<R>(self, rng: R) -> Iter<Self, R, T>

where R: Rng, Self: Sized,

Create an iterator that generates random values of T, using rng as the source of randomness.

fn map<F, S>(self, func: F) -> Map<Self, F, T, S>

where F: Fn(T) -> S, Self: Sized,

Map sampled values to type S

impl Distribution<Complex<f64>> for StandardUniform

Available on crate feature rand only.

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> Complex<f64>

Generate a random value of T, using rng as the source of randomness.

fn sample_iter<R>(self, rng: R) -> Iter<Self, R, T>

where R: Rng, Self: Sized,

Create an iterator that generates random values of T, using rng as the source of randomness.

fn map<F, S>(self, func: F) -> Map<Self, F, T, S>

where F: Fn(T) -> S, Self: Sized,

Map sampled values to type S

impl Div<Complex<f32>> for f32

type Output = Complex<f32>

The resulting type after applying the / operator.

fn div(self, other: Self::Output) -> Self::Output

Performs the / operation.

impl Div<Complex<f64>> for f64

type Output = Complex<f64>

The resulting type after applying the / operator.

fn div(self, other: Self::Output) -> Self::Output

Performs the / operation.

impl Div<f32> for Complex<f32>

type Output = Complex<f32>

The resulting type after applying the / operator.

fn div(self, re: f32) -> Self::Output

Performs the / operation.

impl Div<f64> for Complex<f64>

type Output = Complex<f64>

The resulting type after applying the / operator.

fn div(self, re: f64) -> Self::Output

Performs the / operation.

impl Div for Complex<f32>

type Output = Complex<f32>

The resulting type after applying the / operator.

fn div(self, other: Self) -> Self::Output

Performs the / operation.

impl Div for Complex<f64>

type Output = Complex<f64>

The resulting type after applying the / operator.

fn div(self, other: Self) -> Self::Output

Performs the / operation.

impl DivAssign<f32> for Complex<f32>

fn div_assign(&mut self, re: f32)

Performs the /= operation.

impl DivAssign<f64> for Complex<f64>

fn div_assign(&mut self, re: f64)

Performs the /= operation.

impl DivAssign for Complex<f32>

fn div_assign(&mut self, other: Self)

Performs the /= operation.

impl DivAssign for Complex<f64>

fn div_assign(&mut self, other: Self)

Performs the /= operation.

impl From<Complex<f32>> for Vec2

Available on crate feature glam only.

fn from(z: Complex<f32>) -> Self

Converts to this type from the input type.

impl From<Complex<f64>> for DVec2

Available on crate feature glam only.

fn from(z: Complex<f64>) -> Self

Converts to this type from the input type.

impl From<Complex<f64>> for Vec2

Available on crate feature glam only.

fn from(z: Complex<f64>) -> Self

Converts to this type from the input type.

impl From<DVec2> for Complex<f64>

Available on crate feature glam only.

fn from(v: DVec2) -> Self

Converts to this type from the input type.

impl From<Vec2> for Complex<f32>

Available on crate feature glam only.

fn from(v: Vec2) -> Self

Converts to this type from the input type.

impl From<Vec2> for Complex<f64>

Available on crate feature glam only.

fn from(v: Vec2) -> Self

Converts to this type from the input type.

impl From<f32> for Complex<f32>

fn from(value: f32) -> Self

Converts to this type from the input type.

impl From<f64> for Complex<f64>

fn from(value: f64) -> Self

Converts to this type from the input type.

impl Mul<Complex<f32>> for f32

type Output = Complex<f32>

The resulting type after applying the * operator.

fn mul(self, other: Self::Output) -> Self::Output

Performs the * operation.

impl Mul<Complex<f64>> for f64

type Output = Complex<f64>

The resulting type after applying the * operator.

fn mul(self, other: Self::Output) -> Self::Output

Performs the * operation.

impl Mul<f32> for Complex<f32>

type Output = Complex<f32>

The resulting type after applying the * operator.

fn mul(self, re: f32) -> Self

Performs the * operation.

impl Mul<f64> for Complex<f64>

type Output = Complex<f64>

The resulting type after applying the * operator.

fn mul(self, re: f64) -> Self

Performs the * operation.

impl Mul for Complex<f32>

type Output = Complex<f32>

The resulting type after applying the * operator.

fn mul(self, other: Self) -> Self

Performs the * operation.

impl Mul for Complex<f64>

type Output = Complex<f64>

The resulting type after applying the * operator.

fn mul(self, other: Self) -> Self

Performs the * operation.

impl MulAssign<f32> for Complex<f32>

fn mul_assign(&mut self, re: f32)

Performs the *= operation.

impl MulAssign<f64> for Complex<f64>

fn mul_assign(&mut self, re: f64)

Performs the *= operation.

impl MulAssign for Complex<f32>

fn mul_assign(&mut self, other: Self)

Performs the *= operation.

impl MulAssign for Complex<f64>

fn mul_assign(&mut self, other: Self)

Performs the *= operation.

impl Neg for Complex<f32>

type Output = Complex<f32>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Neg for Complex<f64>

type Output = Complex<f64>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<FT: PartialEq> PartialEq for Complex<FT>

fn eq(&self, other: &Complex<FT>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RelativeEq for Complex<f32>

Available on crate feature approx only.

fn default_max_relative() -> Self::Epsilon

The default relative tolerance for testing values that are far-apart.

fn relative_eq( &self, other: &Self, epsilon: Self::Epsilon, max_relative: Self::Epsilon, ) -> bool

A test for equality that uses a relative comparison if the values are far apart.

fn relative_ne( &self, other: &Rhs, epsilon: Self::Epsilon, max_relative: Self::Epsilon, ) -> bool

The inverse of RelativeEq::relative_eq.

impl RelativeEq for Complex<f64>

Available on crate feature approx only.

fn default_max_relative() -> Self::Epsilon

The default relative tolerance for testing values that are far-apart.

fn relative_eq( &self, other: &Self, epsilon: Self::Epsilon, max_relative: Self::Epsilon, ) -> bool

A test for equality that uses a relative comparison if the values are far apart.

fn relative_ne( &self, other: &Rhs, epsilon: Self::Epsilon, max_relative: Self::Epsilon, ) -> bool

The inverse of RelativeEq::relative_eq.

impl Sub<Complex<f32>> for f32

type Output = Complex<f32>

The resulting type after applying the - operator.

fn sub(self, z: Self::Output) -> Self::Output

Performs the - operation.

impl Sub<Complex<f64>> for f64

type Output = Complex<f64>

The resulting type after applying the - operator.

fn sub(self, z: Self::Output) -> Self::Output

Performs the - operation.

impl Sub<f32> for Complex<f32>

type Output = Complex<f32>

The resulting type after applying the - operator.

fn sub(self, re: f32) -> Self::Output

Performs the - operation.

impl Sub<f64> for Complex<f64>

type Output = Complex<f64>

The resulting type after applying the - operator.

fn sub(self, re: f64) -> Self::Output

Performs the - operation.

impl Sub for Complex<f32>

type Output = Complex<f32>

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self::Output

Performs the - operation.

impl Sub for Complex<f64>

type Output = Complex<f64>

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self::Output

Performs the - operation.

impl SubAssign<f32> for Complex<f32>

fn sub_assign(&mut self, re: f32)

Performs the -= operation.

impl SubAssign<f64> for Complex<f64>

fn sub_assign(&mut self, re: f64)

Performs the -= operation.

impl SubAssign for Complex<f32>

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl SubAssign for Complex<f64>

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl UlpsEq for Complex<f32>

Available on crate feature approx only.

fn default_max_ulps() -> u32

The default ULPs to tolerate when testing values that are far-apart.

fn ulps_eq(&self, other: &Self, epsilon: Self::Epsilon, max_ulps: u32) -> bool

A test for equality that uses units in the last place (ULP) if the values are far apart.

fn ulps_ne(&self, other: &Rhs, epsilon: Self::Epsilon, max_ulps: u32) -> bool

The inverse of UlpsEq::ulps_eq.

impl UlpsEq for Complex<f64>

Available on crate feature approx only.

fn default_max_ulps() -> u32

The default ULPs to tolerate when testing values that are far-apart.

fn ulps_eq(&self, other: &Self, epsilon: Self::Epsilon, max_ulps: u32) -> bool

A test for equality that uses units in the last place (ULP) if the values are far apart.

fn ulps_ne(&self, other: &Rhs, epsilon: Self::Epsilon, max_ulps: u32) -> bool

The inverse of UlpsEq::ulps_eq.

impl<FT: Copy> Copy for Complex<FT>

impl<FT> StructuralPartialEq for Complex<FT>