Trait rust_decimal::MathematicalOps

pub trait MathematicalOps {
    fn exp(&self) -> Decimal;
    fn exp_with_tolerance(&self, tolerance: Decimal) -> Decimal;
    fn powi(&self, exp: i64) -> Decimal;
    fn checked_powi(&self, exp: i64) -> Option<Decimal>;
    fn powu(&self, exp: u64) -> Decimal;
    fn checked_powu(&self, exp: u64) -> Option<Decimal>;
    fn powf(&self, exp: f64) -> Decimal;
    fn checked_powf(&self, exp: f64) -> Option<Decimal>;
    fn powd(&self, exp: Decimal) -> Decimal;
    fn checked_powd(&self, exp: Decimal) -> Option<Decimal>;
    fn sqrt(&self) -> Option<Decimal>;
    fn ln(&self) -> Decimal;
    fn erf(&self) -> Decimal;
    fn norm_cdf(&self) -> Decimal;
    fn norm_pdf(&self) -> Decimal;
}

Trait exposing various mathematical operations that can be applied using a Decimal. This is only present when the maths feature has been enabled.

Required methods

fn exp(&self) -> Decimal

The estimated exponential function, e^x. Stops calculating when it is within tolerance of roughly 0.0000002.

fn exp_with_tolerance(&self, tolerance: Decimal) -> Decimal

The estimated exponential function, e^x using the tolerance provided as a hint as to when to stop calculating. A larger tolerance will cause the number to stop calculating sooner at the potential cost of a slightly less accurate result.

fn powi(&self, exp: i64) -> Decimal

Raise self to the given integer exponent: x^y

fn checked_powi(&self, exp: i64) -> Option<Decimal>

Raise self to the given integer exponent x^y returning None on overflow.

fn powu(&self, exp: u64) -> Decimal

Raise self to the given unsigned integer exponent: x^y

fn checked_powu(&self, exp: u64) -> Option<Decimal>

Raise self to the given unsigned integer exponent x^y returning None on overflow.

fn powf(&self, exp: f64) -> Decimal

Raise self to the given floating point exponent: x^y

fn checked_powf(&self, exp: f64) -> Option<Decimal>

Raise self to the given floating point exponent x^y returning None on overflow.

fn powd(&self, exp: Decimal) -> Decimal

Raise self to the given Decimal exponent: x^y. If exp is not whole then the approximation e^y*ln(x) of is used.

fn checked_powd(&self, exp: Decimal) -> Option<Decimal>

Raise self to the given Decimal exponent x^y returning None on overflow. If exp is not whole then the approximation e^y*ln(x) of is used.

fn sqrt(&self) -> Option<Decimal>

The square root of a Decimal. Uses a standard Babylonian method.

fn ln(&self) -> Decimal

The natural logarithm for a Decimal. Uses a fast estimation algorithm This is more accurate on larger numbers and less on numbers less than 1.

fn erf(&self) -> Decimal

Abramowitz Approximation of Error Function from wikipedia

fn norm_cdf(&self) -> Decimal

The Cumulative distribution function for a Normal distribution

fn norm_pdf(&self) -> Decimal

The Probability density function for a Normal distribution

Loading content...

Implementors

impl MathematicalOps for Decimal

fn exp(&self) -> Decimal

fn exp_with_tolerance(&self, tolerance: Decimal) -> Decimal

fn powi(&self, exp: i64) -> Decimal

fn checked_powi(&self, exp: i64) -> Option<Decimal>

fn powu(&self, exp: u64) -> Decimal

fn checked_powu(&self, exp: u64) -> Option<Decimal>

fn powf(&self, exp: f64) -> Decimal

fn checked_powf(&self, exp: f64) -> Option<Decimal>

fn powd(&self, exp: Decimal) -> Decimal

fn checked_powd(&self, exp: Decimal) -> Option<Decimal>

fn sqrt(&self) -> Option<Decimal>

The square root of a Decimal. Uses a standard Babylonian method.

fn ln(&self) -> Decimal

The natural logarithm for a Decimal. Uses a fast estimation algorithm This is more accurate on larger numbers and less on numbers less than 1.

fn erf(&self) -> Decimal

Abramowitz Approximation of Error Function from wikipedia

fn norm_cdf(&self) -> Decimal

The Cumulative distribution function for a Normal distribution

fn norm_pdf(&self) -> Decimal

The Probability density function for a Normal distribution

Loading content...