Struct RealImpl 

pub struct RealImpl<T: Float>(/* private fields */);

Wrapper around T that checks for valid values (panics on NaN/Inf)

Implementations

impl<T: Float> RealImpl<T>

pub fn new(value: T) -> Self

Create a new value, panics if not finite

pub fn new_unchecked(value: T) -> Self

Create a new value without checking

pub fn raw(self) -> T

Get raw value

impl<T: Float> RealImpl<T>

pub const PI: Self = <Self as Real>::PI

Archimedes’ constant (π)

pub 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].

pub 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].

pub fn atan(self) -> Self

Computes the arctangent of a number.

Return value is in radians in the range [-pi/2, pi/2];

pub fn atan2(y: Self, x: Self) -> Self

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

• 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)

pub fn ceil(self) -> Self

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

pub fn cos(self) -> Self

Computes the cosine of a number (in radians).

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

Calculates Euclidean division, the matching method for rem_euclid.

This computes the integer n such that self = n * rhs + self.rem_euclid(rhs). In other words, the result is self / rhs rounded to the integer n such that self >= n * rhs.

pub fn exp(self) -> Self

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

pub fn floor(self) -> Self

Returns the largest integer less than or equal to self.

pub fn fract(self) -> Self

Returns the fractional part of self.

pub fn ln(self) -> Self

Returns the natural logarithm of the number.

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

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

pub fn log10(self) -> Self

Returns the base 10 logarithm of the number.

pub fn log2(self) -> Self

Returns the base 2 logarithm of the number.

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

Raises a number to a floating point power.

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

Raises a number to an integer power.

pub fn recip(self) -> Self

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

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

Calculates the least nonnegative remainder of self (mod rhs).

In particular, the return value r satisfies 0.0 <= r < rhs.abs() in most cases. However, due to a floating point round-off error it can result in r == rhs.abs(), violating the mathematical definition, if self is much smaller than rhs.abs() in magnitude and self < 0.0. This result is not an element of the function’s codomain, but it is the closest floating point number in the real numbers and thus fulfills the property self == self.div_euclid(rhs) * rhs + self.rem_euclid(rhs) approximately.

pub fn round(self) -> Self

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

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
• NaN if the number is NaN

pub fn sin(self) -> Self

Computes the sine of a number (in radians).

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

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

pub fn sqrt(self) -> Self

Returns the square root of a number.

Returns NaN if self is a negative number other than -0.0.

pub fn tan(self) -> Self

Computes the tangent of a number (in radians).

pub fn from_f32(x: f32) -> Self

Convert an f32 into Self

pub fn as_f32(self) -> f32

Convert self into an f32

Trait Implementations

impl<T: Float> Add for RealImpl<T>

type Output = RealImpl<T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T: Float> AddAssign for RealImpl<T>

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl<T: Clone + Float> Clone for RealImpl<T>

fn clone(&self) -> RealImpl<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Float> Debug for RealImpl<T>

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RealImpl<f32>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'de> Deserialize<'de> for RealImpl<f64>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: Float> Display for RealImpl<T>

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

Formats the value using the given formatter.

impl<T: Float> Div for RealImpl<T>

type Output = RealImpl<T>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T: Float> DivAssign for RealImpl<T>

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl<T: Float> Mul for RealImpl<T>

type Output = RealImpl<T>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T: Float> MulAssign for RealImpl<T>

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl<T: Float> Neg for RealImpl<T>

type Output = RealImpl<T>

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl<T: Float> Num for RealImpl<T>

fn signum(self) -> Self

Returns a number representing sign of self.

fn abs(self) -> Self

Calculate absolute value

impl<T: Float> Ord for RealImpl<T>

fn cmp(&self, other: &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<T: PartialEq + Float> PartialEq for RealImpl<T>

fn eq(&self, other: &RealImpl<T>) -> 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<T: Float> PartialOrd for RealImpl<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

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<T: Float> Real for RealImpl<T>

const PI: Self

Archimedes’ constant (π)

fn acos(self) -> Self

Computes the arccosine of a number.

fn asin(self) -> Self

Computes the arcsine of a number.

fn atan(self) -> Self

Computes the arctangent of a number.

fn atan2(y: Self, x: Self) -> Self

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

fn ceil(self) -> Self

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

fn cos(self) -> Self

Computes the cosine of a number (in radians).

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

Calculates Euclidean division, the matching method for rem_euclid.

fn exp(self) -> Self

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

fn floor(self) -> Self

Returns the largest integer less than or equal to self.

fn fract(self) -> Self

Returns the fractional part of 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 log10(self) -> Self

Returns the base 10 logarithm of the number.

fn log2(self) -> Self

Returns the base 2 logarithm of the number.

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

Raises a number to a floating point power.

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

Raises a number to an integer power.

fn recip(self) -> Self

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

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

Calculates the least nonnegative remainder of self (mod rhs).

fn round(self) -> Self

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

fn sin(self) -> Self

Computes the sine of a number (in radians).

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

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

fn sqrt(self) -> Self

Returns the square root of a number.

fn tan(self) -> Self

Computes the tangent of a number (in radians).

fn from_f32(x: f32) -> Self

Convert an f32 into Self

fn as_f32(self) -> f32

Convert self into an f32

impl<T: Float + SampleUniform> SampleUniform for RealImpl<T>

type Sampler = UniformReal<T>

The UniformSampler implementation supporting type X.

impl<T> Serialize for RealImpl<T>

where T: Serialize + Float,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Float> Sub for RealImpl<T>

type Output = RealImpl<T>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T: Float> SubAssign for RealImpl<T>

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl TryFrom<f32> for RealImpl<f32>

type Error = &'static str

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<f64> for RealImpl<f64>

type Error = &'static str

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T: Float> UNum for RealImpl<T>

const ZERO: Self

Additive identity

const ONE: Self

Multiplicative identity

fn sqr(self) -> Self

Calculate squared value (self * self)

impl<T: Copy + Float> Copy for RealImpl<T>

impl<T: Float> Eq for RealImpl<T>

impl<T: Float> StructuralPartialEq for RealImpl<T>