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

use crate::bint::doc;

macro_rules! impl_desc {
    () => {
        doc::arithmetic_impl_desc!("Strict", "strict", "Each method will always panic if overflow/underflow occurs (i.e. when the checked equivalent would return `None`), regardless of whether overflow checks are enabled.")
    };
}

pub(crate) use impl_desc;

doc::doc_comment_impl!(
    strict_abs,
    strict_add,
    strict_add_signed,
    strict_add_unsigned,
    strict_div,
    strict_div_euclid,
    strict_mul,
    strict_neg,
    strict_pow,
    strict_rem,
    strict_rem_euclid,
    strict_shl,
    strict_shr,
    strict_sub,
    strict_sub_unsigned
);

macro_rules! strict_power_of_five {
    ($sign: ident $bits: literal) => {
        doc::doc_comment! {
            $sign $bits,
            "Returns an integer whose value is 5^power.\n\n"

            "# Panics\n\n"
            "This function will panic if `5^power` is greater than [Self::MAX]",

            "assert_eq!(" doc::type_str!($sign $bits) "::strict_power_of_five(2), " doc::m!($sign $bits) "(25));\n"
        }
    };
}

pub(crate) use strict_power_of_five;

macro_rules! strict_power_of_ten {
    ($sign: ident $bits: literal) => {
        doc::doc_comment! {
            $sign $bits,
            "Returns an integer whose value is 10^power.\n\n"

            "# Panics\n\n"
            "This function will panic if `10^power` is greater than [Self::MAX]",

            "assert_eq!(" doc::type_str!($sign $bits) "::strict_power_of_ten(2), " doc::m!($sign $bits) "(100));\n"
        }
    };
}

pub(crate) use strict_power_of_ten;

macro_rules! strict_mul_digit {
    ($sign: ident $bits: literal) => {
        doc::doc_comment! {
            $sign $bits,
            "Strict integer multiplication by [`prim@u64`].\n\n"
            "Computes self * rhs, panicking if overflow occurred.\n\n"

            "# Panics\n\n"
            "This function will always panic on overflow, regardless of whether overflow checks are enabled."
        }
    };
}

pub(crate) use strict_mul_digit;