Struct symphonia_core::dsp::complex::Complex

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

A complex number.

Fields

re: f32

The real component.

im: f32

The imaginary component.

Implementations

impl Complex

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

Create a new complex number.

pub fn j() -> Self

Create a complex number with a value of 0 + j1.

pub fn scale(&self, scale: f32) -> Self

Scale the complex number.

pub fn conj(&self) -> Self

Take the complex conjugate of self.

For a complex number defined as a + jb the complex conjugate is defined to be a - jb.

Trait Implementations

impl Add for Complex

type Output = Complex

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for Complex

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for Complex

fn clone(&self) -> Complex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Complex

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

Formats the value using the given formatter.

impl Default for Complex

fn default() -> Complex

Returns the “default value” for a type.

impl Div<f32> for Complex

type Output = Complex

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div for Complex

type Output = Complex

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign for Complex

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl Mul<f32> for Complex

type Output = Complex

The resulting type after applying the * operator.

fn mul(self, rhs: f32) -> Self::Output

Performs the * operation.

impl Mul for Complex

type Output = Complex

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign for Complex

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl PartialEq for Complex

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Sub for Complex

type Output = Complex

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for Complex

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Copy for Complex

impl StructuralPartialEq for Complex