Struct Complex

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

Uiua’s complex number type

Fields

re: f64

The real part

im: f64

The imaginary part

Implementations

impl Complex

pub const ZERO: Self = _

The complex number 0 + 0i

pub const ONE: Self = _

The complex number 1 + 0i

pub const I: Self = _

The complex number 0 + 1i

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

Create a new complex number

pub fn min(self, rhs: impl Into<Self>) -> Self

Get the minimum of the real and imaginary parts of two complex numbers, ignoring NaN

pub fn max(self, rhs: impl Into<Self>) -> Self

Get the maximum of the real and imaginary parts of two complex numbers, ignoring NaN

pub fn floor(self) -> Self

Get the floor of the real and imaginary parts of a complex number

pub fn ceil(self) -> Self

Get the ceiling of the real and imaginary parts of a complex number

pub fn round(self) -> Self

Round the real and imaginary parts of a complex number

pub fn abs(self) -> f64

Get the absolute value of a complex number

pub fn atan2(self, x: impl Into<Self>) -> Complex

Get the arctangent of a complex number

pub fn normalize(self) -> Self

Normalize a complex number

pub fn arg(self) -> f64

Calculate the principal value of the complex number

pub fn to_polar(self) -> (f64, f64)

Convert a complex number to polar coordinates

pub fn from_polar(r: f64, theta: f64) -> Self

Convert polar coordinates to a complex number

pub fn powc(self, power: impl Into<Self>) -> Self

Raise a complex number to a complex power

pub fn powf(self, power: f64) -> Self

Raise a complex number to a real power

pub fn exp(self) -> Self

Calculate the exponential of a complex number

pub fn ln(self) -> Self

Calculate the natural logarithm of a complex number

pub fn log(self, base: impl Into<Self>) -> Self

Calculate the logarithm of a complex number

pub fn sqrt(self) -> Self

Calculate the square root of a complex number

pub fn sin(self) -> Self

Calculate the sine of a complex number

pub fn cos(self) -> Self

Calculate the cosine of a complex number

pub fn asin(self) -> Self

Calculate the arc sine of a complex number

pub fn acos(self) -> Self

Calculate the arc cosine of a complex number

pub fn is_nan(&self) -> bool

Check if either real or imaginary part is NaN

pub fn into_real(self) -> Option<f64>

Get the complex number as a real number

Trait Implementations

impl Add<Complex> for f64

type Output = Complex

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<f64> for Complex

type Output = Complex

The resulting type after applying the + operator.

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

Performs the + operation.

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<T> AddAssign<T> for Complex

where Complex: Add<T, Output = Complex>,

fn add_assign(&mut self, rhs: T)

Performs the += operation.

impl ArrayCmp for Complex

fn array_cmp(&self, other: &Self) -> Ordering

Compare two elements

fn array_eq(&self, other: &U) -> bool

Check if two elements are equal

impl ArrayValue for Complex

const NAME: &'static str = "complex"

The type name

const SYMBOL: char = 'ℂ'

A glyph indicating the type

const TYPE_ID: u8 = 3u8

An ID for the type

fn get_scalar_fill(fill: &Fill<'_>) -> Result<Self, &'static str>

Get the scalar fill value from the environment

fn get_array_fill(fill: &Fill<'_>) -> Result<Array<Self>, &'static str>

Get the array fill value from the environment

fn array_hash<H: Hasher>(&self, hasher: &mut H)

Hash the value

fn proxy() -> Self

Get the proxy value

fn empty_list_inner() -> &'static str

Marker for empty lists in grid formatting

fn summarize(elems: &[Self]) -> String

Summarize the elements of an array of this type

fn format_delims() -> (&'static str, &'static str)

Delimiters for formatting

fn format_sep() -> &'static str

Separator for formatting

fn grid_fmt_delims(boxed: bool) -> (char, char)

Delimiters for grid formatting

fn compress_list_grid() -> bool

Whether to compress all items of a list when grid formatting

fn nested_value(&self) -> Option<&Value>

Get a nested value

fn has_wildcard(&self) -> bool

Check if this element has the wildcard value

fn summary_min_elems() -> usize

The minimum number of elements that require a summary

fn alignment() -> ElemAlign

How to align elements when formatting

fn max_col_width<'a>(rows: impl Iterator<Item = &'a [char]> + Clone) -> usize

How to determine the maximum width of a formatted column

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<'de> Deserialize<'de> for Complex

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Complex

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

Formats the value using the given formatter.

impl Div<Complex> for f64

type Output = Complex

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<f64> for Complex

type Output = Complex

The resulting type after applying the / operator.

fn div(self, rhs: f64) -> 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<T> DivAssign<T> for Complex

where Complex: Div<T, Output = Complex>,

fn div_assign(&mut self, rhs: T)

Performs the /= operation.

impl From<(f64, f64)> for Complex

fn from((re, im): (f64, f64)) -> Self

Converts to this type from the input type.

impl From<Complex> for (f64, f64)

fn from(c: Complex) -> Self

Converts to this type from the input type.

impl From<Complex> for Value

fn from(item: Complex) -> Self

Converts to this type from the input type.

impl From<f64> for Complex

fn from(re: f64) -> Self

Converts to this type from the input type.

impl From<u8> for Complex

fn from(value: u8) -> Self

Converts to this type from the input type.

impl FromIterator<Complex> for Value

fn from_iter<I: IntoIterator<Item = Complex>>(iter: I) -> Self

Creates a value from an iterator.

impl Mul<Complex> for f64

type Output = Complex

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f64> for Complex

type Output = Complex

The resulting type after applying the * operator.

fn mul(self, rhs: f64) -> 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<T> MulAssign<T> for Complex

where Complex: Mul<T, Output = Complex>,

fn mul_assign(&mut self, rhs: T)

Performs the *= operation.

impl Neg for Complex

type Output = Complex

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq for Complex

fn eq(&self, other: &Self) -> 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 PartialOrd for Complex

fn partial_cmp(&self, other: &Complex) -> 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 Rem<Complex> for f64

type Output = Complex

The resulting type after applying the % operator.

fn rem(self, rhs: Complex) -> Self::Output

Performs the % operation.

impl Rem<f64> for Complex

type Output = Complex

The resulting type after applying the % operator.

fn rem(self, rhs: f64) -> Self::Output

Performs the % operation.

impl Rem for Complex

type Output = Complex

The resulting type after applying the % operator.

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

Performs the % operation.

impl Serialize for Complex

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<Complex> for f64

type Output = Complex

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<f64> for Complex

type Output = Complex

The resulting type after applying the - operator.

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

Performs the - operation.

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<T> SubAssign<T> for Complex

where Complex: Sub<T, Output = Complex>,

fn sub_assign(&mut self, rhs: T)

Performs the -= operation.

impl Copy for Complex

impl Eq for Complex