Struct decorum::ConstrainedFloat

pub struct ConstrainedFloat<T, P> where
    T: Float,
    P: FloatConstraint<T>,  { /* fields omitted */ }

Constrained, ordered, hashable floating point proxy.

Wraps floating point values and provides a proxy that implements operation and numerical traits, including Hash, Ord, and Eq.

Methods

impl<T, P> ConstrainedFloat<T, P> where
    T: Float,
    P: FloatConstraint<T>, 

fn try_from_raw_float(value: T) -> Result<Self, ()>

fn into_raw_float(self) -> T

impl<T, P> ConstrainedFloat<T, P> where
    T: Float,
    P: FloatConstraint<T>, 

fn from_raw_float(value: T) -> Self

Trait Implementations

impl<'a, T, P> Deserialize<'a> for ConstrainedFloat<T, P> where
    T: Deserialize<'a> + Float,
    P: FloatConstraint<T>, 

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'a>, 

Deserialize this value from the given Serde deserializer.

impl<T, P> Serialize for ConstrainedFloat<T, P> where
    T: Float + Serialize,
    P: FloatConstraint<T>, 

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl<T, P> Clone for ConstrainedFloat<T, P> where
    T: Float,
    P: FloatConstraint<T>,
    T: Clone, 

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, P> Copy for ConstrainedFloat<T, P> where
    T: Float,
    P: FloatConstraint<T>,
    T: Copy, 

impl<T, P> Debug for ConstrainedFloat<T, P> where
    T: Float,
    P: FloatConstraint<T>,
    T: Debug, 

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

Formats the value using the given formatter.

impl<T, P> Default for ConstrainedFloat<T, P> where
    T: Float,
    P: FloatConstraint<T>,
    T: Default, 

fn default() -> Self

Returns the "default value" for a type.

impl<T, P> AsRef<T> for ConstrainedFloat<T, P> where
    T: Float,
    P: FloatConstraint<T>, 

fn as_ref(&self) -> &T

Performs the conversion.

impl<P> Into<f32> for ConstrainedFloat<f32, P> where
    P: FloatConstraint<f32>, 

fn into(self) -> f32

Performs the conversion.

impl<P> Into<f64> for ConstrainedFloat<f64, P> where
    P: FloatConstraint<f64>, 

fn into(self) -> f64

Performs the conversion.

impl<T, P> Add for ConstrainedFloat<T, P> where
    T: Float,
    P: FloatConstraint<T>, 

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T, P> Add<T> for ConstrainedFloat<T, P> where
    T: Float,
    P: FloatConstraint<T>, 

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T, P> AddAssign for ConstrainedFloat<T, P> where
    T: Float,
    P: FloatConstraint<T>, 

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl<T, P> AddAssign<T> for ConstrainedFloat<T, P> where
    T: Float,
    P: FloatConstraint<T>, 

fn add_assign(&mut self, other: T)

Performs the += operation.

impl<T, P> Bounded for ConstrainedFloat<T, P> where
    T: Float,
    P: FloatConstraint<T>, 

fn min_value() -> Self

returns the smallest finite number this type can represent

fn max_value() -> Self

returns the largest finite number this type can represent

impl<T, P> Display for ConstrainedFloat<T, P> where
    T: Display + Float,
    P: FloatConstraint<T>, 

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

Formats the value using the given formatter.

impl<T, P> Div for ConstrainedFloat<T, P> where
    T: Float,
    P: FloatConstraint<T>, 

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T, P> Div<T> for ConstrainedFloat<T, P> where
    T: Float,
    P: FloatConstraint<T>, 

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T, P> DivAssign for ConstrainedFloat<T, P> where
    T: Float,
    P: FloatConstraint<T>, 

fn div_assign(&mut self, other: Self)

Performs the /= operation.

impl<T, P> DivAssign<T> for ConstrainedFloat<T, P> where
    T: Float,
    P: FloatConstraint<T>, 

fn div_assign(&mut self, other: T)

Performs the /= operation.

impl<T, P> Eq for ConstrainedFloat<T, P> where
    T: Float,
    P: FloatConstraint<T>, 

impl<T, P> FloatConst for ConstrainedFloat<T, P> where
    T: Float + FloatConst,
    P: FloatConstraint<T>, 

fn E() -> Self

Return Euler’s number.

fn PI() -> Self

Return Archimedes’ constant.

fn SQRT_2() -> Self

Return sqrt(2.0).

fn FRAC_1_PI() -> Self

Return 1.0 / π.

fn FRAC_2_PI() -> Self

Return 2.0 / π.

fn FRAC_1_SQRT_2() -> Self

Return 1.0 / sqrt(2.0).

fn FRAC_2_SQRT_PI() -> Self

Return 2.0 / sqrt(π).

fn FRAC_PI_2() -> Self

Return π / 2.0.

fn FRAC_PI_3() -> Self

Return π / 3.0.

fn FRAC_PI_4() -> Self

Return π / 4.0.

fn FRAC_PI_6() -> Self

Return π / 6.0.

fn FRAC_PI_8() -> Self

Return π / 8.0.

fn LN_10() -> Self

Return ln(10.0).

fn LN_2() -> Self

Return ln(2.0).

fn LOG10_E() -> Self

Return log10(e).

fn LOG2_E() -> Self

Return log2(e).

impl<T, P> FromPrimitive for ConstrainedFloat<T, P> where
    T: Float + FromPrimitive,
    P: FloatConstraint<T>, 

fn from_i8(value: i8) -> Option<Self>

Convert an i8 to return an optional value of this type. If the type cannot be represented by this value, the None is returned.

fn from_u8(value: u8) -> Option<Self>

Convert an u8 to return an optional value of this type. If the type cannot be represented by this value, the None is returned.

fn from_i16(value: i16) -> Option<Self>

Convert an i16 to return an optional value of this type. If the type cannot be represented by this value, the None is returned.

fn from_u16(value: u16) -> Option<Self>

Convert an u16 to return an optional value of this type. If the type cannot be represented by this value, the None is returned.

fn from_i32(value: i32) -> Option<Self>

Convert an i32 to return an optional value of this type. If the type cannot be represented by this value, the None is returned.

fn from_u32(value: u32) -> Option<Self>

Convert an u32 to return an optional value of this type. If the type cannot be represented by this value, the None is returned.

fn from_i64(value: i64) -> Option<Self>

Convert an i64 to return an optional value of this type. If the type cannot be represented by this value, the None is returned.

fn from_u64(value: u64) -> Option<Self>

Convert an u64 to return an optional value of this type. If the type cannot be represented by this value, the None is returned.

fn from_isize(value: isize) -> Option<Self>

Convert an isize to return an optional value of this type. If the value cannot be represented by this value, the None is returned.

fn from_usize(value: usize) -> Option<Self>

Convert a usize to return an optional value of this type. If the type cannot be represented by this value, the None is returned.

fn from_f32(value: f32) -> Option<Self>

Convert a f32 to return an optional value of this type. If the type cannot be represented by this value, the None is returned.

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

Convert a f64 to return an optional value of this type. If the type cannot be represented by this value, the None is returned.

impl<T, P> Hash for ConstrainedFloat<T, P> where
    T: Float,
    P: FloatConstraint<T>, 

fn hash<H>(&self, state: &mut H) where
    H: Hasher, 

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> Infinite for ConstrainedFloat<T, NotNanConstraint<T>> where
    T: Float, 

fn infinity() -> Self

fn neg_infinity() -> Self

fn is_infinite(self) -> bool

fn is_finite(self) -> bool

impl<T, P> Mul for ConstrainedFloat<T, P> where
    T: Float,
    P: FloatConstraint<T>, 

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T, P> Mul<T> for ConstrainedFloat<T, P> where
    T: Float,
    P: FloatConstraint<T>, 

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T, P> MulAssign for ConstrainedFloat<T, P> where
    T: Float,
    P: FloatConstraint<T>, 

fn mul_assign(&mut self, other: Self)

Performs the *= operation.

impl<T, P> MulAssign<T> for ConstrainedFloat<T, P> where
    T: Float,
    P: FloatConstraint<T>, 

fn mul_assign(&mut self, other: T)

Performs the *= operation.

impl<T, P> Neg for ConstrainedFloat<T, P> where
    T: Float + Num,
    P: FloatConstraint<T>, 

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<T, P> Num for ConstrainedFloat<T, P> where
    T: Float + Num,
    P: FloatConstraint<T>, 

type FromStrRadixErr = ()

fn from_str_radix(
    source: &str,
    radix: u32
) -> Result<Self, Self::FromStrRadixErr>

Convert from a string and radix <= 36.

impl<T, P> NumCast for ConstrainedFloat<T, P> where
    T: Float + Num,
    P: FloatConstraint<T>, 

fn from<U>(value: U) -> Option<Self> where
    U: ToPrimitive, 

Creates a number from another value that can be converted into a primitive via the ToPrimitive trait.

impl<T, P> One for ConstrainedFloat<T, P> where
    T: Float,
    P: FloatConstraint<T>, 

fn one() -> Self

Returns the multiplicative identity element of Self, 1.

impl<T, P> Ord for ConstrainedFloat<T, P> where
    T: Float,
    P: FloatConstraint<T>, 

fn cmp(&self, other: &Self) -> 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, P> PartialEq for ConstrainedFloat<T, P> where
    T: Float,
    P: FloatConstraint<T>, 

fn eq(&self, other: &Self) -> 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 !=.

impl<T, P> PartialOrd for ConstrainedFloat<T, P> where
    T: Float,
    P: FloatConstraint<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

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, P> Real for ConstrainedFloat<T, P> where
    T: Float,
    P: FloatConstraint<T>, 

fn max_value() -> Self

fn min_value() -> Self

fn min_positive_value() -> Self

fn neg_zero() -> Self

fn is_sign_positive(self) -> bool

fn is_sign_negative(self) -> bool

fn classify(self) -> FpCategory

fn is_normal(self) -> bool

fn integer_decode(self) -> (u64, i16, i8)

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

fn sin(self) -> Self

fn cos(self) -> Self

fn tan(self) -> Self

fn asin(self) -> Self

fn acos(self) -> Self

fn atan(self) -> Self

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

fn sin_cos(self) -> (Self, Self)

fn sinh(self) -> Self

fn cosh(self) -> Self

fn tanh(self) -> Self

fn asinh(self) -> Self

fn acosh(self) -> Self

fn atanh(self) -> Self

impl<T, P> Rem for ConstrainedFloat<T, P> where
    T: Float,
    P: FloatConstraint<T>, 

type Output = Self

The resulting type after applying the % operator.

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

Performs the % operation.

impl<T, P> Rem<T> for ConstrainedFloat<T, P> where
    T: Float,
    P: FloatConstraint<T>, 

type Output = Self

The resulting type after applying the % operator.

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

Performs the % operation.

impl<T, P> RemAssign for ConstrainedFloat<T, P> where
    T: Float,
    P: FloatConstraint<T>, 

fn rem_assign(&mut self, other: Self)

Performs the %= operation.

impl<T, P> RemAssign<T> for ConstrainedFloat<T, P> where
    T: Float,
    P: FloatConstraint<T>, 

fn rem_assign(&mut self, other: T)

Performs the %= operation.

impl<T, P> Signed for ConstrainedFloat<T, P> where
    T: Float + Signed,
    P: FloatConstraint<T>, 

fn abs(&self) -> Self

Computes the absolute value.

fn abs_sub(&self, other: &Self) -> Self

The positive difference of two numbers.

fn signum(&self) -> Self

Returns the sign of the number.

fn is_positive(&self) -> bool

Returns true if the number is positive and false if the number is zero or negative.

fn is_negative(&self) -> bool

Returns true if the number is negative and false if the number is zero or positive.

impl<T, P> Sub for ConstrainedFloat<T, P> where
    T: Float,
    P: FloatConstraint<T>, 

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T, P> Sub<T> for ConstrainedFloat<T, P> where
    T: Float,
    P: FloatConstraint<T>, 

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T, P> SubAssign for ConstrainedFloat<T, P> where
    T: Float,
    P: FloatConstraint<T>, 

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl<T, P> SubAssign<T> for ConstrainedFloat<T, P> where
    T: Float,
    P: FloatConstraint<T>, 

fn sub_assign(&mut self, other: T)

Performs the -= operation.

impl<T, P> ToPrimitive for ConstrainedFloat<T, P> where
    T: Float + ToPrimitive,
    P: FloatConstraint<T>, 

fn to_i8(&self) -> Option<i8>

Converts the value of self to an i8.

fn to_u8(&self) -> Option<u8>

Converts the value of self to an u8.

fn to_i16(&self) -> Option<i16>

Converts the value of self to an i16.

fn to_u16(&self) -> Option<u16>

Converts the value of self to an u16.

fn to_i32(&self) -> Option<i32>

Converts the value of self to an i32.

fn to_u32(&self) -> Option<u32>

Converts the value of self to an u32.

fn to_i64(&self) -> Option<i64>

Converts the value of self to an i64.

fn to_u64(&self) -> Option<u64>

Converts the value of self to an u64.

fn to_isize(&self) -> Option<isize>

Converts the value of self to an isize.

fn to_usize(&self) -> Option<usize>

Converts the value of self to a usize.

fn to_f32(&self) -> Option<f32>

Converts the value of self to an f32.

fn to_f64(&self) -> Option<f64>

Converts the value of self to an f64.

impl<T, P> Zero for ConstrainedFloat<T, P> where
    T: Float,
    P: FloatConstraint<T>, 

fn zero() -> Self

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.