Struct lumol::types::Complex

pub struct Complex { /* fields omitted */ }

Complex number, with double precision real and imaginary parts.

Complex implements all the usual arithmetic operations:

let w = Complex::cartesian(-1.0, 0.5);
let z = Complex::cartesian(4.0, 2.0);

// Addition
let c = w + z;
assert_eq!(c, Complex::cartesian(3.0, 2.5));

// Subtraction
let c = w - z;
assert_eq!(c, Complex::cartesian(-5.0, -1.5));

// Multiplication
let c = w * z;
assert_eq!(c, Complex::cartesian(-5.0, 0.0));

let c = 42.0 * w;
assert_eq!(c, Complex::cartesian(-42.0, 21.0));

// Division
let c = z / 2.0;
assert_eq!(c, Complex::cartesian(2.0, 1.0));

Implementations

impl Complex

pub fn polar(r: f64, phi: f64) -> Complex

Create a new Complex from a norm r and a phase phi in radians.

Examples

let z = Complex::polar(3.0, f64::consts::PI);
assert_eq!(z.norm(), 3.0);

pub fn cartesian(x: f64, y: f64) -> Complex

Create a complex from Cartesian coordinates

Examples

let z = Complex::cartesian(3.0, -2.0);
assert_eq!(z.real(), 3.0);
assert_eq!(z.imag(), -2.0);

pub fn zero() -> Complex

Create a new Complex with both cartesian coordinate set to 0.

Examples

let z = Complex::zero();
assert_eq!(z.norm(), 0.0);

pub fn real(&self) -> f64

Get the real part of the complex

Examples

let z = Complex::cartesian(3.0, -2.0);
assert_eq!(z.real(), 3.0);

pub fn imag(&self) -> f64

Get the imaginary part of the complex

Examples

let z = Complex::cartesian(3.0, -2.0);
assert_eq!(z.imag(), -2.0);

pub fn phase(&self) -> f64

Get the phase of the complex in the [-π, π) interval

Examples

let z = Complex::polar(2.0, 0.3);
assert_eq!(z.phase(), 0.3);

pub fn norm(&self) -> f64

Get the norm of the complex

Examples

let z = Complex::polar(2.0, 0.3);
assert_eq!(z.norm(), 2.0);

let z = Complex::cartesian(2.0, 1.0);
assert_eq!(z.norm(), f64::sqrt(5.0));

pub fn norm2(&self) -> f64

Get the square of the norm if this complex

Examples

let z = Complex::cartesian(2.0, 1.0);
assert_eq!(z.norm2(), 5.0);

pub fn conj(&self) -> Complex

Get the conjugate of the complex

Examples

let z = Complex::cartesian(2.0, 1.0);
assert_eq!(z.conj(), Complex::cartesian(2.0, -1.0));

Trait Implementations

impl Add<Complex> for Complex

type Output = Complex

The resulting type after applying the + operator.

pub fn add(self, other: Complex) -> Complex

Performs the + operation.

impl AddAssign<Complex> for Complex

pub fn add_assign(&mut self, other: Complex)

Performs the += operation.

impl Clone for Complex

pub fn clone(&self) -> Complex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Complex

impl Debug for Complex

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

Formats the value using the given formatter.

impl Default for Complex

pub fn default() -> Complex

Returns the "default value" for a type.

impl Div<Complex> for Complex

type Output = Complex

The resulting type after applying the / operator.

pub fn div(self, other: Complex) -> Complex

Performs the / operation.

impl Div<f64> for Complex

type Output = Complex

The resulting type after applying the / operator.

pub fn div(self, other: f64) -> Complex

Performs the / operation.

impl DivAssign<Complex> for Complex

pub fn div_assign(&mut self, other: Complex)

Performs the /= operation.

impl DivAssign<f64> for Complex

pub fn div_assign(&mut self, other: f64)

Performs the /= operation.

impl Mul<Complex> for Complex

type Output = Complex

The resulting type after applying the * operator.

pub fn mul(self, other: Complex) -> Complex

Performs the * operation.

impl Mul<f64> for Complex

type Output = Complex

The resulting type after applying the * operator.

pub fn mul(self, other: f64) -> Complex

Performs the * operation.

impl MulAssign<Complex> for Complex

pub fn mul_assign(&mut self, other: Complex)

Performs the *= operation.

impl MulAssign<f64> for Complex

pub fn mul_assign(&mut self, other: f64)

Performs the *= operation.

impl Neg for Complex

type Output = Complex

The resulting type after applying the - operator.

pub fn neg(self) -> Complex

Performs the unary - operation.

impl One for Complex

pub fn one() -> Complex

Returns the multiplicative identity element of Self, 1.

fn set_one(&mut self)

Sets self to the multiplicative identity element of Self, 1.

fn is_one(&self) -> bool where
    Self: PartialEq<Self>, 

Returns true if self is equal to the multiplicative identity.

impl PartialEq<Complex> for Complex

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

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

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

This method tests for !=.

impl StructuralPartialEq for Complex

impl Sub<Complex> for Complex

type Output = Complex

The resulting type after applying the - operator.

pub fn sub(self, other: Complex) -> Complex

Performs the - operation.

impl SubAssign<Complex> for Complex

pub fn sub_assign(&mut self, other: Complex)

Performs the -= operation.

impl Zero for Complex

pub fn zero() -> Complex

Returns the additive identity element of Self, 0.

pub fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.