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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223

//! # Licensing
//! This Source Code is subject to the terms of the Mozilla Public License
//! version 2.0 (the "License"). You can obtain a copy of the License at
//! http://mozilla.org/MPL/2.0/.

/// Asserts that two expressions are approximately equal to each other.
///
/// You can optionally add an optional diff value. If you don't supply
///  a diff value as an argument, Tolerance::tolerance() is the default used.
///
/// # Examples
///
/// ```rust
/// # #[macro_use] extern crate appro_eq;
/// # fn main() {
/// assert_appro_eq!(1f64, 1.5f64, 0.6f64); // does not panic
/// assert_appro_eq!(0f64, 1e-12f64); // does not panic
/// assert_appro_eq!(vec![0f64, 1.0, 0.0], vec![1e-12f64, 1.0, -1e-13f64]); // does not panic
/// # }
/// ```
/// ```should_panic
/// # #[macro_use] extern crate appro_eq;
/// # fn main() {
/// assert_appro_eq!(1f64, 2f64); // panics
/// # }
/// ```
#[macro_export]
#[cfg_attr(feature = "docs", stable(feature = "default", since = "0.1.0"))]
macro_rules! assert_appro_eq {
    ($a:expr, $b:expr) => {{
        assert!(
            $crate::AbsApproEq::abs_appro_eq(&$a, &$b),
            "assertion failed: `(left == right)` (left: `{:?}` , right: `{:?}`)",
            $a,
            $b
        );
    }};
    ($a:expr, $b:expr, $eps:expr) => {{
        assert!(
            $crate::AbsApproEqWithTol::abs_appro_eq_with_tol(&$a, &$b, &$eps),
            "assertion failed: `(left == right)` (left: `{:?}` , right: `{:?}`, eps: `{:?}`)",
            $a,
            $b,
            $eps
        );
    }};
}

/// Asserts that the absolute error of the two expressions is small enough.
///
/// You can optionally add an optional diff value. If you don't supply
///  a diff value as an argument, Tolerance::tolerance() is the default used.
///
/// # Examples
///
/// ```rust
/// # #[macro_use] extern crate appro_eq;
/// # fn main() {
/// assert_appro_eq_abs!(1f64, 1.5f64, 0.6f64); // does not panic
/// assert_appro_eq_abs!(0f64, 1e-12f64); // does not panic
/// assert_appro_eq_abs!(vec![0f64, 1.0, 0.0], vec![1e-12f64, 1.0, -1e-13f64]); // does not panic
/// # }
/// ```
/// ```should_panic
/// # #[macro_use] extern crate appro_eq;
/// # fn main() {
/// assert_appro_eq_abs!(1f64, 2f64); // panics
/// # }
/// ```
#[macro_export]
#[cfg_attr(feature = "docs", stable(feature = "default", since = "0.1.0"))]
macro_rules! assert_appro_eq_abs {
    ($a:expr, $b:expr) => {{
        assert!(
            $crate::AbsApproEq::abs_appro_eq(&$a, &$b),
            "assertion failed: `(left == right)` (left: `{:?}` , right: `{:?}`)",
            $a,
            $b
        );
    }};
    ($a:expr, $b:expr, $eps:expr) => {{
        assert!(
            $crate::AbsApproEqWithTol::abs_appro_eq_with_tol(&$a, &$b, &$eps),
            "assertion failed: `(left == right)` (left: `{:?}` , right: `{:?}`, eps: `{:?}`)",
            $a,
            $b,
            $eps
        );
    }};
}

/// Asserts that the relative error of the two expressions is small enough.
///
/// You can optionally add an optional diff value. If you don't supply
///  a diff value as an argument, Tolerance::tolerance() is the default used.
///
/// # Examples
///
/// ```rust
/// # #[macro_use] extern crate appro_eq;
/// # fn main() {
/// assert_appro_eq_rel!(1f64, 1.5f64, 0.6f64); // does not panic
/// assert_appro_eq_rel!(1f64, 1.0 + 1e-12f64); // does not panic
/// assert_appro_eq_rel!(vec![1f64, 1.0, 1.0], vec![1.0 + 1e-12f64, 1.0, 1.0 - 1e-13f64]); // does not panic
/// # }
/// ```
/// ```should_panic
/// # #[macro_use] extern crate appro_eq;
/// # fn main() {
/// assert_appro_eq_rel!(1f64, 2f64); // panics
/// # }
/// ```
#[macro_export]
#[cfg_attr(feature = "docs", stable(feature = "default", since = "0.1.0"))]
macro_rules! assert_appro_eq_rel {
    ($a:expr, $b:expr) => {{
        assert!(
            $crate::RelApproEq::rel_appro_eq(&$a, &$b),
            "assertion failed: `(left == right)` (left: `{:?}` , right: `{:?}`)",
            $a,
            $b
        );
    }};
    ($a:expr, $b:expr, $eps:expr) => {{
        assert!(
            $crate::RelApproEqWithTol::rel_appro_eq_with_tol(&$a, &$b, &$eps),
            "assertion failed: `(left == right)` (left: `{:?}` , right: `{:?}`, eps: `{:?}`)",
            $a,
            $b,
            $eps
        );
    }};
}

/// Asserts that two expressions are approximately equal to each other.
///
/// You can optionally add an optional diff value. If you don't supply
///  a diff value as an argument, Tolerance::tolerance() is the default used.
///
/// Unlike assert_appro_eq!, debug_assert_appro_eq! statements are only enabled in non optimized builds by default.
/// An optimized build will omit all debug_assert_appro_eq! statements unless -C debug-assertions is passed to the compiler.
///
/// # Examples
///
/// ```rust
/// # #[macro_use] extern crate appro_eq;
/// # fn main() {
/// debug_assert_appro_eq!(1f64, 1.5f64, 0.6f64); // does not panic
/// debug_assert_appro_eq!(0f64, 1e-12f64); // does not panic
/// debug_assert_appro_eq!(vec![0f64, 1.0, 0.0], vec![1e-12f64, 1.0, -1e-13f64]); // does not panic
/// # }
/// ```
/// ```should_panic
/// # #[macro_use] extern crate appro_eq;
/// # fn main() {
/// debug_assert_appro_eq!(1f64, 2f64); // panics
/// # }
/// ```
#[macro_export]
#[cfg_attr(feature = "docs", stable(feature = "default", since = "0.1.0"))]
macro_rules! debug_assert_appro_eq {
    ($($arg:tt)*) => (if cfg!(debug_assertions) { assert_appro_eq!($($arg)*); })
}

/// Asserts that the absolute error of the two expressions is small enough.
///
/// You can optionally add an optional diff value. If you don't supply
///  a diff value as an argument, Tolerance::tolerance() is the default used.
///
/// Unlike assert_appro_eq_abs!, debug_assert_appro_eq_abs! statements are only enabled in non optimized builds by default.
/// An optimized build will omit all debug_assert_appro_eq_abs! statements unless -C debug-assertions is passed to the compiler.
///
/// # Examples
///
/// ```rust
/// # #[macro_use] extern crate appro_eq;
/// # fn main() {
/// debug_assert_appro_eq_abs!(1f64, 1.5f64, 0.6f64); // does not panic
/// debug_assert_appro_eq_abs!(0f64, 1e-12f64); // does not panic
/// debug_assert_appro_eq_abs!(vec![0f64, 1.0, 0.0], vec![1e-12f64, 1.0, -1e-13f64]); // does not panic
/// # }
/// ```
/// ```should_panic
/// # #[macro_use] extern crate appro_eq;
/// # fn main() {
/// debug_assert_appro_eq_abs!(1f64, 2f64); // panics
/// # }
/// ```
#[macro_export]
#[cfg_attr(feature = "docs", stable(feature = "default", since = "0.1.0"))]
macro_rules! debug_assert_appro_eq_abs {
    ($($arg:tt)*) => (if cfg!(debug_assertions) { assert_appro_eq_abs!($($arg)*); })
}

/// Asserts that the relative error of the two expressions is small enough.
///
/// You can optionally add an optional diff value. If you don't supply
///  a diff value as an argument, Tolerance::tolerance() is the default used.
///
/// Unlike assert_appro_eq_rel!, debug_assert_appro_eq_rel! statements are only enabled in non optimized builds by default.
/// An optimized build will omit all debug_assert_appro_eq_rel! statements unless -C debug-assertions is passed to the compiler.
///
/// # Examples
///
/// ```rust
/// # #[macro_use] extern crate appro_eq;
/// # fn main() {
/// debug_assert_appro_eq_rel!(1f64, 1.5f64, 0.6f64); // does not panic
/// debug_assert_appro_eq_rel!(1f64, 1.0 + 1e-12f64); // does not panic
/// debug_assert_appro_eq_rel!(vec![1f64, 1.0, 1.0], vec![1.0 + 1e-12f64, 1.0, 1.0 - 1e-13f64]); // does not panic
/// # }
/// ```
/// ```should_panic
/// # #[macro_use] extern crate appro_eq;
/// # fn main() {
/// debug_assert_appro_eq_rel!(1f64, 2f64); // panics
/// # }
/// ```
#[macro_export]
#[cfg_attr(feature = "docs", stable(feature = "default", since = "0.1.0"))]
macro_rules! debug_assert_appro_eq_rel {
    ($($arg:tt)*) => (if cfg!(debug_assertions) { assert_appro_eq_rel!($($arg)*); })
}