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
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

/// Defines a binary operation for `GuardedF64` with the specified trait and method.
///
/// This macro generates implementations for various combinations of `GuardedF64`, `f64`, and `UnguardedF64`
/// types, allowing for flexible arithmetic operations while ensuring that the results are checked for validity.
///
/// # Arguments
///
/// * `$op_trait` - The trait representing the binary operation (e.g., `Add`, `Sub`, etc.).
/// * `$op_method` - The method name for the operation (e.g., `add`, `sub`, etc.).
/// * `$implementation` - A block of code that defines how the operation is performed.
/// * `$doc` - A documentation string that describes the operation and its usage.
#[macro_export]
macro_rules! binary_operation {
    (
        impl $op_trait:ident for ...($TGuarded:ty, $TUnguarded:ty) {
            $doc:literal
            fn $op_method:ident ($lhs:ident : $lhs_internal:ty, $rhs:ident : $rhs_internal:ty) -> $ret:ty
            $implementation:block
        }
    ) => {
        binary_operation!(
            $op_trait :: $op_method
            $doc
            fn ($lhs: $TGuarded, $rhs: $rhs_internal) -> $ret {
                let $lhs: $lhs_internal = $lhs.0;
                $implementation
            }
        );

        binary_operation!(
            $op_trait :: $op_method
            $doc
            fn ($lhs: $TUnguarded, $rhs: $rhs_internal) -> $ret {
                let $lhs: $lhs_internal = $lhs.0;
                $implementation
            }
        );

        binary_operation!(
            $op_trait :: $op_method
            $doc
            fn ($lhs: $lhs_internal, $rhs: $TGuarded) -> $ret {
                let $rhs: $rhs_internal = $rhs.0;
                $implementation
            }
        );

        binary_operation!(
            $op_trait :: $op_method
            $doc
            fn ($lhs: $lhs_internal, $rhs: $TUnguarded) -> $ret {
                let $rhs: $rhs_internal = $rhs.0;
                $implementation
            }
        );

        binary_operation!(
            $op_trait :: $op_method
            $doc
            fn ($lhs: $TGuarded, $rhs: $TGuarded) -> $ret {
                let $lhs: $lhs_internal = $lhs.0;
                let $rhs: $rhs_internal = $rhs.0;
                $implementation
            }
        );

        binary_operation!(
            $op_trait :: $op_method
            $doc
            fn ($lhs: $TGuarded, $rhs: $TUnguarded) -> $ret {
                let $lhs: $lhs_internal = $lhs.0;
                let $rhs: $rhs_internal = $rhs.0;
                $implementation
            }
        );

        binary_operation!(
            $op_trait :: $op_method
            $doc
            fn ($lhs: $TUnguarded, $rhs: $TGuarded) -> $ret {
                let $lhs: $lhs_internal = $lhs.0;
                let $rhs: $rhs_internal = $rhs.0;
                $implementation
            }
        );

        binary_operation!(
            $op_trait :: $op_method
            $doc
            fn ($lhs: $TUnguarded, $rhs: $TUnguarded) -> $ret {
                let $lhs: $lhs_internal = $lhs.0;
                let $rhs: $rhs_internal = $rhs.0;
                $implementation
            }
        );
    };

    (
        $op_trait:ident :: $op_method:ident
        $doc:literal
        fn ($lhs:ident : $LHS:ty, $rhs:ident : $RHS:ty) -> $ret:ty $implementation:block
    ) => {
        impl $op_trait<$RHS> for $LHS {
            type Output = $ret;

            #[doc = $doc]
            #[inline(always)]
            fn $op_method(self, $rhs: $RHS) -> Self::Output {
                let $lhs: $LHS = self;
                $implementation
            }
        }

        impl $op_trait<&$RHS> for $LHS {
            type Output = $ret;

            #[doc = $doc]
            #[inline(always)]
            fn $op_method(self, $rhs: &$RHS) -> Self::Output {
                self.$op_method(*$rhs)
            }
        }

        impl $op_trait<$RHS> for &$LHS {
            type Output = $ret;

            #[doc = $doc]
            #[inline(always)]
            fn $op_method(self, $rhs: $RHS) -> Self::Output {
                (*self).$op_method($rhs)
            }
        }

        impl $op_trait<&$RHS> for &$LHS {
            type Output = $ret;

            #[doc = $doc]
            #[inline(always)]
            fn $op_method(self, $rhs: &$RHS) -> Self::Output {
                (*self).$op_method(*$rhs)
            }
        }
    };
}