Struct Double

Source
pub struct Double(/* private fields */);

Implementations§

Source§

impl Double

Source

pub const NEG_INFINITY: Self

Source

pub const INFINITY: Self

Source

pub const MIN: Self

Source

pub const MAX: Self

Source

pub const NAN: Self

Source

pub fn new(f: f64) -> Self

Source

pub fn is_nan(&self) -> bool

Returns true if this value is NaN.

Source

pub fn is_finite(&self) -> bool

Returns true if this number is neither infinite nor NaN.

Source

pub fn is_infinite(&self) -> bool

Returns true if this value is positive infinity or negative infinity, and false otherwise.

Source

pub fn is_positive(&self) -> bool

Returns true if self has a positive sign, including +0.0, NaNs with positive sign bit and positive infinity.

Note that IEEE 754 doesn’t assign any meaning to the sign bit in case of a NaN, and as Rust doesn’t guarantee that the bit pattern of NaNs are conserved over arithmetic operations, the result of is_positive on a NaN might produce an unexpected result in some cases. See explanation of NaN as a special value for more info.

Source

pub fn is_negative(&self) -> bool

Returns false if self has a negative sign, including -0.0, NaNs with negative sign bit and negative infinity.

Note that IEEE 754 doesn’t assign any meaning to the sign bit in case of a NaN, and as Rust doesn’t guarantee that the bit pattern of NaNs are conserved over arithmetic operations, the result of is_negative on a NaN might produce an unexpected result in some cases. See explanation of NaN as a special value for more info.

Source

pub const fn into_f64(self) -> f64

Converts this value into a f64.

Methods from Deref<Target = f64>§

1.43.0 · Source

pub const RADIX: u32 = 2u32

1.43.0 · Source

pub const MANTISSA_DIGITS: u32 = 53u32

1.43.0 · Source

pub const DIGITS: u32 = 15u32

1.43.0 · Source

pub const EPSILON: f64 = 2.2204460492503131E-16f64

1.43.0 · Source

pub const MIN: f64 = -1.7976931348623157E+308f64

1.43.0 · Source

pub const MIN_POSITIVE: f64 = 2.2250738585072014E-308f64

1.43.0 · Source

pub const MAX: f64 = 1.7976931348623157E+308f64

1.43.0 · Source

pub const MIN_EXP: i32 = -1_021i32

1.43.0 · Source

pub const MAX_EXP: i32 = 1_024i32

1.43.0 · Source

pub const MIN_10_EXP: i32 = -307i32

1.43.0 · Source

pub const MAX_10_EXP: i32 = 308i32

1.43.0 · Source

pub const NAN: f64 = NaN_f64

1.43.0 · Source

pub const INFINITY: f64 = +Inf_f64

1.43.0 · Source

pub const NEG_INFINITY: f64 = -Inf_f64

1.62.0 · Source

pub fn total_cmp(&self, other: &f64) -> Ordering

Returns the ordering between self and other.

Unlike the standard partial comparison between floating point numbers, this comparison always produces an ordering in accordance to the totalOrder predicate as defined in the IEEE 754 (2008 revision) floating point standard. The values are ordered in the following sequence:

  • negative quiet NaN
  • negative signaling NaN
  • negative infinity
  • negative numbers
  • negative subnormal numbers
  • negative zero
  • positive zero
  • positive subnormal numbers
  • positive numbers
  • positive infinity
  • positive signaling NaN
  • positive quiet NaN.

The ordering established by this function does not always agree with the PartialOrd and PartialEq implementations of f64. For example, they consider negative and positive zero equal, while total_cmp doesn’t.

The interpretation of the signaling NaN bit follows the definition in the IEEE 754 standard, which may not match the interpretation by some of the older, non-conformant (e.g. MIPS) hardware implementations.

§Example
struct GoodBoy {
    name: String,
    weight: f64,
}

let mut bois = vec![
    GoodBoy { name: "Pucci".to_owned(), weight: 0.1 },
    GoodBoy { name: "Woofer".to_owned(), weight: 99.0 },
    GoodBoy { name: "Yapper".to_owned(), weight: 10.0 },
    GoodBoy { name: "Chonk".to_owned(), weight: f64::INFINITY },
    GoodBoy { name: "Abs. Unit".to_owned(), weight: f64::NAN },
    GoodBoy { name: "Floaty".to_owned(), weight: -5.0 },
];

bois.sort_by(|a, b| a.weight.total_cmp(&b.weight));

// `f64::NAN` could be positive or negative, which will affect the sort order.
if f64::NAN.is_sign_negative() {
    assert!(bois.into_iter().map(|b| b.weight)
        .zip([f64::NAN, -5.0, 0.1, 10.0, 99.0, f64::INFINITY].iter())
        .all(|(a, b)| a.to_bits() == b.to_bits()))
} else {
    assert!(bois.into_iter().map(|b| b.weight)
        .zip([-5.0, 0.1, 10.0, 99.0, f64::INFINITY, f64::NAN].iter())
        .all(|(a, b)| a.to_bits() == b.to_bits()))
}

Trait Implementations§

Source§

impl Add for Double

Source§

type Output = Double

The resulting type after applying the + operator.
Source§

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

Performs the + operation. Read more
Source§

impl AsRef<f64> for Double

Source§

fn as_ref(&self) -> &f64

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl Borrow<f64> for Double

Source§

fn borrow(&self) -> &f64

Immutably borrows from an owned value. Read more
Source§

impl Clone for Double

Source§

fn clone(&self) -> Double

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Double

Source§

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

Formats the value using the given formatter. Read more
Source§

impl DerefMut for Double

Source§

fn deref_mut(&mut self) -> &mut f64

Mutably dereferences the value.
Source§

impl Display for Double

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Div for Double

Source§

type Output = Double

The resulting type after applying the / operator.
Source§

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

Performs the / operation. Read more
Source§

impl<'a> From<&'a Double> for Double

Source§

fn from(value: &'a Double) -> Self

Converts to this type from the input type.
Source§

impl From<Double> for f64

Source§

fn from(value: Double) -> Self

Converts to this type from the input type.
Source§

impl From<DoubleBuf> for Double

Source§

fn from(value: DoubleBuf) -> Self

Converts to this type from the input type.
Source§

impl From<f32> for Double

Source§

fn from(value: f32) -> Self

Converts to this type from the input type.
Source§

impl From<f64> for Double

Source§

fn from(value: f64) -> Self

Converts to this type from the input type.
Source§

impl FromStr for Double

Source§

type Err = InvalidDouble

The associated error which can be returned from parsing.
Source§

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type. Read more
Source§

impl Hash for Double

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl LexicalFormOf<Double> for Double

Source§

type ValueError = Infallible

Source§

fn try_as_value(&self) -> Result<Double, Self::ValueError>

Source§

fn as_value(&self) -> V
where Self: LexicalFormOf<V, ValueError = Infallible>,

Source§

impl Mul for Double

Source§

type Output = Double

The resulting type after applying the * operator.
Source§

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

Performs the * operation. Read more
Source§

impl Ord for Double

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

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

Restrict a value to a certain interval. Read more
Source§

impl ParseXsd for Double

Source§

type LexicalForm = Double

Source§

fn parse_xsd(lexical_value: &str) -> ParseXsdResult<Self, Self::LexicalForm>

Source§

impl PartialEq for Double

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialOrd for Double

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Sub for Double

Source§

type Output = Double

The resulting type after applying the - operator.
Source§

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

Performs the - operation. Read more
Source§

impl TryFrom<Decimal> for Double

Source§

type Error = FromDecimalError

The type returned in the event of a conversion error.
Source§

fn try_from(value: Decimal) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl TryFrom<Double> for Decimal

Source§

type Error = NonDecimalFloat

The type returned in the event of a conversion error.
Source§

fn try_from(value: Double) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl XsdValue for Double

Source§

fn datatype(&self) -> Datatype

Returns the XSD datatype that best describes the value.
Source§

impl Deref for Double

Source§

type Target = f64

The resulting type after dereferencing.
Source§

fn deref(&self) -> &f64

Dereferences the value.
Source§

impl Copy for Double

Source§

impl Eq for Double

Source§

impl StructuralPartialEq for Double

Auto Trait Implementations§

§

impl Freeze for Double

§

impl RefUnwindSafe for Double

§

impl Send for Double

§

impl Sync for Double

§

impl Unpin for Double

§

impl UnwindSafe for Double

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.