Struct rug::complex::OrdComplex

pub struct OrdComplex { /* fields omitted */ }

A complex number that supports ordering and hashing.

For ordering, the real part has precedence over the imaginary part. Negative zero is ordered as less than positive zero. All NaNs are ordered as equal and as less than negative infinity, with the NaN sign ignored.

Examples

use rug::Complex;
use rug::complex::OrdComplex;
use rug::float::Special;
use std::cmp::Ordering;

let nan_c = Complex::with_val(53, (Special::Nan, Special::Nan));
let nan = OrdComplex::from(nan_c);
assert_eq!(nan.cmp(&nan), Ordering::Equal);

let one_neg0_c = Complex::with_val(53, (1, Special::NegZero));
let one_neg0 = OrdComplex::from(one_neg0_c);
let one_pos0_c = Complex::with_val(53, (1, Special::Zero));
let one_pos0 = OrdComplex::from(one_pos0_c);
assert_eq!(one_neg0.cmp(&one_pos0), Ordering::Less);

let zero_inf_s = (Special::Zero, Special::Infinity);
let zero_inf_c = Complex::with_val(53, zero_inf_s);
let zero_inf = OrdComplex::from(zero_inf_c);
assert_eq!(one_pos0.cmp(&zero_inf), Ordering::Greater);

Methods

impl OrdComplex

fn as_complex(&self) -> &Complex

Extracts the underlying Complex.

Examples

use rug::Complex;
use rug::complex::OrdComplex;
let c = Complex::with_val(53, (1.5, 2.5));
let ord = OrdComplex::from(c);
let c_ref = ord.as_complex();
let (re, im) = c_ref.as_real_imag();
assert_eq!(*re, 1.5);
assert_eq!(*im, 2.5);

fn as_complex_mut(&mut self) -> &mut Complex

Extracts the underlying Complex.

Examples

use rug::Complex;
use rug::complex::OrdComplex;
let c = Complex::with_val(53, (1.5, -2.5));
let mut ord = OrdComplex::from(c);
ord.as_complex_mut().conj_mut();
let (re, im) = ord.as_complex().as_real_imag();
assert_eq!(*re, 1.5);
assert_eq!(*im, 2.5);

Trait Implementations

impl Clone for OrdComplex

fn clone(&self) -> OrdComplex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OrdComplex

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

Formats the value using the given formatter.

impl Default for OrdComplex

fn default() -> OrdComplex

Returns the "default value" for a type.

impl Hash for OrdComplex

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq for OrdComplex

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

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

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

This method tests for !=.

impl Eq for OrdComplex

impl PartialOrd for OrdComplex

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Ord for OrdComplex

fn cmp(&self, other: &OrdComplex) -> Ordering

This method returns an Ordering between self and other.

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

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

Compares and returns the maximum of two values.

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

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

Compares and returns the minimum of two values.

impl From<Complex> for OrdComplex

fn from(c: Complex) -> OrdComplex

Performs the conversion.