floatguard 0.1.2

A library for checked floating-point arithmetic in Rust, safely elminating NaN and Infinity from floating-point computations.
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

#[macro_export]
macro_rules! math {
    (
        ($( $T:ty ),* )
        $doc:literal
        const fn $name:ident ($base:ident : $base_ty:ty) -> $returns:ty $implementation:block
    ) => {
        $(
            impl $T {
                #[doc = $doc]
                #[must_use = "method returns a new instance and does not mutate the original value"]
                #[inline(always)]
                pub const fn $name(self) -> $returns {
                    let $base: $base_ty = self.0;
                    $implementation
                }
            }
        )*
    };

    (
        ($( $T:ty ),*)
        $doc:literal
        fn $name:ident ($base:ident : $base_ty:ty) -> $ret:ty $implementation:block
    ) => {
        $(
            impl $T {
                #[doc = $doc]
                #[must_use = "method returns a new instance and does not mutate the original value"]
                #[inline(always)]
                pub fn $name(self) -> $ret {
                    let $base: $base_ty = self.0;
                    $implementation
                }
            }
        )*
    };

    (
        ($( $T:ty ),*)
        $doc:literal
        fn $name:ident ($base:ident : $base_ty:ty, $operand:ident : $operand_ty:ty ) -> $ret:ty $implementation:block
    ) => {
        $(
            impl $T {
                #[doc = $doc]
                #[must_use = "method returns a new instance and does not mutate the original value"]
                #[inline(always)]
                pub fn $name(self, $operand: $operand_ty) -> $ret {
                    let $base: $base_ty = self.0;
                    $implementation
                }
            }
        )*
    };
}