Struct mpmfnum::fixed::FixedContext

pub struct FixedContext { /* private fields */ }

Rounding contexts for fixed-point numbers.

The associated storage type is Fixed.

Values rounded this context are fixed-point numbers: (-1)^s * c * 2^scale where c is a fixed-precision unsigned or signed integer and scale is a fixed integer.

A FixedContext is parameterized by

• signedness (unsigned vs. signed),
• scale factor (position of least-significant digit),
• total bitwidth of the encoding,
• rounding mode,
• overflow behavior.

By default, the rounding mode is RoundingMode::ToZero, and the overflow handling is Overflow::Wrap. See Overflow for supported overflow behavior.

Implementations

impl FixedContext

pub fn new(signed: bool, scale: isize, nbits: usize) -> Self

Constructs new rounding context. The default rounding mode is truncation (see ToZero). The default overflow behavior is saturation (see Wrap).

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

Sets the rounding mode of this FixedContext.

pub fn with_overflow(self, overflow: Overflow) -> Self

Sets the overflow behavior of this FixedContext.

pub fn maxval(&self) -> Fixed

The maximum value in format specified by this FixedContext. If the format is unsigned, this is just 2^scale * 2^nbits - 1. If the format is signed, this is just 2^scale * 2^(nbits-1) - 1.

pub fn minval(&self) -> Fixed

The minimum value in a format specified by this FixedContext. If the format is unsigned, this is just 0. If the format is signed, this is just 2^scale * -2^(nbits-1).

pub fn zero(&self) -> Fixed

Constructs zero in the format described by FixedContext

pub fn quantum(&self) -> Fixed

Constructs the smallest representable difference in the format described by FixedContext.

Trait Implementations

impl Clone for FixedContext

fn clone(&self) -> FixedContext

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FixedContext

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

Formats the value using the given formatter.

impl RoundedAbs for FixedContext

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

Performs rounded |x|.

impl RoundedAcos for FixedContext

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

Performs rounded arccos(x).

impl RoundedAcosh for FixedContext

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

Performs rounded arcosh(x).

impl RoundedAdd for FixedContext

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

where N1: Real, N2: Real,

Performs rounded x + y.

impl RoundedAsin for FixedContext

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

Performs rounded arcsin(x).

impl RoundedAsinh for FixedContext

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

Performs rounded arsinh(x).

impl RoundedAtan for FixedContext

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

Performs rounded arctan(x).

impl RoundedAtan2 for FixedContext

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

where N1: Real, N2: Real,

Performs rounded arctan(y / x).

impl RoundedAtanh for FixedContext

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

Performs rounded artanh(x).

impl RoundedCbrt for FixedContext

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

Performs rounded cbrt(x).

impl RoundedCos for FixedContext

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

Performs rounded cos(x).

impl RoundedCosPi for FixedContext

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

Performs rounded cos(pi * x).

impl RoundedCosh for FixedContext

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

Performs rounded cosh(x).

impl RoundedDiv for FixedContext

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

where N1: Real, N2: Real,

Performs rounded x / y.

impl RoundedErf for FixedContext

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

Performs rounded erf(x).

impl RoundedErfc for FixedContext

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

Performs rounded erfc(x).

impl RoundedExp for FixedContext

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

Performs rounded exp(x).

impl RoundedExp10m1 for FixedContext

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

Performs rounded 10^x - 1.

impl RoundedExp2 for FixedContext

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

Performs rounded 2^x.

impl RoundedExp2m1 for FixedContext

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

Performs rounded 2^x - 1.

impl RoundedExpm1 for FixedContext

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

Performs rounded e^x - 1.

impl RoundedFMA for FixedContext

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 FixedContext

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

where N1: Real, N2: Real,

Performs rounded fmod(x, y).

impl RoundedGamma for FixedContext

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

Performs rounded tgamma(x).

impl RoundedHypot for FixedContext

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 FixedContext

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

Performs rounded lgamma(x).

impl RoundedLog for FixedContext

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

Performs rounded ln(x).

impl RoundedLog10 for FixedContext

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

Performs rounded log10(x).

impl RoundedLog10p1 for FixedContext

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

Performs rounded log10(x + 1).

impl RoundedLog1p for FixedContext

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

Performs rounded log(x + 1).

impl RoundedLog2 for FixedContext

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

Performs rounded log2(x).

impl RoundedLog2p1 for FixedContext

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

Performs rounded log2(x + 1).

impl RoundedMul for FixedContext

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

where N1: Real, N2: Real,

Performs rounded x * y.

impl RoundedNeg for FixedContext

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

Performs rounded -x.

impl RoundedPow for FixedContext

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

where N1: Real, N2: Real,

Performs rounded x ^ y.

impl RoundedRecip for FixedContext

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

Performs rounded 1/x.

impl RoundedRecipSqrt for FixedContext

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

Performs rounded 1/sqrt(x).

impl RoundedRemainder for FixedContext

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

where N1: Real, N2: Real,

Performs rounded remainder(x, y).

impl RoundedSin for FixedContext

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

Performs rounded sin(x).

impl RoundedSinPi for FixedContext

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

Performs rounded sin(pi * x).

impl RoundedSinh for FixedContext

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

Performs rounded sinh(x).

impl RoundedSqrt for FixedContext

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

Performs rounded sqrt(x).

impl RoundedSub for FixedContext

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

where N1: Real, N2: Real,

Performs rounded x - y.

impl RoundedTan for FixedContext

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

Performs rounded tan(x).

impl RoundedTanPi for FixedContext

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

Performs rounded tan(pi * x).

impl RoundedTanh for FixedContext

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

Performs rounded tanh(x).

impl RoundingContext for FixedContext

type Format = Fixed

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.