xref: /llvm-project/libc/src/math/generic/sinhf16.cpp (revision ed3d05178274890fb804f43ae1bcdfd33b5fd8f0)
1*ed3d0517SOverMighty //===-- Half-precision sinh(x) function -----------------------------------===//
2*ed3d0517SOverMighty //
3*ed3d0517SOverMighty // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4*ed3d0517SOverMighty // See https://llvm.org/LICENSE.txt for license information.
5*ed3d0517SOverMighty // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6*ed3d0517SOverMighty //
7*ed3d0517SOverMighty //===----------------------------------------------------------------------===//
8*ed3d0517SOverMighty 
9*ed3d0517SOverMighty #include "src/math/sinhf16.h"
10*ed3d0517SOverMighty #include "expxf16.h"
11*ed3d0517SOverMighty #include "hdr/errno_macros.h"
12*ed3d0517SOverMighty #include "hdr/fenv_macros.h"
13*ed3d0517SOverMighty #include "src/__support/FPUtil/FEnvImpl.h"
14*ed3d0517SOverMighty #include "src/__support/FPUtil/FPBits.h"
15*ed3d0517SOverMighty #include "src/__support/FPUtil/except_value_utils.h"
16*ed3d0517SOverMighty #include "src/__support/FPUtil/rounding_mode.h"
17*ed3d0517SOverMighty #include "src/__support/common.h"
18*ed3d0517SOverMighty #include "src/__support/macros/config.h"
19*ed3d0517SOverMighty #include "src/__support/macros/optimization.h"
20*ed3d0517SOverMighty 
21*ed3d0517SOverMighty namespace LIBC_NAMESPACE_DECL {
22*ed3d0517SOverMighty 
23*ed3d0517SOverMighty static constexpr fputil::ExceptValues<float16, 16> SINHF16_EXCEPTS_POS = {{
24*ed3d0517SOverMighty     // x = 0x1.714p-5, sinhf16(x) = 0x1.714p-5 (RZ)
25*ed3d0517SOverMighty     {0x29c5U, 0x29c5U, 1U, 0U, 1U},
26*ed3d0517SOverMighty     // x = 0x1.25p-4, sinhf16(x) = 0x1.25p-4 (RZ)
27*ed3d0517SOverMighty     {0x2c94U, 0x2c94U, 1U, 0U, 1U},
28*ed3d0517SOverMighty     // x = 0x1.f5p-4, sinhf16(x) = 0x1.f64p-4 (RZ)
29*ed3d0517SOverMighty     {0x2fd4U, 0x2fd9U, 1U, 0U, 0U},
30*ed3d0517SOverMighty     // x = 0x1.b1cp-3, sinhf16(x) = 0x1.b4cp-3 (RZ)
31*ed3d0517SOverMighty     {0x32c7U, 0x32d3U, 1U, 0U, 1U},
32*ed3d0517SOverMighty     // x = 0x1.6e8p-2, sinhf16(x) = 0x1.764p-2 (RZ)
33*ed3d0517SOverMighty     {0x35baU, 0x35d9U, 1U, 0U, 1U},
34*ed3d0517SOverMighty     // x = 0x1.6b4p-1, sinhf16(x) = 0x1.8a4p-1 (RZ)
35*ed3d0517SOverMighty     {0x39adU, 0x3a29U, 1U, 0U, 1U},
36*ed3d0517SOverMighty     // x = 0x1.a58p-1, sinhf16(x) = 0x1.d68p-1 (RZ)
37*ed3d0517SOverMighty     {0x3a96U, 0x3b5aU, 1U, 0U, 1U},
38*ed3d0517SOverMighty     // x = 0x1.574p+0, sinhf16(x) = 0x1.c78p+0 (RZ)
39*ed3d0517SOverMighty     {0x3d5dU, 0x3f1eU, 1U, 0U, 1U},
40*ed3d0517SOverMighty     // x = 0x1.648p+1, sinhf16(x) = 0x1.024p+3 (RZ)
41*ed3d0517SOverMighty     {0x4192U, 0x4809U, 1U, 0U, 0U},
42*ed3d0517SOverMighty     // x = 0x1.cdcp+1, sinhf16(x) = 0x1.26cp+4 (RZ)
43*ed3d0517SOverMighty     {0x4337U, 0x4c9bU, 1U, 0U, 0U},
44*ed3d0517SOverMighty     // x = 0x1.d0cp+1, sinhf16(x) = 0x1.2d8p+4 (RZ)
45*ed3d0517SOverMighty     {0x4343U, 0x4cb6U, 1U, 0U, 1U},
46*ed3d0517SOverMighty     // x = 0x1.018p+2, sinhf16(x) = 0x1.bfp+4 (RZ)
47*ed3d0517SOverMighty     {0x4406U, 0x4efcU, 1U, 0U, 0U},
48*ed3d0517SOverMighty     // x = 0x1.2fcp+2, sinhf16(x) = 0x1.cc4p+5 (RZ)
49*ed3d0517SOverMighty     {0x44bfU, 0x5331U, 1U, 0U, 1U},
50*ed3d0517SOverMighty     // x = 0x1.4ecp+2, sinhf16(x) = 0x1.75cp+6 (RZ)
51*ed3d0517SOverMighty     {0x453bU, 0x55d7U, 1U, 0U, 0U},
52*ed3d0517SOverMighty     // x = 0x1.8a4p+2, sinhf16(x) = 0x1.d94p+7 (RZ)
53*ed3d0517SOverMighty     {0x4629U, 0x5b65U, 1U, 0U, 1U},
54*ed3d0517SOverMighty     // x = 0x1.5fp+3, sinhf16(x) = 0x1.c54p+14 (RZ)
55*ed3d0517SOverMighty     {0x497cU, 0x7715U, 1U, 0U, 1U},
56*ed3d0517SOverMighty }};
57*ed3d0517SOverMighty 
58*ed3d0517SOverMighty static constexpr fputil::ExceptValues<float16, 12> SINHF16_EXCEPTS_NEG = {{
59*ed3d0517SOverMighty     // x = -0x1.714p-5, sinhf16(x) = -0x1.714p-5 (RZ)
60*ed3d0517SOverMighty     {0xa9c5U, 0xa9c5U, 0U, 1U, 1U},
61*ed3d0517SOverMighty     // x = -0x1.25p-4, sinhf16(x) = -0x1.25p-4 (RZ)
62*ed3d0517SOverMighty     {0xac94U, 0xac94U, 0U, 1U, 1U},
63*ed3d0517SOverMighty     // x = -0x1.f5p-4, sinhf16(x) = -0x1.f64p-4 (RZ)
64*ed3d0517SOverMighty     {0xafd4U, 0xafd9U, 0U, 1U, 0U},
65*ed3d0517SOverMighty     // x = -0x1.6e8p-2, sinhf16(x) = -0x1.764p-2 (RZ)
66*ed3d0517SOverMighty     {0xb5baU, 0xb5d9U, 0U, 1U, 1U},
67*ed3d0517SOverMighty     // x = -0x1.a58p-1, sinhf16(x) = -0x1.d68p-1 (RZ)
68*ed3d0517SOverMighty     {0xba96U, 0xbb5aU, 0U, 1U, 1U},
69*ed3d0517SOverMighty     // x = -0x1.cdcp+1, sinhf16(x) = -0x1.26cp+4 (RZ)
70*ed3d0517SOverMighty     {0xc337U, 0xcc9bU, 0U, 1U, 0U},
71*ed3d0517SOverMighty     // x = -0x1.d0cp+1, sinhf16(x) = -0x1.2d8p+4 (RZ)
72*ed3d0517SOverMighty     {0xc343U, 0xccb6U, 0U, 1U, 1U},
73*ed3d0517SOverMighty     // x = -0x1.018p+2, sinhf16(x) = -0x1.bfp+4 (RZ)
74*ed3d0517SOverMighty     {0xc406U, 0xcefcU, 0U, 1U, 0U},
75*ed3d0517SOverMighty     // x = -0x1.2fcp+2, sinhf16(x) = -0x1.cc4p+5 (RZ)
76*ed3d0517SOverMighty     {0xc4bfU, 0xd331U, 0U, 1U, 1U},
77*ed3d0517SOverMighty     // x = -0x1.4ecp+2, sinhf16(x) = -0x1.75cp+6 (RZ)
78*ed3d0517SOverMighty     {0xc53bU, 0xd5d7U, 0U, 1U, 0U},
79*ed3d0517SOverMighty     // x = -0x1.8a4p+2, sinhf16(x) = -0x1.d94p+7 (RZ)
80*ed3d0517SOverMighty     {0xc629U, 0xdb65U, 0U, 1U, 1U},
81*ed3d0517SOverMighty     // x = -0x1.5fp+3, sinhf16(x) = -0x1.c54p+14 (RZ)
82*ed3d0517SOverMighty     {0xc97cU, 0xf715U, 0U, 1U, 1U},
83*ed3d0517SOverMighty }};
84*ed3d0517SOverMighty 
85*ed3d0517SOverMighty LLVM_LIBC_FUNCTION(float16, sinhf16, (float16 x)) {
86*ed3d0517SOverMighty   using FPBits = fputil::FPBits<float16>;
87*ed3d0517SOverMighty   FPBits x_bits(x);
88*ed3d0517SOverMighty 
89*ed3d0517SOverMighty   uint16_t x_u = x_bits.uintval();
90*ed3d0517SOverMighty   uint16_t x_abs = x_u & 0x7fffU;
91*ed3d0517SOverMighty 
92*ed3d0517SOverMighty   // When |x| = 0, or -2^(-14) <= x <= -2^(-9), or |x| >= asinh(2^16), or x is
93*ed3d0517SOverMighty   // NaN.
94*ed3d0517SOverMighty   if (LIBC_UNLIKELY(x_abs == 0U || (x_u >= 0x8400U && x_u <= 0xa400U) ||
95*ed3d0517SOverMighty                     x_abs >= 0x49e5U)) {
96*ed3d0517SOverMighty     // sinh(NaN) = NaN
97*ed3d0517SOverMighty     if (x_bits.is_nan()) {
98*ed3d0517SOverMighty       if (x_bits.is_signaling_nan()) {
99*ed3d0517SOverMighty         fputil::raise_except_if_required(FE_INVALID);
100*ed3d0517SOverMighty         return FPBits::quiet_nan().get_val();
101*ed3d0517SOverMighty       }
102*ed3d0517SOverMighty 
103*ed3d0517SOverMighty       return x;
104*ed3d0517SOverMighty     }
105*ed3d0517SOverMighty 
106*ed3d0517SOverMighty     // sinh(+/-0) = sinh(+/-0)
107*ed3d0517SOverMighty     if (x_abs == 0U)
108*ed3d0517SOverMighty       return FPBits::zero(x_bits.sign()).get_val();
109*ed3d0517SOverMighty 
110*ed3d0517SOverMighty     // When |x| >= asinh(2^16).
111*ed3d0517SOverMighty     if (x_abs >= 0x49e5U) {
112*ed3d0517SOverMighty       // sinh(+/-inf) = +/-inf
113*ed3d0517SOverMighty       if (x_bits.is_inf())
114*ed3d0517SOverMighty         return FPBits::inf(x_bits.sign()).get_val();
115*ed3d0517SOverMighty 
116*ed3d0517SOverMighty       int rounding_mode = fputil::quick_get_round();
117*ed3d0517SOverMighty       if (rounding_mode == FE_TONEAREST ||
118*ed3d0517SOverMighty           (x_bits.is_pos() && rounding_mode == FE_UPWARD) ||
119*ed3d0517SOverMighty           (x_bits.is_neg() && rounding_mode == FE_DOWNWARD)) {
120*ed3d0517SOverMighty         fputil::set_errno_if_required(ERANGE);
121*ed3d0517SOverMighty         fputil::raise_except_if_required(FE_OVERFLOW | FE_INEXACT);
122*ed3d0517SOverMighty         return FPBits::inf(x_bits.sign()).get_val();
123*ed3d0517SOverMighty       }
124*ed3d0517SOverMighty       return FPBits::max_normal(x_bits.sign()).get_val();
125*ed3d0517SOverMighty     }
126*ed3d0517SOverMighty 
127*ed3d0517SOverMighty     // When -2^(-14) <= x <= -2^(-9).
128*ed3d0517SOverMighty     if (fputil::fenv_is_round_down())
129*ed3d0517SOverMighty       return FPBits(static_cast<uint16_t>(x_u + 1)).get_val();
130*ed3d0517SOverMighty     return FPBits(static_cast<uint16_t>(x_u)).get_val();
131*ed3d0517SOverMighty   }
132*ed3d0517SOverMighty 
133*ed3d0517SOverMighty   if (x_bits.is_pos()) {
134*ed3d0517SOverMighty     if (auto r = SINHF16_EXCEPTS_POS.lookup(x_u); LIBC_UNLIKELY(r.has_value()))
135*ed3d0517SOverMighty       return r.value();
136*ed3d0517SOverMighty   } else {
137*ed3d0517SOverMighty     if (auto r = SINHF16_EXCEPTS_NEG.lookup(x_u); LIBC_UNLIKELY(r.has_value()))
138*ed3d0517SOverMighty       return r.value();
139*ed3d0517SOverMighty   }
140*ed3d0517SOverMighty 
141*ed3d0517SOverMighty   return eval_sinh_or_cosh</*IsSinh=*/true>(x);
142*ed3d0517SOverMighty }
143*ed3d0517SOverMighty 
144*ed3d0517SOverMighty } // namespace LIBC_NAMESPACE_DECL
145