mpmfnum 0.2.0

A numbers library in Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

//! Rounded mathematical operations.
//!
//! Implementations of these traits operate on [`Real`] types,
//! rounding the result according to a given [`RoundingContext`].
//!

use crate::{Real, RoundingContext};

macro_rules! rounded_1ary {
    ($trait:ident, $impl:ident, $descr:expr) => {
        #[doc = "Rounded `"]
        #[doc = $descr]
        #[doc = "` for rounding contexts."]
        pub trait $trait: RoundingContext {
            #[doc = "Performs rounded `"]
            #[doc = $descr]
            #[doc = "`."]
            fn $impl<N: Real>(&self, src: &N) -> Self::Format;
        }

        #[doc = "Computes `"]
        #[doc = $descr]
        #[doc = "` and rounds according to the [`RoundingContext`] ctx."]
        pub fn $impl<Ctx, N>(ctx: &Ctx, src: &N) -> Ctx::Format
        where
            Ctx: $trait,
            N: Real,
        {
            ctx.$impl(src)
        }
    };
}

// Traits for 1-ary operators
rounded_1ary!(RoundedNeg, neg, "-x");
rounded_1ary!(RoundedAbs, abs, "|x|");
rounded_1ary!(RoundedSqrt, sqrt, "sqrt(x)");
rounded_1ary!(RoundedCbrt, cbrt, "cbrt(x)");
rounded_1ary!(RoundedRecip, recip, "1/x");
rounded_1ary!(RoundedRecipSqrt, recip_sqrt, "1/sqrt(x)");
rounded_1ary!(RoundedExp, exp, "exp(x)");
rounded_1ary!(RoundedExp2, exp2, "2^x");
rounded_1ary!(RoundedLog, log, "ln(x)");
rounded_1ary!(RoundedLog2, log2, "log2(x)");
rounded_1ary!(RoundedLog10, log10, "log10(x)");
rounded_1ary!(RoundedExpm1, expm1, "e^x - 1");
rounded_1ary!(RoundedExp2m1, exp2m1, "2^x - 1");
rounded_1ary!(RoundedExp10m1, exp10m1, "10^x - 1");
rounded_1ary!(RoundedLog1p, log1p, "log(x + 1)");
rounded_1ary!(RoundedLog2p1, log2p1, "log2(x + 1)");
rounded_1ary!(RoundedLog10p1, log10p1, "log10(x + 1)");
rounded_1ary!(RoundedSin, sin, "sin(x)");
rounded_1ary!(RoundedCos, cos, "cos(x)");
rounded_1ary!(RoundedTan, tan, "tan(x)");
rounded_1ary!(RoundedSinPi, sin_pi, "sin(pi * x)");
rounded_1ary!(RoundedCosPi, cos_pi, "cos(pi * x)");
rounded_1ary!(RoundedTanPi, tan_pi, "tan(pi * x)");
rounded_1ary!(RoundedAsin, asin, "arcsin(x)");
rounded_1ary!(RoundedAcos, acos, "arccos(x)");
rounded_1ary!(RoundedAtan, atan, "arctan(x)");
rounded_1ary!(RoundedSinh, sinh, "sinh(x)");
rounded_1ary!(RoundedCosh, cosh, "cosh(x)");
rounded_1ary!(RoundedTanh, tanh, "tanh(x)");
rounded_1ary!(RoundedAsinh, asinh, "arsinh(x)");
rounded_1ary!(RoundedAcosh, acosh, "arcosh(x)");
rounded_1ary!(RoundedAtanh, atanh, "artanh(x)");
rounded_1ary!(RoundedErf, erf, "erf(x)");
rounded_1ary!(RoundedErfc, erfc, "erfc(x)");
rounded_1ary!(RoundedGamma, tgamma, "tgamma(x)");
rounded_1ary!(RoundedLgamma, lgamma, "lgamma(x)");

macro_rules! rounded_2ary {
    ($trait:ident, $impl:ident, $descr:expr) => {
        #[doc = "Rounded `"]
        #[doc = $descr]
        #[doc = "` for rounding contexts."]
        pub trait $trait: RoundingContext {
            #[doc = "Performs rounded `"]
            #[doc = $descr]
            #[doc = "`."]
            fn $impl<N1, N2>(&self, src1: &N1, src2: &N2) -> Self::Format
            where
                N1: Real,
                N2: Real;
        }

        #[doc = "Computes `"]
        #[doc = $descr]
        #[doc = "` and rounds according to the [`RoundingContext`] ctx."]
        pub fn $impl<Ctx, N1, N2>(ctx: &Ctx, src1: &N1, src2: &N2) -> Ctx::Format
        where
            Ctx: $trait,
            N1: Real,
            N2: Real,
        {
            ctx.$impl(src1, src2)
        }
    };
}

// Traits for 2-ary operators
rounded_2ary!(RoundedAdd, add, "x + y");
rounded_2ary!(RoundedSub, sub, "x - y");
rounded_2ary!(RoundedMul, mul, "x * y");
rounded_2ary!(RoundedDiv, div, "x / y");
rounded_2ary!(RoundedPow, pow, "x ^ y");
rounded_2ary!(RoundedHypot, hypot, "sqrt(x^2 + y^2)");
rounded_2ary!(RoundedFmod, fmod, "fmod(x, y)");
rounded_2ary!(RoundedRemainder, remainder, "remainder(x, y)");
rounded_2ary!(RoundedAtan2, atan2, "arctan(y / x)");

macro_rules! rounded_3ary {
    ($trait:ident, $impl:ident, $descr:expr) => {
        #[doc = "Rounded `"]
        #[doc = $descr]
        #[doc = "` for rounding contexts."]
        pub trait $trait: RoundingContext {
            #[doc = "Performs rounded `"]
            #[doc = $descr]
            #[doc = "`."]
            fn $impl<N1, N2, N3>(&self, src1: &N1, src2: &N2, src3: &N3) -> Self::Format
            where
                N1: Real,
                N2: Real,
                N3: Real;
        }

        #[doc = "Computes `"]
        #[doc = $descr]
        #[doc = "` and rounds according to the [`RoundingContext`] ctx."]
        pub fn $impl<Ctx, N1, N2, N3>(ctx: &Ctx, src1: &N1, src2: &N2, src3: &N3) -> Ctx::Format
        where
            Ctx: $trait,
            N1: Real,
            N2: Real,
            N3: Real,
        {
            ctx.$impl(src1, src2, src3)
        }
    };
}

// Traits for 3-ary operators
rounded_3ary!(RoundedFMA, fma, "a*b + c");