1560ed8ceSOverMighty //===-- Half-precision e^x - 1 function -----------------------------------===// 2560ed8ceSOverMighty // 3560ed8ceSOverMighty // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4560ed8ceSOverMighty // See https://llvm.org/LICENSE.txt for license information. 5560ed8ceSOverMighty // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6560ed8ceSOverMighty // 7560ed8ceSOverMighty //===----------------------------------------------------------------------===// 8560ed8ceSOverMighty 9560ed8ceSOverMighty #include "src/math/expm1f16.h" 10560ed8ceSOverMighty #include "expxf16.h" 11560ed8ceSOverMighty #include "hdr/errno_macros.h" 12560ed8ceSOverMighty #include "hdr/fenv_macros.h" 13560ed8ceSOverMighty #include "src/__support/FPUtil/FEnvImpl.h" 14560ed8ceSOverMighty #include "src/__support/FPUtil/FPBits.h" 15560ed8ceSOverMighty #include "src/__support/FPUtil/PolyEval.h" 16*127349fcSOverMighty #include "src/__support/FPUtil/cast.h" 17560ed8ceSOverMighty #include "src/__support/FPUtil/except_value_utils.h" 18560ed8ceSOverMighty #include "src/__support/FPUtil/multiply_add.h" 19560ed8ceSOverMighty #include "src/__support/FPUtil/rounding_mode.h" 20560ed8ceSOverMighty #include "src/__support/common.h" 21560ed8ceSOverMighty #include "src/__support/macros/config.h" 22560ed8ceSOverMighty #include "src/__support/macros/optimization.h" 23560ed8ceSOverMighty 24560ed8ceSOverMighty namespace LIBC_NAMESPACE_DECL { 25560ed8ceSOverMighty 26560ed8ceSOverMighty static constexpr fputil::ExceptValues<float16, 1> EXPM1F16_EXCEPTS_LO = {{ 27560ed8ceSOverMighty // (input, RZ output, RU offset, RD offset, RN offset) 28560ed8ceSOverMighty // x = 0x1.564p-5, expm1f16(x) = 0x1.5d4p-5 (RZ) 29560ed8ceSOverMighty {0x2959U, 0x2975U, 1U, 0U, 1U}, 30560ed8ceSOverMighty }}; 31560ed8ceSOverMighty 32560ed8ceSOverMighty #ifdef LIBC_TARGET_CPU_HAS_FMA 33560ed8ceSOverMighty static constexpr size_t N_EXPM1F16_EXCEPTS_HI = 2; 34560ed8ceSOverMighty #else 35560ed8ceSOverMighty static constexpr size_t N_EXPM1F16_EXCEPTS_HI = 3; 36560ed8ceSOverMighty #endif 37560ed8ceSOverMighty 38560ed8ceSOverMighty static constexpr fputil::ExceptValues<float16, N_EXPM1F16_EXCEPTS_HI> 39560ed8ceSOverMighty EXPM1F16_EXCEPTS_HI = {{ 40560ed8ceSOverMighty // (input, RZ output, RU offset, RD offset, RN offset) 41560ed8ceSOverMighty // x = 0x1.c34p+0, expm1f16(x) = 0x1.34cp+2 (RZ) 42560ed8ceSOverMighty {0x3f0dU, 0x44d3U, 1U, 0U, 1U}, 43560ed8ceSOverMighty // x = -0x1.e28p-3, expm1f16(x) = -0x1.adcp-3 (RZ) 44560ed8ceSOverMighty {0xb38aU, 0xb2b7U, 0U, 1U, 1U}, 45560ed8ceSOverMighty #ifndef LIBC_TARGET_CPU_HAS_FMA 46560ed8ceSOverMighty // x = 0x1.a08p-3, exp10m1f(x) = 0x1.cdcp-3 (RZ) 47560ed8ceSOverMighty {0x3282U, 0x3337U, 1U, 0U, 0U}, 48560ed8ceSOverMighty #endif 49560ed8ceSOverMighty }}; 50560ed8ceSOverMighty 51560ed8ceSOverMighty LLVM_LIBC_FUNCTION(float16, expm1f16, (float16 x)) { 52560ed8ceSOverMighty using FPBits = fputil::FPBits<float16>; 53560ed8ceSOverMighty FPBits x_bits(x); 54560ed8ceSOverMighty 55560ed8ceSOverMighty uint16_t x_u = x_bits.uintval(); 56560ed8ceSOverMighty uint16_t x_abs = x_u & 0x7fffU; 57560ed8ceSOverMighty 58560ed8ceSOverMighty // When |x| <= 2^(-3), or |x| >= -11 * log(2), or x is NaN. 59560ed8ceSOverMighty if (LIBC_UNLIKELY(x_abs <= 0x3000U || x_abs >= 0x47a0U)) { 60560ed8ceSOverMighty // expm1(NaN) = NaN 61560ed8ceSOverMighty if (x_bits.is_nan()) { 62560ed8ceSOverMighty if (x_bits.is_signaling_nan()) { 63560ed8ceSOverMighty fputil::raise_except_if_required(FE_INVALID); 64560ed8ceSOverMighty return FPBits::quiet_nan().get_val(); 65560ed8ceSOverMighty } 66560ed8ceSOverMighty 67560ed8ceSOverMighty return x; 68560ed8ceSOverMighty } 69560ed8ceSOverMighty 70560ed8ceSOverMighty // expm1(+/-0) = +/-0 71560ed8ceSOverMighty if (x_abs == 0) 72560ed8ceSOverMighty return x; 73560ed8ceSOverMighty 74560ed8ceSOverMighty // When x >= 16 * log(2). 75560ed8ceSOverMighty if (x_bits.is_pos() && x_abs >= 0x498cU) { 76560ed8ceSOverMighty // expm1(+inf) = +inf 77560ed8ceSOverMighty if (x_bits.is_inf()) 78560ed8ceSOverMighty return FPBits::inf().get_val(); 79560ed8ceSOverMighty 80560ed8ceSOverMighty switch (fputil::quick_get_round()) { 81560ed8ceSOverMighty case FE_TONEAREST: 82560ed8ceSOverMighty case FE_UPWARD: 83560ed8ceSOverMighty fputil::set_errno_if_required(ERANGE); 84560ed8ceSOverMighty fputil::raise_except_if_required(FE_OVERFLOW | FE_INEXACT); 85560ed8ceSOverMighty return FPBits::inf().get_val(); 86560ed8ceSOverMighty default: 87560ed8ceSOverMighty return FPBits::max_normal().get_val(); 88560ed8ceSOverMighty } 89560ed8ceSOverMighty } 90560ed8ceSOverMighty 91560ed8ceSOverMighty // When x <= -11 * log(2). 92560ed8ceSOverMighty if (x_u >= 0xc7a0U) { 93560ed8ceSOverMighty // expm1(-inf) = -1 94560ed8ceSOverMighty if (x_bits.is_inf()) 95560ed8ceSOverMighty return FPBits::one(Sign::NEG).get_val(); 96560ed8ceSOverMighty 97560ed8ceSOverMighty // When x > -0x1.0ap+3, round(expm1(x), HP, RN) = -1. 98560ed8ceSOverMighty if (x_u > 0xc828U) 99560ed8ceSOverMighty return fputil::round_result_slightly_up( 100560ed8ceSOverMighty FPBits::one(Sign::NEG).get_val()); 101560ed8ceSOverMighty // When x <= -0x1.0ap+3, round(expm1(x), HP, RN) = -0x1.ffcp-1. 102560ed8ceSOverMighty return fputil::round_result_slightly_down( 103*127349fcSOverMighty fputil::cast<float16>(-0x1.ffcp-1)); 104560ed8ceSOverMighty } 105560ed8ceSOverMighty 106560ed8ceSOverMighty // When 0 < |x| <= 2^(-3). 107560ed8ceSOverMighty if (x_abs <= 0x3000U && !x_bits.is_zero()) { 108560ed8ceSOverMighty if (auto r = EXPM1F16_EXCEPTS_LO.lookup(x_u); 109560ed8ceSOverMighty LIBC_UNLIKELY(r.has_value())) 110560ed8ceSOverMighty return r.value(); 111560ed8ceSOverMighty 112560ed8ceSOverMighty float xf = x; 113560ed8ceSOverMighty // Degree-5 minimax polynomial generated by Sollya with the following 114560ed8ceSOverMighty // commands: 115560ed8ceSOverMighty // > display = hexadecimal; 116560ed8ceSOverMighty // > P = fpminimax(expm1(x)/x, 4, [|SG...|], [-2^-3, 2^-3]); 117560ed8ceSOverMighty // > x * P; 118*127349fcSOverMighty return fputil::cast<float16>( 119560ed8ceSOverMighty xf * fputil::polyeval(xf, 0x1p+0f, 0x1.fffff8p-2f, 0x1.555556p-3f, 120560ed8ceSOverMighty 0x1.55905ep-5f, 0x1.1124c2p-7f)); 121560ed8ceSOverMighty } 122560ed8ceSOverMighty } 123560ed8ceSOverMighty 124560ed8ceSOverMighty if (auto r = EXPM1F16_EXCEPTS_HI.lookup(x_u); LIBC_UNLIKELY(r.has_value())) 125560ed8ceSOverMighty return r.value(); 126560ed8ceSOverMighty 127560ed8ceSOverMighty // exp(x) = exp(hi + mid) * exp(lo) 128560ed8ceSOverMighty auto [exp_hi_mid, exp_lo] = exp_range_reduction(x); 129560ed8ceSOverMighty // expm1(x) = exp(hi + mid) * exp(lo) - 1 130*127349fcSOverMighty return fputil::cast<float16>(fputil::multiply_add(exp_hi_mid, exp_lo, -1.0f)); 131560ed8ceSOverMighty } 132560ed8ceSOverMighty 133560ed8ceSOverMighty } // namespace LIBC_NAMESPACE_DECL 134