Struct qoqo_calculator::CalculatorComplex

pub struct CalculatorComplex {
    pub re: CalculatorFloat,
    pub im: CalculatorFloat,
}

Struct CalculatorComplex.

Fields

re: CalculatorFloat

CalculatorFloat value of real part of CalculatorComplex

im: CalculatorFloat

CalculatorFloat value of imaginary part of CalculatorComplex

Implementations

impl CalculatorComplex

pub const ZERO: CalculatorComplex

Constant zero for CalculatorComplex

pub const ONE: CalculatorComplex

Constant one for CalculatorFloat

pub const I: CalculatorComplex

Constant imaginary number for CalculatorFloat

pub fn new<T1, T2>(re: T1, im: T2) -> Self where
    CalculatorFloat: From<T1>,
    CalculatorFloat: From<T2>, 

Return CalculatorComplex constructed form pair of real values.

Arguments

• re - Real part given as type that can be converted to CalculatorFloat
• im - Imaginary part given as type that can be converted to CalculatorFloat

pub fn arg(&self) -> CalculatorFloat

Return phase of complex number x: arg(x).

pub fn norm_sqr(&self) -> CalculatorFloat

Return square norm of complex number x: |x|^2=x.re^2+x.im^2.

pub fn norm(&self) -> CalculatorFloat

Return norm of complex number x: |x|=(x.re^2+x.im^2)^1/2.

pub fn conj(&self) -> CalculatorComplex

Return complex conjugate of x: x*=x.re-i*x.im.

pub fn isclose<T>(&self, other: T) -> bool where
    CalculatorComplex: From<T>, 

Return true when x is close to y.

impl CalculatorComplex

Implement Inverse 1/x for CalculatorFloat.

pub fn recip(&self) -> CalculatorComplex

Returns Inverse 1/x for CalculatorFloat.

Trait Implementations

impl<T> Add<T> for CalculatorComplex where
    CalculatorComplex: From<T>, 

Implement + for CalculatorComplex and generic type T.

Arguments

• other - Any type T for which CalculatorComplex::From trait is implemented

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T> AddAssign<T> for CalculatorComplex where
    CalculatorComplex: From<T>, 

Implement += for CalculatorComplex and generic type T.

Arguments

• other - Any type T for which CalculatorComplex::From trait is implemented

fn add_assign(&mut self, other: T)

Performs the += operation.

impl Clone for CalculatorComplex

fn clone(&self) -> CalculatorComplex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CalculatorComplex

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

Formats the value using the given formatter.

impl Default for CalculatorComplex

Implement Default value 0 for CalculatorComplex.

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CalculatorComplex

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for CalculatorComplex

Implement Display trait for CalculatorComplex.

Allows use of simple text formating

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

Formats the value using the given formatter.

impl<T> Div<T> for CalculatorComplex where
    CalculatorComplex: From<T>, 

Implement * for CalculatorComplex and generic type T.

Arguments

• other - Any type T for which CalculatorComplex::From trait is implemented

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T> DivAssign<T> for CalculatorComplex where
    CalculatorComplex: From<T>, 

Implement *= for CalculatorComplex and generic type T.

Arguments

• other - Any type T for which CalculatorComplex::From trait is implemented

fn div_assign(&mut self, other: T)

Performs the /= operation.

impl<'a> From<&'a CalculatorComplex> for CalculatorComplex

Initialize CalculatorComplex from CalculatorComplex reference &CalculatorComplex.

Returns

• CalculatorFloat

fn from(item: &'a CalculatorComplex) -> Self

Performs the conversion.

impl From<Complex<f64>> for CalculatorComplex

Initialize CalculatorComplex from Complex.

Returns

• CalculatorComplex

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

Performs the conversion.

impl<T> From<T> for CalculatorComplex where
    CalculatorFloat: From<T>, 

Initialize CalculatorComplex from type that can be cast to CalculatorFloat.

Returns

• CalculatorComplex

fn from(item: T) -> Self

Performs the conversion.

impl<T> Mul<T> for CalculatorComplex where
    CalculatorComplex: From<T>, 

Implement * for CalculatorComplex and generic type T.

Arguments

• other - Any type T for which CalculatorComplex::From trait is implemented

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T> MulAssign<T> for CalculatorComplex where
    CalculatorComplex: From<T>, 

Implement *= for CalculatorComplex and generic type T.

Arguments

• other - Any type T for which CalculatorComplex::From trait is implemented

fn mul_assign(&mut self, other: T)

Performs the *= operation.

impl Neg for CalculatorComplex

Implement minus sign for CalculatorComplex.

type Output = CalculatorComplex

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl PartialEq<CalculatorComplex> for CalculatorComplex

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

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

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

This method tests for !=.

impl Serialize for CalculatorComplex

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<T> Sub<T> for CalculatorComplex where
    CalculatorComplex: From<T>, 

Implement - for CalculatorComplex and generic type T.

Arguments

• other - Any type T for which CalculatorComplex::From trait is implemented

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T> SubAssign<T> for CalculatorComplex where
    CalculatorComplex: From<T>, 

Implement -= for CalculatorComplex and generic type T.

Arguments

• other - Any type T for which CalculatorComplex::From trait is implemented

fn sub_assign(&mut self, other: T)

Performs the -= operation.

impl Sum<CalculatorComplex> for CalculatorComplex

Implements summing over an iterator of CalculatorComplex

Arguments

• iter - Any iterator over CalculatorComplex items

fn sum<I: Iterator<Item = CalculatorComplex>>(iter: I) -> Self

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl TryFrom<CalculatorComplex> for f64

Try turning CalculatorComplex into f64 float.

Returns

• f64

Panics

Panics when CalculatorFloat contains symbolic string value

type Error = CalculatorError

The type returned in the event of a conversion error.

fn try_from(value: CalculatorComplex) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<CalculatorComplex> for Complex<f64>

Try turning CalculatorComplex into Complex float.

Returns

• f64

Panics

Panics when CalculatorFloat contains symbolic string value

type Error = CalculatorError

The type returned in the event of a conversion error.

fn try_from(value: CalculatorComplex) -> Result<Self, CalculatorError>

Performs the conversion.

impl StructuralPartialEq for CalculatorComplex