xref: /aosp_15_r20/external/llvm-libc/test/src/math/RoundEvenTest.h (revision 71db0c75aadcf003ffe3238005f61d7618a3fead)
1 //===-- Utility class to test roundeven[f|l] --------------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #ifndef LLVM_LIBC_TEST_SRC_MATH_ROUNDEVENTEST_H
10 #define LLVM_LIBC_TEST_SRC_MATH_ROUNDEVENTEST_H
11 
12 #include "src/__support/CPP/algorithm.h"
13 #include "test/UnitTest/FEnvSafeTest.h"
14 #include "test/UnitTest/FPMatcher.h"
15 #include "test/UnitTest/Test.h"
16 #include "utils/MPFRWrapper/MPFRUtils.h"
17 
18 #include "hdr/math_macros.h"
19 
20 namespace mpfr = LIBC_NAMESPACE::testing::mpfr;
21 
22 template <typename T>
23 class RoundEvenTest : public LIBC_NAMESPACE::testing::FEnvSafeTest {
24 
25   DECLARE_SPECIAL_CONSTANTS(T)
26 
27 public:
28   typedef T (*RoundEvenFunc)(T);
29 
testSpecialNumbers(RoundEvenFunc func)30   void testSpecialNumbers(RoundEvenFunc func) {
31     EXPECT_FP_EQ(zero, func(zero));
32     EXPECT_FP_EQ(neg_zero, func(neg_zero));
33 
34     EXPECT_FP_EQ(inf, func(inf));
35     EXPECT_FP_EQ(neg_inf, func(neg_inf));
36 
37     EXPECT_FP_EQ(aNaN, func(aNaN));
38   }
39 
testRoundedNumbers(RoundEvenFunc func)40   void testRoundedNumbers(RoundEvenFunc func) {
41     EXPECT_FP_EQ(T(1.0), func(T(1.0)));
42     EXPECT_FP_EQ(T(-1.0), func(T(-1.0)));
43     EXPECT_FP_EQ(T(10.0), func(T(10.0)));
44     EXPECT_FP_EQ(T(-10.0), func(T(-10.0)));
45     EXPECT_FP_EQ(T(1234.0), func(T(1234.0)));
46     EXPECT_FP_EQ(T(-1234.0), func(T(-1234.0)));
47   }
48 
testFractions(RoundEvenFunc func)49   void testFractions(RoundEvenFunc func) {
50     EXPECT_FP_EQ(T(0.0), func(T(0.5)));
51     EXPECT_FP_EQ(T(-0.0), func(T(-0.5)));
52     EXPECT_FP_EQ(T(0.0), func(T(0.115)));
53     EXPECT_FP_EQ(T(-0.0), func(T(-0.115)));
54     EXPECT_FP_EQ(T(1.0), func(T(0.715)));
55     EXPECT_FP_EQ(T(-1.0), func(T(-0.715)));
56     EXPECT_FP_EQ(T(1.0), func(T(1.3)));
57     EXPECT_FP_EQ(T(-1.0), func(T(-1.3)));
58     EXPECT_FP_EQ(T(2.0), func(T(1.5)));
59     EXPECT_FP_EQ(T(-2.0), func(T(-1.5)));
60     EXPECT_FP_EQ(T(2.0), func(T(1.75)));
61     EXPECT_FP_EQ(T(-2.0), func(T(-1.75)));
62     EXPECT_FP_EQ(T(11.0), func(T(10.65)));
63     EXPECT_FP_EQ(T(-11.0), func(T(-10.65)));
64     EXPECT_FP_EQ(T(123.0), func(T(123.25)));
65     EXPECT_FP_EQ(T(124.0), func(T(123.50)));
66     EXPECT_FP_EQ(T(124.0), func(T(123.75)));
67     EXPECT_FP_EQ(T(-123.0), func(T(-123.25)));
68     EXPECT_FP_EQ(T(-124.0), func(T(-123.50)));
69     EXPECT_FP_EQ(T(-124.0), func(T(-123.75)));
70     EXPECT_FP_EQ(T(124.0), func(T(124.50)));
71     EXPECT_FP_EQ(T(-124.0), func(T(-124.50)));
72   }
73 
testRange(RoundEvenFunc func)74   void testRange(RoundEvenFunc func) {
75     constexpr int COUNT = 100'000;
76     constexpr StorageType STEP = LIBC_NAMESPACE::cpp::max(
77         static_cast<StorageType>(STORAGE_MAX / COUNT), StorageType(1));
78     StorageType v = 0;
79     for (int i = 0; i <= COUNT; ++i, v += STEP) {
80       FPBits xbits(v);
81       T x = xbits.get_val();
82       if (xbits.is_inf_or_nan())
83         continue;
84 
85       ASSERT_MPFR_MATCH(mpfr::Operation::RoundEven, x, func(x), 0.0);
86     }
87   }
88 };
89 
90 #define LIST_ROUNDEVEN_TESTS(T, func)                                          \
91   using LlvmLibcRoundEvenTest = RoundEvenTest<T>;                              \
92   TEST_F(LlvmLibcRoundEvenTest, SpecialNumbers) { testSpecialNumbers(&func); } \
93   TEST_F(LlvmLibcRoundEvenTest, RoundedNubmers) { testRoundedNumbers(&func); } \
94   TEST_F(LlvmLibcRoundEvenTest, Fractions) { testFractions(&func); }           \
95   TEST_F(LlvmLibcRoundEvenTest, Range) { testRange(&func); }
96 
97 #endif // LLVM_LIBC_TEST_SRC_MATH_ROUNDEVENTEST_H
98