Struct rug::float::OrdFloat

pub struct OrdFloat { /* fields omitted */ }

A float that supports ordering and hashing.

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::Float;
use rug::float::{OrdFloat, Special};
use std::cmp::Ordering;

let nan_f = Float::with_val(53, Special::Nan);
let nan = OrdFloat::from(nan_f);
assert_eq!(nan.cmp(&nan), Ordering::Equal);

let neg_inf_f = Float::with_val(53, Special::NegInfinity);
let neg_inf = OrdFloat::from(neg_inf_f);
assert_eq!(nan.cmp(&neg_inf), Ordering::Less);

let zero_f = Float::with_val(53, Special::Zero);
let zero = OrdFloat::from(zero_f);
let neg_zero_f = Float::with_val(53, Special::NegZero);
let neg_zero = OrdFloat::from(neg_zero_f);
assert_eq!(zero.cmp(&neg_zero), Ordering::Greater);

Methods

impl OrdFloat

fn as_float(&self) -> &Float

Extracts the underlying Float.

Examples

use rug::Float;
use rug::float::OrdFloat;
let f = Float::with_val(53, 1.5);
let ord = OrdFloat::from(f);
let f_ref = ord.as_float();
assert_eq!(f_ref.to_f64(), 1.5);

fn as_float_mut(&mut self) -> &mut Float

Extracts the underlying Float.

Examples

use rug::Float;
use rug::float::OrdFloat;
let f = Float::with_val(53, -1.5);
let mut ord = OrdFloat::from(f);
ord.as_float_mut().abs_mut();
assert_eq!(ord.as_float().to_f64(), 1.5);

Trait Implementations

impl Clone for OrdFloat

fn clone(&self) -> OrdFloat

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OrdFloat

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

Formats the value using the given formatter.

impl Default for OrdFloat

fn default() -> OrdFloat

Returns the "default value" for a type.

impl Hash for OrdFloat

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 OrdFloat

fn eq(&self, other: &OrdFloat) -> 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 OrdFloat

impl PartialOrd for OrdFloat

fn partial_cmp(&self, other: &OrdFloat) -> 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 OrdFloat

fn cmp(&self, other: &OrdFloat) -> 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<Float> for OrdFloat

fn from(f: Float) -> OrdFloat

Performs the conversion.