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