1 //===-- Unittests for sincosf ---------------------------------------------===//
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/sincosf.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(SinCosfTest, SpecialNumbers) {
36   llvmlibc_errno = 0;
37   float sin, cos;
38 
39   __llvm_libc::sincosf(valueFromBits(BitPatterns::aQuietNaN), &sin, &cos);
40   EXPECT_TRUE(isQuietNaN(cos));
41   EXPECT_TRUE(isQuietNaN(sin));
42   EXPECT_EQ(llvmlibc_errno, 0);
43 
44   __llvm_libc::sincosf(valueFromBits(BitPatterns::aNegativeQuietNaN), &sin,
45                        &cos);
46   EXPECT_TRUE(isNegativeQuietNaN(cos));
47   EXPECT_TRUE(isNegativeQuietNaN(sin));
48   EXPECT_EQ(llvmlibc_errno, 0);
49 
50   __llvm_libc::sincosf(valueFromBits(BitPatterns::aSignallingNaN), &sin, &cos);
51   EXPECT_TRUE(isQuietNaN(cos));
52   EXPECT_TRUE(isQuietNaN(sin));
53   EXPECT_EQ(llvmlibc_errno, 0);
54 
55   __llvm_libc::sincosf(valueFromBits(BitPatterns::aNegativeSignallingNaN), &sin,
56                        &cos);
57   EXPECT_TRUE(isNegativeQuietNaN(cos));
58   EXPECT_TRUE(isNegativeQuietNaN(sin));
59   EXPECT_EQ(llvmlibc_errno, 0);
60 
61   __llvm_libc::sincosf(valueFromBits(BitPatterns::zero), &sin, &cos);
62   EXPECT_EQ(BitPatterns::one, valueAsBits(cos));
63   EXPECT_EQ(BitPatterns::zero, valueAsBits(sin));
64   EXPECT_EQ(llvmlibc_errno, 0);
65 
66   __llvm_libc::sincosf(valueFromBits(BitPatterns::negZero), &sin, &cos);
67   EXPECT_EQ(BitPatterns::one, valueAsBits(cos));
68   EXPECT_EQ(BitPatterns::negZero, valueAsBits(sin));
69   EXPECT_EQ(llvmlibc_errno, 0);
70 
71   llvmlibc_errno = 0;
72   __llvm_libc::sincosf(valueFromBits(BitPatterns::inf), &sin, &cos);
73   EXPECT_TRUE(isQuietNaN(cos));
74   EXPECT_TRUE(isQuietNaN(sin));
75   EXPECT_EQ(llvmlibc_errno, EDOM);
76 
77   llvmlibc_errno = 0;
78   __llvm_libc::sincosf(valueFromBits(BitPatterns::negInf), &sin, &cos);
79   EXPECT_TRUE(isQuietNaN(cos));
80   EXPECT_TRUE(isQuietNaN(sin));
81   EXPECT_EQ(llvmlibc_errno, EDOM);
82 }
83 
84 TEST(SinCosfTest, InFloatRange) {
85   constexpr uint32_t count = 1000000;
86   constexpr uint32_t step = UINT32_MAX / count;
87   for (uint32_t i = 0, v = 0; i <= count; ++i, v += step) {
88     float x = valueFromBits(v);
89     if (isnan(x) || isinf(x))
90       continue;
91 
92     float sin, cos;
93     __llvm_libc::sincosf(x, &sin, &cos);
94     ASSERT_MPFR_MATCH(mpfr::Operation::Cos, x, cos, 1.0);
95     ASSERT_MPFR_MATCH(mpfr::Operation::Sin, x, sin, 1.0);
96   }
97 }
98 
99 // For small values, cos(x) is 1 and sin(x) is x.
100 TEST(SinCosfTest, SmallValues) {
101   uint32_t bits = 0x17800000;
102   float x = valueFromBits(bits);
103   float result_cos, result_sin;
104   __llvm_libc::sincosf(x, &result_sin, &result_cos);
105   EXPECT_MPFR_MATCH(mpfr::Operation::Cos, x, result_cos, 1.0);
106   EXPECT_MPFR_MATCH(mpfr::Operation::Sin, x, result_sin, 1.0);
107   EXPECT_EQ(BitPatterns::one, valueAsBits(result_cos));
108   EXPECT_EQ(bits, valueAsBits(result_sin));
109 
110   bits = 0x00400000;
111   x = valueFromBits(bits);
112   __llvm_libc::sincosf(x, &result_sin, &result_cos);
113   EXPECT_MPFR_MATCH(mpfr::Operation::Cos, x, result_cos, 1.0);
114   EXPECT_MPFR_MATCH(mpfr::Operation::Sin, x, result_sin, 1.0);
115   EXPECT_EQ(BitPatterns::one, valueAsBits(result_cos));
116   EXPECT_EQ(bits, valueAsBits(result_sin));
117 }
118 
119 // SDCOMP-26094: check sinf in the cases for which the range reducer
120 // returns values furthest beyond its nominal upper bound of pi/4.
121 TEST(SinCosfTest, SDCOMP_26094) {
122   for (uint32_t v : sdcomp26094Values) {
123     float x = valueFromBits(v);
124     float sin, cos;
125     __llvm_libc::sincosf(x, &sin, &cos);
126     EXPECT_MPFR_MATCH(mpfr::Operation::Cos, x, cos, 1.0);
127     EXPECT_MPFR_MATCH(mpfr::Operation::Sin, x, sin, 1.0);
128   }
129 }
130