Struct Finite 

pub struct Finite<F: IsFinite>(/* private fields */);

Implementations

impl<F: IsFinite> Finite<F>

pub fn try_new(val: F) -> Result<Self, InfiniteError>

Attempts to create a new Finite float.

Errors

If the value is non-finite.

pub const unsafe fn unchecked(val: F) -> Self

Const-safe constructor for Finite that never checks the value.

Safety

Ensure that the value can never be infinity or NaN.

pub const fn val(self) -> F

Gets the inner value of this number.

impl<F: IsFinite> Finite<F>

pub fn new(val: F) -> Self

Creates a new checked float.

Panics

If the number is non-finite. Note that this fn will not panic in release mode, unless the strict feature flag is set.

impl<F: IsFinite + ToOrd> Finite<F>

pub fn max(self, other: impl IntoInner<F>) -> Self

Returns the larger of two floating point values.

pub fn min(self, other: impl IntoInner<F>) -> Self

Returns the smaller of two floating point values.

impl<F: IsFinite + Round> Finite<F>

pub fn floor(self) -> Self

Rounds this floating point number to the previous whole number.

pub fn ceil(self) -> Self

Rounds this floating point number to the next whole number.

pub fn round(self) -> Self

Rounds this floating point number to the nearest whole number.

pub fn trunc(self) -> Self

Drops the fractional part of this floating point number.

pub fn fract(self) -> Self

Returns the fractional part of this floating point number.

impl<F: IsFinite + Signed> Finite<F>

pub fn abs(self) -> Self

Computes the absolute value of self.

pub fn signum(self) -> Self

Returns a number that represents the sign of self.

• 1.0 if the number is positive, +0.0 or INFINITY
• -1.0 if the number is negative, -0.0 or NEG_INFINITY

pub fn is_sign_negative(self) -> bool

Returns true if self has a negative sign, including -0.0 and negative infinity.

pub fn is_sign_positive(self) -> bool

Returns true if self has a positive sign, including +0.0 and positive infinity.

impl<F: IsFinite> Finite<F>

pub fn try_add(self, rhs: impl IntoInner<F>) -> Result<Self, InfiniteError>

where F: Add<Output = F>,

Attempts to add two numbers.

Errors

If the result is non-finite.

pub fn try_sub(self, rhs: impl IntoInner<F>) -> Result<Self, InfiniteError>

where F: Sub<Output = F>,

Attempts to subtract two numbers.

Errors

If the result is non-finite.

impl<F: IsFinite> Finite<F>

pub fn try_neg(self) -> Result<Self, InfiniteError>

where F: Neg<Output = F>,

Attempts to negate a number.

Errors

If the result is non-finite.

impl<F: IsFinite> Finite<F>

pub fn try_mul(self, rhs: impl IntoInner<F>) -> Result<Self, InfiniteError>

where F: Mul<Output = F>,

Attempts to multiply two numbers.

Errors

If the result is non-finite.

pub fn try_div(self, rhs: impl IntoInner<F>) -> Result<Self, InfiniteError>

where F: Div<Output = F>,

Attempts to divide two numbers.

Errors

If the result is non-finite.

pub fn try_rem(self, rhs: impl IntoInner<F>) -> Result<Self, InfiniteError>

where F: Rem<Output = F>,

Attempts to find the remainder of two numbers.

Errors

If the result is non-finite.

impl<F: IsFinite + Pow> Finite<F>

pub fn try_powf(self, n: impl IntoInner<F>) -> Result<Self, InfiniteError>

Attempts to raise self to the power n.

Errors

If the result is non-finite.

pub fn try_powi(self, n: i32) -> Result<Self, InfiniteError>

Attempts to raise self to the power n.

Errors

If the result is non-finite.

pub fn powf(self, n: impl IntoInner<F>) -> Self

Raises self to the power n.

Panics

If the result is non-finite.

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

Raises self to the power n.

Panics

If the result is non-finite.

pub fn try_recip(self) -> Result<Self, InfiniteError>

Attempts to compute the reciprocal (1/x) of self.

Errors

If the result is non-finite.

pub fn recip(self) -> Self

Computes the reciprocal (1/x) of self.

Panics

If the result is non-finite.

pub fn try_sqrt(self) -> Result<Self, InfiniteError>

Attempts to find the square root of a number.

Errors

If the result is non-finite.

pub fn sqrt(self) -> Self

Computes the square root of a number.

Panics

If the result is non-finite.

pub fn cbrt(self) -> Self

Computes the cube root of a number.

pub fn try_hypot(self, other: impl IntoInner<F>) -> Result<Self, InfiniteError>

Attempts to calculate the length of the hypotenuse of a right-angle triangle given legs of length x and y.

Equivalent to sqrt(x^2 + y^2).

Errors

If the result is non-finite.

pub fn hypot(self, other: impl IntoInner<F>) -> Self

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

Panics

If the result is non-finite.

impl<F: IsFinite + Exp> Finite<F>

pub fn try_exp(self) -> Result<Self, InfiniteError>

Attempts to find e^(self), the exponential function.

Errors

If the result is non-finite.

pub fn try_exp2(self) -> Result<Self, InfiniteError>

Attempts to find 2^(self).

Errors

If the result is non-finite.

pub fn try_exp_m1(self) -> Result<Self, InfiniteError>

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

Errors

If the result is non-finite.

pub fn exp(self) -> Self

Computes e^(self), the exponential function.

Panics

If the result is non-finite.

pub fn exp2(self) -> Self

Computes 2^(self).

Panics

If the result is non-finite.

pub fn exp_m1(self) -> Self

Computes e^(self) - 1 more accurately than performing the operations separately.

Panics

If the result is non-finite.

pub fn try_log(self, b: impl IntoInner<F>) -> Result<Self, InfiniteError>

Attempts to find the log base b of self.

Errors

If the result is non-finite.

pub fn try_ln(self) -> Result<Self, InfiniteError>

Attempts to find the natural log (base e) of self.

Errors

If the result is non-finite.

pub fn try_log2(self) -> Result<Self, InfiniteError>

Attempts to find the log base 2 of self.

Errors

If the result is non-finite.

pub fn try_log10(self) -> Result<Self, InfiniteError>

Attempts to find the log base 10 of self.

Errors

If the result is non-finite.

pub fn try_ln_1p(self) -> Result<Self, InfiniteError>

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

Errors

If the result is non-finite.

pub fn log(self, b: impl IntoInner<F>) -> Self

Computes the log base b of self.

Panics

If the result is non-finite.

pub fn ln(self) -> Self

Computes the natural log (base e) of self.

Panics

If the result is non-finite.

pub fn log2(self) -> Self

Computes the log base 2 of self.

Panics

If the result is non-finite.

pub fn log10(self) -> Self

Computes the log base 10 of self.

Panics

If the result is non-finite.

pub fn ln_1p(self) -> Self

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

Panics

If the result is non-finite.

impl<F: IsFinite + Trig> Finite<F>

pub fn sin(self) -> Self

Computes the sine of a number.

pub fn cos(self) -> Self

Computes the cosine of a number.

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

Computes the sine and cosine of a number simultaneously.

pub fn try_tan(self) -> Result<Self, InfiniteError>

Attempts to compute the tangent of a number (in radians).

Errors

If the result is non-finite.

pub fn tan(self) -> Self

Computes the tangent of a number.

Panics

If the result is non-finite.

pub fn try_asin(self) -> Result<Self, InfiniteError>

Attempts to compute the arcsine of a number (in radians).

Errors

If the result is non-finite (caused if the magnitude of the input exceeds 1).

pub fn try_acos(self) -> Result<Self, InfiniteError>

Attempts to compute the arccosine of a number (in radians).

Errors

If the result is non-finite (caused if the magnitude of the input exceeds 1).

pub fn asin(self) -> Self

Computes the arcsine of a number.

Panics

If the result is non-finite (caused if the magnitude of the input exceeds 1).

pub fn acos(self) -> Self

Computes the arccosine of a number.

Panics

If the result is non-finite (caused if the magnitude of the input exceeds 1).

pub fn atan(self) -> Self

Computes the arctangent of a number.

pub fn try_atan2(self, other: impl IntoInner<F>) -> Result<Self, InfiniteError>

Attempts to compute the four quadrant arctangent of self (y) and other (x) in radians.

Errors

If the result is non-finite.

pub fn atan2(self, other: impl IntoInner<F>) -> Self

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

Panics

If the result is non-finite.

Trait Implementations

impl<F: IsFinite + Add<Output = F>, Rhs: IntoInner<F>> Add<Rhs> for Finite<F>

type Output = Finite<F>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<F: IsFinite + Add<Output = F>, Rhs: IntoInner<F>> AddAssign<Rhs> for Finite<F>

fn add_assign(&mut self, rhs: Rhs)

Performs the += operation.

impl<F: Clone + IsFinite> Clone for Finite<F>

fn clone(&self) -> Finite<F>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: Debug + IsFinite> Debug for Finite<F>

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

Formats the value using the given formatter.

impl<F: Default + IsFinite> Default for Finite<F>

fn default() -> Finite<F>

Returns the “default value” for a type.

impl<F: IsFinite + Div<Output = F>, Rhs: IntoInner<F>> Div<Rhs> for Finite<F>

type Output = Finite<F>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<F: IsFinite + Div<Output = F>, Rhs: IntoInner<F>> DivAssign<Rhs> for Finite<F>

fn div_assign(&mut self, rhs: Rhs)

Performs the /= operation.

impl<F: IsFinite + Mul<Output = F>, Rhs: IntoInner<F>> Mul<Rhs> for Finite<F>

type Output = Finite<F>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<F: IsFinite + Mul<Output = F>, Rhs: IntoInner<F>> MulAssign<Rhs> for Finite<F>

fn mul_assign(&mut self, rhs: Rhs)

Performs the *= operation.

impl<F: IsFinite + Neg<Output = F>> Neg for Finite<F>

type Output = Finite<F>

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl<F: IsFinite + ToOrd> Ord for Finite<F>

fn cmp(&self, rhs: &Self) -> 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<F: IsFinite + ToOrd, Rhs: IntoInner<F> + Copy> PartialEq<Rhs> for Finite<F>

fn eq(&self, rhs: &Rhs) -> 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<F: IsFinite + ToOrd, Rhs: IntoInner<F> + Copy> PartialOrd<Rhs> for Finite<F>

fn partial_cmp(&self, rhs: &Rhs) -> 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<F: IsFinite + Rem<Output = F>, Rhs: IntoInner<F>> Rem<Rhs> for Finite<F>

type Output = Finite<F>

The resulting type after applying the % operator.

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

Performs the % operation.

impl<F: IsFinite + Rem<Output = F>, Rhs: IntoInner<F>> RemAssign<Rhs> for Finite<F>

fn rem_assign(&mut self, rhs: Rhs)

Performs the %= operation.

impl<F: IsFinite + Sub<Output = F>, Rhs: IntoInner<F>> Sub<Rhs> for Finite<F>

type Output = Finite<F>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<F: IsFinite + Sub<Output = F>, Rhs: IntoInner<F>> SubAssign<Rhs> for Finite<F>

fn sub_assign(&mut self, rhs: Rhs)

Performs the -= operation.

impl<F: Copy + IsFinite> Copy for Finite<F>

impl<F: IsFinite + ToOrd> Eq for Finite<F>