Struct quantum2::complex::Complex

pub struct Complex { /* fields omitted */ }

Holds a complex number with 64-bit float parts.

Methods

impl Complex

pub fn new(re: f64, im: f64) -> Complex

Construct a new complex number as re + im * i with 64-bit float parts.

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

Construct a new complex number as r * exp(i * phi) with 64-bit float parts.

pub fn nth_root_of_unity(n: u32) -> Complex

Construct a new primitive nth root of unity.

pub fn zero() -> Complex

Zero in the complex plane, i.e. 0 + 0i.

pub fn one() -> Complex

One in the complex plane, i.e. 1 + 0i.

pub fn i() -> Complex

The imaginary unit.

pub fn norm_sqr(&self) -> f64

Compute the square of the norm/absolute value, i.e. |z|^2.

pub fn pow(&self, n: u32) -> Complex

Compute an integer power of this number efficiently with repeated squaring.

pub fn re(&self) -> f64

The real part.

pub fn im(&self) -> f64

The imaginary part.

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

Approximately equal test.

Trait Implementations

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 Copy for Complex

impl PartialEq<Complex> 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: &Complex) -> bool

This method tests for !=.

impl Debug for Complex

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

Formats the value using the given formatter.

impl Add<Complex> for Complex

type Output = Complex

The resulting type after applying the + operator.

fn add(self, rhs: Complex) -> Complex

Performs the + operation.

impl Mul<Complex> for Complex

type Output = Complex

The resulting type after applying the * operator.

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

Performs the * operation.

impl Neg for Complex

type Output = Complex

The resulting type after applying the - operator.

fn neg(self) -> Complex

Performs the unary - operation.

impl AddAssign<Complex> for Complex

fn add_assign(&mut self, rhs: Complex)

Performs the += operation.

impl MulAssign<Complex> for Complex

fn mul_assign(&mut self, rhs: Complex)

Performs the *= operation.