| //===-- Utility class to test different flavors of remquo -------*- C++ -*-===// |
| // |
| // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. |
| // See https://llvm.org/LICENSE.txt for license information. |
| // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception |
| // |
| //===----------------------------------------------------------------------===// |
| |
| #ifndef LLVM_LIBC_TEST_SRC_MATH_REMQUOTEST_H |
| #define LLVM_LIBC_TEST_SRC_MATH_REMQUOTEST_H |
| |
| #include "hdr/math_macros.h" |
| #include "src/__support/FPUtil/BasicOperations.h" |
| #include "src/__support/FPUtil/FPBits.h" |
| #include "test/UnitTest/FEnvSafeTest.h" |
| #include "test/UnitTest/FPMatcher.h" |
| #include "test/UnitTest/Test.h" |
| #include "utils/MPFRWrapper/MPFRUtils.h" |
| |
| namespace mpfr = LIBC_NAMESPACE::testing::mpfr; |
| |
| template <typename T> |
| class RemQuoTestTemplate : public LIBC_NAMESPACE::testing::FEnvSafeTest { |
| using FPBits = LIBC_NAMESPACE::fputil::FPBits<T>; |
| using StorageType = typename FPBits::StorageType; |
| |
| const T inf = FPBits::inf(Sign::POS).get_val(); |
| const T neg_inf = FPBits::inf(Sign::NEG).get_val(); |
| const T zero = FPBits::zero(Sign::POS).get_val(); |
| const T neg_zero = FPBits::zero(Sign::NEG).get_val(); |
| const T nan = FPBits::quiet_nan().get_val(); |
| |
| static constexpr StorageType MIN_SUBNORMAL = |
| FPBits::min_subnormal().uintval(); |
| static constexpr StorageType MAX_SUBNORMAL = |
| FPBits::max_subnormal().uintval(); |
| static constexpr StorageType MIN_NORMAL = FPBits::min_normal().uintval(); |
| static constexpr StorageType MAX_NORMAL = FPBits::max_normal().uintval(); |
| |
| public: |
| typedef T (*RemQuoFunc)(T, T, int *); |
| |
| void testSpecialNumbers(RemQuoFunc func) { |
| int quotient; |
| T x, y; |
| |
| y = T(1.0); |
| x = inf; |
| EXPECT_FP_EQ(nan, func(x, y, "ient)); |
| x = neg_inf; |
| EXPECT_FP_EQ(nan, func(x, y, "ient)); |
| |
| x = T(1.0); |
| y = zero; |
| EXPECT_FP_EQ(nan, func(x, y, "ient)); |
| y = neg_zero; |
| EXPECT_FP_EQ(nan, func(x, y, "ient)); |
| |
| y = nan; |
| x = T(1.0); |
| EXPECT_FP_EQ(nan, func(x, y, "ient)); |
| |
| y = T(1.0); |
| x = nan; |
| EXPECT_FP_EQ(nan, func(x, y, "ient)); |
| |
| x = nan; |
| y = nan; |
| EXPECT_FP_EQ(nan, func(x, y, "ient)); |
| |
| x = zero; |
| y = T(1.0); |
| EXPECT_FP_EQ(func(x, y, "ient), zero); |
| |
| x = neg_zero; |
| y = T(1.0); |
| EXPECT_FP_EQ(func(x, y, "ient), neg_zero); |
| |
| x = T(1.125); |
| y = inf; |
| EXPECT_FP_EQ(func(x, y, "ient), x); |
| EXPECT_EQ(quotient, 0); |
| } |
| |
| void testEqualNumeratorAndDenominator(RemQuoFunc func) { |
| T x = T(1.125), y = T(1.125); |
| int q; |
| |
| // When the remainder is zero, the standard requires it to |
| // have the same sign as x. |
| |
| EXPECT_FP_EQ(func(x, y, &q), zero); |
| EXPECT_EQ(q, 1); |
| |
| EXPECT_FP_EQ(func(x, -y, &q), zero); |
| EXPECT_EQ(q, -1); |
| |
| EXPECT_FP_EQ(func(-x, y, &q), neg_zero); |
| EXPECT_EQ(q, -1); |
| |
| EXPECT_FP_EQ(func(-x, -y, &q), neg_zero); |
| EXPECT_EQ(q, 1); |
| } |
| |
| void testSubnormalRange(RemQuoFunc func) { |
| constexpr StorageType COUNT = 100'001; |
| constexpr StorageType STEP = (MAX_SUBNORMAL - MIN_SUBNORMAL) / COUNT; |
| for (StorageType v = MIN_SUBNORMAL, w = MAX_SUBNORMAL; |
| v <= MAX_SUBNORMAL && w >= MIN_SUBNORMAL; v += STEP, w -= STEP) { |
| T x = FPBits(v).get_val(), y = FPBits(w).get_val(); |
| mpfr::BinaryOutput<T> result; |
| mpfr::BinaryInput<T> input{x, y}; |
| result.f = func(x, y, &result.i); |
| ASSERT_MPFR_MATCH(mpfr::Operation::RemQuo, input, result, 0.0); |
| } |
| } |
| |
| void testNormalRange(RemQuoFunc func) { |
| constexpr StorageType COUNT = 1'001; |
| constexpr StorageType STEP = (MAX_NORMAL - MIN_NORMAL) / COUNT; |
| for (StorageType v = MIN_NORMAL, w = MAX_NORMAL; |
| v <= MAX_NORMAL && w >= MIN_NORMAL; v += STEP, w -= STEP) { |
| T x = FPBits(v).get_val(), y = FPBits(w).get_val(); |
| mpfr::BinaryOutput<T> result; |
| mpfr::BinaryInput<T> input{x, y}; |
| result.f = func(x, y, &result.i); |
| |
| // In normal range on x86 platforms, the long double implicit 1 bit can be |
| // zero making the numbers NaN. Hence we test for them separately. |
| if (isnan(x) || isnan(y)) { |
| ASSERT_FP_EQ(result.f, nan); |
| continue; |
| } |
| |
| ASSERT_MPFR_MATCH(mpfr::Operation::RemQuo, input, result, 0.0); |
| } |
| } |
| }; |
| |
| #define LIST_REMQUO_TESTS(T, func) \ |
| using LlvmLibcRemQuoTest = RemQuoTestTemplate<T>; \ |
| TEST_F(LlvmLibcRemQuoTest, SpecialNumbers) { testSpecialNumbers(&func); } \ |
| TEST_F(LlvmLibcRemQuoTest, EqualNumeratorAndDenominator) { \ |
| testEqualNumeratorAndDenominator(&func); \ |
| } \ |
| TEST_F(LlvmLibcRemQuoTest, SubnormalRange) { testSubnormalRange(&func); } \ |
| TEST_F(LlvmLibcRemQuoTest, NormalRange) { testNormalRange(&func); } |
| |
| #endif // LLVM_LIBC_TEST_SRC_MATH_REMQUOTEST_H |