Struct decorum::ConstrainedFloat

#[repr(transparent)]
pub struct ConstrainedFloat<T, P> { /* private fields */ }

Floating-point proxy that provides a total ordering, equivalence, hashing, and constraints.

ConstrainedFloat wraps primitive floating-point types and provides implementations for numeric traits using a total ordering, including Ord, Eq, and Hash. ConstrainedFloat supports various constraints on the class of values that may be represented and panics if these constraints are violated.

This type is re-exported but should not (and cannot) be used directly. Use the type aliases Total, NotNan, and Finite instead.

Total Ordering

All proxy types use the following total ordering:

$$-\infin<\cdots<0<\cdots<\infin<\text{NaN}$$

See the cmp module for a description of the total ordering used to implement Ord and Eq.

Constraints

Constraints restrict the set of values that a proxy may take by disallowing certain classes or subsets of those values. If a constraint is violated (because a proxy type would need to take a value it disallows), the operation panics.

Constraints may disallow two broad classes of floating-point values: infinities and NaNs. Constraints are exposed by the Total, NotNan, and Finite type definitions. Note that Total uses a unit constraint, which enforces no constraints at all and never panics.

Implementations

impl<T, P> ConstrainedFloat<T, P> where
    T: Float + Primitive,
    P: Constraint<T>, 

pub fn from_inner(value: T) -> Self

Converts a primitive floating-point value into a proxy.

The same behavior is provided by an implementation of the From trait.

Panics

This conversion and the implementation of the From trait will panic if the primitive floating-point value violates the constraints of the proxy.

Examples

Converting primitive floating-point values into proxies:

use decorum::R64;

fn f(x: R64) -> R64 {
    x * 2.0
}

// Conversion using `from_inner`.
let y = f(R64::from_inner(2.0));
// Conversion using `From`/`Into`.
let z = f(2.0.into());

Performing a conversion that panics:

use decorum::R64;

// `R64` does not allow `NaN`s, but `0.0 / 0.0` produces a `NaN`.
let x = R64::from_inner(0.0 / 0.0); // Panics.

pub fn into_inner(self) -> T

Converts a proxy into a primitive floating-point value.

Examples

Converting a proxy into a primitive floating-point value:

use decorum::R64;

fn f() -> R64 {
    // ...
}

let x: f64 = f().into_inner();

pub fn from_subset<Q>(other: ConstrainedFloat<T, Q>) -> Self where
    Q: Constraint<T> + SubsetOf<P>, 

Converts a proxy into another proxy that is capable of representing a superset of the values that are members of its constraint.

Examples

Converting between compatible proxy types:

use decorum::{N64, R64};
use num::Zero;

let x = R64::zero();
let y = N64::from_subset(x);

pub fn into_superset<Q>(self) -> ConstrainedFloat<T, Q> where
    Q: Constraint<T> + SupersetOf<P>, 

Converts a proxy into another proxy that is capable of representing a superset of the values that are members of its constraint.

Examples

Converting between compatible proxy types:

use decorum::{N64, R64};
use num::Zero;

let x = R64::zero();
let y: N64 = x.into_superset();

Trait Implementations

impl<T, P> AbsDiffEq<ConstrainedFloat<T, P>> for ConstrainedFloat<T, P> where
    T: AbsDiffEq<Epsilon = T> + Float + Primitive,
    P: Constraint<T>, 

type Epsilon = ConstrainedFloat<T, P>

Used for specifying relative comparisons.

fn default_epsilon() -> Self::Epsilon

The default tolerance to use when testing values that are close together.

fn abs_diff_eq(&self, other: &Self, epsilon: Self::Epsilon) -> bool

A test for equality that uses the absolute difference to compute the approximate equality of two numbers.

fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool

The inverse of ApproxEq::abs_diff_eq.

impl<T, P> Add<ConstrainedFloat<T, P>> for ConstrainedFloat<T, P> where
    T: Float + Primitive,
    P: Constraint<T>, 

type Output = ConstrainedFloat<T, P>

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 + Primitive,
    P: Constraint<T>, 

type Output = ConstrainedFloat<T, P>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T, P> AddAssign<ConstrainedFloat<T, P>> for ConstrainedFloat<T, P> where
    T: Float + Primitive,
    P: Constraint<T>, 

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl<T, P> AddAssign<T> for ConstrainedFloat<T, P> where
    T: Float + Primitive,
    P: Constraint<T>, 

fn add_assign(&mut self, other: T)

Performs the += operation.

impl<T, P> AsRef<T> for ConstrainedFloat<T, P> where
    T: Float + Primitive,
    P: Constraint<T>, 

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T, P> Bounded for ConstrainedFloat<T, P> where
    T: Float + Primitive,
    P: Constraint<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: Clone, P: Clone> Clone for ConstrainedFloat<T, P>

fn clone(&self) -> ConstrainedFloat<T, P>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, P> Default for ConstrainedFloat<T, P> where
    T: Default + Float + Primitive,
    P: Constraint<T>, 

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T, P> Deserialize<'de> for ConstrainedFloat<T, P> where
    T: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

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

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

Formats the value using the given formatter.

impl<T, P> Div<ConstrainedFloat<T, P>> for ConstrainedFloat<T, P> where
    T: Float + Primitive,
    P: Constraint<T>, 

type Output = ConstrainedFloat<T, P>

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 + Primitive,
    P: Constraint<T>, 

type Output = ConstrainedFloat<T, P>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T, P> DivAssign<ConstrainedFloat<T, P>> for ConstrainedFloat<T, P> where
    T: Float + Primitive,
    P: Constraint<T>, 

fn div_assign(&mut self, other: Self)

Performs the /= operation.

impl<T, P> DivAssign<T> for ConstrainedFloat<T, P> where
    T: Float + Primitive,
    P: Constraint<T>, 

fn div_assign(&mut self, other: T)

Performs the /= operation.

impl<T, P> Encoding for ConstrainedFloat<T, P> where
    T: Float + Primitive,
    P: Constraint<T>, 

const MAX: Self = ConstrainedFloat::from_inner_unchecked(T::MAX)

const MIN: Self = ConstrainedFloat::from_inner_unchecked(T::MIN)

const MIN_POSITIVE: Self = ConstrainedFloat::from_inner_unchecked(T::MIN_POSITIVE)

const EPSILON: Self = ConstrainedFloat::from_inner_unchecked(T::EPSILON)

fn classify(self) -> FpCategory

fn is_normal(self) -> bool

fn is_sign_positive(self) -> bool

fn is_sign_negative(self) -> bool

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

impl<T, P> Float for ConstrainedFloat<T, P> where
    T: Float + ForeignFloat + IntrinsicOrd + Primitive,
    P: Constraint<T> + Member<InfiniteClass> + Member<NanClass>, 

fn infinity() -> Self

Returns the infinite value.

fn neg_infinity() -> Self

Returns the negative infinite value.

fn is_infinite(self) -> bool

Returns true if this value is positive infinity or negative infinity and false otherwise.

fn is_finite(self) -> bool

Returns true if this number is neither infinite nor NaN.

fn nan() -> Self

Returns the NaN value.

fn is_nan(self) -> bool

Returns true if this value is NaN and false otherwise.

fn max_value() -> Self

Returns the largest finite value that this type can represent.

fn min_value() -> Self

Returns the smallest finite value that this type can represent.

fn min_positive_value() -> Self

Returns the smallest positive, normalized value that this type can represent.

fn epsilon() -> Self

Returns epsilon, a small positive value.

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

Returns the minimum of the two numbers.

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

Returns the maximum of the two numbers.

fn neg_zero() -> Self

Returns -0.0.

fn is_sign_positive(self) -> bool

Returns true if self is positive, including +0.0, Float::infinity(), and since Rust 1.20 also Float::nan().

fn is_sign_negative(self) -> bool

Returns true if self is negative, including -0.0, Float::neg_infinity(), and since Rust 1.20 also -Float::nan().

fn signum(self) -> Self

Returns a number that represents the sign of self.

fn abs(self) -> Self

Computes the absolute value of self. Returns Float::nan() if the number is Float::nan().

fn classify(self) -> FpCategory

Returns the floating point category of the number. If only one property is going to be tested, it is generally faster to use the specific predicate instead.

fn is_normal(self) -> bool

Returns true if the number is neither zero, infinite, subnormal, or NaN.

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

Returns the mantissa, base 2 exponent, and sign as integers, respectively. The original number can be recovered by sign * mantissa * 2 ^ exponent.

fn floor(self) -> Self

Returns the largest integer less than or equal to a number.

fn ceil(self) -> Self

Returns the smallest integer greater than or equal to a number.

fn round(self) -> Self

Returns the nearest integer to a number. Round half-way cases away from 0.0.

fn trunc(self) -> Self

Return the integer part of a number.

fn fract(self) -> Self

Returns the fractional part of a number.

fn recip(self) -> Self

Take the reciprocal (inverse) of a number, 1/x.

fn mul_add(self, a: Self, b: Self) -> Self

Fused multiply-add. Computes (self * a) + b with only one rounding error, yielding a more accurate result than an unfused multiply-add.

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

The positive difference of two numbers.

fn powi(self, n: i32) -> Self

Raise a number to an integer power.

fn powf(self, n: Self) -> Self

Raise a number to a floating point power.

fn sqrt(self) -> Self

Take the square root of a number.

fn cbrt(self) -> Self

Take the cubic root of a number.

fn exp(self) -> Self

Returns e^(self), (the exponential function).

fn exp2(self) -> Self

Returns 2^(self).

fn exp_m1(self) -> Self

Returns e^(self) - 1 in a way that is accurate even if the number is close to zero.

fn log(self, base: Self) -> Self

Returns the logarithm of the number with respect to an arbitrary base.

fn ln(self) -> Self

Returns the natural logarithm of the number.

fn log2(self) -> Self

Returns the base 2 logarithm of the number.

fn log10(self) -> Self

Returns the base 10 logarithm of the number.

fn ln_1p(self) -> Self

Returns ln(1+n) (natural logarithm) more accurately than if the operations were performed separately.

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

Calculate the length of the hypotenuse of a right-angle triangle given legs of length x and y.

fn sin(self) -> Self

Computes the sine of a number (in radians).

fn cos(self) -> Self

Computes the cosine of a number (in radians).

fn tan(self) -> Self

Computes the tangent of a number (in radians).

fn asin(self) -> Self

Computes the arcsine of a number. Return value is in radians in the range [-pi/2, pi/2] or NaN if the number is outside the range [-1, 1].

fn acos(self) -> Self

Computes the arccosine of a number. Return value is in radians in the range [0, pi] or NaN if the number is outside the range [-1, 1].

fn atan(self) -> Self

Computes the arctangent of a number. Return value is in radians in the range [-pi/2, pi/2];

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

Computes the four quadrant arctangent of self (y) and other (x).

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

Simultaneously computes the sine and cosine of the number, x. Returns (sin(x), cos(x)).

fn sinh(self) -> Self

Hyperbolic sine function.

fn cosh(self) -> Self

Hyperbolic cosine function.

fn tanh(self) -> Self

Hyperbolic tangent function.

fn asinh(self) -> Self

Inverse hyperbolic sine function.

fn acosh(self) -> Self

Inverse hyperbolic cosine function.

fn atanh(self) -> Self

Inverse hyperbolic tangent function.

fn to_degrees(self) -> Self

Converts radians to degrees.

fn to_radians(self) -> Self

Converts degrees to radians.

fn copysign(self, sign: Self) -> Self

Returns a number composed of the magnitude of self and the sign of sign.

impl<T, P> FloatConst for ConstrainedFloat<T, P> where
    T: Float + Primitive,
    P: Constraint<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).

fn TAU() -> Self where
    Self: Add<Self, Output = Self>, 

Return the full circle constant τ.

fn LOG10_2() -> Self where
    Self: Div<Self, Output = Self>, 

Return log10(2.0).

fn LOG2_10() -> Self where
    Self: Div<Self, Output = Self>, 

Return log2(10.0).

impl<T> From<ConstrainedFloat<T, FiniteConstraint<T>>> for Total<T> where
    T: Float + Primitive, 

fn from(other: Finite<T>) -> Self

Converts to this type from the input type.

impl<T> From<ConstrainedFloat<T, FiniteConstraint<T>>> for NotNan<T> where
    T: Float + Primitive, 

fn from(other: Finite<T>) -> Self

Converts to this type from the input type.

impl<T> From<ConstrainedFloat<T, NotNanConstraint<T>>> for Total<T> where
    T: Float + Primitive, 

fn from(other: NotNan<T>) -> Self

Converts to this type from the input type.

impl<P> From<ConstrainedFloat<f32, P>> for f32 where
    P: Constraint<f32>, 

fn from(value: ConstrainedFloat<f32, P>) -> Self

Converts to this type from the input type.

impl<P> From<ConstrainedFloat<f64, P>> for f64 where
    P: Constraint<f64>, 

fn from(value: ConstrainedFloat<f64, P>) -> Self

Converts to this type from the input type.

impl<T, P> From<T> for ConstrainedFloat<T, P> where
    T: Float + Primitive,
    P: Constraint<T>, 

fn from(value: T) -> Self

Converts to this type from the input type.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

fn from_i128(n: i128) -> Option<Self>

Converts an i128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u128(n: u128) -> Option<Self>

Converts an u128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

impl<T, P> FromStr for ConstrainedFloat<T, P> where
    T: Float + FromStr + Primitive,
    P: Constraint<T>, 

type Err = <T as FromStr>::Err

The associated error which can be returned from parsing.

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

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

impl<T, P> Hash for ConstrainedFloat<T, P> where
    T: Float + Primitive,
    P: Constraint<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, P> Infinite for ConstrainedFloat<T, P> where
    T: Float + Primitive,
    P: Constraint<T> + Member<InfiniteClass>, 

const INFINITY: Self = ConstrainedFloat::from_inner_unchecked(T::INFINITY)

const NEG_INFINITY: Self = ConstrainedFloat::from_inner_unchecked(T::NEG_INFINITY)

fn is_infinite(self) -> bool

fn is_finite(self) -> bool

impl<T, P> IntrinsicOrd for ConstrainedFloat<T, P> where
    T: Float + IntrinsicOrd + Primitive,
    P: Constraint<T>, 

fn is_undefined(&self) -> bool

Returns true if a value encodes undefined, otherwise false.

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

Compares two values and returns their pairwise minimum and maximum.

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

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

impl<T, P> LowerExp for ConstrainedFloat<T, P> where
    T: Float + LowerExp + Primitive,
    P: Constraint<T>, 

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

Formats the value using the given formatter.

impl<T, P> Mul<ConstrainedFloat<T, P>> for ConstrainedFloat<T, P> where
    T: Float + Primitive,
    P: Constraint<T>, 

type Output = ConstrainedFloat<T, P>

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 + Primitive,
    P: Constraint<T>, 

type Output = ConstrainedFloat<T, P>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T, P> MulAssign<ConstrainedFloat<T, P>> for ConstrainedFloat<T, P> where
    T: Float + Primitive,
    P: Constraint<T>, 

fn mul_assign(&mut self, other: Self)

Performs the *= operation.

impl<T, P> MulAssign<T> for ConstrainedFloat<T, P> where
    T: Float + Primitive,
    P: Constraint<T>, 

fn mul_assign(&mut self, other: T)

Performs the *= operation.

impl<T, P> Nan for ConstrainedFloat<T, P> where
    T: Float + Primitive,
    P: Constraint<T> + Member<NanClass>, 

const NAN: Self = ConstrainedFloat::from_inner_unchecked(T::NAN)

A representation of NaN.

fn is_nan(self) -> bool

impl<T, P> Neg for ConstrainedFloat<T, P> where
    T: Float + Primitive,
    P: Constraint<T>, 

type Output = ConstrainedFloat<T, P>

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
    Self: PartialEq,
    T: Float + Primitive,
    P: Constraint<T>, 

type FromStrRadixErr = ()

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

Convert from a string and radix (typically 2..=36).

impl<T, P> NumCast for ConstrainedFloat<T, P> where
    T: Float + NumCast + Primitive + ToPrimitive,
    P: Constraint<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. If the source value cannot be represented by the target type, then None is returned.

impl<T, P> One for ConstrainedFloat<T, P> where
    T: Float + Primitive,
    P: Constraint<T>, 

fn one() -> Self

Returns the multiplicative identity element of Self, 1.

fn set_one(&mut self)

Sets self to the multiplicative identity element of Self, 1.

fn is_one(&self) -> bool where
    Self: PartialEq<Self>, 

Returns true if self is equal to the multiplicative identity.

impl<T, P> Ord for ConstrainedFloat<T, P> where
    T: Float + Primitive,
    P: Constraint<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.

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

Restrict a value to a certain interval.

impl<T, P> PartialEq<ConstrainedFloat<T, P>> for ConstrainedFloat<T, P> where
    T: Float + Primitive,
    P: Constraint<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> PartialEq<T> for ConstrainedFloat<T, P> where
    T: Float + Primitive,
    P: Constraint<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 !=.

impl<T, P> PartialOrd<ConstrainedFloat<T, P>> for ConstrainedFloat<T, P> where
    T: Float + Primitive,
    P: Constraint<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> PartialOrd<T> for ConstrainedFloat<T, P> where
    T: Float + Primitive,
    P: Constraint<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<T, P> Product<ConstrainedFloat<T, P>> for ConstrainedFloat<T, P> where
    T: Float + Primitive,
    P: Constraint<T>, 

fn product<I>(input: I) -> Self where
    I: Iterator<Item = Self>, 

Method which takes an iterator and generates Self from the elements by multiplying the items.

impl<T, P> Real for ConstrainedFloat<T, P> where
    T: Float + Primitive,
    P: Constraint<T>, 

const E: Self = ConstrainedFloat::from_inner_unchecked(Real::E)

const PI: Self = ConstrainedFloat::from_inner_unchecked(Real::PI)

const FRAC_1_PI: Self = ConstrainedFloat::from_inner_unchecked(Real::FRAC_1_PI)

const FRAC_2_PI: Self = ConstrainedFloat::from_inner_unchecked(Real::FRAC_2_PI)

const FRAC_2_SQRT_PI: Self = ConstrainedFloat::from_inner_unchecked(Real::FRAC_2_SQRT_PI)

const FRAC_PI_2: Self = ConstrainedFloat::from_inner_unchecked(Real::FRAC_PI_2)

const FRAC_PI_3: Self = ConstrainedFloat::from_inner_unchecked(Real::FRAC_PI_3)

const FRAC_PI_4: Self = ConstrainedFloat::from_inner_unchecked(Real::FRAC_PI_4)

const FRAC_PI_6: Self = ConstrainedFloat::from_inner_unchecked(Real::FRAC_PI_6)

const FRAC_PI_8: Self = ConstrainedFloat::from_inner_unchecked(Real::FRAC_PI_8)

const SQRT_2: Self = ConstrainedFloat::from_inner_unchecked(Real::SQRT_2)

const FRAC_1_SQRT_2: Self = ConstrainedFloat::from_inner_unchecked(Real::FRAC_1_SQRT_2)

const LN_2: Self = ConstrainedFloat::from_inner_unchecked(Real::LN_2)

const LN_10: Self = ConstrainedFloat::from_inner_unchecked(Real::LN_10)

const LOG2_E: Self = ConstrainedFloat::from_inner_unchecked(Real::LOG2_E)

const LOG10_E: Self = ConstrainedFloat::from_inner_unchecked(Real::LOG10_E)

fn floor(self) -> Self

fn ceil(self) -> Self

fn round(self) -> Self

fn trunc(self) -> Self

fn fract(self) -> Self

fn recip(self) -> Self

fn mul_add(self, a: Self, b: Self) -> Self

fn powi(self, n: i32) -> Self

fn powf(self, n: Self) -> Self

fn sqrt(self) -> Self

fn cbrt(self) -> Self

fn exp(self) -> Self

fn exp2(self) -> Self

fn exp_m1(self) -> Self

fn log(self, base: Self) -> Self

fn ln(self) -> Self

fn log2(self) -> Self

fn log10(self) -> Self

fn ln_1p(self) -> Self

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> RelativeEq<ConstrainedFloat<T, P>> for ConstrainedFloat<T, P> where
    T: Float + Primitive + RelativeEq<Epsilon = T>,
    P: Constraint<T>, 

fn default_max_relative() -> Self::Epsilon

The default relative tolerance for testing values that are far-apart.

fn relative_eq(
    &self,
    other: &Self,
    epsilon: Self::Epsilon,
    max_relative: Self::Epsilon
) -> bool

A test for equality that uses a relative comparison if the values are far apart.

fn relative_ne(
    &self,
    other: &Rhs,
    epsilon: Self::Epsilon,
    max_relative: Self::Epsilon
) -> bool

The inverse of ApproxEq::relative_eq.

impl<T, P> Rem<ConstrainedFloat<T, P>> for ConstrainedFloat<T, P> where
    T: Float + Primitive,
    P: Constraint<T>, 

type Output = ConstrainedFloat<T, P>

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 + Primitive,
    P: Constraint<T>, 

type Output = ConstrainedFloat<T, P>

The resulting type after applying the % operator.

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

Performs the % operation.

impl<T, P> RemAssign<ConstrainedFloat<T, P>> for ConstrainedFloat<T, P> where
    T: Float + Primitive,
    P: Constraint<T>, 

fn rem_assign(&mut self, other: Self)

Performs the %= operation.

impl<T, P> RemAssign<T> for ConstrainedFloat<T, P> where
    T: Float + Primitive,
    P: Constraint<T>, 

fn rem_assign(&mut self, other: T)

Performs the %= operation.

impl<T, P> Serialize for ConstrainedFloat<T, P> where
    T: Serialize, 

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> Signed for ConstrainedFloat<T, P> where
    T: Float + Primitive,
    P: Constraint<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<ConstrainedFloat<T, P>> for ConstrainedFloat<T, P> where
    T: Float + Primitive,
    P: Constraint<T>, 

type Output = ConstrainedFloat<T, P>

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 + Primitive,
    P: Constraint<T>, 

type Output = ConstrainedFloat<T, P>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T, P> SubAssign<ConstrainedFloat<T, P>> for ConstrainedFloat<T, P> where
    T: Float + Primitive,
    P: Constraint<T>, 

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl<T, P> SubAssign<T> for ConstrainedFloat<T, P> where
    T: Float + Primitive,
    P: Constraint<T>, 

fn sub_assign(&mut self, other: T)

Performs the -= operation.

impl<T, P> Sum<ConstrainedFloat<T, P>> for ConstrainedFloat<T, P> where
    T: Float + Primitive,
    P: Constraint<T>, 

fn sum<I>(input: I) -> Self where
    I: Iterator<Item = Self>, 

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl<T, P> ToCanonicalBits for ConstrainedFloat<T, P> where
    T: Float + Primitive,
    P: Constraint<T>, 

fn to_canonical_bits(self) -> u64

Conversion to a canonical representation.

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

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

Converts the value of self to an i8. If the value cannot be represented by an i8, then None is returned.

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

Converts the value of self to a u8. If the value cannot be represented by a u8, then None is returned.

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

Converts the value of self to an i16. If the value cannot be represented by an i16, then None is returned.

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

Converts the value of self to a u16. If the value cannot be represented by a u16, then None is returned.

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

Converts the value of self to an i32. If the value cannot be represented by an i32, then None is returned.

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

Converts the value of self to a u32. If the value cannot be represented by a u32, then None is returned.

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

Converts the value of self to an i64. If the value cannot be represented by an i64, then None is returned.

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

Converts the value of self to a u64. If the value cannot be represented by a u64, then None is returned.

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

Converts the value of self to an isize. If the value cannot be represented by an isize, then None is returned.

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

Converts the value of self to a usize. If the value cannot be represented by a usize, then None is returned.

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

Converts the value of self to an f32. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f32.

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

Converts the value of self to an f64. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f64.

fn to_i128(&self) -> Option<i128>

Converts the value of self to an i128. If the value cannot be represented by an i128 (i64 under the default implementation), then None is returned.

fn to_u128(&self) -> Option<u128>

Converts the value of self to a u128. If the value cannot be represented by a u128 (u64 under the default implementation), then None is returned.

impl<T, P> UlpsEq<ConstrainedFloat<T, P>> for ConstrainedFloat<T, P> where
    T: Float + Primitive + UlpsEq<Epsilon = T>,
    P: Constraint<T>, 

fn default_max_ulps() -> u32

The default ULPs to tolerate when testing values that are far-apart.

fn ulps_eq(&self, other: &Self, epsilon: Self::Epsilon, max_ulps: u32) -> bool

A test for equality that uses units in the last place (ULP) if the values are far apart.

fn ulps_ne(&self, other: &Rhs, epsilon: Self::Epsilon, max_ulps: u32) -> bool

The inverse of ApproxEq::ulps_eq.

impl<T, P> UpperExp for ConstrainedFloat<T, P> where
    T: Float + Primitive + UpperExp,
    P: Constraint<T>, 

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

Formats the value using the given formatter.

impl<T, P> Zero for ConstrainedFloat<T, P> where
    T: Float + Primitive,
    P: Constraint<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.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl<T: Copy, P: Copy> Copy for ConstrainedFloat<T, P>

impl<T, P> Eq for ConstrainedFloat<T, P> where
    T: Float + Primitive,
    P: Constraint<T>,