Struct re_types::datatypes::Float64

#[repr(transparent)]
pub struct Float64(pub f64);

Datatype: A double-precision 64-bit IEEE 754 floating point number.

Tuple Fields

0: f64

Methods from Deref<Target = f64>

pub const RADIX: u32 = 2u32

pub const MANTISSA_DIGITS: u32 = 53u32

pub const DIGITS: u32 = 15u32

pub const EPSILON: f64 = 2.2204460492503131E-16f64

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

pub const MIN_POSITIVE: f64 = 2.2250738585072014E-308f64

pub const MAX: f64 = 1.7976931348623157E+308f64

pub const MIN_EXP: i32 = -1_021i32

pub const MAX_EXP: i32 = 1_024i32

pub const MIN_10_EXP: i32 = -307i32

pub const MAX_10_EXP: i32 = 308i32

pub const NAN: f64 = NaN_f64

pub const INFINITY: f64 = +Inf_f64

pub const NEG_INFINITY: f64 = -Inf_f64

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

Return 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

impl Borrow<Float64> for Scalar

fn borrow(&self) -> &Float64

Immutably borrows from an owned value.

impl Borrow<Float64> for ZoomLevel

fn borrow(&self) -> &Float64

Immutably borrows from an owned value.

impl Clone for Float64

fn clone(&self) -> Float64

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Float64

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

Formats the value using the given formatter.

impl Default for Float64

fn default() -> Float64

Returns the “default value” for a type.

impl Deref for Float64

type Target = f64

The resulting type after dereferencing.

fn deref(&self) -> &f64

Dereferences the value.

impl DerefMut for Float64

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

Mutably dereferences the value.

impl Display for Float64

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

Formats the value using the given formatter.

impl From<Float64> for f64

fn from(value: Float64) -> f64

Converts to this type from the input type.

impl From<f64> for Float64

fn from(value: f64) -> Float64

Converts to this type from the input type.

impl Loggable for Float64

type Name = DatatypeName

fn name() -> <Float64 as Loggable>::Name

The fully-qualified name of this loggable, e.g. rerun.datatypes.Vec2D.

fn arrow_datatype() -> DataType

The underlying [arrow2::datatypes::DataType], excluding datatype extensions.

fn to_arrow_opt<'a>( data: impl IntoIterator<Item = Option<impl Into<Cow<'a, Float64>>>> ) -> Result<Box<dyn Array>, SerializationError>

where Float64: Clone + 'a,

Given an iterator of options of owned or reference values to the current Loggable, serializes them into an Arrow array.

fn from_arrow_opt( arrow_data: &(dyn Array + 'static) ) -> Result<Vec<Option<Float64>>, DeserializationError>

where Float64: Sized,

Given an Arrow array, deserializes it into a collection of optional Loggables.

fn from_arrow( arrow_data: &(dyn Array + 'static) ) -> Result<Vec<Float64>, DeserializationError>

where Float64: Sized,

Given an Arrow array, deserializes it into a collection of Loggables.

fn to_arrow<'a>( data: impl IntoIterator<Item = impl Into<Cow<'a, Self>>> ) -> Result<Box<dyn Array>, SerializationError>

where Self: 'a,

Given an iterator of owned or reference values to the current Loggable, serializes them into an Arrow array.

impl PartialEq for Float64

fn eq(&self, other: &Float64) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Float64

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

fn heap_size_bytes(&self) -> u64

Returns the total size of self on the heap, in bytes.

fn is_pod() -> bool

Is Self just plain old data?

fn total_size_bytes(&self) -> u64

Returns the total size of self in bytes, accounting for both stack and heap space.

fn stack_size_bytes(&self) -> u64

Returns the total size of self on the stack, in bytes.

impl Zeroable for Float64

fn zeroed() -> Self

Calls zeroed.

impl Copy for Float64

impl Pod for Float64

impl StructuralPartialEq for Float64