Struct range_union_find::NonNanFloat

#[repr(transparent)]
pub struct NonNanFloat<T: Float>(_);

Wrapper for non-NaN floats that implements Eq and Ord.

Implementations

impl<T: Float> NonNanFloat<T>

pub fn try_new(val: T) -> Result<Self, FloatIsNan>

Try to wrap a float, returning an Error if the float is NaN.

pub fn new(val: T) -> Self

Try to wrap a float, panicking if the float is NaN.

pub fn into_inner(&self) -> T

Trait Implementations

impl<T: Float> Add<NonNanFloat<T>> for NonNanFloat<T>

type Output = NonNanFloat<T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T: Clone + Float> Clone for NonNanFloat<T>

fn clone(&self) -> NonNanFloat<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Float> Debug for NonNanFloat<T>

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

Formats the value using the given formatter.

impl<T: Default + Float> Default for NonNanFloat<T>

fn default() -> NonNanFloat<T>

Returns the “default value” for a type.

impl<T: Float> Deref for NonNanFloat<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl From<NonNanFloat<f32>> for f32

fn from(value: NonNanFloat<f32>) -> Self

Converts to this type from the input type.

impl From<NonNanFloat<f64>> for f64

fn from(value: NonNanFloat<f64>) -> Self

Converts to this type from the input type.

impl Hash for NonNanFloat<f32>

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Hash for NonNanFloat<f64>

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Float> NumInRange for NonNanFloat<T>where NonNanFloat<T>: Steppable,

fn min_value() -> Self

Return the minimum possible value the number can take.

fn max_value() -> Self

Return the maximum possible value the number can take.

const MIN_DECR_IS_UNDERFLOW: bool = false

Whether caling Steppable::step_decr on the min value would underflow the type.

const MAX_INCR_IS_OVERFLOW: bool = false

Whether caling Steppable::step_incr on the max value would overflow the type.

impl<T: Float> Ord for NonNanFloat<T>

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<T: PartialEq + Float> PartialEq<NonNanFloat<T>> for NonNanFloat<T>

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

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

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

fn partial_cmp(&self, other: &T) -> 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 Steppable for NonNanFloat<f32>

Considerations for stepping floating-point types:

• Steps are performed to the next possible representable value, so the size of the step varies with the original number’s magnitude.
• Approximations and floating-point error can lead to miniscule gaps and other unexpected behaviors. For example, 0.3-0.2-0.1=-2.7755575615628914e-17 will not be contained in a nonnegative range starting at 0.

fn step_incr(&self) -> Self

Return the smallest possible value larger than the input value. Should saturate at the maximum possible value.

fn step_decr(&self) -> Self

Return the largest possible value smaller than the input value. Should saturate at the minimum possible value.

fn range_size<B: Borrow<Self>, R: RangeBounds<B>>( range: R ) -> Result<Self, RangeOperationError>

Return the size of the range.

fn range_tuple_size<N: Borrow<Self>>( start: N, end: N ) -> Result<Self, RangeOperationError>

Functions like Self::range_size given input start..=end.

impl Steppable for NonNanFloat<f64>

Considerations for stepping floating-point types:

• Steps are performed to the next possible representable value, so the size of the step varies with the original number’s magnitude.
• Approximations and floating-point error can lead to miniscule gaps and other unexpected behaviors. For example, 0.3-0.2-0.1=-2.7755575615628914e-17 will not be contained in a nonnegative range starting at 0.

fn step_incr(&self) -> Self

Return the smallest possible value larger than the input value. Should saturate at the maximum possible value.

fn step_decr(&self) -> Self

Return the largest possible value smaller than the input value. Should saturate at the minimum possible value.

fn range_size<B: Borrow<Self>, R: RangeBounds<B>>( range: R ) -> Result<Self, RangeOperationError>

Return the size of the range.

fn range_tuple_size<N: Borrow<Self>>( start: N, end: N ) -> Result<Self, RangeOperationError>

Functions like Self::range_size given input start..=end.

impl TryFrom<f32> for NonNanFloat<f32>

type Error = FloatIsNan

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<f64> for NonNanFloat<f64>

type Error = FloatIsNan

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T: Copy + Float> Copy for NonNanFloat<T>

impl<T: Float> Eq for NonNanFloat<T>

impl<T: Float> StructuralPartialEq for NonNanFloat<T>