1 //===-- Unittests for sinf ------------------------------------------------===//
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 #include "include/errno.h"
10 #include "include/math.h"
11 #include "src/errno/llvmlibc_errno.h"
12 #include "src/math/sinf.h"
13 #include "test/src/math/sdcomp26094.h"
14 #include "utils/CPP/Array.h"
15 #include "utils/FPUtil/BitPatterns.h"
16 #include "utils/FPUtil/ClassificationFunctions.h"
17 #include "utils/FPUtil/FloatOperations.h"
18 #include "utils/FPUtil/FloatProperties.h"
19 #include "utils/MPFRWrapper/MPFRUtils.h"
20 #include "utils/UnitTest/Test.h"
21 
22 #include <stdint.h>
23 
24 using __llvm_libc::fputil::isNegativeQuietNaN;
25 using __llvm_libc::fputil::isQuietNaN;
26 using __llvm_libc::fputil::valueAsBits;
27 using __llvm_libc::fputil::valueFromBits;
28 
29 using BitPatterns = __llvm_libc::fputil::BitPatterns<float>;
30 
31 using __llvm_libc::testing::sdcomp26094Values;
32 
33 namespace mpfr = __llvm_libc::testing::mpfr;
34 
35 TEST(SinfTest, SpecialNumbers) {
36   llvmlibc_errno = 0;
37 
38   EXPECT_TRUE(
39       isQuietNaN(__llvm_libc::sinf(valueFromBits(BitPatterns::aQuietNaN))));
40   EXPECT_EQ(llvmlibc_errno, 0);
41 
42   EXPECT_TRUE(isNegativeQuietNaN(
43       __llvm_libc::sinf(valueFromBits(BitPatterns::aNegativeQuietNaN))));
44   EXPECT_EQ(llvmlibc_errno, 0);
45 
46   EXPECT_TRUE(isQuietNaN(
47       __llvm_libc::sinf(valueFromBits(BitPatterns::aSignallingNaN))));
48   EXPECT_EQ(llvmlibc_errno, 0);
49 
50   EXPECT_TRUE(isNegativeQuietNaN(
51       __llvm_libc::sinf(valueFromBits(BitPatterns::aNegativeSignallingNaN))));
52   EXPECT_EQ(llvmlibc_errno, 0);
53 
54   EXPECT_EQ(BitPatterns::zero,
55             valueAsBits(__llvm_libc::sinf(valueFromBits(BitPatterns::zero))));
56   EXPECT_EQ(llvmlibc_errno, 0);
57 
58   EXPECT_EQ(BitPatterns::negZero, valueAsBits(__llvm_libc::sinf(
59                                       valueFromBits(BitPatterns::negZero))));
60   EXPECT_EQ(llvmlibc_errno, 0);
61 
62   llvmlibc_errno = 0;
63   EXPECT_TRUE(isQuietNaN(__llvm_libc::sinf(valueFromBits(BitPatterns::inf))));
64   EXPECT_EQ(llvmlibc_errno, EDOM);
65 
66   llvmlibc_errno = 0;
67   EXPECT_TRUE(
68       isQuietNaN(__llvm_libc::sinf(valueFromBits(BitPatterns::negInf))));
69   EXPECT_EQ(llvmlibc_errno, EDOM);
70 }
71 
72 TEST(SinfTest, InFloatRange) {
73   constexpr uint32_t count = 1000000;
74   constexpr uint32_t step = UINT32_MAX / count;
75   for (uint32_t i = 0, v = 0; i <= count; ++i, v += step) {
76     float x = valueFromBits(v);
77     if (isnan(x) || isinf(x))
78       continue;
79     ASSERT_MPFR_MATCH(mpfr::Operation::Sin, x, __llvm_libc::sinf(x), 1.0);
80   }
81 }
82 
83 TEST(SinfTest, SpecificBitPatterns) {
84   float x = valueFromBits(0xc70d39a1);
85   EXPECT_MPFR_MATCH(mpfr::Operation::Sin, x, __llvm_libc::sinf(x), 1.0);
86 }
87 
88 // For small values, sin(x) is x.
89 TEST(SinfTest, SmallValues) {
90   uint32_t bits = 0x17800000;
91   float x = valueFromBits(bits);
92   float result = __llvm_libc::sinf(x);
93   EXPECT_MPFR_MATCH(mpfr::Operation::Sin, x, result, 1.0);
94   EXPECT_EQ(bits, valueAsBits(result));
95 
96   bits = 0x00400000;
97   x = valueFromBits(bits);
98   result = __llvm_libc::sinf(x);
99   EXPECT_MPFR_MATCH(mpfr::Operation::Sin, x, result, 1.0);
100   EXPECT_EQ(bits, valueAsBits(result));
101 }
102 
103 // SDCOMP-26094: check sinf in the cases for which the range reducer
104 // returns values furthest beyond its nominal upper bound of pi/4.
105 TEST(SinfTest, SDCOMP_26094) {
106   for (uint32_t v : sdcomp26094Values) {
107     float x = valueFromBits(v);
108     EXPECT_MPFR_MATCH(mpfr::Operation::Sin, x, __llvm_libc::sinf(x), 1.0);
109   }
110 }
111