Merge pull request #101 from jonaspleyer/debug-macros

Add Debug macros

Author: jonaspleyer

approx/src/macros.rs

@@ -183,3 +183,64 @@ macro_rules! assert_ulps_ne {
         __assert_approx!(ulps_ne, $given, $expected $(, $opt = $val)*)
     };
 }
+
+macro_rules! make_debug (
+    ($new_name:ident, $macro_name:ident) => {make_debug!($new_name, $macro_name, $);};
+    ($new_name:ident, $macro_name:ident, $dol:tt) => {
+        /// Debug version of [`
+        #[doc = stringify!($macro_name)]
+        /// `].
+        ///
+        /// This macro is only active when the `cfg!(debug_assertions)` criterion is met.
+        /// This is usually the case when libraries are compiled in debug or release mode.
+        /// This macro will return `true` when `cfg!(debug_assertions)` is not active.
+        ///
+        /// ```text
+        /// if cfg!(debug_assertions) {
+        ///     // .. run macro
+        /// } else {
+        ///     true
+        /// }
+        /// ```
+        #[macro_export]
+        macro_rules! $new_name {
+            ($dol($to:tt)*) => {if cfg!(debug_assertions) {$macro_name!($dol($to)*)} else {true}}
+        }
+    };
+    (@assert $new_name:ident, $macro_name:ident) => {make_debug!(@assert $new_name, $macro_name, $);};
+    (@assert $new_name:ident, $macro_name:ident, $dol:tt) => {
+        /// Debug version of [`
+        #[doc = stringify!($macro_name)]
+        /// `]
+        ///
+        /// This macro is only active when the `cfg!(debug_assertions)` criterion is met.
+        /// This is usually the case when libraries are compiled in debug or release mode.
+        /// This macro  never panic when `cfg!(debug_assertions)` is not active.
+        ///
+        /// ```text
+        /// if cfg!(debug_assertions) {
+        ///     // .. run macro with assertion
+        /// }
+        /// ```
+        #[macro_export]
+        macro_rules! $new_name {
+            ($dol($to:tt)*) => {if cfg!(debug_assertions) {$macro_name!($dol($to)*)}}
+        }
+
+    };
+);
+
+make_debug!(debug_abs_diff_eq, abs_diff_eq);
+make_debug!(debug_abs_diff_ne, abs_diff_ne);
+make_debug!(@assert debug_assert_abs_diff_eq, assert_abs_diff_eq);
+make_debug!(@assert debug_assert_abs_diff_ne, assert_abs_diff_ne);
+
+make_debug!(debug_relative_eq, relative_eq);
+make_debug!(debug_relative_ne, relative_ne);
+make_debug!(@assert debug_assert_relative_eq, assert_relative_eq);
+make_debug!(@assert debug_assert_relative_ne, assert_relative_ne);
+
+make_debug!(debug_ulps_eq, ulps_eq);
+make_debug!(debug_ulps_ne, ulps_ne);
+make_debug!(@assert debug_assert_ulps_eq, assert_ulps_eq);
+make_debug!(@assert debug_assert_ulps_ne, assert_ulps_ne);

approx/tests/abs_diff_eq.rs

@@ -681,3 +681,18 @@ mod test_indexmap {
         );
     }
 }
+
+#[test]
+fn test_debug_abs_diff() {
+    let x = 1.0;
+    let y = if cfg!(debug_assertions) { 1.1 } else { 2.0 };
+    assert!(debug_abs_diff_eq!(x, y, epsilon = 0.15));
+    debug_assert_abs_diff_eq!(x, y, epsilon = 0.15);
+
+    let x = 50798.34f32;
+    let y = 29580.13f32;
+    let epsilon = if cfg!(debug_assertions) { 0.0 } else { 2.2e4 };
+
+    assert!(debug_abs_diff_ne!(x, y, epsilon = epsilon));
+    debug_assert_abs_diff_ne!(x, y, epsilon = epsilon);
+}

approx/tests/relative_eq.rs

@@ -703,3 +703,19 @@ mod test_indexmap {
         );
     }
 }
+
+#[test]
+fn test_debug_relative_diff() {
+    let x = 10.0;
+    let y = if cfg!(debug_assertions) { 11.1 } else { 2.0 };
+
+    debug_assert_relative_eq!(x, y, max_relative = 0.15);
+    assert!(debug_relative_eq!(x, y, max_relative = 0.15));
+
+    let x = 249587e-3;
+    let y = 248938e-3;
+    let max_relative = if cfg!(debug_assertions) { 0.0 } else { 1.0 };
+
+    debug_assert_relative_ne!(x, y, max_relative = max_relative);
+    assert!(debug_relative_ne!(x, y, max_relative = max_relative));
+}

approx/tests/ulps_eq.rs

@@ -658,3 +658,20 @@ mod test_indexmap {
         );
     }
 }
+
+#[test]
+fn test_debug_ulps_diff() {
+    let x = 83055.0;
+    let y = 83055.2;
+    let m = if cfg!(debug_assertions) { 3 } else { 0 };
+
+    debug_assert_ulps_ne!(x, y, max_ulps = m);
+    assert!(debug_ulps_ne!(x, y, max_ulps = m));
+
+    let x = 50798.34f32;
+    let y = 50798.13f32;
+    let m = if cfg!(debug_assertions) { 55 } else { 0 };
+
+    assert!(debug_ulps_eq!(x, y, max_ulps = m));
+    debug_assert_ulps_eq!(x, y, max_ulps = m);
+}