Struct FiniteFloat

pub struct FiniteFloat<T: Float + Display>(/* private fields */);

A finite float cannot contain NaN, +Inf or -Inf values. We did so in order to be able to implement the Ord trait. See e.g. this.

Implementations

impl<T: Float + Display> FiniteFloat<T>

pub fn new(val: T) -> Option<FiniteFloat<T>>

Returns None if the given value is not finite.

pub fn get(&self) -> T

Returns the value this float contains. The return value is finite and can thus be used

Trait Implementations

impl<T: Clone + Float + Display> Clone for FiniteFloat<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Float + Display> Debug for FiniteFloat<T>

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

impl<T: FromStr + Float + Display> FromStr for FiniteFloat<T>

type Err = ParseFloatError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<T: Float + Display> Ord for FiniteFloat<T>

fn cmp(&self, other: &FiniteFloat<T>) -> 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<T: PartialEq + Float + Display> PartialEq for FiniteFloat<T>

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

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<T: Float + Display> Eq for FiniteFloat<T>

impl<T: Float + Display> StructuralPartialEq for FiniteFloat<T>