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