Add float comparison operators

Author: ianfixes

CHANGELOG.md

@@ -10,6 +10,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Environment variable to run a custom initiialization script during CI testing: `CUSTOM_INIT_SCRIPT`
 - Environment variable to run from a subdirectory during CI testing: `USE_SUBDIR`
 - `assertComparativeEqual()` and `assertComparativeNotEqual()` to evaluate equality on an `a - b == 0` basis (and/or `!(a > b) && !(a < b)`)
+- `assertEqualFloat()` and `assertNotEqualFloat()` for comparing floats with epsilon
+- `assertEqualINF()` and `assertNotEqualINF()` for comparing floats to infinity
+- `assertEqualNAN()` and `assertNotEqualNAN()` for comparing floats to `NaN`
 
 ### Changed
 - Rubocop expected syntax downgraded from ruby 2.6 to 2.5

REFERENCE.md

@@ -220,6 +220,14 @@ assertMoreOrEqual(lowerBound, actual);       // a >= b
 assertTrue(actual);
 assertFalse(actual);
 assertNull(actual);
+
+// special cases for floats
+assertEqualFloat(expected, actual, epsilon);    // fabs(a - b) <= epsilon
+assertNotEqualFloat(unwanted, actual, epsilon); // fabs(a - b) >= epsilon
+assertEqualINF(actual);
+assertNotEqualINF(actual);
+assertEqualNAN(arg);
+assertNotEqualNAN(arg);
 ```
 
 These functions will report the result of the test to the console, and the testing will continue if they fail.

SampleProjects/DoSomething/test/bad-errormessages.cpp

@@ -19,6 +19,13 @@ unittest(check_that_assertion_error_messages_are_comprehensible)
   assertFalse(true);
   assertNull(3);
   assertNotNull(NULL);
+
+  assertEqualFloat(1.2, 1.0, 0.01);
+  assertNotEqualFloat(1.0, 1.02, 0.1);
+  assertEqualINF(42);
+  assertNotEqualINF(INFINITY);
+  assertEqualNAN(42);
+  assertNotEqualNAN(0.0/0.0);
 }
 
 unittest_main()

SampleProjects/DoSomething/test/good-assert.cpp

@@ -32,4 +32,15 @@ unittest(assert_equal_without_total_ordering)
 
 }
 
+unittest(float_assertions)
+{
+  assertEqualINF(exp(800));
+  assertEqualINF(0.0/0.0);
+  assertNotEqualINF(42);
+
+  assertEqualNAN(INFINITY - INFINITY);
+  assertEqualNAN(0.0/0.0);
+  assertNotEqualNAN(42);
+}
+
 unittest_main()

cpp/unittest/Assertion.h

@@ -43,6 +43,14 @@
 #define assertNull(arg) assertEqual((void*)NULL, (void*)arg)
 #define assertNotNull(arg) assertNotEqual((void*)NULL, (void*)arg)
 
+#define assertEqualFloat(arg1, arg2, arg3)    assertOp("assertEqualFloat", "upperBound", arg3, compareMoreOrEqual, ">=", "actual", fabs(arg1 - arg2))
+#define assertNotEqualFloat(arg1, arg2, arg3) assertOp("assertNotEqualFloat", "lowerBound", arg3, compareLessOrEqual, "<=", "actual", fabs(arg1 - arg2))
+#define assertEqualINF(arg)                   assertOp("assertEqualINF", "expected", INFINITY, compareEqual, "==", "actual", arg)
+#define assertNotEqualINF(arg)                assertOp("assertNotEqualINF", "unwanted", INFINITY, compareNotEqual, "!=", "actual", arg)
+#define assertEqualNAN(arg)                   assertOp("assertEqualNAN", "expected", true, compareEqual, "==", "actual", isnan(arg))
+#define assertNotEqualNAN(arg)                assertOp("assertNotEqualNAN", "unwanted", true, compareNotEqual, "!=", "actual", isnan(arg))
+
+
 /** macro generates optional output and calls fail() followed by a return if false. */
 #define assureEqual(arg1,arg2)               assureOp("assureEqual","expected",arg1,evaluateDoubleEqual,"==","actual",arg2)
 #define assureNotEqual(arg1,arg2)            assureOp("assureNotEqual","unwanted",arg1,evaluateNotEqual,"!=","actual",arg2)
@@ -56,3 +64,10 @@
 #define assureFalse(arg) assureEqual(false, arg)
 #define assureNull(arg) assureEqual((void*)NULL, (void*)arg)
 #define assureNotNull(arg) assureNotEqual((void*)NULL, (void*)arg)
+
+#define assureEqualFloat(arg1, arg2, arg3)    assureOp("assertEqualFloat", "upperBound", arg3, compareMoreOrEqual, ">=", "actual", fabs(arg1 - arg2))
+#define assureNotEqualFloat(arg1, arg2, arg3) assureOp("assertNotEqualFloat", "lowerBound", arg3, compareLessOrEqual, "<=", "actual", fabs(arg1 - arg2))
+#define assureEqualINF(arg)                   assureOp("assertEqualINF", "expected", INFINITY, compareEqual, "==", "actual", arg)
+#define assureNotEqualINF(arg)                assureOp("assertNotEqualINF", "unwanted", INFINITY, compareNotEqual, "!=", "actual", arg)
+#define assureEqualNAN(arg)                   assureOp("assertEqualNAN", "expected", true, compareEqual, "==", "actual", isnan(arg))
+#define assureNotEqualNAN(arg)                assureOp("assertNotEqualNAN", "unwanted", true, compareNotEqual, "!=", "actual", isnan(arg))