Struct ForceDistance 

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

Component: The target distance between two nodes.

This is helpful to scale the layout, for example if long labels are involved.

⚠️ This type is unstable and may change significantly in a way that the data won’t be backwards compatible.

Tuple Fields

0: Float64

Methods from Deref<Target = f64>

pub const RADIX: u32 = 2

pub const BITS: u32 = 64

pub const MANTISSA_DIGITS: u32 = 53

pub const DIGITS: u32 = 15

pub const EPSILON: f64 = 2.2204460492503131e-16_f64

pub const MIN: f64 = -1.7976931348623157e+308_f64

pub const MIN_POSITIVE: f64 = 2.2250738585072014e-308_f64

pub const MAX: f64 = 1.7976931348623157e+308_f64

pub const MIN_EXP: i32 = -1021

pub const MAX_EXP: i32 = 1024

pub const MIN_10_EXP: i32 = -307

pub const MAX_10_EXP: i32 = 308

pub const NAN: f64

pub const INFINITY: f64

pub const NEG_INFINITY: f64

pub const MAX_EXACT_INTEGER: i64

pub const MIN_EXACT_INTEGER: i64

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

impl Borrow<Float64> for ForceDistance

fn borrow(&self) -> &Float64

Immutably borrows from an owned value.

impl Clone for ForceDistance

fn clone(&self) -> ForceDistance

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ForceDistance

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

Formats the value using the given formatter.

impl Default for ForceDistance

fn default() -> ForceDistance

Returns the “default value” for a type.

impl Deref for ForceDistance

type Target = Float64

The resulting type after dereferencing.

fn deref(&self) -> &Float64

Dereferences the value.

impl DerefMut for ForceDistance

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

Mutably dereferences the value.

impl<'a> From<&'a ForceDistance> for Cow<'a, ForceDistance>

fn from(value: &'a ForceDistance) -> Cow<'a, ForceDistance>

Converts to this type from the input type.

impl<'a> From<ForceDistance> for Cow<'a, ForceDistance>

fn from(value: ForceDistance) -> Cow<'a, ForceDistance>

Converts to this type from the input type.

impl<T> From<T> for ForceDistance

where T: Into<Float64>,

fn from(v: T) -> ForceDistance

Converts to this type from the input type.

impl PartialEq for ForceDistance

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl SizeBytes for ForceDistance

fn heap_size_bytes(&self) -> u64

Returns how many bytes self uses on the heap.

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 WrapperComponent for ForceDistance

type Datatype = Float64

The underlying Loggable datatype for this component.

fn name() -> ComponentType

The fully-qualified type of this component, e.g. rerun.components.Position2D.

fn into_inner(self) -> <ForceDistance as WrapperComponent>::Datatype

Unwraps the component into its underlying datatype.

impl Copy for ForceDistance

impl StructuralPartialEq for ForceDistance