Skip to content
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions libc/config/linux/x86_64/entrypoints.txt
Original file line number Diff line number Diff line change
Expand Up @@ -415,6 +415,7 @@ set(TARGET_LIBM_ENTRYPOINTS
libc.src.math.exp
libc.src.math.exp10
libc.src.math.exp10f
libc.src.math.exp10m1f
libc.src.math.exp2
libc.src.math.exp2f
libc.src.math.exp2m1f
Expand Down
2 changes: 1 addition & 1 deletion libc/docs/math/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,7 @@ Higher Math Functions
+-----------+------------------+-----------------+------------------------+----------------------+------------------------+------------------------+----------------------------+
| exp10 | |check| | |check| | | |check| | | 7.12.6.2 | F.10.3.2 |
+-----------+------------------+-----------------+------------------------+----------------------+------------------------+------------------------+----------------------------+
| exp10m1 | | | | |check| | | 7.12.6.3 | F.10.3.3 |
| exp10m1 | |check| | | | |check| | | 7.12.6.3 | F.10.3.3 |
+-----------+------------------+-----------------+------------------------+----------------------+------------------------+------------------------+----------------------------+
| exp2 | |check| | |check| | | |check| | | 7.12.6.4 | F.10.3.4 |
+-----------+------------------+-----------------+------------------------+----------------------+------------------------+------------------------+----------------------------+
Expand Down
6 changes: 6 additions & 0 deletions libc/newhdrgen/yaml/math.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -280,6 +280,12 @@ functions:
return_type: float
arguments:
- type: float
- name: exp10m1f
standards:
- stdc
return_type: float
arguments:
- type: float
- name: exp10m1f16
standards:
- stdc
Expand Down
3 changes: 2 additions & 1 deletion libc/spec/stdc.td
Original file line number Diff line number Diff line change
Expand Up @@ -695,6 +695,7 @@ def StdC : StandardSpec<"stdc"> {
FunctionSpec<"exp10f", RetValSpec<FloatType>, [ArgSpec<FloatType>]>,
GuardedFunctionSpec<"exp10f16", RetValSpec<Float16Type>, [ArgSpec<Float16Type>], "LIBC_TYPES_HAS_FLOAT16">,

FunctionSpec<"exp10m1f", RetValSpec<FloatType>, [ArgSpec<FloatType>]>,
GuardedFunctionSpec<"exp10m1f16", RetValSpec<Float16Type>, [ArgSpec<Float16Type>], "LIBC_TYPES_HAS_FLOAT16">,

FunctionSpec<"remainder", RetValSpec<DoubleType>, [ArgSpec<DoubleType>, ArgSpec<DoubleType>]>,
Expand Down Expand Up @@ -1737,7 +1738,7 @@ def StdC : StandardSpec<"stdc"> {
]
>;


NamedType StructLconv = NamedType<"struct lconv">;
PtrType StructLconvPtr = PtrType<StructLconv>;

Expand Down
1 change: 1 addition & 0 deletions libc/src/math/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,7 @@ add_math_entrypoint_object(exp10)
add_math_entrypoint_object(exp10f)
add_math_entrypoint_object(exp10f16)

add_math_entrypoint_object(exp10m1f)
add_math_entrypoint_object(exp10m1f16)

add_math_entrypoint_object(expm1)
Expand Down
18 changes: 18 additions & 0 deletions libc/src/math/exp10m1f.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
//===-- Implementation header for exp10m1f ----------------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//

#ifndef LLVM_LIBC_SRC_MATH_EXP10M1F_H
#define LLVM_LIBC_SRC_MATH_EXP10M1F_H

namespace LIBC_NAMESPACE {

float exp10m1f(float x);

} // namespace LIBC_NAMESPACE

#endif // LLVM_LIBC_SRC_MATH_EXP10M1F_H
24 changes: 23 additions & 1 deletion libc/src/math/generic/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -359,7 +359,7 @@ add_header_library(
libc.src.__support.FPUtil.fp_bits
libc.src.__support.FPUtil.polyeval
libc.src.__support.FPUtil.nearest_integer
libc.src.__support.common
libc.src.__support.common
)

add_header_library(
Expand Down Expand Up @@ -1569,6 +1569,7 @@ add_entrypoint_object(
.explogxf
libc.src.errno.errno
libc.src.__support.common
libc.src.__support.FPUtil.except_value_utils
libc.src.__support.FPUtil.fenv_impl
libc.src.__support.FPUtil.fp_bits
libc.src.__support.FPUtil.multiply_add
Expand Down Expand Up @@ -1686,6 +1687,27 @@ add_entrypoint_object(
-O3
)

add_entrypoint_object(
exp10m1f
SRCS
exp10m1f.cpp
HDRS
../exp10m1f.h
DEPENDS
.explogxf
libc.src.errno.errno
libc.src.__support.common
libc.src.__support.FPUtil.except_value_utils
libc.src.__support.FPUtil.fenv_impl
libc.src.__support.FPUtil.fp_bits
libc.src.__support.FPUtil.multiply_add
libc.src.__support.FPUtil.polyeval
libc.src.__support.FPUtil.rounding_mode
libc.src.__support.macros.optimization
COMPILE_OPTIONS
-O3
)

add_entrypoint_object(
exp10m1f16
SRCS
Expand Down
215 changes: 215 additions & 0 deletions libc/src/math/generic/exp10m1f.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,215 @@
//===-- Implementation of exp10m1f function -------------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//

#include "src/math/exp10m1f.h"
#include "src/__support/FPUtil/FEnvImpl.h"
#include "src/__support/FPUtil/FPBits.h"
#include "src/__support/FPUtil/PolyEval.h"
#include "src/__support/FPUtil/except_value_utils.h"
#include "src/__support/FPUtil/multiply_add.h"
#include "src/__support/FPUtil/rounding_mode.h"
#include "src/__support/common.h"
#include "src/__support/macros/optimization.h"
#include "src/errno/libc_errno.h"

#include "explogxf.h"

namespace LIBC_NAMESPACE {

static constexpr size_t N_EXCEPTS_LO = 11;

static constexpr fputil::ExceptValues<float, N_EXCEPTS_LO> EXP10M1F_EXCEPTS_LO =
{{
// x = 0x1.0fe54ep-11, exp10m1f(x) = 0x1.3937eep-10 (RZ)
{0x3a07'f2a7U, 0x3a9c'9bf7U, 1U, 0U, 1U},
// x = 0x1.80e6eap-11, exp10m1f(x) = 0x1.bb8272p-10 (RZ)
{0x3a40'7375U, 0x3add'c139U, 1U, 0U, 1U},
// x = -0x1.2a33bcp-51, exp10m1f(x) = -0x1.57515ep-50 (RZ)
{0xa615'19deU, 0xa6ab'a8afU, 0U, 1U, 0U},
// x = -0x0p+0, exp10m1f(x) = -0x0p+0 (RZ)
{0x8000'0000U, 0x8000'0000U, 0U, 0U, 0U},
// x = -0x1.b59e08p-31, exp10m1f(x) = -0x1.f7d356p-30 (RZ)
{0xb05a'cf04U, 0xb0fb'e9abU, 0U, 1U, 1U},
// x = -0x1.bf342p-12, exp10m1f(x) = -0x1.014e02p-10 (RZ)
{0xb9df'9a10U, 0xba80'a701U, 0U, 1U, 0U},
// x = -0x1.6207fp-11, exp10m1f(x) = -0x1.9746cap-10 (RZ)
{0xba31'03f8U, 0xbacb'a365U, 0U, 1U, 1U},
// x = -0x1.bd0c66p-11, exp10m1f(x) = -0x1.ffe168p-10 (RZ)
{0xba5e'8633U, 0xbaff'f0b4U, 0U, 1U, 1U},
// x = -0x1.ffd84cp-10, exp10m1f(x) = -0x1.25faf2p-8 (RZ)
{0xbaff'ec26U, 0xbb92'fd79U, 0U, 1U, 0U},
// x = -0x1.a74172p-9, exp10m1f(x) = -0x1.e57be2p-8 (RZ)
{0xbb53'a0b9U, 0xbbf2'bdf1U, 0U, 1U, 1U},
// x = -0x1.cb694cp-9, exp10m1f(x) = -0x1.0764e4p-7 (RZ)
{0xbb65'b4a6U, 0xbc03'b272U, 0U, 1U, 0U},
}};

static constexpr size_t N_EXCEPTS_HI = 19;

static constexpr fputil::ExceptValues<float, N_EXCEPTS_HI> EXP10M1F_EXCEPTS_HI =
{{
// (input, RZ output, RU offset, RD offset, RN offset)
// x = 0x1.8d31eep-8, exp10m1f(x) = 0x1.cc7e4cp-7 (RZ)
{0x3bc6'98f7U, 0x3c66'3f26U, 1U, 0U, 1U},
// x = 0x1.915fcep-8, exp10m1f(x) = 0x1.d15f72p-7 (RZ)
{0x3bc8'afe7U, 0x3c68'afb9U, 1U, 0U, 0U},
// x = 0x1.bcf982p-8, exp10m1f(x) = 0x1.022928p-6 (RZ)
{0x3bde'7cc1U, 0x3c81'1494U, 1U, 0U, 1U},
// x = 0x1.99ff0ap-7, exp10m1f(x) = 0x1.dee416p-6 (RZ)
{0x3c4c'ff85U, 0x3cef'720bU, 1U, 0U, 0U},
// x = 0x1.75ea14p-6, exp10m1f(x) = 0x1.b9ff16p-5 (RZ)
{0x3cba'f50aU, 0x3d5c'ff8bU, 1U, 0U, 0U},
// x = 0x1.f81b64p-6, exp10m1f(x) = 0x1.2cb6bcp-4 (RZ)
{0x3cfc'0db2U, 0x3d96'5b5eU, 1U, 0U, 0U},
// x = 0x1.fafecp+3, exp10m1f(x) = 0x1.8c880ap+52 (RZ)
{0x417d'7f60U, 0x59c6'4405U, 1U, 0U, 0U},
// x = -0x1.3bf094p-8, exp10m1f(x) = -0x1.69ba4ap-7 (RZ)
{0xbb9d'f84aU, 0xbc34'dd25U, 0U, 1U, 0U},
// x = -0x1.4558bcp-8, exp10m1f(x) = -0x1.746fb8p-7 (RZ)
{0xbba2'ac5eU, 0xbc3a'37dcU, 0U, 1U, 1U},
// x = -0x1.4bb43p-8, exp10m1f(x) = -0x1.7babe4p-7 (RZ)
{0xbba5'da18U, 0xbc3d'd5f2U, 0U, 1U, 1U},
// x = -0x1.776cc8p-8, exp10m1f(x) = -0x1.ad62c4p-7 (RZ)
{0xbbbb'b664U, 0xbc56'b162U, 0U, 1U, 0U},
// x = -0x1.f024cp-8, exp10m1f(x) = -0x1.1b20d6p-6 (RZ)
{0xbbf8'1260U, 0xbc8d'906bU, 0U, 1U, 1U},
// x = -0x1.f510eep-8, exp10m1f(x) = -0x1.1de9aap-6 (RZ)
{0xbbfa'8877U, 0xbc8e'f4d5U, 0U, 1U, 0U},
// x = -0x1.0b43c4p-7, exp10m1f(x) = -0x1.30d418p-6 (RZ)
{0xbc05'a1e2U, 0xbc98'6a0cU, 0U, 1U, 0U},
// x = -0x1.245ee4p-7, exp10m1f(x) = -0x1.4d2b86p-6 (RZ)
{0xbc12'2f72U, 0xbca6'95c3U, 0U, 1U, 0U},
// x = -0x1.f9f2dap-7, exp10m1f(x) = -0x1.1e2186p-5 (RZ)
{0xbc7c'f96dU, 0xbd0f'10c3U, 0U, 1U, 0U},
// x = -0x1.08e42p-6, exp10m1f(x) = -0x1.2b5c4p-5 (RZ)
{0xbc84'7210U, 0xbd15'ae20U, 0U, 1U, 1U},
// x = -0x1.0cdc44p-5, exp10m1f(x) = -0x1.2a2152p-4 (RZ)
{0xbd06'6e22U, 0xbd95'10a9U, 0U, 1U, 1U},
// x = -0x1.ca4322p-5, exp10m1f(x) = -0x1.ef073p-4 (RZ)
{0xbd65'2191U, 0xbdf7'8398U, 0U, 1U, 1U},
}};

LLVM_LIBC_FUNCTION(float, exp10m1f, (float x)) {
using FPBits = fputil::FPBits<float>;
FPBits xbits(x);

uint32_t x_u = xbits.uintval();
uint32_t x_abs = x_u & 0x7fff'ffffU;

// When x >= log10(2^128), or x is nan
if (LIBC_UNLIKELY(xbits.is_pos() && x_u >= 0x421a'209bU)) {
if (xbits.is_finite()) {
int rounding = fputil::quick_get_round();
if (rounding == FE_DOWNWARD || rounding == FE_TOWARDZERO)
return FPBits::max_normal().get_val();

fputil::set_errno_if_required(ERANGE);
fputil::raise_except_if_required(FE_OVERFLOW);
}

// x >= log10(2^128) and 10^x - 1 rounds to +inf, or x is +inf or nan
return x + FPBits::inf().get_val();
}

// When |x| <= log10(2) * 2^(-6)
if (LIBC_UNLIKELY(x_abs <= 0x3b9a'209bU)) {
if (auto r = EXP10M1F_EXCEPTS_LO.lookup(x_u); LIBC_UNLIKELY(r.has_value()))
return r.value();

double dx = x;
double dx_sq = dx * dx;
double c0 = dx * Exp10Base::COEFFS[0];
double c1 =
fputil::multiply_add(dx, Exp10Base::COEFFS[2], Exp10Base::COEFFS[1]);
double c2 =
fputil::multiply_add(dx, Exp10Base::COEFFS[4], Exp10Base::COEFFS[3]);
// 10^dx - 1 ~ (1 + COEFFS[0] * dx + ... + COEFFS[4] * dx^5) - 1
// = COEFFS[0] * dx + ... + COEFFS[4] * dx^5
return static_cast<float>(fputil::polyeval(dx_sq, c0, c1, c2));
Comment on lines +125 to +134
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Based on Exp10Base::powb_lo.

}

// When x <= log10(2^-25), or x is nan
if (LIBC_UNLIKELY(x_u >= 0xc0f0d2f1)) {
// exp10m1(-inf) = -1
if (xbits.is_inf())
return -1.0f;
// exp10m1(nan) = nan
if (xbits.is_nan())
return x;

int rounding = fputil::quick_get_round();
if (rounding == FE_UPWARD || rounding == FE_TOWARDZERO ||
(rounding == FE_TONEAREST && x_u == 0xc0f0d2f1))
return -0x1.ffff'fep-1f; // -1.0f + 0x1.0p-24f
fputil::set_errno_if_required(ERANGE);
fputil::raise_except_if_required(FE_UNDERFLOW);
return -1.0f;
}
// Exact outputs when x = 1, 2, ..., 10.
// Quick check mask: 0x800f'ffffU = ~(bits of 1.0f | ... | bits of 10.0f)
if (LIBC_UNLIKELY((x_u & 0x800f'ffffU) == 0)) {
switch (x_u) {
case 0x3f800000U: // x = 1.0f
return 9.0f;
case 0x40000000U: // x = 2.0f
return 99.0f;
case 0x40400000U: // x = 3.0f
return 999.0f;
case 0x40800000U: // x = 4.0f
return 9'999.0f;
case 0x40a00000U: // x = 5.0f
return 99'999.0f;
case 0x40c00000U: // x = 6.0f
return 999'999.0f;
case 0x40e00000U: // x = 7.0f
return 9'999'999.0f;
case 0x41000000U: { // x = 8.0f
int rounding = fputil::quick_get_round();
if (rounding == FE_UPWARD || rounding == FE_TONEAREST)
return 100'000'000.0f;
return 99'999'992.0f;
}
case 0x41100000U: { // x = 9.0f
int rounding = fputil::quick_get_round();
if (rounding == FE_UPWARD || rounding == FE_TONEAREST)
return 1'000'000'000.0f;
return 999'999'936.0f;
}
case 0x41200000U: { // x = 10.0f
int rounding = fputil::quick_get_round();
if (rounding == FE_UPWARD || rounding == FE_TONEAREST)
return 10'000'000'000.0f;
return 9'999'998'976.0f;
}
}
}

if (auto r = EXP10M1F_EXCEPTS_HI.lookup(x_u); LIBC_UNLIKELY(r.has_value()))
return r.value();

// Range reduction: 10^x = 2^(mid + hi) * 10^lo
// rr = (2^(mid + hi), lo)
auto rr = exp_b_range_reduc<Exp10Base>(x);

// The low part is approximated by a degree-5 minimax polynomial.
// 10^lo ~ 1 + COEFFS[0] * lo + ... + COEFFS[4] * lo^5
double lo_sq = rr.lo * rr.lo;
double c0 = fputil::multiply_add(rr.lo, Exp10Base::COEFFS[0], 1.0);
double c1 =
fputil::multiply_add(rr.lo, Exp10Base::COEFFS[2], Exp10Base::COEFFS[1]);
double c2 =
fputil::multiply_add(rr.lo, Exp10Base::COEFFS[4], Exp10Base::COEFFS[3]);
double exp10_lo = fputil::polyeval(lo_sq, c0, c1, c2);
// 10^x - 1 = 2^(mid + hi) * 10^lo - 1
// ~ mh * exp10_lo - 1
return static_cast<float>(fputil::multiply_add(exp10_lo, rr.mh, -1.0));
}

} // namespace LIBC_NAMESPACE
8 changes: 4 additions & 4 deletions libc/src/math/generic/explogxf.h
Original file line number Diff line number Diff line change
Expand Up @@ -159,12 +159,12 @@ template <class Base> LIBC_INLINE exp_b_reduc_t exp_b_range_reduc(float x) {
int k = static_cast<int>(kd);
// hi = floor(kd * 2^(-MID_BITS))
// exp_hi = shift hi to the exponent field of double precision.
int64_t exp_hi = static_cast<int64_t>((k >> Base::MID_BITS))
<< fputil::FPBits<double>::FRACTION_LEN;
uint64_t exp_hi = static_cast<uint64_t>(k >> Base::MID_BITS)
<< fputil::FPBits<double>::FRACTION_LEN;
// mh = 2^hi * 2^mid
// mh_bits = bit field of mh
int64_t mh_bits = Base::EXP_2_MID[k & Base::MID_MASK] + exp_hi;
double mh = fputil::FPBits<double>(uint64_t(mh_bits)).get_val();
uint64_t mh_bits = Base::EXP_2_MID[k & Base::MID_MASK] + exp_hi;
double mh = fputil::FPBits<double>(mh_bits).get_val();
// dx = lo = x - (hi + mid) * log(2)
double dx = fputil::multiply_add(
kd, Base::M_LOGB_2_LO, fputil::multiply_add(kd, Base::M_LOGB_2_HI, xd));
Expand Down
3 changes: 2 additions & 1 deletion libc/test/UnitTest/FPMatcher.h
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,8 @@ template <typename T> struct FPTest : public Test {
LIBC_NAMESPACE::cpp::numeric_limits<StorageType>::max();
static constexpr T zero = FPBits::zero(Sign::POS).get_val();
static constexpr T neg_zero = FPBits::zero(Sign::NEG).get_val();
static constexpr T aNaN = FPBits::quiet_nan().get_val();
static constexpr T aNaN = FPBits::quiet_nan(Sign::POS).get_val();
static constexpr T neg_aNaN = FPBits::quiet_nan(Sign::NEG).get_val();
static constexpr T sNaN = FPBits::signaling_nan().get_val();
static constexpr T inf = FPBits::inf(Sign::POS).get_val();
static constexpr T neg_inf = FPBits::inf(Sign::NEG).get_val();
Expand Down
15 changes: 15 additions & 0 deletions libc/test/src/math/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -1084,6 +1084,21 @@ add_fp_unittest(
libc.src.math.exp10m1f16
)

add_fp_unittest(
exp10m1f_test
NEED_MPFR
SUITE
libc-math-unittests
SRCS
exp10m1f_test.cpp
DEPENDS
libc.hdr.math_macros
libc.src.errno.errno
libc.src.math.exp10m1f
libc.src.__support.CPP.array
libc.src.__support.FPUtil.fp_bits
)

add_fp_unittest(
copysign_test
SUITE
Expand Down
Loading
Loading