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