From a52b8580f01fa10778d9965ae15235c14f2bcb2c Mon Sep 17 00:00:00 2001
From: Pierre Wendling <[EMAIL REDACTED]>
Date: Fri, 27 May 2022 23:49:42 -0400
Subject: [PATCH] Test: Tidy up test descriptions and documentation.
Test function documentation now lists the input(s) and expected output(s).
Descriptions in TestCaseReference were updated.
---
test/testautomation_math.c | 678 +++++++++++++++++++++++--------------
1 file changed, 420 insertions(+), 258 deletions(-)
diff --git a/test/testautomation_math.c b/test/testautomation_math.c
index 1e34128c7b7..20628e528b0 100644
--- a/test/testautomation_math.c
+++ b/test/testautomation_math.c
@@ -8,21 +8,23 @@
#include "SDL.h"
#include "SDL_test.h"
+/* ================= Test Constants ================== */
+
/* Range tests parameters */
#define RANGE_TEST_ITERATIONS 10000000
#define RANGE_TEST_STEP SDL_MAX_UINT32 / RANGE_TEST_ITERATIONS
-/* Define the Euler constant */
+/* Margin of error for imprecise tests */
+#define EPSILON 1.0E-10
+
+/* Euler constant (used in exp/log) */
#ifndef M_E
#define EULER 2.7182818284590450907955982984276488423347473144531250
#else
#define EULER M_E
#endif
-/* Margin of error for imprecise tests */
-#define EPSILON 1.0E-10
-
-/* Square root of 3 */
+/* Square root of 3 (used in atan2) */
#define SQRT3 1.7320508075688771931766041234368458390235900878906250
/* ================= Test Structs ================== */
@@ -60,7 +62,7 @@ typedef double(SDLCALL *dd_to_d_func)(double, double);
* \brief Runs all the cases on a given function with a signature double -> double.
* The result is expected to be exact.
*
- * \param func_name, the name of the tested function.
+ * \param func_name, a printable name for the tested function.
* \param func, the function to call.
* \param cases, an array of all the cases.
* \param cases_size, the size of the cases array.
@@ -86,7 +88,7 @@ helper_dtod(const char *func_name, d_to_d_func func,
* \brief Runs all the cases on a given function with a signature double -> double.
* Checks if the result between expected +/- EPSILON.
*
- * \param func_name, the name of the tested function.
+ * \param func_name, a printable name for the tested function.
* \param func, the function to call.
* \param cases, an array of all the cases.
* \param cases_size, the size of the cases array.
@@ -115,7 +117,7 @@ helper_dtod_inexact(const char *func_name, d_to_d_func func,
* \brief Runs all the cases on a given function with a signature
* (double, double) -> double. The result is expected to be exact.
*
- * \param func_name, the name of the tested function.
+ * \param func_name, a printable name for the tested function.
* \param func, the function to call.
* \param cases, an array of all the cases.
* \param cases_size, the size of the cases array.
@@ -141,7 +143,7 @@ helper_ddtod(const char *func_name, dd_to_d_func func,
* \brief Runs all the cases on a given function with a signature
* (double, double) -> double. Checks if the result between expected +/- EPSILON.
*
- * \param func_name, the name of the tested function.
+ * \param func_name, a printable name for the tested function.
* \param func, the function to call.
* \param cases, an array of all the cases.
* \param cases_size, the size of the cases array.
@@ -172,7 +174,7 @@ helper_ddtod_inexact(const char *func_name, dd_to_d_func func,
* This function is only meant to test functions that returns the input value if it is
* integral: f(x) -> x for x in N.
*
- * \param func_name, the name of the tested function.
+ * \param func_name, a printable name for the tested function.
* \param func, the function to call.
*/
static int
@@ -211,7 +213,8 @@ helper_range(const char *func_name, d_to_d_func func)
/* SDL_floor tests functions */
/**
- * \brief Checks positive and negative infinity.
+ * Inputs: +/-Infinity.
+ * Expected: Infinity is returned as-is.
*/
static int
floor_infCases(void *args)
@@ -232,17 +235,22 @@ floor_infCases(void *args)
}
/**
- * \brief Checks positive and negative zero.
+ * Inputs: +/-0.0.
+ * Expected: Zero is returned as-is.
*/
static int
floor_zeroCases(void *args)
{
- const d_to_d zero_cases[] = { { 0.0, 0.0 }, { -0.0, -0.0 } };
+ const d_to_d zero_cases[] = {
+ { 0.0, 0.0 },
+ { -0.0, -0.0 }
+ };
return helper_dtod("Floor", SDL_floor, zero_cases, SDL_arraysize(zero_cases));
}
/**
- * \brief Checks the NaN case.
+ * Input: NAN.
+ * Expected: NAN is returned.
*/
static int
floor_nanCase(void *args)
@@ -255,7 +263,8 @@ floor_nanCase(void *args)
}
/**
- * \brief Checks round values (x.0) for themselves
+ * Inputs: integral values.
+ * Expected: the input value is returned as-is.
*/
static int
floor_roundNumbersCases(void *args)
@@ -274,7 +283,8 @@ floor_roundNumbersCases(void *args)
}
/**
- * \brief Checks a set of fractions
+ * Inputs: fractional values.
+ * Expected: the lower integral value is returned.
*/
static int
floor_fractionCases(void *args)
@@ -295,7 +305,8 @@ floor_fractionCases(void *args)
}
/**
- * \brief Checks a range of values between 0 and UINT32_MAX
+ * Inputs: values in the range [0, UINT32_MAX].
+ * Expected: the input value is returned as-is.
*/
static int
floor_rangeTest(void *args)
@@ -306,7 +317,8 @@ floor_rangeTest(void *args)
/* SDL_ceil tests functions */
/**
- * \brief Checks positive and negative infinity.
+ * Inputs: +/-Infinity.
+ * Expected: Infinity is returned as-is.
*/
static int
ceil_infCases(void *args)
@@ -327,17 +339,22 @@ ceil_infCases(void *args)
}
/**
- * \brief Checks positive and negative zero.
+ * Inputs: +/-0.0.
+ * Expected: Zero is returned as-is.
*/
static int
ceil_zeroCases(void *args)
{
- const d_to_d zero_cases[] = { { 0.0, 0.0 }, { -0.0, -0.0 } };
+ const d_to_d zero_cases[] = {
+ { 0.0, 0.0 },
+ { -0.0, -0.0 }
+ };
return helper_dtod("Ceil", SDL_ceil, zero_cases, SDL_arraysize(zero_cases));
}
/**
- * \brief Checks the NaN case.
+ * Input: NAN.
+ * Expected: NAN is returned.
*/
static int
ceil_nanCase(void *args)
@@ -350,7 +367,8 @@ ceil_nanCase(void *args)
}
/**
- * \brief Checks round values (x.0) for themselves
+ * Inputs: integral values.
+ * Expected: the input value is returned as-is.
*/
static int
ceil_roundNumbersCases(void *args)
@@ -369,7 +387,8 @@ ceil_roundNumbersCases(void *args)
}
/**
- * \brief Checks a set of fractions
+ * Inputs: fractional values.
+ * Expected: the higher integral value is returned.
*/
static int
ceil_fractionCases(void *args)
@@ -390,7 +409,8 @@ ceil_fractionCases(void *args)
}
/**
- * \brief Checks a range of values between 0 and UINT32_MAX
+ * Inputs: values in the range [0, UINT32_MAX].
+ * Expected: the input value is returned as-is.
*/
static int
ceil_rangeTest(void *args)
@@ -401,7 +421,8 @@ ceil_rangeTest(void *args)
/* SDL_trunc tests functions */
/**
- * \brief Checks positive and negative infinity.
+ * Inputs: +/-Infinity.
+ * Expected: Infinity is returned as-is.
*/
static int
trunc_infCases(void *args)
@@ -422,17 +443,22 @@ trunc_infCases(void *args)
}
/**
- * \brief Checks positive and negative zero.
+ * Inputs: +/-0.0.
+ * Expected: Zero is returned as-is.
*/
static int
trunc_zeroCases(void *args)
{
- const d_to_d zero_cases[] = { { 0.0, 0.0 }, { -0.0, -0.0 } };
+ const d_to_d zero_cases[] = {
+ { 0.0, 0.0 },
+ { -0.0, -0.0 }
+ };
return helper_dtod("Trunc", SDL_trunc, zero_cases, SDL_arraysize(zero_cases));
}
/**
- * \brief Checks the NaN case.
+ * Input: NAN.
+ * Expected: NAN is returned.
*/
static int
trunc_nanCase(void *args)
@@ -445,7 +471,8 @@ trunc_nanCase(void *args)
}
/**
- * \brief Checks round values (x.0) for themselves
+ * Inputs: integral values.
+ * Expected: the input value is returned as-is.
*/
static int
trunc_roundNumbersCases(void *args)
@@ -464,7 +491,8 @@ trunc_roundNumbersCases(void *args)
}
/**
- * \brief Checks a set of fractions
+ * Inputs: fractional values.
+ * Expected: the integral part is returned.
*/
static int
trunc_fractionCases(void *args)
@@ -485,7 +513,8 @@ trunc_fractionCases(void *args)
}
/**
- * \brief Checks a range of values between 0 and UINT32_MAX
+ * Inputs: values in the range [0, UINT32_MAX].
+ * Expected: the input value is returned as-is.
*/
static int
trunc_rangeTest(void *args)
@@ -496,7 +525,8 @@ trunc_rangeTest(void *args)
/* SDL_round tests functions */
/**
- * \brief Checks positive and negative infinity.
+ * Inputs: +/-Infinity.
+ * Expected: Infinity is returned as-is.
*/
static int
round_infCases(void *args)
@@ -517,17 +547,22 @@ round_infCases(void *args)
}
/**
- * \brief Checks positive and negative zero.
+ * Inputs: +/-0.0.
+ * Expected: Zero is returned as-is.
*/
static int
round_zeroCases(void *args)
{
- const d_to_d zero_cases[] = { { 0.0, 0.0 }, { -0.0, -0.0 } };
+ const d_to_d zero_cases[] = {
+ { 0.0, 0.0 },
+ { -0.0, -0.0 }
+ };
return helper_dtod("Round", SDL_round, zero_cases, SDL_arraysize(zero_cases));
}
/**
- * \brief Checks the NaN case.
+ * Input: NAN.
+ * Expected: NAN is returned.
*/
static int
round_nanCase(void *args)
@@ -540,7 +575,8 @@ round_nanCase(void *args)
}
/**
- * \brief Checks round values (x.0) for themselves
+ * Inputs: integral values.
+ * Expected: the input value is returned as-is.
*/
static int
round_roundNumbersCases(void *args)
@@ -559,7 +595,8 @@ round_roundNumbersCases(void *args)
}
/**
- * \brief Checks a set of fractions
+ * Inputs: fractional values.
+ * Expected: the nearest integral value is returned.
*/
static int
round_fractionCases(void *args)
@@ -580,7 +617,8 @@ round_fractionCases(void *args)
}
/**
- * \brief Checks a range of values between 0 and UINT32_MAX
+ * Inputs: values in the range [0, UINT32_MAX].
+ * Expected: the input value is returned as-is.
*/
static int
round_rangeTest(void *args)
@@ -591,7 +629,8 @@ round_rangeTest(void *args)
/* SDL_fabs tests functions */
/**
- * \brief Checks positive and negative infinity.
+ * Inputs: +/-Infinity.
+ * Expected: Positive Infinity is returned.
*/
static int
fabs_infCases(void *args)
@@ -612,17 +651,22 @@ fabs_infCases(void *args)
}
/**
- * \brief Checks positive and negative zero
+ * Inputs: +/-0.0.
+ * Expected: Positive zero is returned.
*/
static int
fabs_zeroCases(void *args)
{
- const d_to_d zero_cases[] = { { 0.0, 0.0 }, { -0.0, 0.0 } };
+ const d_to_d zero_cases[] = {
+ { 0.0, 0.0 },
+ { -0.0, 0.0 }
+ };
return helper_dtod("Fabs", SDL_fabs, zero_cases, SDL_arraysize(zero_cases));
}
/**
- * \brief Checks the NaN case.
+ * Input: NAN.
+ * Expected: NAN is returned.
*/
static int
fabs_nanCase(void *args)
@@ -635,7 +679,8 @@ fabs_nanCase(void *args)
}
/**
- * \brief Checks a range of values between 0 and UINT32_MAX
+ * Inputs: values in the range [0, UINT32_MAX].
+ * Expected: the input value is returned as-is.
*/
static int
fabs_rangeTest(void *args)
@@ -646,7 +691,8 @@ fabs_rangeTest(void *args)
/* SDL_copysign tests functions */
/**
- * \brief Checks positive and negative inifnity.
+ * Inputs: (+/-Infinity, +/-1.0).
+ * Expected: Infinity with the sign of 1.0 is returned.
*/
static int
copysign_infCases(void *args)
@@ -677,7 +723,8 @@ copysign_infCases(void *args)
}
/**
- * \brief Checks positive and negative zero.
+ * Inputs: (+/-0.0, +/-1.0).
+ * Expected: 0.0 with the sign of 1.0 is returned.
*/
static int
copysign_zeroCases(void *args)
@@ -692,7 +739,9 @@ copysign_zeroCases(void *args)
}
/**
- * \brief Checks the NaN cases.
+ * Inputs: (NAN, +/-1.0).
+ * Expected: NAN with the sign of 1.0 is returned.
+ * NOTE: On some platforms signed NAN is not supported, so we only check if the result is still NAN.
*/
static int
copysign_nanCases(void *args)
@@ -712,7 +761,8 @@ copysign_nanCases(void *args)
}
/**
- * \brief Checks a range of values between 0 and UINT32_MAX
+ * Inputs: values in the range [0, UINT32_MAX], +/-1.0.
+ * Expected: the input value with the sign of 1.0 is returned.
*/
static int
copysign_rangeTest(void *args)
@@ -754,7 +804,8 @@ copysign_rangeTest(void *args)
/* SDL_fmod tests functions */
/**
- * \brief Checks division of positive and negative inifnity.
+ * Inputs: (+/-Infinity, +/-1.0).
+ * Expected: NAN is returned.
*/
static int
fmod_divOfInfCases(void *args)
@@ -785,7 +836,8 @@ fmod_divOfInfCases(void *args)
}
/**
- * \brief Checks division by positive and negative inifnity.
+ * Inputs: (+/-1.0, +/-Infinity).
+ * Expected: 1.0 is returned as-is.
*/
static int
fmod_divByInfCases(void *args)
@@ -816,7 +868,8 @@ fmod_divByInfCases(void *args)
}
/**
- * \brief Checks division of positive and negative zero.
+ * Inputs: (+/-0.0, +/-1.0).
+ * Expected: Zero is returned as-is.
*/
static int
fmod_divOfZeroCases(void *args)
@@ -831,7 +884,8 @@ fmod_divOfZeroCases(void *args)
}
/**
- * \brief Checks division by positive and negative zero.
+ * Inputs: (+/-1.0, +/-0.0).
+ * Expected: NAN is returned.
*/
static int
fmod_divByZeroCases(void *args)
@@ -862,7 +916,8 @@ fmod_divByZeroCases(void *args)
}
/**
- * \brief Checks the NaN cases.
+ * Inputs: all permutation of NAN and +/-1.0.
+ * Expected: NAN is returned.
*/
static int
fmod_nanCases(void *args)
@@ -893,7 +948,8 @@ fmod_nanCases(void *args)
}
/**
- * \brief Checks a set of regular values.
+ * Inputs: values within the domain of the function.
+ * Expected: the correct result is returned.
*/
static int
fmod_regularCases(void *args)
@@ -908,7 +964,8 @@ fmod_regularCases(void *args)
}
/**
- * \brief Checks a range of values between 0 and UINT32_MAX
+ * Inputs: values in the range [0, UINT32_MAX] divided by 1.0.
+ * Expected: Positive zero is always returned.
*/
static int
fmod_rangeTest(void *args)
@@ -942,7 +999,8 @@ fmod_rangeTest(void *args)
/* SDL_exp tests functions */
/**
- * \brief Checks positive and negative infinity.
+ * Inputs: +/-Infinity.
+ * Expected: Infinity is returned as-is.
*/
static int
exp_infCases(void *args)
@@ -963,7 +1021,8 @@ exp_infCases(void *args)
}
/**
- * \brief Checks positive and negative zero.
+ * Inputs: +/-0.0.
+ * Expected: 1.0 is returned.
*/
static int
exp_zeroCases(void *args)
@@ -976,9 +1035,9 @@ exp_zeroCases(void *args)
}
/**
- * \brief Checks for overflow.
- *
- * This test is skipped for double types larger than 64 bits.
+ * Input: 710.0 (overflows for 64bits double).
+ * Expected: Infinity is returned.
+ * NOTE: This test is skipped for double types larger than 64 bits.
*/
static int
exp_overflowCase(void *args)
@@ -997,7 +1056,8 @@ exp_overflowCase(void *args)
}
/**
- * \brief Checks the base case of 1.0.
+ * Input: 1.0
+ * Expected: The euler constant.
*/
static int
exp_baseCase(void *args)
@@ -1010,7 +1070,8 @@ exp_baseCase(void *args)
}
/**
- * \brief Checks a set of regular cases.
+ * Inputs: values within the domain of the function.
+ * Expected: the correct result is returned.
*/
static int
exp_regularCases(void *args)
@@ -1033,7 +1094,8 @@ exp_regularCases(void *args)
/* SDL_log tests functions */
/**
- * \brief Checks limits (zeros and positive infinity).
+ * Inputs: Positive Infinity and +/-0.0.
+ * Expected: Positive and negative Infinity respectively.
*/
static int
log_limitCases(void *args)
@@ -1059,7 +1121,8 @@ log_limitCases(void *args)
}
/**
- * \brief Checks some base cases.
+ * Inputs: 1.0 and the Euler constant.
+ * Expected: 0.0 and 1.0 respectively.
*/
static int
log_baseCases(void *args)
@@ -1080,7 +1143,8 @@ log_baseCases(void *args)
}
/**
- * \brief Checks the nan cases.
+ * Inputs: NAN and a negative value.
+ * Expected: NAN is returned.
*/
static int
log_nanCases(void *args)
@@ -1101,7 +1165,8 @@ log_nanCases(void *args)
}
/**
- * \brief Checks a set of regular cases.
+ * Inputs: values within the domain of the function.
+ * Expected: the correct result is returned.
*/
static int
log_regularCases(void *args)
@@ -1119,7 +1184,8 @@ log_regularCases(void *args)
/* SDL_log10 tests functions */
/**
- * \brief Checks limits (zeros and positive infinity).
+ * Inputs: Positive Infinity and +/-0.0.
+ * Expected: Positive and negative Infinity respectively.
*/
static int
log10_limitCases(void *args)
@@ -1145,7 +1211,8 @@ log10_limitCases(void *args)
}
/**
- * \brief Checks some base cases.
+ * Inputs: Powers of ten from 0 to 9.
+ * Expected: the exact power of ten is returned.
*/
static int
log10_baseCases(void *args)
@@ -1166,7 +1233,8 @@ log10_baseCases(void *args)
}
/**
- * \brief Checks the nan cases.
+ * Inputs: NAN and a negative value.
+ * Expected: NAN is returned.
*/
static int
log10_nanCases(void *args)
@@ -1187,7 +1255,8 @@ log10_nanCases(void *args)
}
/**
- * \brief Checks a set of regular cases.
+ * Inputs: values within the domain of the function.
+ * Expected: the correct result is returned.
*/
static int
log10_regularCases(void *args)
@@ -1207,7 +1276,8 @@ log10_regularCases(void *args)
/* Tests with positive and negative infinities as exponents */
/**
- * \brief Checks the cases where the base is negative one and the exponent is infinity.
+ * Inputs: (-1.0, +/-Infinity).
+ * Expected: 1.0 is returned.
*/
static int
pow_baseNOneExpInfCases(void *args)
@@ -1227,7 +1297,8 @@ pow_baseNOneExpInfCases(void *args)
return TEST_COMPLETED;
}
/**
- * \brief Checks the case where the base is zero and the exponent is negative infinity.
+ * Inputs: (+/-0.0, -Infinity).
+ * Expected: Infinity is returned.
*/
static int
pow_baseZeroExpNInfCases(void *args)
@@ -1248,7 +1319,8 @@ pow_baseZeroExpNInfCases(void *args)
}
/**
- * \brief Checks the remaining cases where the exponent is infinity.
+ * Inputs: (x, +/-Infinity) where x is not +/-0.0.
+ * Expected: 0.0 when x < 1, Infinity when x > 1.
*/
static int
pow_expInfCases(void *args)
@@ -1281,7 +1353,8 @@ pow_expInfCases(void *args)
/* Tests with positive and negative infinities as base */
/**
- * \brief Checks the cases with positive infinity as base.
+ * Inputs: (Positive Infinity, x) where x is not +/-0.0.
+ * Expected: 0.0 when x is < 0, positive Infinity when x > 0.
*/
static int
pow_basePInfCases(void *args)
@@ -1312,7 +1385,12 @@ pow_basePInfCases(void *args)
}
/**
- * \brief Checks the cases with negative infinity as base.
+ * Inputs: (Negative Infinity, x) where x is not +/-0.0.
+ * Expected:
+ * - -0.0 when x is a negative odd integer,
+ * - 0.0 when x is a negative even integer or negative non-integer,
+ * - Negative Infinity when x is a positive odd integer,
+ * - Positive Infinity when x is a positive even integer or positive non-integer.
*/
static int
pow_baseNInfCases(void *args)
@@ -1352,10 +1430,13 @@ pow_baseNInfCases(void *args)
return TEST_COMPLETED;
}
-/* Tests related to nan */
+/* Tests related to NAN */
/**
- * \brief Checks the case where the base is finite and negative and exponent is finite and non-integer.
+ * Inputs:
+ * - finite and negative base,
+ * - finite and non-integer exponent.
+ * Expected: NAN is returned.
*/
static int
pow_badOperationCase(void *args)
@@ -1368,7 +1449,8 @@ pow_badOperationCase(void *args)
}
/**
- * \brief Checks the case where the exponent is nan but the base is 1.
+ * Inputs: (1.0, NAN)
+ * Expected: 1.0 is returned.
*/
static int
pow_base1ExpNanCase(void *args)
@@ -1381,7 +1463,8 @@ pow_base1ExpNanCase(void *args)
}
/**
- * \brief Checks the cases where the base is nan but the exponent is 0.
+ * Inputs: (NAN, +/-0.0)
+ * Expected: 1.0 is returned.
*/
static int
pow_baseNanExp0Cases(void *args)
@@ -1402,7 +1485,8 @@ pow_baseNanExp0Cases(void *args)
}
/**
- * \brief Checks the cases where either argument is nan.
+ * Inputs: NAN as base, exponent or both.
+ * Expected: NAN is returned.
*/
static int
pow_nanArgsCases(void *args)
@@ -1430,7 +1514,10 @@ pow_nanArgsCases(void *args)
/* Tests with positive and negative zeros as base */
/**
- * \brief Checks cases with negative zero as base and an odd exponent.
+ * Inputs: (-0.0, x) where x is an odd integer.
+ * Expected:
+ * - Negative Infinity with a negative exponent,
+ * - -0.0 with a positive exponent.
*/
static int
pow_baseNZeroExpOddCases(void *args)
@@ -1451,7 +1538,10 @@ pow_baseNZeroExpOddCases(void *args)
}
/**
- * \brief Checks cases with positive zero as base and an odd exponent.
+ * Inputs: (0.0, x) where x is an odd integer.
+ * Expected:
+ * - 0.0 with a positive exponent,
+ * - Positive Infinity with a negative exponent.
*/
static int
pow_basePZeroExpOddCases(void *args)
@@ -1472,7 +1562,12 @@ pow_basePZeroExpOddCases(void *args)
}
/**
- * \brief Checks cases with negative zero as base and the exponent is finite and even or non-integer.
+ * Inputs: (-0.0, x), with x either:
+ * - finite and even,
+ * - finite and non-integer.
+ * Expected:
+ * - Positive Infinity if the exponent is negative,
+ * - 0.0 if the exponent is positive.
*/
static int
pow_baseNZeroCases(void *args)
@@ -1503,7 +1598,12 @@ pow_baseNZeroCases(void *args)
}
/**
- * \brief Checks cases with positive zero as base and the exponent is finite and even or non-integer.
+ * Inputs: (0.0, x), with x either:
+ * - finite and even,
+ * - finite and non-integer.
+ * Expected:
+ * - Positive Infinity if the exponent is negative,
+ * - 0.0 if the exponent is positive.
*/
static int
pow_basePZeroCases(void *args)
@@ -1536,7 +1636,8 @@ pow_basePZeroCases(void *args)
/* Remaining tests */
/**
- * \brief Checks a set of regular values.
+ * Inputs: values within the domain of the function.
+ * Expected: the correct result is returned.
*/
static int
pow_regularCases(void *args)
@@ -1553,26 +1654,28 @@ pow_regularCases(void *args)
}
/**
- * \brief Checks the powers of two from 1 to 8.
+ * Inputs: (2.0, x), with x in range [0, 8].
+ * Expected: the correct result is returned.
*/
static int
pow_powerOfTwo(void *args)
{
const dd_to_d power_of_two_cases[] = {
- { 2.0, 1, 2.0 },
- { 2.0, 2, 4.0 },
- { 2.0, 3, 8.0 },
- { 2.0, 4, 16.0 },
- { 2.0, 5, 32.0 },
- { 2.0, 6, 64.0 },
- { 2.0, 7, 128.0 },
- { 2.0, 8, 256.0 },
+ { 2.0, 1.0, 2.0 },
+ { 2.0, 2.0, 4.0 },
+ { 2.0, 3.0, 8.0 },
+ { 2.0, 4.0, 16.0 },
+ { 2.0, 5.0, 32.0 },
+ { 2.0, 6.0, 64.0 },
+ { 2.0, 7.0, 128.0 },
+ { 2.0, 8.0, 256.0 },
};
return helper_ddtod("Pow", SDL_pow, power_of_two_cases, SDL_arraysize(power_of_two_cases));
}
/**
- * \brief Checks a range of values between 0 and UINT32_MAX to the power of 0.
+ * Inputs: values in the range [0, UINT32_MAX] to the power of +/-0.0.
+ * Expected: 1.0 is always returned.
*/
static int
pow_rangeTest(void *args)
@@ -1614,7 +1717,8 @@ pow_rangeTest(void *args)
/* SDL_sqrt tests functions */
/**
- * \brief Checks for positive infinity.
+ * Input: Positive Infinity.
+ * Expected: Positive Infinity is returned.
*/
static int
sqrt_infCase(void *args)
@@ -1627,7 +1731,8 @@ sqrt_infCase(void *args)
}
/**
- * \brief Checks for the nan case.
+ * Input: NAN.
+ * Expected: NAN is returned.
*/
static int
sqrt_nanCase(void *args)
@@ -1640,7 +1745,8 @@ sqrt_nanCase(void *args)
}
/**
- * \brief Checks for out of domain values (<0).
+ * Inputs: values outside the domain of the function.
+ * Expected: NAN is returned.
*/
static int
sqrt_outOfDomainCases(void *args)
@@ -1666,7 +1772,8 @@ sqrt_outOfDomainCases(void *args)
}
/**
- * \brief Checks a set of base cases.
+ * Inputs: +/-0.0 and 1.0.
+ * Expected: the input value is returned as-is.
*/
static int
sqrt_baseCases(void *args)
@@ -1680,7 +1787,8 @@ sqrt_baseCases(void *args)
}
/**
- * \brief Checks a set of regular cases.
+ * Inputs: values within the domain of the function.
+ * Expected: the correct result is returned.
*/
static int
sqrt_regularCases(void *args)
@@ -1700,7 +1808,8 @@ sqrt_regularCases(void *args)
/* SDL_scalbn tests functions */
/**
- * \brief Checks for positive and negative infinity arg.
+ * Input: (+/-Infinity, 1).
+ * Expected: Infinity is returned as-is.
*/
static int
scalbn_infCases(void *args)
@@ -1721,7 +1830,8 @@ scalbn_infCases(void *args)
}
/**
- * \brief Checks for positive and negative zero arg.
+ * Inputs: (+/-0.0, 1).
+ * Expected: Zero is returned as-is.
*/
static int
scalbn_baseZeroCases(void *args)
@@ -1742,7 +1852,8 @@ scalbn_baseZeroCases(void *args)
}
/**
- * \brief Checks for zero exp.
+ * Input: (x, 0)
+ * Expected: x is returned as-is.
*/
static int
scalbn_expZeroCase(void *args)
@@ -1755,7 +1866,8 @@ scalbn_expZeroCase(void *args)
}
/**
- * \brief Checks for NAN arg.
+ * Input: (NAN, x).
+ * Expected: NAN is returned.
*/
static int
scalbn_nanCase(void *args)
@@ -1768,9 +1880,9 @@ scalbn_nanCase(void *args)
}
/**
- * \brief Checks a set of regular values.
- *
- * This test depends on SDL_pow functionning.
+ * Inputs: values inside the domain of the function.
+ * Expected: the correct result is returned.
+ * NOTE: This test depends on SDL_pow and FLT_RADIX.
*/
static int
scalbn_regularCases(void *args)
@@ -1807,7 +1919,8 @@ scalbn_regularCases(void *args)
/* SDL_cos tests functions */
/**
- * \brief Checks positive and negative infinity.
+ * Inputs: +/-Infinity.
+ * Expected: NAN is returned.
*/
static int
cos_infCases(void *args)
@@ -1828,7 +1941,8 @@ cos_infCases(void *args)
}
/**
- * \brief Checks for nan.
+ * Input: NAN.
+ * Expected: NAN is returned.
*/
static int
cos_nanCase(void *args)
@@ -1841,7 +1955,8 @@ cos_nanCase(void *args)
}
/**
- * \brief Checks a set of regular values.
+ * Inputs: +/-0.0 and +/-Pi.
+ * Expected: +1.0 and -1.0 respectively.
*/
static int
cos_regularCases(void *args)
@@ -1856,7 +1971,8 @@ cos_regularCases(void *args)
}
/**
- * \brief Checks cosine precision for the first 10 decimals.
+ * Inputs: Angles between 1/10 and 9/10 of Pi (positive and negative).
+ * Expected: The correct result is returned (+/-EPSILON).
*/
static int
cos_precisionTest(void *args)
@@ -1885,7 +2001,8 @@ cos_precisionTest(void *args)
}
/**
- * \brief Checks a range of values between 0 and UINT32_MAX.
+ * Inputs: Values in the range [0, UINT32_MAX].
+ * Expected: A value between 0 and 1 is returned.
*/
static int
cos_rangeTest(void *args)
@@ -1919,7 +2036,8 @@ cos_rangeTest(void *args)
/* SDL_sin tests functions */
/**
- * \brief Checks positive and negative infinity.
+ * Inputs: +/-Infinity.
+ * Expected: NAN is returned.
*/
static int
sin_infCases(void *args)
@@ -1940,7 +2058,8 @@ sin_infCases(void *args)
}
/**
- * \brief Checks for nan.
+ * Input: NAN.
+ * Expected: NAN is returned.
*/
static int
sin_nanCase(void *args)
@@ -1953,7 +2072,8 @@ sin_nanCase(void *args)
}
/**
- * \brief Checks a set of regular values.
+ * Inputs: +/-0.0 and +/-Pi/2.
+ * Expected: +/-0.0 and +/-1.0 respectively.
*/
static int
sin_regularCases(void *args)
@@ -1968,7 +2088,9 @@ sin_regularCases(void *args)
}
/**
- * \brief Checks sine precision for the first 10 decimals.
+ * Inputs: Angles between 1/10 and 10/10 of Pi (positive and negative).
+ * Expected: The correct result is returned (+/-EPSILON).
+ * NOTE: +/-Pi/2 is tested in the regular cases.
*/
static int
sin_precisionTest(void *args)
@@ -1978,26 +2100,27 @@ sin_precisionTest(void *args)
{ M_PI * 2.0 / 10.0, 0.5877852522 },
{ M_PI * 3.0 / 10.0, 0.8090169943 },
{ M_PI * 4.0 / 10.0, 0.9510565162 },
- { M_PI * 5.0 / 10.0, 1.0 },
{ M_PI * 6.0 / 10.0, 0.9510565162 },
{ M_PI * 7.0 / 10.0, 0.8090169943 },
{ M_PI * 8.0 / 10.0, 0.5877852522 },
{ M_PI * 9.0 / 10.0, 0.3090169943 },
+ { M_PI, 0.0 },
{ M_PI * -1.0 / 10.0, -0.3090169943 },
{ M_PI * -2.0 / 10.0, -0.5877852522 },
{ M_PI * -3.0 / 10.0, -0.8090169943 },
{ M_PI * -4.0 / 10.0, -0.9510565162 },
- { M_PI * -5.0 / 10.0, -1.0 },
{ M_PI * -6.0 / 10.0, -0.9510565162 },
{ M_PI * -7.0 / 10.0, -0.8090169943 },
{ M_PI * -8.0 / 10.0, -0.5877852522 },
- { M_PI * -9.0 / 10.0, -0.3090169943 }
+ { M_PI * -9.0 / 10.0, -0.3090169943 },
+ { -M_PI, 0.0 },
};
return helper_dtod_inexact("Sin", SDL_sin, precision_cases, SDL_arraysize(precision_cases));
}
/**
- * \brief Checks a range of values between 0 and UINT32_MAX.
+ * Inputs: Values in the range [0, UINT32_MAX].
+ * Expected: A value between 0 and 1 is returned.
*/
static int
sin_rangeTest(void *args)
@@ -2031,7 +2154,8 @@ sin_rangeTest(void *args)
/* SDL_tan tests functions */
/**
- * \brief Checks positive and negative infinity.
+ * Inputs: +/-Infinity.
+ * Expected: NAN is returned.
*/
static int
tan_infCases(void *args)
@@ -2052,7 +2176,8 @@ tan_infCases(void *args)
}
/**
- * \brief Checks for nan.
+ * Input: NAN.
+ * Expected: NAN is returned.
*/
static int
tan_nanCase(void *args)
@@ -2065,7 +2190,8 @@ tan_nanCase(void *args)
}
/**
- * \brief Checks positive and negative zero.
+ * Inputs: +/-0.0.
+ * Expected: Zero is returned as-is.
*/
static int
tan_zeroCases(void *args)
@@ -2078,7 +2204,9 @@ tan_zeroCases(void *args)
}
/**
- * \brief Checks tangent precision for the first 10 decimals.
+ * Inputs: Angles between 1/11 and 10/11 of Pi (positive and negative).
+ * Expected: The correct result is returned (+/-EPSILON).
+ * NOTE: +/-Pi/2 is intentionally avoided as it returns garbage values.
*/
static int
tan_precisionTest(void *args)
@@ -2111,7 +2239,8 @@ tan_precisionTest(void *args)
/* SDL_acos tests functions */
/**
- * \brief Checks limits of the domain (+/-1).
+ * Inputs: +/-1.0.
+ * Expected: 0.0 and Pi respectively.
*/
static int
acos_limitCases(void *args)
@@ -2132,7 +2261,8 @@ acos_limitCases(void *args)
}
/**
- * \brief Checks values outside the domain (|x| > 1).
+ * Inputs: Values outside the domain of [-1, 1].
+ * Expected: NAN is returned.
*/
static int
acos_outOfDomainCases(void *args)
@@ -2153,7 +2283,8 @@ acos_outOfDomainCases(void *args)
}
/**
- * \brief Checks for nan.
+ * Input: NAN.
+ * Expected: NAN is returned.
*/
static int
acos_nanCase(void *args)
@@ -2166,7 +2297,8 @@ acos_nanCase(void *args)
}
/**
- * \brief Checks arc cosine precision for the first 10 decimals.
+ * Inputs: Values between -0.9 and 0.9 with steps of 0.1.
+ * Expected: The correct result is returned (+/-EPSILON).
*/
static int
acos_precisionTest(void *args)
@@ -2199,7 +2331,8 @@ acos_precisionTest(void *args)
/* SDL_asin tests functions */
/**
- * \brief Checks limits of the domain (+/-1).
+ * Inputs: +/-1.0.
+ * Expected: +/-Pi/2 is returned.
*/
static int
asin_limitCases(void *args)
@@ -2220,7 +2353,8 @@ asin_limitCases(void *args)
}
/**
- * \brief Checks values outside the domain (|x| > 1).
+ * Inputs: Values outside the domain of [-1, 1].
+ * Expected: NAN is returned.
*/
static int
asin_outOfDomainCases(void *args)
@@ -2241,7 +2375,8 @@ asin_outOfDomainCases(void *args)
}
/**
- * \brief Checks for nan.
+ * Input: NAN.
+ * Expected: NAN is returned.
*/
static int
asin_nanCase(void *args)
@@ -2254,7 +2389,8 @@ asin_nanCase(void *args)
}
/**
- * \brief Checks arc sine precision for the first 10 decimals.
+ * Inputs: Values between -0.9 and 0.9 with steps of 0.1.
+ * Expected: The correct result is returned (+/-EPSILON).
*/
static int
asin_precisionTest(void *
(Patch may be truncated, please check the link at the top of this post.)