1 //===-- Unittests for roundf ----------------------------------------------===//
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/math.h"
10 #include "src/math/roundf.h"
11 #include "utils/FPUtil/BitPatterns.h"
12 #include "utils/FPUtil/FloatOperations.h"
13 #include "utils/FPUtil/FloatProperties.h"
14 #include "utils/MPFRWrapper/MPFRUtils.h"
15 #include "utils/UnitTest/Test.h"
16 
17 using __llvm_libc::fputil::valueAsBits;
18 using __llvm_libc::fputil::valueFromBits;
19 
20 using BitPatterns = __llvm_libc::fputil::BitPatterns<float>;
21 using Properties = __llvm_libc::fputil::FloatProperties<float>;
22 
23 namespace mpfr = __llvm_libc::testing::mpfr;
24 
25 // Zero tolerance; As in, exact match with MPFR result.
26 static constexpr mpfr::Tolerance tolerance{mpfr::Tolerance::doublePrecision, 0,
27                                            0};
28 
29 TEST(RoundfTest, SpecialNumbers) {
30   EXPECT_EQ(
31       BitPatterns::aQuietNaN,
32       valueAsBits(__llvm_libc::roundf(valueFromBits(BitPatterns::aQuietNaN))));
33   EXPECT_EQ(BitPatterns::aNegativeQuietNaN,
34             valueAsBits(__llvm_libc::roundf(
35                 valueFromBits(BitPatterns::aNegativeQuietNaN))));
36 
37   EXPECT_EQ(BitPatterns::aSignallingNaN,
38             valueAsBits(__llvm_libc::roundf(
39                 valueFromBits(BitPatterns::aSignallingNaN))));
40   EXPECT_EQ(BitPatterns::aNegativeSignallingNaN,
41             valueAsBits(__llvm_libc::roundf(
42                 valueFromBits(BitPatterns::aNegativeSignallingNaN))));
43 
44   EXPECT_EQ(BitPatterns::inf,
45             valueAsBits(__llvm_libc::roundf(valueFromBits(BitPatterns::inf))));
46   EXPECT_EQ(BitPatterns::negInf, valueAsBits(__llvm_libc::roundf(
47                                      valueFromBits(BitPatterns::negInf))));
48 
49   EXPECT_EQ(BitPatterns::zero,
50             valueAsBits(__llvm_libc::roundf(valueFromBits(BitPatterns::zero))));
51   EXPECT_EQ(BitPatterns::negZero, valueAsBits(__llvm_libc::roundf(
52                                       valueFromBits(BitPatterns::negZero))));
53 }
54 
55 TEST(RoundfTest, RoundedNumbers) {
56   EXPECT_EQ(valueAsBits(1.0f), valueAsBits(__llvm_libc::roundf(1.0f)));
57   EXPECT_EQ(valueAsBits(-1.0f), valueAsBits(__llvm_libc::roundf(-1.0f)));
58   EXPECT_EQ(valueAsBits(10.0f), valueAsBits(__llvm_libc::roundf(10.0f)));
59   EXPECT_EQ(valueAsBits(-10.0f), valueAsBits(__llvm_libc::roundf(-10.0f)));
60   EXPECT_EQ(valueAsBits(12345.0f), valueAsBits(__llvm_libc::roundf(12345.0f)));
61   EXPECT_EQ(valueAsBits(-12345.0f),
62             valueAsBits(__llvm_libc::roundf(-12345.0f)));
63 }
64 
65 TEST(RoundfTest, CloseToZeroNumbers) {
66   EXPECT_EQ(valueAsBits(1.0f), valueAsBits(__llvm_libc::roundf(0.5f)));
67   EXPECT_EQ(valueAsBits(-1.0f), valueAsBits(__llvm_libc::roundf(-0.5f)));
68   EXPECT_EQ(valueAsBits(0.0f), valueAsBits(__llvm_libc::roundf(0.115f)));
69   EXPECT_EQ(valueAsBits(-0.0f), valueAsBits(__llvm_libc::roundf(-0.115f)));
70   EXPECT_EQ(valueAsBits(1.0f), valueAsBits(__llvm_libc::roundf(0.715f)));
71   EXPECT_EQ(valueAsBits(-1.0f), valueAsBits(__llvm_libc::roundf(-0.715f)));
72 }
73 
74 TEST(RoundfTest, InFloatRange) {
75   using BitsType = Properties::BitsType;
76   constexpr BitsType count = 1000000;
77   constexpr BitsType step = UINT32_MAX / count;
78   for (BitsType i = 0, v = 0; i <= count; ++i, v += step) {
79     double x = valueFromBits(v);
80     if (isnan(x) || isinf(x))
81       continue;
82     ASSERT_MPFR_MATCH(mpfr::Operation::Round, x, __llvm_libc::roundf(x),
83                       tolerance);
84   }
85 }
86