Struct noisy_float::NoisyFloat

pub struct NoisyFloat<F: Float, C: FloatChecker<F>> {
    // some fields omitted
}

A floating point number with a restricted set of legal values.

Typical users will not need to access this struct directly, but can instead use the type aliases found in the module noisy_float::types. However, this struct together with a FloatChecker implementation can be used to define custom behavior.

The underlying float type is F, usually f32 or f64. Valid values for the float are determined by the float checker C. If an invalid value would ever be returned from a method on this type, the method will panic instead, using either assert! or debug_assert! as defined by the float checker. The exception to this rule is for methods that return an Option containing a NoisyFloat, in which case the result would be None if the value is invalid.

Methods

impl<F: Float, C: FloatChecker<F>> NoisyFloat<F, C>

fn new(value: F) -> Self

Constructs a NoisyFloat with the given value.

Uses the FloatChecker to assert that the value is valid.

fn try_new(value: F) -> Option<Self>

Tries to construct a NoisyFloat with the given value.

Returns None if the value is invalid.

fn from_f32(value: f32) -> Self

Constructs a NoisyFloat with the given f32 value.

May panic not only by the FloatChecker but also by unwrapping the result of a NumCast invocation for type F, although the later should not occur in normal situations.

fn from_f64(value: f64) -> Self

Constructs a NoisyFloat with the given f64 value.

May panic not only by the FloatChecker but also by unwrapping the result of a NumCast invocation for type F, although the later should not occur in normal situations.

fn raw(self) -> F

Returns the underlying float value.

Trait Implementations

impl<F: Float, C: FloatChecker<F>> Clone for NoisyFloat<F, C>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Float, C: FloatChecker<F>> Copy for NoisyFloat<F, C>

impl<F: Float, C: FloatChecker<F>> PartialEq for NoisyFloat<F, C>

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<F: Float, C: FloatChecker<F>> Eq for NoisyFloat<F, C>

impl<F: Float, C: FloatChecker<F>> PartialOrd for NoisyFloat<F, C>

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: &Self) -> bool

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

fn le(&self, other: &Self) -> bool

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

fn gt(&self, other: &Self) -> bool

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

fn ge(&self, other: &Self) -> bool

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

impl<F: Float, C: FloatChecker<F>> Ord for NoisyFloat<F, C>

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

This method returns an Ordering between self and other.

impl<F: Float, C: FloatChecker<F>> Add for NoisyFloat<F, C>

type Output = Self

The resulting type after applying the + operator

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

The method for the + operator

impl<F: Float, C: FloatChecker<F>> Sub for NoisyFloat<F, C>

type Output = Self

The resulting type after applying the - operator

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

The method for the - operator

impl<F: Float, C: FloatChecker<F>> Mul for NoisyFloat<F, C>

type Output = Self

The resulting type after applying the * operator

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

The method for the * operator

impl<F: Float, C: FloatChecker<F>> Div for NoisyFloat<F, C>

type Output = Self

The resulting type after applying the / operator

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

The method for the / operator

impl<F: Float, C: FloatChecker<F>> Rem for NoisyFloat<F, C>

type Output = Self

The resulting type after applying the % operator

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

The method for the % operator

impl<F: Float + AddAssign, C: FloatChecker<F>> AddAssign for NoisyFloat<F, C>

fn add_assign(&mut self, rhs: Self)

The method for the += operator

impl<F: Float + SubAssign, C: FloatChecker<F>> SubAssign for NoisyFloat<F, C>

fn sub_assign(&mut self, rhs: Self)

The method for the -= operator

impl<F: Float + MulAssign, C: FloatChecker<F>> MulAssign for NoisyFloat<F, C>

fn mul_assign(&mut self, rhs: Self)

The method for the *= operator

impl<F: Float + DivAssign, C: FloatChecker<F>> DivAssign for NoisyFloat<F, C>

fn div_assign(&mut self, rhs: Self)

The method for the /= operator

impl<F: Float + RemAssign, C: FloatChecker<F>> RemAssign for NoisyFloat<F, C>

fn rem_assign(&mut self, rhs: Self)

The method for the %= operator

impl<F: Float, C: FloatChecker<F>> Neg for NoisyFloat<F, C>

type Output = Self

The resulting type after applying the - operator

fn neg(self) -> Self

The method for the unary - operator

impl<F: Float, C: FloatChecker<F>> Zero for NoisyFloat<F, C>

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.

impl<F: Float, C: FloatChecker<F>> One for NoisyFloat<F, C>

fn one() -> Self

Returns the multiplicative identity element of Self, 1.

impl<F: Float, C: FloatChecker<F>> Num for NoisyFloat<F, C>

type FromStrRadixErr = F::FromStrRadixErr

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

Convert from a string and radix <= 36.

impl<F: Float, C: FloatChecker<F>> ToPrimitive for NoisyFloat<F, C>

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_i8(&self) -> Option<i8>

Converts the value of self to an i8.

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

Converts the value of self to an i16.

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

Converts the value of self to an i32.

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

Converts the value of self to a usize.

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

Converts the value of self to an u8.

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

Converts the value of self to an u16.

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

Converts the value of self to an u32.

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<F: Float, C: FloatChecker<F>> NumCast for NoisyFloat<F, C>

fn from<T: ToPrimitive>(n: T) -> Option<Self>

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

impl<F: Float, C: FloatChecker<F>> Float for NoisyFloat<F, C>

fn nan() -> Self

Returns the NaN value.

fn infinity() -> Self

Returns the infinite value.

fn neg_infinity() -> Self

Returns the negative infinite value.

fn neg_zero() -> Self

Returns -0.0.

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 max_value() -> Self

Returns the largest finite value that this type can represent.

fn is_nan(self) -> bool

Returns true if this value is NaN and false otherwise.

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 is_normal(self) -> bool

Returns true if the number is neither zero, infinite, [subnormal][subnormal], or 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 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 abs(self) -> Self

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

fn signum(self) -> Self

Returns a number that represents the sign of self.

fn is_sign_positive(self) -> bool

Returns true if self is positive, including +0.0 and Float::infinity().

fn is_sign_negative(self) -> bool

Returns true if self is negative, including -0.0 and Float::neg_infinity().

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

Fused multiply-add. Computes (self * a) + b with only one rounding error. This produces a more accurate result with better performance than a separate multiplication operation followed by an add.

fn recip(self) -> Self

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

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 exp(self) -> Self

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

fn exp2(self) -> Self

Returns 2^(self).

fn ln(self) -> Self

Returns the natural logarithm of the number.

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

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

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 max(self, other: Self) -> Self

Returns the maximum of the two numbers.

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

Returns the minimum of the two numbers.

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

The positive difference of two numbers.

fn cbrt(self) -> Self

Take the cubic root of a number.

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 exp_m1(self) -> Self

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

fn ln_1p(self) -> Self

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

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 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. The floating point encoding is documented in the [Reference][floating-point].

fn to_degrees(self) -> Self

Converts radians to degrees.

fn to_radians(self) -> Self

Converts degrees to radians.

impl<C: FloatChecker<f32>> Into<f32> for NoisyFloat<f32, C>

Note: due to complications with Rust's type system, cannot implement Into generically like impl<F: Float, C: FloatChecker<F>> Into<F> for NoisyFloat<F, C>.

fn into(self) -> f32

Performs the conversion.

impl<C: FloatChecker<f64>> Into<f64> for NoisyFloat<f64, C>

Note: due to complications with Rust's type system, cannot implement Into generically like impl<F: Float, C: FloatChecker<F>> Into<F> for NoisyFloat<F, C>.

fn into(self) -> f64

Performs the conversion.

impl<F: Float + Debug, C: FloatChecker<F>> Debug for NoisyFloat<F, C>

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

Formats the value using the given formatter.

impl<F: Float + Display, C: FloatChecker<F>> Display for NoisyFloat<F, C>

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

Formats the value using the given formatter.

impl<F: Float + LowerExp, C: FloatChecker<F>> LowerExp for NoisyFloat<F, C>

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

Formats the value using the given formatter.

impl<F: Float + UpperExp, C: FloatChecker<F>> UpperExp for NoisyFloat<F, C>

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

Formats the value using the given formatter.