fastnum 0.7.4

Fast decimal numbers library
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
145
146

macro_rules! is_zero {
    ($sign: ident $bits: literal) => {
        doc::doc_comment! {
            $sign $bits,
            "Returns whether `self` is zero.",

            "assert!(" doc::type_str!($sign $bits) "::ZERO.is_zero());\n"
            "assert!(!" doc::type_str!($sign $bits) "::ONE.is_zero());\n"
        }
    };
}

pub(crate) use is_zero;

macro_rules! is_one {
    ($sign: ident $bits: literal) => {
        doc::doc_comment! {
            $sign $bits,
            "Returns whether `self` is one.",

            "assert!(" doc::type_str!($sign $bits) "::ONE.is_one());\n"
            "assert!(!" doc::type_str!($sign $bits) "::MAX.is_one());\n"
        }
    };
}

pub(crate) use is_one;

macro_rules! eq {
    ($sign: ident $bits: literal) => {
        doc::doc_comment! {
            $sign $bits,
            "Tests for `self` and `other` values to be equal, and is used by `==`."
        }
    };
}

pub(crate) use eq;

macro_rules! ne {
    ($sign: ident $bits: literal) => {
        doc::doc_comment! {
            $sign $bits,
            "Tests for `self` and `other` values to be not equal, and is used by `!=`."
        }
    };
}

pub(crate) use ne;

macro_rules! cmp {
    ($sign: ident $bits: literal) => {
        doc::doc_comment! {
            $sign $bits,
            "This method returns an [core::cmp::Ordering] between `self` and `other`.\n\n"
            "By convention, `self.cmp(&other)` returns the ordering matching the expression\n"
            "`self <operator> other` if true."
        }
    };
}

pub(crate) use cmp;

macro_rules! max {
    ($sign: ident $bits: literal) => {
        doc::doc_comment! {
            $sign $bits,
            "Compares and returns the maximum of two values.\n\n"
            "Returns the second argument if the comparison determines them to be equal."
        }
    };
}

pub(crate) use max;

macro_rules! min {
    ($sign: ident $bits: literal) => {
        doc::doc_comment! {
            $sign $bits,
            "Compares and returns the minimum of two values.\n\n"
            "Returns the first argument if the comparison determines them to be equal."
        }
    };
}

pub(crate) use min;

macro_rules! clamp {
    ($sign: ident $bits: literal) => {
        doc::doc_comment! {
            $sign $bits,
            "Restrict a value to a certain interval.\n\n"
            "Returns `max` if `self` is greater than `max`, and `min` if `self` is less than `min`."
            "Otherwise this returns `self`."

            "# Panics\n\n"
            "Panics if `min > max`."
        }
    };
}

pub(crate) use clamp;

macro_rules! lt {
    ($sign: ident $bits: literal) => {
        doc::doc_comment! {
            $sign $bits,
            "Tests less than (for `self` and `other`) and is used by the `<` operator."
        }
    };
}

pub(crate) use lt;

macro_rules! le {
    ($sign: ident $bits: literal) => {
        doc::doc_comment! {
            $sign $bits,
            "Tests less than or equal to (for `self` and `other`) and is used by the `<=` operator."
        }
    };
}

pub(crate) use le;

macro_rules! gt {
    ($sign: ident $bits: literal) => {
        doc::doc_comment! {
            $sign $bits,
            "Tests greater than (for `self` and `other`) and is used by the `>` operator."
        }
    };
}

pub(crate) use gt;

macro_rules! ge {
    ($sign: ident $bits: literal) => {
        doc::doc_comment! {
            $sign $bits,
            "Tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator."
        }
    };
}

pub(crate) use ge;