Trait RawRealTrait

Source

pub trait RawRealTrait:
    RawScalarTrait<ValidationErrors = ErrorsValidationRawReal<Self>>
    + PartialOrd
    + PartialOrd<f64>
    + Sign
    + Rounding {
    type RawComplex: RawComplexTrait<RawReal = Self>;

Show 28 methods    // Required methods
    fn unchecked_abs(self) -> Self;
    fn unchecked_atan2(self, denominator: &Self) -> Self;
    fn unchecked_pow_exponent_real(self, exponent: &Self) -> Self;
    fn unchecked_hypot(self, other: &Self) -> Self;
    fn unchecked_ln_1p(self) -> Self;
    fn unchecked_exp_m1(self) -> Self;
    fn unchecked_mul_add_mul_mut(
        &mut self,
        mul: &Self,
        add_mul1: &Self,
        add_mul2: &Self,
    );
    fn unchecked_mul_sub_mul_mut(
        &mut self,
        mul: &Self,
        sub_mul1: &Self,
        sub_mul2: &Self,
    );
    fn raw_total_cmp(&self, other: &Self) -> Ordering;
    fn raw_clamp(self, min: &Self, max: &Self) -> Self;
    fn raw_classify(&self) -> FpCategory;
    fn raw_two(precision: u32) -> Self;
    fn raw_one_div_2(precision: u32) -> Self;
    fn raw_pi(precision: u32) -> Self;
    fn raw_two_pi(precision: u32) -> Self;
    fn raw_pi_div_2(precision: u32) -> Self;
    fn raw_max_finite(precision: u32) -> Self;
    fn raw_min_finite(precision: u32) -> Self;
    fn raw_epsilon(precision: u32) -> Self;
    fn raw_ln_2(_precision: u32) -> Self;
    fn raw_ln_10(_precision: u32) -> Self;
    fn raw_log10_2(_precision: u32) -> Self;
    fn raw_log2_10(_precision: u32) -> Self;
    fn raw_log2_e(_precision: u32) -> Self;
    fn raw_log10_e(_precision: u32) -> Self;
    fn raw_e(_precision: u32) -> Self;
    fn try_new_raw_real_from_f64<RealPolicy: ValidationPolicyReal<Value = Self>>(
        value: f64,
    ) -> Result<Self, ErrorsTryFromf64<Self>>;
    fn precision(&self) -> u32;
}

Expand description

A trait for raw real scalar types, extending RawScalarTrait with real-specific operations.

This trait is implemented by the underlying real number types within a kernel, such as f64 or rug::Float. It builds upon RawScalarTrait by adding operations that are unique to real numbers, like atan2, and by enforcing an ordering relationship.

§Trait Bounds

RawScalarTrait<ValidationErrors = ErrorsValidationRawReal<Self>>: Ensures that the type is a raw scalar and that its validation error type is the standard one for real numbers.
PartialOrd: Requires that the type can be partially ordered, which is fundamental for real numbers.
PartialOrd<f64>: These crucial bounds allow instances of the raw real type to be directly compared with f64 constants. This is essential for implementing domain checks (e.g., value < 0.0 or value >= 0.0) that work across both f64 and rug::Float without extra conversions.

§Associated Types

type RawComplex: RawComplexTrait<RawReal = Self>: This links the raw real type to its corresponding complex number representation. For example, for f64, this would be num::Complex<f64>. This association is vital for operations that can transition from the real to the complex domain.

Required Associated Types§

Source

type RawComplex: RawComplexTrait<RawReal = Self>

The associated complex type that uses this type as its real part.

Required Methods§

Source

fn unchecked_abs(self) -> Self

Computes the absolute value of self without validation.

Contract: The caller must ensure that the input value has already been validated and is suitable for the operation.

Source

fn unchecked_atan2(self, denominator: &Self) -> Self

Computes the four-quadrant arctangent of self (y) and denominator (x) without validation.

Contract: The caller must ensure that self and denominator are not both zero.

Source

fn unchecked_pow_exponent_real(self, exponent: &Self) -> Self

Raises self to the power of a real exponent without validation.

Contract: The caller must ensure the inputs are valid for the power function. For example, if self is negative, the exponent should be an integer, but this function does not enforce this.

Source

fn unchecked_mul_add_mul_mut( &mut self, mul: &Self, add_mul1: &Self, add_mul2: &Self, )

Multiplies two pairs and adds them, rounding to the nearest. a.unchecked_mul_add_mul_mut(&b, &c, &d) produces a result like &a * &b + &c * &d, but stores the result in a using its precision.

Contract: The caller must ensure all inputs are valid.

Source

fn unchecked_mul_sub_mul_mut( &mut self, mul: &Self, sub_mul1: &Self, sub_mul2: &Self, )

Multiplies two pairs and subtracts them, rounding to the nearest. a.unchecked_mul_sub_mul_mut(&b, &c, &d) produces a result like &a * &b - &c * &d, but stores the result in a using its precision.

Contract: The caller must ensure all inputs are valid.

Source