Struct ComplexNumber

pub struct ComplexNumber<T: ComplexNumberRequiredTraits<T>> {
    pub real: T,
    pub complex: T,
}

Fields

real: T

complex: T

Implementations

impl<T: ComplexNumberRequiredTraits<T>> ComplexNumber<T>

pub fn new(real: T, complex: T) -> ComplexNumber<T>

pub fn complex_conjugate(&self) -> Self

Creates a new complex number that is the complex conjugate of the original

use matrix::complex_number::ComplexNumber;
use rand::prelude::*;
let mut rng = rand::thread_rng();
let real = rng.gen_range(1.0..=100.0);
let complex = rng.gen_range(1.0..=100.0);
let complex_number = ComplexNumber::new(real, complex);

assert_eq!(
    complex_number.complex_conjugate(),
    ComplexNumber::new(real, -complex,)
);

pub fn magnitude(&self) -> T

Calculates the cartesian magnitude of a complex number Requires T to implement the sqrt trait which exposes the square_root() method

use matrix::complex_number::ComplexNumber;
let test_complex_number = ComplexNumber::new(3.0, 4.0);
assert_eq!(test_complex_number.magnitude(), 5.0);

pub fn normalized(&self) -> Self

Creates a new complex number that is a normalised copy of the first.

use matrix::complex_number::ComplexNumber;
let test_complex_number = ComplexNumber::new(3.0, 4.0);
let normalised = test_complex_number.normalized();
assert_eq!(normalised.real, 0.6);
assert_eq!(normalised.complex, 0.8);

pub fn square_root(&self) -> Self

Calculates the square root of a complex number

use matrix::complex_number::ComplexNumber;
let complex = ComplexNumber::new(3.0, 4.0);

assert_eq!(complex.square_root(), ComplexNumber::new(2.0, 1.0));

pub fn powf(&self, n: T) -> Self

Implementation of the Pow trait for ComplexNumber

Trait Implementations

impl<T: ComplexNumberRequiredTraits<T>> Add for ComplexNumber<T>

type Output = ComplexNumber<T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T: ComplexNumberRequiredTraits<T>> AddAssign for ComplexNumber<T>

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl<T: Clone + ComplexNumberRequiredTraits<T>> Clone for ComplexNumber<T>

fn clone(&self) -> ComplexNumber<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + ComplexNumberRequiredTraits<T>> Debug for ComplexNumber<T>

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

Formats the value using the given formatter.

impl<T: ComplexNumberRequiredTraits<T>> Default for ComplexNumber<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: ComplexNumberRequiredTraits<T>> Display for ComplexNumber<T>

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

Formats the value using the given formatter.

impl<T: ComplexNumberRequiredTraits<T>> Div for ComplexNumber<T>

type Output = ComplexNumber<T>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T: ComplexNumberRequiredTraits<T>> DivAssign for ComplexNumber<T>

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl<T: ComplexNumberRequiredTraits<T>> From<u8> for ComplexNumber<T>

fn from(value: u8) -> Self

Converts to this type from the input type.

impl<T: ComplexNumberRequiredTraits<T>> Mul for ComplexNumber<T>

type Output = ComplexNumber<T>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T: ComplexNumberRequiredTraits<T>> MulAssign for ComplexNumber<T>

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl<T: ComplexNumberRequiredTraits<T>> Neg for ComplexNumber<T>

type Output = ComplexNumber<T>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<T: PartialEq + ComplexNumberRequiredTraits<T>> PartialEq for ComplexNumber<T>

fn eq(&self, other: &ComplexNumber<T>) -> 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<T: PartialOrd + ComplexNumberRequiredTraits<T>> PartialOrd for ComplexNumber<T>

fn partial_cmp(&self, other: &ComplexNumber<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: ComplexNumberRequiredTraits<T>> Pow for ComplexNumber<T>

fn pow(&self, n: ComplexNumber<T>) -> Self

impl<T: ComplexNumberRequiredTraits<T>> Sqrt for ComplexNumber<T>

fn square_root(&self) -> Self

impl<T: ComplexNumberRequiredTraits<T>> Sub for ComplexNumber<T>

type Output = ComplexNumber<T>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T: Copy + ComplexNumberRequiredTraits<T>> Copy for ComplexNumber<T>

impl<T: ComplexNumberRequiredTraits<T>> StructuralPartialEq for ComplexNumber<T>