Struct UnsignedF64 

pub struct UnsignedF64(/* private fields */);

a float that is guaranteed to be positive or zero

Implementations

impl UnsignedF64

pub const PI: UnsignedF64

pub const E: UnsignedF64

pub const FRAC_1_PI: UnsignedF64

pub const FRAC_1_SQRT_2: UnsignedF64

pub const FRAC_2_PI: UnsignedF64

pub const FRAC_2_SQRT_PI: UnsignedF64

pub const FRAC_PI_2: UnsignedF64

pub const FRAC_PI_3: UnsignedF64

pub const FRAC_PI_4: UnsignedF64

pub const FRAC_PI_6: UnsignedF64

pub const FRAC_PI_8: UnsignedF64

pub const LN_10: UnsignedF64

pub const LN_2: UnsignedF64

pub const LOG10_E: UnsignedF64

pub const LOG2_E: UnsignedF64

pub const SQRT_2: UnsignedF64

pub const TAU: UnsignedF64

pub const EPSILON: UnsignedF64

pub const INFINITY: UnsignedF64

pub const ZERO: UnsignedF64

pub const ONE: UnsignedF64

pub fn new(value: f64) -> Option<UnsignedF64>

Creates a new UnsignedF64 if the value is positive or zero. Returns None if the value is negative. Note: This converts -0.0 to 0.0 as -0.0 can introduce negative values in some operations that are otherwise safe.

pub fn square(f: f64) -> UnsignedF64

pub fn floor(&self) -> UnsignedF64

pub fn ceil(&self) -> UnsignedF64

pub fn round(&self) -> UnsignedF64

pub fn trunc(&self) -> UnsignedF64

pub fn fract(&self) -> UnsignedF64

pub fn abs(&self) -> UnsignedF64

pub fn signum(&self) -> f64

This can return -1 in the case of -0.0. -0.0 is valid for UnsignedF64 since its zero, but signum considers it negative.

pub fn copysign(&self, sign: f64) -> f64

This can return a negative if sign is -0.0. -0.0 is valid for UnsignedF64 since its zero, but copysign considers it negative.

pub fn mul_add(&self, a: UnsignedF64, b: UnsignedF64) -> UnsignedF64

pub fn rem_euclid(&self, rhs: UnsignedF64) -> UnsignedF64

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

pub fn powf(&self, n: f64) -> UnsignedF64

pub fn sqrt(&self) -> UnsignedF64

This should not return NaN.

pub fn exp(&self) -> UnsignedF64

pub fn exp2(&self) -> UnsignedF64

pub fn ln(&self) -> f64

pub fn log(&self, base: f64) -> f64

pub fn log2(&self) -> f64

pub fn log10(&self) -> f64

pub fn cbrt(&self) -> UnsignedF64

pub fn hypot(&self, other: f64) -> UnsignedF64

pub fn sin(&self) -> f64

pub fn cos(&self) -> f64

pub fn tan(&self) -> f64

pub fn asin(&self) -> UnsignedF64

pub fn acos(&self) -> UnsignedF64

pub fn atan(&self) -> UnsignedF64

pub fn sin_cos(&self) -> (f64, f64)

pub fn exp_m1(&self) -> UnsignedF64

pub fn ln_1p(&self) -> UnsignedF64

pub fn sinh(&self) -> UnsignedF64

pub fn cosh(&self) -> UnsignedF64

pub fn tanh(&self) -> UnsignedF64

pub fn asinh(&self) -> UnsignedF64

pub fn acosh(&self) -> UnsignedF64

pub fn atanh(&self) -> UnsignedF64

pub fn is_nan(&self) -> bool

pub fn is_infinite(&self) -> bool

pub fn is_finite(&self) -> bool

pub fn is_subnormal(&self) -> bool

pub fn is_normal(&self) -> bool

pub fn classify(&self) -> FpCategory

pub fn is_sign_positive(&self) -> bool

this may be false if the value is -0.0

pub fn is_sign_negative(&self) -> bool

this may be true if the value is -0.0

pub fn recip(&self) -> UnsignedF64

pub fn to_degrees(&self) -> UnsignedF64

pub fn to_radians(&self) -> UnsignedF64

pub fn max(self, other: UnsignedF64) -> UnsignedF64

pub fn min(self, other: UnsignedF64) -> UnsignedF64

pub fn total_cmp(&self, other: &UnsignedF64) -> Ordering

pub fn clamp(self, min: UnsignedF64, max: UnsignedF64) -> UnsignedF64

pub unsafe fn from_f64_unchecked(value: f64) -> UnsignedF64

Performs no checking. Useful in scenarios where you know the value is positive and you want to avoid the overhead of checking.

Safety

The value must be positive or zero.

Trait Implementations

impl Add<f64> for UnsignedF64

type Output = f64

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for UnsignedF64

type Output = UnsignedF64

The resulting type after applying the + operator.

fn add(self, other: UnsignedF64) -> UnsignedF64

Performs the + operation.

impl AddAssign for UnsignedF64

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl AsMut<f64> for UnsignedF64

fn as_mut(&mut self) -> &mut f64

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

impl AsRef<f64> for UnsignedF64

fn as_ref(&self) -> &f64

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

impl Clone for UnsignedF64

fn clone(&self) -> UnsignedF64

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UnsignedF64

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

Formats the value using the given formatter.

impl Default for UnsignedF64

fn default() -> UnsignedF64

Returns the “default value” for a type.

impl Display for UnsignedF64

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

Formats the value using the given formatter.

impl Div<f64> for UnsignedF64

type Output = f64

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div for UnsignedF64

type Output = UnsignedF64

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign for UnsignedF64

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl From<UnsignedF64> for f64

fn from(value: UnsignedF64) -> f64

Converts to this type from the input type.

impl Mul<f64> for UnsignedF64

type Output = f64

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for UnsignedF64

type Output = UnsignedF64

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign for UnsignedF64

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl Neg for UnsignedF64

type Output = f64

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq<f64> for UnsignedF64

fn eq(&self, other: &f64) -> 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 PartialEq for UnsignedF64

fn eq(&self, other: &UnsignedF64) -> 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 PartialOrd<f64> for UnsignedF64

fn partial_cmp(&self, other: &f64) -> 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 PartialOrd for UnsignedF64

fn partial_cmp(&self, other: &UnsignedF64) -> 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 Sub<f64> for UnsignedF64

type Output = f64

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for UnsignedF64

type Output = f64

The resulting type after applying the - operator.

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

Performs the - operation.

impl TryFrom<f64> for UnsignedF64

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: f64) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for UnsignedF64

impl StructuralPartialEq for UnsignedF64