Struct igraph_complex_t 

pub struct igraph_complex_t { /* private fields */ }

Implementations

impl igraph_complex_t

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

Builds a complex number from its real and imaginary parts.

pub const fn re(&self) -> f64

The real part.

pub const fn im(&self) -> f64

The imaginary part.

impl igraph_complex_t

pub fn conj(self) -> Self

The complex conjugate (igraph_complex_conj, undocumented in igraph_complex.h).

pub fn inv(self) -> Self

The multiplicative inverse 1 / z (igraph_complex_inv, undocumented in igraph_complex.h).

pub fn sqrt(self) -> Self

The principal square root (igraph_complex_sqrt, undocumented in igraph_complex.h).

pub fn exp(self) -> Self

The exponential e^z (igraph_complex_exp, undocumented in igraph_complex.h).

pub fn ln(self) -> Self

The principal natural logarithm (igraph_complex_log, undocumented in igraph_complex.h).

pub fn log10(self) -> Self

The principal base-10 logarithm (igraph_complex_log10, undocumented in igraph_complex.h).

pub fn sin(self) -> Self

The sine (igraph_complex_sin, undocumented in igraph_complex.h).

pub fn cos(self) -> Self

The cosine (igraph_complex_cos, undocumented in igraph_complex.h).

pub fn tan(self) -> Self

The tangent (igraph_complex_tan, undocumented in igraph_complex.h).

pub fn sec(self) -> Self

The secant 1 / cos z (igraph_complex_sec, undocumented in igraph_complex.h).

pub fn csc(self) -> Self

The cosecant 1 / sin z (igraph_complex_csc, undocumented in igraph_complex.h).

pub fn cot(self) -> Self

The cotangent 1 / tan z (igraph_complex_cot, undocumented in igraph_complex.h).

impl igraph_complex_t

pub const I: Self

The complex number i.

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

Builds r·e^{iθ} from polar coordinates (igraph_complex_polar, undocumented in igraph_complex.h).

use igraph::igraph_complex_t as Complex;
let z = Complex::from_polar(2.0, std::f64::consts::FRAC_PI_2);
assert!(z.almost_equals(Complex::new(0.0, 2.0), 1e-12));
assert_eq!((z * z).re(), -4.0);

pub fn sqrt_real(x: f64) -> Self

The (principal) square root of a real number, which may be imaginary (igraph_complex_sqrt_real, undocumented in igraph_complex.h).

pub fn abs(self) -> f64

The modulus |z| (igraph_complex_abs, undocumented in igraph_complex.h).

pub fn logabs(self) -> f64

The natural logarithm of the modulus, ln |z|, computed accurately (igraph_complex_logabs, undocumented in igraph_complex.h).

pub fn arg(self) -> f64

The argument (phase angle) in (-π, π] (igraph_complex_arg, undocumented in igraph_complex.h).

pub fn almost_equals(self, other: Self, eps: f64) -> bool

Whether self and other are equal up to the relative tolerance eps (igraph_complex_almost_equals).

pub fn pow(self, exponent: Self) -> Self

The complex power self^exponent (igraph_complex_pow, undocumented in igraph_complex.h).

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

The real power self^exponent (igraph_complex_pow_real, undocumented in igraph_complex.h).

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

The logarithm in base base (igraph_complex_log_b, undocumented in igraph_complex.h).

pub fn add_real(self, x: f64) -> Self

Adds a real number (igraph_complex_add_real, undocumented in igraph_complex.h).

pub fn add_imag(self, y: f64) -> Self

Adds an imaginary number i·y (igraph_complex_add_imag, undocumented in igraph_complex.h).

pub fn sub_real(self, x: f64) -> Self

Subtracts a real number (igraph_complex_sub_real, undocumented in igraph_complex.h).

pub fn sub_imag(self, y: f64) -> Self

Subtracts an imaginary number i·y (igraph_complex_sub_imag, undocumented in igraph_complex.h).

pub fn mul_real(self, x: f64) -> Self

Multiplies by a real number (igraph_complex_mul_real, undocumented in igraph_complex.h).

pub fn mul_imag(self, y: f64) -> Self

Multiplies by an imaginary number i·y (igraph_complex_mul_imag, undocumented in igraph_complex.h).

pub fn div_real(self, x: f64) -> Self

Divides by a real number (igraph_complex_div_real, undocumented in igraph_complex.h).

pub fn div_imag(self, y: f64) -> Self

Divides by an imaginary number i·y (igraph_complex_div_imag, undocumented in igraph_complex.h).

Trait Implementations

impl Add for igraph_complex_t

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

Complex arithmetic with igraph_complex_add.

type Output = igraph_complex_t

The resulting type after applying the + operator.

impl AddAssign for igraph_complex_t

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for igraph_complex_t

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for igraph_complex_t

impl Debug for igraph_complex_t

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

Formats the value using the given formatter.

impl Default for igraph_complex_t

fn default() -> Self

Returns the “default value” for a type.

impl Display for igraph_complex_t

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

Formats like igraph does (igraph_complex_snprintf), e.g. 1+2i.

impl Div for igraph_complex_t

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

Complex arithmetic with igraph_complex_div.

type Output = igraph_complex_t

The resulting type after applying the / operator.

impl DivAssign for igraph_complex_t

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl Extend<igraph_complex_t> for igraph_vector_complex_t

fn extend<I: IntoIterator<Item = igraph_complex_t>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl From<(f64, f64)> for igraph_complex_t

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

Converts to this type from the input type.

impl From<f64> for igraph_complex_t

fn from(re: f64) -> Self

A complex number with zero imaginary part.

impl FromIterator<igraph_complex_t> for igraph_vector_complex_t

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

Creates a value from an iterator.

impl Mul for igraph_complex_t

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

Complex arithmetic with igraph_complex_mul.

type Output = igraph_complex_t

The resulting type after applying the * operator.

impl MulAssign for igraph_complex_t

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl Neg for igraph_complex_t

fn neg(self) -> Self

Negation (igraph_complex_neg, undocumented in igraph_complex.h).

type Output = igraph_complex_t

The resulting type after applying the - operator.

impl PartialEq for igraph_complex_t

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 Sub for igraph_complex_t

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

Complex arithmetic with igraph_complex_sub.

type Output = igraph_complex_t

The resulting type after applying the - operator.

impl SubAssign for igraph_complex_t

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.