Struct micromath::F32

pub struct F32(pub f32);

32-bit floating point wrapper which implements fast approximation-based operations.

Implementations

impl F32

pub fn abs(self) -> Self

Computes the absolute value of self.

Returns Self::NAN if the number is Self::NAN.

impl F32

pub fn asin(self) -> Self

Computes asin(x) approximation in radians in the range [-pi/2, pi/2].

impl F32

pub fn atan(self) -> Self

Approximates atan(x) approximation in radians with a maximum error of 0.002.

Returns Self::NAN if the number is Self::NAN.

pub fn atan_norm(self) -> Self

Approximates atan(x) normalized to the [−1,1] range with a maximum error of 0.1620 degrees.

impl F32

pub fn atan2(self, rhs: Self) -> Self

Approximates the four quadrant arctangent of self (y) and rhs (x) in radians with a maximum error of 0.002.

• x = 0, y = 0: 0
• x >= 0: arctan(y/x) -> [-pi/2, pi/2]
• y >= 0: arctan(y/x) + pi -> (pi/2, pi]
• y < 0: arctan(y/x) - pi -> (-pi, -pi/2)

impl F32

pub fn ceil(self) -> Self

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

impl F32

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

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

impl F32

pub fn cos(self) -> Self

Approximates cos(x) in radians with a maximum error of 0.002.

impl F32

pub fn div_euclid(self, rhs: Self) -> Self

Calculates Euclidean division, the matching method for rem_euclid.

impl F32

pub fn exp(self) -> Self

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

impl F32

pub fn floor(self) -> Self

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

impl F32

pub fn fract(self) -> Self

Returns the fractional part of a number with sign.

impl F32

pub fn hypot(self, rhs: Self) -> Self

Calculate the length of the hypotenuse of a right-angle triangle.

impl F32

pub fn inv(self) -> Self

Fast approximation of 1/x.

impl F32

pub fn invsqrt(self) -> Self

Approximate inverse square root with an average deviation of ~5%.

impl F32

pub fn ln(self) -> Self

Approximates the natural logarithm of the number.

impl F32

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

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

impl F32

pub fn log10(self) -> Self

Approximates the base 10 logarithm of the number.

impl F32

pub fn log2(self) -> Self

Approximates the base 2 logarithm of the number.

impl F32

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

Approximates a number raised to a floating point power.

impl F32

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

Approximates a number raised to an integer power.

impl F32

pub fn rem_euclid(self, rhs: Self) -> Self

Calculates the least non-negative remainder of self (mod rhs).

impl F32

pub fn round(self) -> Self

Returns the nearest integer to a number.

impl F32

pub fn sin(self) -> Self

Approximates sin(x) in radians with a maximum error of 0.002.

impl F32

pub fn sqrt(self) -> Self

Approximates the square root of a number with an average deviation of ~5%.

Returns Self::NAN if self is a negative number.

impl F32

pub fn tan(self) -> Self

Approximates tan(x) in radians with a maximum error of 0.6.

impl F32

pub fn trunc(self) -> Self

Returns the integer part of a number.

impl F32

pub const ZERO: Self

The value 0.0.

pub const ONE: Self

The value 1.0.

pub const RADIX: u32

The radix or base of the internal representation of f32.

pub const MANTISSA_DIGITS: u32

Number of significant digits in base 2.

pub const DIGITS: u32

Approximate number of significant digits in base 10.

pub const EPSILON: Self

Machine epsilon value for f32.

This is the difference between 1.0 and the next larger representable number.

pub const MIN: Self

Smallest finite f32 value.

pub const MIN_POSITIVE: Self

Smallest positive normal f32 value.

pub const MAX: Self

Largest finite f32 value.

pub const MIN_EXP: i32

One greater than the minimum possible normal power of 2 exponent.

pub const MAX_EXP: i32

Maximum possible power of 2 exponent.

pub const MIN_10_EXP: i32

Minimum possible normal power of 10 exponent.

pub const MAX_10_EXP: i32

Maximum possible power of 10 exponent.

pub const NAN: Self

Not a Number (NaN).

pub const INFINITY: Self

Infinity (∞).

pub const NEG_INFINITY: Self

Negative infinity (−∞).

pub fn is_nan(self) -> bool

Returns true if this value is NaN.

pub fn is_infinite(self) -> bool

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

pub fn is_finite(self) -> bool

Returns true if this number is neither infinite nor NaN.

pub fn is_sign_positive(self) -> bool

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

pub fn is_sign_negative(self) -> bool

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

pub fn to_bits(self) -> u32

Raw transmutation to u32.

This is currently identical to transmute::<f32, u32>(self) on all platforms.

See F32::from_bits for some discussion of the portability of this operation (there are almost no issues).

pub fn from_bits(v: u32) -> Self

Raw transmutation from u32.

This is currently identical to transmute::<u32, f32>(v) on all platforms. It turns out this is incredibly portable, for two reasons:

• Floats and Ints have the same endianness on all supported platforms.
• IEEE-754 very precisely specifies the bit layout of floats.

See f32::from_bits for more information.

Trait Implementations

impl Add<F32> for F32

type Output = F32

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<f32> for F32

type Output = F32

The resulting type after applying the + operator.

fn add(self, rhs: f32) -> F32

Performs the + operation.

impl AddAssign<F32> for F32

fn add_assign(&mut self, rhs: F32)

Performs the += operation.

impl AddAssign<f32> for F32

fn add_assign(&mut self, rhs: f32)

Performs the += operation.

impl Clone for F32

fn clone(&self) -> F32

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for F32

This is supported on crate feature vector only.

impl Copy for F32

impl Debug for F32

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

Formats the value using the given formatter.

impl Default for F32

fn default() -> F32

Returns the “default value” for a type.

impl Display for F32

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

Formats the value using the given formatter.

impl Div<F32> for F32

type Output = F32

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<f32> for F32

type Output = F32

The resulting type after applying the / operator.

fn div(self, rhs: f32) -> F32

Performs the / operation.

impl DivAssign<F32> for F32

fn div_assign(&mut self, rhs: F32)

Performs the /= operation.

impl DivAssign<f32> for F32

fn div_assign(&mut self, rhs: f32)

Performs the /= operation.

impl From<f32> for F32

fn from(n: f32) -> F32

Performs the conversion.

impl From<i16> for F32

fn from(n: i16) -> F32

Performs the conversion.

impl From<i8> for F32

fn from(n: i8) -> F32

Performs the conversion.

impl From<u16> for F32

fn from(n: u16) -> F32

Performs the conversion.

impl From<u8> for F32

fn from(n: u8) -> F32

Performs the conversion.

impl FromStr for F32

type Err = ParseFloatError

The associated error which can be returned from parsing.

fn from_str(src: &str) -> Result<F32, ParseFloatError>

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

impl Inv for F32

This is supported on crate feature num-traits only.

type Output = Self

The result after applying the operator.

fn inv(self) -> Self

Returns the multiplicative inverse of self.

impl LowerExp for F32

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

Formats the value using the given formatter.

impl Mul<F32> for F32

type Output = F32

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f32> for F32

type Output = F32

The resulting type after applying the * operator.

fn mul(self, rhs: f32) -> F32

Performs the * operation.

impl MulAssign<F32> for F32

fn mul_assign(&mut self, rhs: F32)

Performs the *= operation.

impl MulAssign<f32> for F32

fn mul_assign(&mut self, rhs: f32)

Performs the *= operation.

impl Neg for F32

type Output = F32

The resulting type after applying the - operator.

fn neg(self) -> F32

Performs the unary - operation.

impl Num for F32

This is supported on crate feature num-traits only.

type FromStrRadixErr = ParseFloatError

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

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

impl One for F32

This is supported on crate feature num-traits only.

fn one() -> Self

Returns the multiplicative identity element of Self, 1.

fn is_one(&self) -> bool

Returns true if self is equal to the multiplicative identity.

pub fn set_one(&mut self)

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

impl PartialEq<F32> for F32

fn eq(&self, other: &F32) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &F32) -> bool

This method tests for !=.

impl PartialEq<f32> for F32

fn eq(&self, other: &f32) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<F32> for F32

fn partial_cmp(&self, other: &F32) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

pub 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 PartialOrd<f32> for F32

fn partial_cmp(&self, other: &f32) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

pub 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 Product<F32> for F32

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

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

impl Rem<F32> for F32

type Output = F32

The resulting type after applying the % operator.

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

Performs the % operation.

impl Rem<f32> for F32

type Output = F32

The resulting type after applying the % operator.

fn rem(self, rhs: f32) -> F32

Performs the % operation.

impl RemAssign<F32> for F32

fn rem_assign(&mut self, rhs: F32)

Performs the %= operation.

impl RemAssign<f32> for F32

fn rem_assign(&mut self, rhs: f32)

Performs the %= operation.

impl StructuralPartialEq for F32

impl Sub<F32> for F32

type Output = F32

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<f32> for F32

type Output = F32

The resulting type after applying the - operator.

fn sub(self, rhs: f32) -> F32

Performs the - operation.

impl SubAssign<F32> for F32

fn sub_assign(&mut self, rhs: F32)

Performs the -= operation.

impl SubAssign<f32> for F32

fn sub_assign(&mut self, rhs: f32)

Performs the -= operation.

impl Sum<F32> for F32

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

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

impl UpperExp for F32

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

Formats the value using the given formatter.

impl Zero for F32

This is supported on crate feature num-traits only.

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.

pub fn set_zero(&mut self)

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