std::expm1, std::expm1f, std::expm1l
From cppreference.com
| ヘッダー <cmath> で定義 |
||
| (1) | ||
float expm1 ( float num ); double expm1 ( double num ); |
(C++23まで) | |
| /*浮動小数点数型*/ expm1 ( /*浮動小数点数型*/ num ); |
(C++23から) (C++26 以降 constexpr) |
|
float expm1f( float num ); |
(2) | (C++11以降) (C++26 以降 constexpr) |
long double expm1l( long double num ); |
(3) | (C++11以降) (C++26 以降 constexpr) |
| SIMDオーバーロード (C++26以降) |
||
| ヘッダー <simd> で定義 |
||
| template< /*math-floating-point*/ V > constexpr /*deduced-simd-t*/<V> |
(S) | (C++26以降) |
| 追加のオーバーロード (C++11以降) |
||
| ヘッダー <cmath> で定義 |
||
template< class Integer > double expm1 ( Integer num ); |
(A) | (C++26 以降 constexpr) |
1-3) 与えられたべき乗 num における e(ネイピア数、2.7182818...)を計算し、そこから 1.0 を引きます。この関数は、num がゼロに近い場合、式 std::exp(num) - 1.0 よりも高精度です。ライブラリは、パラメータの型として、すべての cv-修飾されていない浮動小数点数型に対して
std::expm1 のオーバーロードを提供します。(since C++23)|
S) SIMD オーバーロードは、v_num に対して要素ごとの
std::expm1 を実行します。
|
(C++26以降) |
|
A) すべての整数型に対する追加のオーバーロードが提供されます。これらは double として扱われます。
|
(C++11以降) |
目次 |
[編集] Parameters
| num | - | 浮動小数点数または整数値 |
[編集] Return value
エラーが発生しなかった場合、enum
-1 が返されます。
オーバーフローによる範囲エラーが発生した場合、+HUGE_VAL、+HUGE_VALF、または +HUGE_VALL が返されます。
アンダーフローによる範囲エラーが発生した場合、正確な結果 (丸め後) が返される。
[編集] Error handling
エラーは math_errhandling で指定された通りに報告される。
実装がIEEE浮動小数点算術 (IEC 60559) をサポートしている場合、
- 引数が ±0 の場合、引数は変更されずに返されます。
- 引数が -∞ の場合、-1 が返されます。
- 引数が +∞ の場合、+∞ が返されます。
- 引数が NaN の場合、NaN が返されます。
[編集] Notes
関数 std::expm1 と std::log1p は、例えば小さな日次金利の計算など、金融計算に役立ちます。 (1+x)n
-1 は std::expm1(n * std::log1p(x)) として表現できます。これらの関数は、逆双曲線関数の正確な記述を単純化します。
IEEE互換の型 double の場合、709.8 < num であればオーバーフローが保証されます。
追加のオーバーロードは、(A) とまったく同じように提供される必要はありません。整数型の引数 num に対して、std::expm1(num) が std::expm1(static_cast<double>(num)) と同じ効果を持つことを保証するのに十分であればよいのです。
[編集] Example
このコードを実行
#include <cerrno> #include <cfenv> #include <cmath> #include <cstring> #include <iostream> // #pragma STDC FENV_ACCESS ON int main() { std::cout << "expm1(1) = " << std::expm1(1) << '\n' << "Interest earned in 2 days on $100, compounded daily at 1%\n" << " on a 30/360 calendar = " << 100 * std::expm1(2 * std::log1p(0.01 / 360)) << '\n' << "exp(1e-16)-1 = " << std::exp(1e-16) - 1 << ", but expm1(1e-16) = " << std::expm1(1e-16) << '\n'; // special values std::cout << "expm1(-0) = " << std::expm1(-0.0) << '\n' << "expm1(-Inf) = " << std::expm1(-INFINITY) << '\n'; // error handling errno = 0; std::feclearexcept(FE_ALL_EXCEPT); std::cout << "expm1(710) = " << std::expm1(710) << '\n'; if (errno == ERANGE) std::cout << " errno == ERANGE: " << std::strerror(errno) << '\n'; if (std::fetestexcept(FE_OVERFLOW)) std::cout << " FE_OVERFLOW raised\n"; }
実行結果の例
expm1(1) = 1.71828
Interest earned in 2 days on $100, compounded daily at 1%
on a 30/360 calendar = 0.00555563
exp(1e-16)-1 = 0, but expm1(1e-16) = 1e-16
expm1(-0) = -0
expm1(-Inf) = -1
expm1(710) = inf
errno == ERANGE: Result too large
FE_OVERFLOW raised[編集] See also
| (C++11)(C++11) |
与えられたべき乗に累乗した e を返す (ex) (関数) |
| (C++11)(C++11)(C++11) |
与えられたべき乗に累乗した 2 を返す (2x) (関数) |
| (C++11)(C++11)(C++11) |
与えられた数値に 1 を足した値の自然対数 (e を底とする) (ln(1+x)) (関数) |
| C ドキュメント for expm1
| |