Struct ordered_float::NotNaN

pub struct NotNaN<T: Float>(_);

A wrapper around Floats providing an implementation of Ord and Hash.

A NaN value cannot be stored in this type.

Methods

impl<T: Float> NotNaN<T>

pub fn new(val: T) -> Result<Self, FloatIsNaN>

Create a NotNaN value.

Returns Err if val is NaN

pub unsafe fn unchecked_new(val: T) -> Self

Create a NotNaN value from a value that is guaranteed to not be NaN

Behaviour is undefined if val is NaN

pub fn into_inner(self) -> T

Get the value out.

Trait Implementations

impl<T: PartialOrd + Float> PartialOrd for NotNaN<T>

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

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

fn lt(&self, other: &NotNaN<T>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &NotNaN<T>) -> bool

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

fn gt(&self, other: &NotNaN<T>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &NotNaN<T>) -> bool

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

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

fn eq(&self, other: &NotNaN<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &NotNaN<T>) -> bool

This method tests for !=.

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

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

Formats the value using the given formatter.

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

fn default() -> NotNaN<T>

Returns the "default value" for a type.

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

impl<T: Float> AsRef<T> for NotNaN<T>

fn as_ref(&self) -> &T

Performs the conversion.

impl<T: Float + PartialOrd> Ord for NotNaN<T>

fn cmp(&self, other: &NotNaN<T>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

impl<T: Float> Hash for NotNaN<T>

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,

Feeds a slice of this type into the given [Hasher].

impl<T: Float + Display> Display for NotNaN<T>

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

Formats the value using the given formatter.

impl Into<f32> for NotNaN<f32>

fn into(self) -> f32

Performs the conversion.

impl Into<f64> for NotNaN<f64>

fn into(self) -> f64

Performs the conversion.

impl<T: Float> From<T> for NotNaN<T>

Creates a NotNaN value from a Float.

Panics if the provided value is NaN or the computation results in NaN

fn from(v: T) -> Self

Performs the conversion.

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

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: Float + PartialEq> Eq for NotNaN<T>

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

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

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

Adds a float directly.

Panics if the provided value is NaN or the computation results in NaN

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: T) -> Self

Performs the + operation.

impl AddAssign for NotNaN<f64>

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl AddAssign for NotNaN<f32>

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl AddAssign<f64> for NotNaN<f64>

Adds a float directly.

Panics if the provided value is NaN or the computation results in NaN

fn add_assign(&mut self, other: f64)

Performs the += operation.

impl AddAssign<f32> for NotNaN<f32>

Adds a float directly.

Panics if the provided value is NaN.

fn add_assign(&mut self, other: f32)

Performs the += operation.

impl<T: Float> Sub for NotNaN<T>

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T: Float> Sub<T> for NotNaN<T>

Subtracts a float directly.

Panics if the provided value is NaN or the computation results in NaN

type Output = Self

The resulting type after applying the - operator.

fn sub(self, other: T) -> Self

Performs the - operation.

impl SubAssign for NotNaN<f64>

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl SubAssign for NotNaN<f32>

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl SubAssign<f64> for NotNaN<f64>

Subtracts a float directly.

Panics if the provided value is NaN or the computation results in NaN

fn sub_assign(&mut self, other: f64)

Performs the -= operation.

impl SubAssign<f32> for NotNaN<f32>

Subtracts a float directly.

Panics if the provided value is NaN or the computation results in NaN

fn sub_assign(&mut self, other: f32)

Performs the -= operation.

impl<T: Float> Mul for NotNaN<T>

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T: Float> Mul<T> for NotNaN<T>

Multiplies a float directly.

Panics if the provided value is NaN or the computation results in NaN

type Output = Self

The resulting type after applying the * operator.

fn mul(self, other: T) -> Self

Performs the * operation.

impl MulAssign for NotNaN<f64>

fn mul_assign(&mut self, other: Self)

Performs the *= operation.

impl MulAssign for NotNaN<f32>

fn mul_assign(&mut self, other: Self)

Performs the *= operation.

impl MulAssign<f64> for NotNaN<f64>

Multiplies a float directly.

Panics if the provided value is NaN.

fn mul_assign(&mut self, other: f64)

Performs the *= operation.

impl MulAssign<f32> for NotNaN<f32>

Multiplies a float directly.

Panics if the provided value is NaN or the computation results in NaN

fn mul_assign(&mut self, other: f32)

Performs the *= operation.

impl<T: Float> Div for NotNaN<T>

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T: Float> Div<T> for NotNaN<T>

Divides a float directly.

Panics if the provided value is NaN or the computation results in NaN

type Output = Self

The resulting type after applying the / operator.

fn div(self, other: T) -> Self

Performs the / operation.

impl DivAssign for NotNaN<f64>

fn div_assign(&mut self, other: Self)

Performs the /= operation.

impl DivAssign for NotNaN<f32>

fn div_assign(&mut self, other: Self)

Performs the /= operation.

impl DivAssign<f64> for NotNaN<f64>

Divides a float directly.

Panics if the provided value is NaN or the computation results in NaN

fn div_assign(&mut self, other: f64)

Performs the /= operation.

impl DivAssign<f32> for NotNaN<f32>

Divides a float directly.

Panics if the provided value is NaN or the computation results in NaN

fn div_assign(&mut self, other: f32)

Performs the /= operation.

impl<T: Float> Rem for NotNaN<T>

type Output = Self

The resulting type after applying the % operator.

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

Performs the % operation.

impl<T: Float> Rem<T> for NotNaN<T>

Calculates % with a float directly.

Panics if the provided value is NaN or the computation results in NaN

type Output = Self

The resulting type after applying the % operator.

fn rem(self, other: T) -> Self

Performs the % operation.

impl RemAssign for NotNaN<f64>

fn rem_assign(&mut self, other: Self)

Performs the %= operation.

impl RemAssign for NotNaN<f32>

fn rem_assign(&mut self, other: Self)

Performs the %= operation.

impl RemAssign<f64> for NotNaN<f64>

Calculates %= with a float directly.

Panics if the provided value is NaN or the computation results in NaN

fn rem_assign(&mut self, other: f64)

Performs the %= operation.

impl RemAssign<f32> for NotNaN<f32>

Calculates %= with a float directly.

Panics if the provided value is NaN or the computation results in NaN

fn rem_assign(&mut self, other: f32)

Performs the %= operation.

impl<T: Float> Neg for NotNaN<T>

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.