Struct mpmfnum::float::FloatContext

pub struct FloatContext { /* private fields */ }

Rounding contexts for fixed-precision, floating-point numbers with unbounded exponent.

The associated storage type is Float.

This is not IEEE 754 style rounding: values rounded under this context are base-2 scientific numbers (-1)^s * c * 2^exp where c is a fixed-precision unsigned integer and exp is an unbounded signed integer.

A FloatContext is parameterized by

• maximum precision (see Real::prec),
• rounding mode.

By default, the rounding mode is RoundingMode::NearestTiesToEven. This rounding context is similar to the one implemented by Rug (MPFR).

Implementations

impl FloatContext

pub fn new(prec: usize) -> Self

Constructs a new rounding context.

pub fn with_max_p(self, prec: usize) -> Self

Sets the precision of this context.

pub fn with_rm(self, rm: RoundingMode) -> Self

Sets the rounding mode of this context.

pub fn max_p(&self) -> usize

Returns the maximum precision allowed by this format.

pub fn rm(&self) -> RoundingMode

Returns the rounding mode of this context.

Trait Implementations

impl Clone for FloatContext

fn clone(&self) -> FloatContext

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FloatContext

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

Formats the value using the given formatter.

impl RoundedAbs for FloatContext

fn abs<N: Real>(&self, src: &N) -> Self::Format

Performs rounded |x|.

impl RoundedAcos for FloatContext

fn acos<N: Real>(&self, src: &N) -> Self::Format

Performs rounded arccos(x).

impl RoundedAcosh for FloatContext

fn acosh<N: Real>(&self, src: &N) -> Self::Format

Performs rounded arcosh(x).

impl RoundedAdd for FloatContext

fn add<N1, N2>(&self, src1: &N1, src2: &N2) -> Self::Format

where N1: Real, N2: Real,

Performs rounded x + y.

impl RoundedAsin for FloatContext

fn asin<N: Real>(&self, src: &N) -> Self::Format

Performs rounded arcsin(x).

impl RoundedAsinh for FloatContext

fn asinh<N: Real>(&self, src: &N) -> Self::Format

Performs rounded arsinh(x).

impl RoundedAtan for FloatContext

fn atan<N: Real>(&self, src: &N) -> Self::Format

Performs rounded arctan(x).

impl RoundedAtan2 for FloatContext

fn atan2<N1, N2>(&self, src1: &N1, src2: &N2) -> Self::Format

where N1: Real, N2: Real,

Performs rounded arctan(y / x).

impl RoundedAtanh for FloatContext

fn atanh<N: Real>(&self, src: &N) -> Self::Format

Performs rounded artanh(x).

impl RoundedCbrt for FloatContext

fn cbrt<N: Real>(&self, src: &N) -> Self::Format

Performs rounded cbrt(x).

impl RoundedCos for FloatContext

fn cos<N: Real>(&self, src: &N) -> Self::Format

Performs rounded cos(x).

impl RoundedCosPi for FloatContext

fn cos_pi<N: Real>(&self, src: &N) -> Self::Format

Performs rounded cos(pi * x).

impl RoundedCosh for FloatContext

fn cosh<N: Real>(&self, src: &N) -> Self::Format

Performs rounded cosh(x).

impl RoundedDiv for FloatContext

fn div<N1, N2>(&self, src1: &N1, src2: &N2) -> Self::Format

where N1: Real, N2: Real,

Performs rounded x / y.

impl RoundedErf for FloatContext

fn erf<N: Real>(&self, src: &N) -> Self::Format

Performs rounded erf(x).

impl RoundedErfc for FloatContext

fn erfc<N: Real>(&self, src: &N) -> Self::Format

Performs rounded erfc(x).

impl RoundedExp for FloatContext

fn exp<N: Real>(&self, src: &N) -> Self::Format

Performs rounded exp(x).

impl RoundedExp10m1 for FloatContext

fn exp10m1<N: Real>(&self, src: &N) -> Self::Format

Performs rounded 10^x - 1.

impl RoundedExp2 for FloatContext

fn exp2<N: Real>(&self, src: &N) -> Self::Format

Performs rounded 2^x.

impl RoundedExp2m1 for FloatContext

fn exp2m1<N: Real>(&self, src: &N) -> Self::Format

Performs rounded 2^x - 1.

impl RoundedExpm1 for FloatContext

fn expm1<N: Real>(&self, src: &N) -> Self::Format

Performs rounded e^x - 1.

impl RoundedFMA for FloatContext

fn fma<N1, N2, N3>(&self, src1: &N1, src2: &N2, src3: &N3) -> Self::Format

where N1: Real, N2: Real, N3: Real,

Performs rounded a*b + c.

impl RoundedFmod for FloatContext

fn fmod<N1, N2>(&self, src1: &N1, src2: &N2) -> Self::Format

where N1: Real, N2: Real,

Performs rounded fmod(x, y).

impl RoundedGamma for FloatContext

fn tgamma<N: Real>(&self, src: &N) -> Self::Format

Performs rounded tgamma(x).

impl RoundedHypot for FloatContext

fn hypot<N1, N2>(&self, src1: &N1, src2: &N2) -> Self::Format

where N1: Real, N2: Real,

Performs rounded sqrt(x^2 + y^2).

impl RoundedLgamma for FloatContext

fn lgamma<N: Real>(&self, src: &N) -> Self::Format

Performs rounded lgamma(x).

impl RoundedLog for FloatContext

fn log<N: Real>(&self, src: &N) -> Self::Format

Performs rounded ln(x).

impl RoundedLog10 for FloatContext

fn log10<N: Real>(&self, src: &N) -> Self::Format

Performs rounded log10(x).

impl RoundedLog10p1 for FloatContext

fn log10p1<N: Real>(&self, src: &N) -> Self::Format

Performs rounded log10(x + 1).

impl RoundedLog1p for FloatContext

fn log1p<N: Real>(&self, src: &N) -> Self::Format

Performs rounded log(x + 1).

impl RoundedLog2 for FloatContext

fn log2<N: Real>(&self, src: &N) -> Self::Format

Performs rounded log2(x).

impl RoundedLog2p1 for FloatContext

fn log2p1<N: Real>(&self, src: &N) -> Self::Format

Performs rounded log2(x + 1).

impl RoundedMul for FloatContext

fn mul<N1, N2>(&self, src1: &N1, src2: &N2) -> Self::Format

where N1: Real, N2: Real,

Performs rounded x * y.

impl RoundedNeg for FloatContext

fn neg<N: Real>(&self, src: &N) -> Self::Format

Performs rounded -x.

impl RoundedPow for FloatContext

fn pow<N1, N2>(&self, src1: &N1, src2: &N2) -> Self::Format

where N1: Real, N2: Real,

Performs rounded x ^ y.

impl RoundedRecip for FloatContext

fn recip<N: Real>(&self, src: &N) -> Self::Format

Performs rounded 1/x.

impl RoundedRecipSqrt for FloatContext

fn recip_sqrt<N: Real>(&self, src: &N) -> Self::Format

Performs rounded 1/sqrt(x).

impl RoundedRemainder for FloatContext

fn remainder<N1, N2>(&self, src1: &N1, src2: &N2) -> Self::Format

where N1: Real, N2: Real,

Performs rounded remainder(x, y).

impl RoundedSin for FloatContext

fn sin<N: Real>(&self, src: &N) -> Self::Format

Performs rounded sin(x).

impl RoundedSinPi for FloatContext

fn sin_pi<N: Real>(&self, src: &N) -> Self::Format

Performs rounded sin(pi * x).

impl RoundedSinh for FloatContext

fn sinh<N: Real>(&self, src: &N) -> Self::Format

Performs rounded sinh(x).

impl RoundedSqrt for FloatContext

fn sqrt<N: Real>(&self, src: &N) -> Self::Format

Performs rounded sqrt(x).

impl RoundedSub for FloatContext

fn sub<N1, N2>(&self, src1: &N1, src2: &N2) -> Self::Format

where N1: Real, N2: Real,

Performs rounded x - y.

impl RoundedTan for FloatContext

fn tan<N: Real>(&self, src: &N) -> Self::Format

Performs rounded tan(x).

impl RoundedTanPi for FloatContext

fn tan_pi<N: Real>(&self, src: &N) -> Self::Format

Performs rounded tan(pi * x).

impl RoundedTanh for FloatContext

fn tanh<N: Real>(&self, src: &N) -> Self::Format

Performs rounded tanh(x).

impl RoundingContext for FloatContext

type Format = Float

Result type of operations under this context.

fn round<T: Real>(&self, val: &T) -> Self::Format

Rounds any Real value to a RoundingContext::Format value, rounding according to this RoundingContext.