xref: /aosp_15_r20/external/llvm-libc/test/src/math/smoke/FDimTest.h (revision 71db0c75aadcf003ffe3238005f61d7618a3fead)
1*71db0c75SAndroid Build Coastguard Worker //===-- Utility class to test different flavors of fdim ---------*- C++ -*-===//
2*71db0c75SAndroid Build Coastguard Worker //
3*71db0c75SAndroid Build Coastguard Worker // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4*71db0c75SAndroid Build Coastguard Worker // See https://llvm.org/LICENSE.txt for license information.
5*71db0c75SAndroid Build Coastguard Worker // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6*71db0c75SAndroid Build Coastguard Worker //
7*71db0c75SAndroid Build Coastguard Worker //===---------------------------------------------------------------------===//
8*71db0c75SAndroid Build Coastguard Worker 
9*71db0c75SAndroid Build Coastguard Worker #include "src/__support/CPP/algorithm.h"
10*71db0c75SAndroid Build Coastguard Worker #include "src/__support/FPUtil/FPBits.h"
11*71db0c75SAndroid Build Coastguard Worker #include "test/UnitTest/FEnvSafeTest.h"
12*71db0c75SAndroid Build Coastguard Worker #include "test/UnitTest/FPMatcher.h"
13*71db0c75SAndroid Build Coastguard Worker #include "test/UnitTest/Test.h"
14*71db0c75SAndroid Build Coastguard Worker 
15*71db0c75SAndroid Build Coastguard Worker using LIBC_NAMESPACE::Sign;
16*71db0c75SAndroid Build Coastguard Worker 
17*71db0c75SAndroid Build Coastguard Worker template <typename T>
18*71db0c75SAndroid Build Coastguard Worker class FDimTestTemplate : public LIBC_NAMESPACE::testing::FEnvSafeTest {
19*71db0c75SAndroid Build Coastguard Worker public:
20*71db0c75SAndroid Build Coastguard Worker   using FuncPtr = T (*)(T, T);
21*71db0c75SAndroid Build Coastguard Worker   using FPBits = LIBC_NAMESPACE::fputil::FPBits<T>;
22*71db0c75SAndroid Build Coastguard Worker   using StorageType = typename FPBits::StorageType;
23*71db0c75SAndroid Build Coastguard Worker 
24*71db0c75SAndroid Build Coastguard Worker   const T inf = FPBits::inf(Sign::POS).get_val();
25*71db0c75SAndroid Build Coastguard Worker   const T neg_inf = FPBits::inf(Sign::NEG).get_val();
26*71db0c75SAndroid Build Coastguard Worker   const T zero = FPBits::zero(Sign::POS).get_val();
27*71db0c75SAndroid Build Coastguard Worker   const T neg_zero = FPBits::zero(Sign::NEG).get_val();
28*71db0c75SAndroid Build Coastguard Worker   const T nan = FPBits::quiet_nan().get_val();
29*71db0c75SAndroid Build Coastguard Worker 
test_nan_arg(FuncPtr func)30*71db0c75SAndroid Build Coastguard Worker   void test_nan_arg(FuncPtr func) {
31*71db0c75SAndroid Build Coastguard Worker     EXPECT_FP_EQ(nan, func(nan, inf));
32*71db0c75SAndroid Build Coastguard Worker     EXPECT_FP_EQ(nan, func(neg_inf, nan));
33*71db0c75SAndroid Build Coastguard Worker     EXPECT_FP_EQ(nan, func(nan, zero));
34*71db0c75SAndroid Build Coastguard Worker     EXPECT_FP_EQ(nan, func(neg_zero, nan));
35*71db0c75SAndroid Build Coastguard Worker     EXPECT_FP_EQ(nan, func(nan, T(-1.2345)));
36*71db0c75SAndroid Build Coastguard Worker     EXPECT_FP_EQ(nan, func(T(1.2345), nan));
37*71db0c75SAndroid Build Coastguard Worker     EXPECT_FP_EQ(func(nan, nan), nan);
38*71db0c75SAndroid Build Coastguard Worker   }
39*71db0c75SAndroid Build Coastguard Worker 
test_inf_arg(FuncPtr func)40*71db0c75SAndroid Build Coastguard Worker   void test_inf_arg(FuncPtr func) {
41*71db0c75SAndroid Build Coastguard Worker     EXPECT_FP_EQ(zero, func(neg_inf, inf));
42*71db0c75SAndroid Build Coastguard Worker     EXPECT_FP_EQ(inf, func(inf, zero));
43*71db0c75SAndroid Build Coastguard Worker     EXPECT_FP_EQ(zero, func(neg_zero, inf));
44*71db0c75SAndroid Build Coastguard Worker     EXPECT_FP_EQ(inf, func(inf, T(1.2345)));
45*71db0c75SAndroid Build Coastguard Worker     EXPECT_FP_EQ(zero, func(T(-1.2345), inf));
46*71db0c75SAndroid Build Coastguard Worker   }
47*71db0c75SAndroid Build Coastguard Worker 
test_neg_inf_arg(FuncPtr func)48*71db0c75SAndroid Build Coastguard Worker   void test_neg_inf_arg(FuncPtr func) {
49*71db0c75SAndroid Build Coastguard Worker     EXPECT_FP_EQ(inf, func(inf, neg_inf));
50*71db0c75SAndroid Build Coastguard Worker     EXPECT_FP_EQ(zero, func(neg_inf, zero));
51*71db0c75SAndroid Build Coastguard Worker     EXPECT_FP_EQ(inf, func(neg_zero, neg_inf));
52*71db0c75SAndroid Build Coastguard Worker     EXPECT_FP_EQ(zero, func(neg_inf, T(-1.2345)));
53*71db0c75SAndroid Build Coastguard Worker     EXPECT_FP_EQ(inf, func(T(1.2345), neg_inf));
54*71db0c75SAndroid Build Coastguard Worker   }
55*71db0c75SAndroid Build Coastguard Worker 
test_both_zero(FuncPtr func)56*71db0c75SAndroid Build Coastguard Worker   void test_both_zero(FuncPtr func) {
57*71db0c75SAndroid Build Coastguard Worker     EXPECT_FP_EQ(zero, func(zero, zero));
58*71db0c75SAndroid Build Coastguard Worker     EXPECT_FP_EQ(zero, func(zero, neg_zero));
59*71db0c75SAndroid Build Coastguard Worker     EXPECT_FP_EQ(zero, func(neg_zero, zero));
60*71db0c75SAndroid Build Coastguard Worker     EXPECT_FP_EQ(zero, func(neg_zero, neg_zero));
61*71db0c75SAndroid Build Coastguard Worker   }
62*71db0c75SAndroid Build Coastguard Worker 
test_in_range(FuncPtr func)63*71db0c75SAndroid Build Coastguard Worker   void test_in_range(FuncPtr func) {
64*71db0c75SAndroid Build Coastguard Worker     constexpr StorageType STORAGE_MAX =
65*71db0c75SAndroid Build Coastguard Worker         LIBC_NAMESPACE::cpp::numeric_limits<StorageType>::max();
66*71db0c75SAndroid Build Coastguard Worker     constexpr int COUNT = 100'001;
67*71db0c75SAndroid Build Coastguard Worker     constexpr StorageType STEP = LIBC_NAMESPACE::cpp::max(
68*71db0c75SAndroid Build Coastguard Worker         static_cast<StorageType>(STORAGE_MAX / COUNT), StorageType(1));
69*71db0c75SAndroid Build Coastguard Worker     StorageType v = 0, w = STORAGE_MAX;
70*71db0c75SAndroid Build Coastguard Worker     for (int i = 0; i <= COUNT; ++i, v += STEP, w -= STEP) {
71*71db0c75SAndroid Build Coastguard Worker       FPBits xbits(v), ybits(w);
72*71db0c75SAndroid Build Coastguard Worker       if (xbits.is_inf_or_nan())
73*71db0c75SAndroid Build Coastguard Worker         continue;
74*71db0c75SAndroid Build Coastguard Worker       if (ybits.is_inf_or_nan())
75*71db0c75SAndroid Build Coastguard Worker         continue;
76*71db0c75SAndroid Build Coastguard Worker 
77*71db0c75SAndroid Build Coastguard Worker       T x = xbits.get_val();
78*71db0c75SAndroid Build Coastguard Worker       T y = ybits.get_val();
79*71db0c75SAndroid Build Coastguard Worker 
80*71db0c75SAndroid Build Coastguard Worker       if (x > y) {
81*71db0c75SAndroid Build Coastguard Worker         EXPECT_FP_EQ(x - y, func(x, y));
82*71db0c75SAndroid Build Coastguard Worker       } else {
83*71db0c75SAndroid Build Coastguard Worker         EXPECT_FP_EQ(zero, func(x, y));
84*71db0c75SAndroid Build Coastguard Worker       }
85*71db0c75SAndroid Build Coastguard Worker     }
86*71db0c75SAndroid Build Coastguard Worker   }
87*71db0c75SAndroid Build Coastguard Worker };
88*71db0c75SAndroid Build Coastguard Worker 
89*71db0c75SAndroid Build Coastguard Worker #define LIST_FDIM_TESTS(T, func)                                               \
90*71db0c75SAndroid Build Coastguard Worker   using LlvmLibcFDimTest = FDimTestTemplate<T>;                                \
91*71db0c75SAndroid Build Coastguard Worker   TEST_F(LlvmLibcFDimTest, NaNArg) { test_nan_arg(&func); }                    \
92*71db0c75SAndroid Build Coastguard Worker   TEST_F(LlvmLibcFDimTest, InfArg) { test_inf_arg(&func); }                    \
93*71db0c75SAndroid Build Coastguard Worker   TEST_F(LlvmLibcFDimTest, NegInfArg) { test_neg_inf_arg(&func); }             \
94*71db0c75SAndroid Build Coastguard Worker   TEST_F(LlvmLibcFDimTest, BothZero) { test_both_zero(&func); }                \
95*71db0c75SAndroid Build Coastguard Worker   TEST_F(LlvmLibcFDimTest, InFloatRange) { test_in_range(&func); }             \
96*71db0c75SAndroid Build Coastguard Worker   static_assert(true, "Require semicolon.")
97