Struct rug::complex::OrdComplex

#[repr(transparent)]
pub struct OrdComplex { /* fields omitted */ }

A complex number that supports total ordering and hashing.

For ordering, the real part has precedence over the imaginary part. Negative zero is ordered as less than positive zero. Negative NaN is ordered as less than negative infinity, while positive NaN is ordered as greater than positive infinity. Comparing two negative NaNs or two positive NaNs produces equality.

Examples

use rug::{complex::OrdComplex, float::Special, Complex};
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

pub fn as_complex(&self) -> &Complex

Extracts the underlying Complex.

Examples

use rug::{complex::OrdComplex, Complex};
let c = Complex::with_val(53, (1.5, 2.5));
let ord = OrdComplex::from(c);
let c_ref = ord.as_complex();
assert_eq!(*c_ref.real(), 1.5);
assert_eq!(*c_ref.imag(), 2.5);

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

Extracts the underlying Complex.

Examples

use rug::{complex::OrdComplex, Complex};
let c = Complex::with_val(53, (1.5, -2.5));
let mut ord = OrdComplex::from(c);
ord.as_complex_mut().conj_mut();
let c_ref = ord.as_complex();
assert_eq!(*c_ref.real(), 1.5);
assert_eq!(*c_ref.imag(), 2.5);

Trait Implementations

impl From<Complex> for OrdComplex

fn from(src: Complex) -> Self

Performs the conversion.

impl From<OrdComplex> for Complex

fn from(src: OrdComplex) -> Self

Performs the conversion.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialOrd<OrdComplex> for OrdComplex

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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 PartialEq<OrdComplex> for OrdComplex

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

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 Eq for OrdComplex

impl Debug for OrdComplex

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

Formats the value using the given formatter.

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 Serialize for OrdComplex

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for OrdComplex

fn deserialize<D: Deserializer<'de>>(
    deserializer: D
) -> Result<OrdComplex, D::Error>

Deserialize this value from the given Serde deserializer.

fn deserialize_in_place<D: Deserializer<'de>>(
    deserializer: D,
    place: &mut OrdComplex
) -> Result<(), D::Error>