1 //===-- Unittests for atanhf ----------------------------------------------===//
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 "hdr/math_macros.h"
10 #include "src/__support/FPUtil/FPBits.h"
11 #include "src/errno/libc_errno.h"
12 #include "src/math/atanhf.h"
13 #include "test/UnitTest/FPMatcher.h"
14 #include "test/UnitTest/Test.h"
15
16 #include <stdint.h>
17
18 using LIBC_NAMESPACE::Sign;
19
20 using LlvmLibcAtanhfTest = LIBC_NAMESPACE::testing::FPTest<float>;
21
TEST_F(LlvmLibcAtanhfTest,SpecialNumbers)22 TEST_F(LlvmLibcAtanhfTest, SpecialNumbers) {
23 LIBC_NAMESPACE::libc_errno = 0;
24
25 // TODO: Strengthen errno,exception checks and remove these assert macros
26 // after new matchers/test fixtures are added, see:
27 // https://github.com/llvm/llvm-project/issues/90653
28 LIBC_NAMESPACE::fputil::clear_except(FE_ALL_EXCEPT);
29 EXPECT_FP_EQ_ALL_ROUNDING(aNaN, LIBC_NAMESPACE::atanhf(aNaN));
30 // TODO: Uncomment these checks later, RoundingMode affects running
31 // tests in this way https://github.com/llvm/llvm-project/issues/90653.
32 // EXPECT_FP_EXCEPTION(0);
33 EXPECT_MATH_ERRNO(0);
34
35 LIBC_NAMESPACE::fputil::clear_except(FE_ALL_EXCEPT);
36 EXPECT_FP_EQ_ALL_ROUNDING(0.0f, LIBC_NAMESPACE::atanhf(0.0f));
37 // See above TODO
38 // EXPECT_FP_EXCEPTION(0);
39 EXPECT_MATH_ERRNO(0);
40
41 LIBC_NAMESPACE::fputil::clear_except(FE_ALL_EXCEPT);
42 EXPECT_FP_EQ_ALL_ROUNDING(-0.0f, LIBC_NAMESPACE::atanhf(-0.0f));
43 // See above TODO
44 // EXPECT_FP_EXCEPTION(0);
45 EXPECT_MATH_ERRNO(0);
46
47 EXPECT_FP_EQ_WITH_EXCEPTION(inf, LIBC_NAMESPACE::atanhf(1.0f), FE_DIVBYZERO);
48 EXPECT_MATH_ERRNO(ERANGE);
49
50 EXPECT_FP_EQ_WITH_EXCEPTION(neg_inf, LIBC_NAMESPACE::atanhf(-1.0f),
51 FE_DIVBYZERO);
52 EXPECT_MATH_ERRNO(ERANGE);
53
54 auto bt = FPBits(1.0f);
55 bt.set_uintval(bt.uintval() + 1);
56
57 EXPECT_FP_IS_NAN_WITH_EXCEPTION(LIBC_NAMESPACE::atanhf(bt.get_val()),
58 FE_INVALID);
59 EXPECT_MATH_ERRNO(EDOM);
60
61 bt.set_sign(Sign::NEG);
62 EXPECT_FP_IS_NAN_WITH_EXCEPTION(LIBC_NAMESPACE::atanhf(bt.get_val()),
63 FE_INVALID);
64 EXPECT_MATH_ERRNO(EDOM);
65
66 EXPECT_FP_IS_NAN_WITH_EXCEPTION(LIBC_NAMESPACE::atanhf(2.0f), FE_INVALID);
67 EXPECT_MATH_ERRNO(EDOM);
68
69 EXPECT_FP_IS_NAN_WITH_EXCEPTION(LIBC_NAMESPACE::atanhf(-2.0f), FE_INVALID);
70 EXPECT_MATH_ERRNO(EDOM);
71
72 EXPECT_FP_IS_NAN_WITH_EXCEPTION(LIBC_NAMESPACE::atanhf(inf), FE_INVALID);
73 EXPECT_MATH_ERRNO(EDOM);
74
75 bt.set_sign(Sign::NEG);
76 EXPECT_FP_IS_NAN_WITH_EXCEPTION(LIBC_NAMESPACE::atanhf(neg_inf), FE_INVALID);
77 EXPECT_MATH_ERRNO(EDOM);
78 }
79
80 #ifdef LIBC_TEST_FTZ_DAZ
81
82 using namespace LIBC_NAMESPACE::testing;
83
TEST_F(LlvmLibcAtanhfTest,FTZMode)84 TEST_F(LlvmLibcAtanhfTest, FTZMode) {
85 ModifyMXCSR mxcsr(FTZ);
86
87 EXPECT_FP_EQ(0.0f, LIBC_NAMESPACE::atanhf(min_denormal));
88 }
89
TEST_F(LlvmLibcAtanhfTest,DAZMode)90 TEST_F(LlvmLibcAtanhfTest, DAZMode) {
91 ModifyMXCSR mxcsr(DAZ);
92
93 EXPECT_FP_EQ(0.0f, LIBC_NAMESPACE::atanhf(min_denormal));
94 }
95
TEST_F(LlvmLibcAtanhfTest,FTZDAZMode)96 TEST_F(LlvmLibcAtanhfTest, FTZDAZMode) {
97 ModifyMXCSR mxcsr(FTZ | DAZ);
98
99 EXPECT_FP_EQ(0.0f, LIBC_NAMESPACE::atanhf(min_denormal));
100 }
101
102 #endif
103