xref: /aosp_15_r20/external/llvm-libc/test/src/math/smoke/FMaximumMagNumTest.h (revision 71db0c75aadcf003ffe3238005f61d7618a3fead)
1 //===-- Utility class to test fmaximum_mag_num[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_SMOKE_FMAXIMUMMAG_NUMTEST_H
10 #define LLVM_LIBC_TEST_SRC_MATH_SMOKE_FMAXIMUMMAG_NUMTEST_H
11 
12 #include "src/__support/CPP/algorithm.h"
13 #include "src/__support/FPUtil/BasicOperations.h"
14 #include "src/__support/FPUtil/FPBits.h"
15 #include "test/UnitTest/FEnvSafeTest.h"
16 #include "test/UnitTest/FPMatcher.h"
17 #include "test/UnitTest/Test.h"
18 
19 template <typename T>
20 class FMaximumMagNumTest : public LIBC_NAMESPACE::testing::FEnvSafeTest {
21 
22   DECLARE_SPECIAL_CONSTANTS(T)
23 
24 public:
25   typedef T (*FMaximumMagNumFunc)(T, T);
26 
testNaN(FMaximumMagNumFunc func)27   void testNaN(FMaximumMagNumFunc func) {
28     EXPECT_FP_EQ(inf, func(aNaN, inf));
29     EXPECT_FP_EQ_WITH_EXCEPTION(inf, func(sNaN, inf), FE_INVALID);
30     EXPECT_FP_EQ(neg_inf, func(neg_inf, aNaN));
31     EXPECT_FP_EQ_WITH_EXCEPTION(neg_inf, func(neg_inf, sNaN), FE_INVALID);
32     EXPECT_EQ(FPBits(aNaN).uintval(), FPBits(func(aNaN, aNaN)).uintval());
33     EXPECT_FP_EQ(zero, func(aNaN, zero));
34     EXPECT_FP_EQ(neg_zero, func(neg_zero, aNaN));
35     EXPECT_FP_EQ_WITH_EXCEPTION(zero, func(sNaN, zero), FE_INVALID);
36     EXPECT_FP_EQ_WITH_EXCEPTION(neg_zero, func(neg_zero, sNaN), FE_INVALID);
37     EXPECT_FP_EQ(T(-1.2345), func(aNaN, T(-1.2345)));
38     EXPECT_FP_EQ(T(1.2345), func(T(1.2345), aNaN));
39     EXPECT_FP_EQ_WITH_EXCEPTION(T(-1.2345), func(sNaN, T(-1.2345)), FE_INVALID);
40     EXPECT_FP_EQ_WITH_EXCEPTION(T(1.2345), func(T(1.2345), sNaN), FE_INVALID);
41     EXPECT_FP_IS_NAN_WITH_EXCEPTION(func(aNaN, sNaN), FE_INVALID);
42     EXPECT_FP_IS_NAN_WITH_EXCEPTION(func(sNaN, aNaN), FE_INVALID);
43     EXPECT_EQ(FPBits(aNaN).uintval(), FPBits(func(aNaN, sNaN)).uintval());
44     EXPECT_EQ(FPBits(aNaN).uintval(), FPBits(func(sNaN, aNaN)).uintval());
45     EXPECT_EQ(FPBits(aNaN).uintval(), FPBits(func(sNaN, sNaN)).uintval());
46   }
47 
testInfArg(FMaximumMagNumFunc func)48   void testInfArg(FMaximumMagNumFunc func) {
49     EXPECT_FP_EQ(inf, func(neg_inf, inf));
50     EXPECT_FP_EQ(inf, func(inf, zero));
51     EXPECT_FP_EQ(inf, func(neg_zero, inf));
52     EXPECT_FP_EQ(inf, func(inf, T(1.2345)));
53     EXPECT_FP_EQ(inf, func(T(-1.2345), inf));
54   }
55 
testNegInfArg(FMaximumMagNumFunc func)56   void testNegInfArg(FMaximumMagNumFunc func) {
57     EXPECT_FP_EQ(inf, func(inf, neg_inf));
58     EXPECT_FP_EQ(neg_inf, func(neg_inf, zero));
59     EXPECT_FP_EQ(neg_inf, func(neg_zero, neg_inf));
60     EXPECT_FP_EQ(neg_inf, func(neg_inf, T(-1.2345)));
61     EXPECT_FP_EQ(neg_inf, func(T(1.2345), neg_inf));
62   }
63 
testBothZero(FMaximumMagNumFunc func)64   void testBothZero(FMaximumMagNumFunc func) {
65     EXPECT_FP_EQ(zero, func(zero, zero));
66     EXPECT_FP_EQ(zero, func(neg_zero, zero));
67     EXPECT_FP_EQ(zero, func(zero, neg_zero));
68     EXPECT_FP_EQ(neg_zero, func(neg_zero, neg_zero));
69   }
70 
testRange(FMaximumMagNumFunc func)71   void testRange(FMaximumMagNumFunc func) {
72     constexpr int COUNT = 100'001;
73     constexpr StorageType STEP = LIBC_NAMESPACE::cpp::max(
74         static_cast<StorageType>(STORAGE_MAX / COUNT), StorageType(1));
75     StorageType v = 0, w = STORAGE_MAX;
76     for (int i = 0; i <= COUNT; ++i, v += STEP, w -= STEP) {
77       FPBits xbits(v), ybits(w);
78       if (xbits.is_inf_or_nan())
79         continue;
80       if (ybits.is_inf_or_nan())
81         continue;
82       T x = xbits.get_val();
83       T y = ybits.get_val();
84       if ((x == 0) && (y == 0))
85         continue;
86 
87       if (LIBC_NAMESPACE::fputil::abs(x) > LIBC_NAMESPACE::fputil::abs(y))
88         EXPECT_FP_EQ(x, func(x, y));
89       else
90         EXPECT_FP_EQ(y, func(x, y));
91     }
92   }
93 };
94 
95 #define LIST_FMAXIMUM_MAG_NUM_TESTS(T, func)                                   \
96   using LlvmLibcFMaximumMagNumTest = FMaximumMagNumTest<T>;                    \
97   TEST_F(LlvmLibcFMaximumMagNumTest, NaN) { testNaN(&func); }                  \
98   TEST_F(LlvmLibcFMaximumMagNumTest, InfArg) { testInfArg(&func); }            \
99   TEST_F(LlvmLibcFMaximumMagNumTest, NegInfArg) { testNegInfArg(&func); }      \
100   TEST_F(LlvmLibcFMaximumMagNumTest, BothZero) { testBothZero(&func); }        \
101   TEST_F(LlvmLibcFMaximumMagNumTest, Range) { testRange(&func); }
102 
103 #endif // LLVM_LIBC_TEST_SRC_MATH_SMOKE_FMAXIMUMMAG_NUMTEST_H
104