Struct Float

pub struct Float { /* private fields */ }

A custom floating-point number representation that separates the number into its fundamental components for more precise comparison operations.

Implementations

impl Float

pub const ZERO: Float

pub const ONE: Float

pub const TWO: Float

pub fn from_f64(value: f64) -> Option<Self>

Creates a new Float from a f64 value.

This method decomposes the floating-point number into its constituent parts, normalizing the mantissa to remove trailing zeros and adjusting the exponent accordingly.

Arguments

• value - The floating-point f64 number to decompose.

Returns

A Float representation of the input number.

Example

use fast_float_compare::Float;

let num = Float::from_f64(1.23);
assert!(num.is_some());

Errors

Returns None if the number is NaN or infinite.

pub fn to_f64(&self) -> f64

Converts a Float back to an f64.

This method reconstructs the original floating-point number from its mantissa, exponent, and sign components.

Example

use fast_float_compare::Float;

let num = Float::from_f64(1.23).unwrap();
let value = num.to_f64();
assert_eq!(value, 1.23);

Returns

The reconstructed f64 value.

Trait Implementations

impl Clone for Float

fn clone(&self) -> Float

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Float

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

Formats the value using the given formatter.

impl Ord for Float

Implements the Ord trait for Float. This trait allows for comparison between Float values.

Example

use fast_float_compare::Float;

let a = Float::from_f64(1.23).unwrap();
let b = Float::from_f64(4.56).unwrap();
assert!(a < b);

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Float

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

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for Float

impl Eq for Float

impl StructuralPartialEq for Float