std::log1p, std::log1pf, std::log1pl

 

C++

コンパイラサポート

フリースタンディングとホスト

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

機能テストマクロ (C++20)

言語サポートライブラリ

コンセプトライブラリ (C++20)

診断ライブラリ

メモリ管理ライブラリ

メタプログラミングライブラリ (C++11)

汎用ユーティリティライブラリ

コンテナライブラリ

イテレータライブラリ

Rangesライブラリ (C++20)

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

ファイルシステムライブラリ (C++17)

並行サポートライブラリ (C++11)

実行制御ライブラリ (C++26)

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

数値ライブラリ

共通の数学関数
数学特殊関数 (C++17)
数学定数 (C++20)
基本的な線形代数アルゴリズム (C++26)
データ並列型 (SIMD) (C++26)
浮動小数点環境 (C++11)
複素数
数値配列 (valarray)
擬似乱数生成
ビット操作 (C++20)
因数操作
gcd (C++17)	lcm (C++17)
補間
midpoint (C++20)	lerp (C++20)
飽和演算
add_sat (C++26) sub_sat (C++26) saturate_cast (C++26)	mul_sat (C++26) div_sat (C++26)
汎用数値演算
iota (C++11) ranges::iota (C++23) accumulate inner_product adjacent_difference    partial_sum	reduce (C++17) transform_reduce (C++17) inclusive_scan (C++17) exclusive_scan (C++17) transform_inclusive_scan (C++17) transform_exclusive_scan (C++17)

 

共通の数学関数

関数
基本的な数学関数
abs(int)labsllabsimaxabs (C++11)   abs(float)fabs divldivlldivimaxdiv (C++11)	fmod remainder (C++11)   remquo (C++11) fma (C++11) fmax (C++11) fmin (C++11) fdim (C++11) nannanfnanl (C++11)(C++11)(C++11)
指数関数
exp exp2 (C++11) expm1 (C++11)	log log10 log1p (C++11) log2 (C++11)
べき乗関数
sqrt cbrt (C++11)	hypot (C++11) pow
三角関数と 双曲線関数
sin cos tan asin acos atan atan2	sinh cosh tanh asinh (C++11) acosh (C++11) atanh (C++11)
誤差関数とガンマ関数
erf (C++11) erfc (C++11)	lgamma (C++11) tgamma (C++11)

最近接整数への浮動小数点数操作
ceil floor roundlroundllround (C++11)(C++11)(C++11)	trunc (C++11) nearbyint (C++11) rintlrintllrint (C++11)(C++11)(C++11)
浮動小数点数の操作関数
ldexp scalbnscalbln (C++11)(C++11) ilogb (C++11) logb (C++11)	frexp modf nextafternexttoward (C++11)(C++11) copysign (C++11)
分類と比較
fpclassify (C++11) isfinite (C++11) isinf (C++11) isnan (C++11) isnormal (C++11) signbit (C++11)	isgreater (C++11) isgreaterequal (C++11) isless (C++11) islessequal (C++11) islessgreater (C++11) isunordered (C++11)
型
div_t ldiv_t lldiv_t (C++11)	imaxdiv_t (C++11) float_t (C++11) double_t (C++11)
マクロ定数
HUGE_VALFHUGE_VALHUGE_VALL (C++11)(C++11) math_errhandlingMATH_ERRNOMATH_ERREXCEPT (C++11)   INFINITY (C++11) NAN (C++11)	分類 FP_NORMALFP_SUBNORMALFP_ZEROFP_INFINITEFP_NAN (C++11)(C++11)(C++11)(C++11)(C++11)

 

ヘッダー <cmath> で定義
	(1)
float        log1p ( float num ); double      log1p ( double num ); long double log1p ( long double num );			(C++23まで)
/*浮動小数点数型*/             log1p ( /*浮動小数点型*/ num );			(C++23から) (C++26 以降 constexpr)
float        log1pf( float num );		(2)	(C++11以降) (C++26 以降 constexpr)
long double log1pl( long double num );		(3)	(C++11以降) (C++26 以降 constexpr)
SIMDオーバーロード (C++26以降)
ヘッダー <simd> で定義
template< /*math-floating-point*/ V > constexpr /*deduced-simd-t*/<V>             log1p ( const V& v_num );		(S)	(C++26以降)
追加のオーバーロード (C++11以降)
ヘッダー <cmath> で定義
template< class Integer > double      log1p ( Integer num );		(A)	(C++26 以降 constexpr)

1-3) 1 + num の自然対数（底がe）を計算します。この関数は、num がゼロに近い場合、式 std::log(1 + num) よりも精度が高いです。ライブラリは、パラメータの型としてすべての cv 修飾されていない浮動小数点型に対する std::log1p のオーバーロードを提供します。(since C++23)

S) SIMD オーバーロードは、v_num に対して要素ごとの std::log1p を実行します。 (定義については、math-floating-point および deduced-simd-t を参照してください。)

(C++26以降)

A) すべての整数型に対する追加のオーバーロードが提供されます。これらは double として扱われます。

(C++11以降)

Parameters

num

-

浮動小数点数または整数値

Return value

エラーが発生しない場合、ln(1+num) が返されます。

領域エラーが発生した場合、実装定義の値が返される (サポートされている場合はNaN)。

If a pole error occurs, -HUGE_VAL, -HUGE_VALF, or -HUGE_VALL is returned.

アンダーフローによる範囲エラーが発生した場合、正確な結果 (丸め後) が返される。

Error handling

エラーは math_errhandling で指定された通りに報告される。

num が -1 未満の場合、ドメインエラーが発生します。

num が -1 の場合、極値エラーが発生する可能性があります。

実装がIEEE浮動小数点算術 (IEC 60559) をサポートしている場合、

• 引数が ±0 の場合、引数は変更されずに返されます。
• 引数が -1 の場合、-∞ が返され、FE_DIVBYZERO が発生します。
• 引数が -1 未満の場合、NaN が返され、FE_INVALID が発生します。
• 引数が +∞ の場合、+∞ が返されます。
• 引数が NaN の場合、NaN が返されます。

Notes

std::expm1 および std::log1p 関数は、例えば小さな日歩を計算する際の財務計算に役立ちます。 (1 + x)n
- 1 は std::expm1(n * std::log1p(x)) と表現できます。これらの関数は、逆双曲線関数の正確な記述を単純化します。

追加のオーバーロードは、(A) とまったく同じように提供される必要はありません。整数型の引数 num に対して、std::log1p(num) が std::log1p(static_cast<double>(num)) と同じ効果を持つことを保証するのに十分であればよいのです。

Example

このコードを実行

#include <cerrno>
#include <cfenv>
#include <cmath>
#include <cstring>
#include <iostream>
// #pragma STDC FENV_ACCESS ON
 
int main()
{
    std::cout << "log1p(0) = " << log1p(0) << '\n'
              << "Interest earned in 2 days on $100, compounded daily at 1%\n"
              << "    on a 30/360 calendar = "
              << 100 * expm1(2 * log1p(0.01 / 360)) << '\n'
              << "log(1+1e-16) = " << std::log(1 + 1e-16)
              << ", but log1p(1e-16) = " << std::log1p(1e-16) << '\n';
 
    // special values
    std::cout << "log1p(-0) = " << std::log1p(-0.0) << '\n'
              << "log1p(+Inf) = " << std::log1p(INFINITY) << '\n';
 
    // error handling
    errno = 0;
    std::feclearexcept(FE_ALL_EXCEPT);
 
    std::cout << "log1p(-1) = " << std::log1p(-1) << '\n';
 
    if (errno == ERANGE)
        std::cout << "    errno == ERANGE: " << std::strerror(errno) << '\n';
    if (std::fetestexcept(FE_DIVBYZERO))
        std::cout << "    FE_DIVBYZERO raised\n";
}

実行結果の例

log1p(0) = 0
Interest earned in 2 days on $100, compounded daily at 1%
    on a 30/360 calendar = 0.00555563
log(1+1e-16) = 0, but log1p(1e-16) = 1e-16
log1p(-0) = -0
log1p(+Inf) = inf
log1p(-1) = -inf
    errno == ERANGE: Result too large
    FE_DIVBYZERO raised

See also

loglogflogl (C++11)(C++11)	自然対数 (e を底とする) を計算する (\({\small\ln{x}}\)ln(x)) (関数)
log10log10flog10l (C++11)(C++11)	常用対数 (10 を底とする) を計算する (\({\small\log_{10}{x}}\)log10(x)) (関数)
log2log2flog2l (C++11)(C++11)(C++11)	与えられた数値の 2 を底とする対数 (\({\small\log_{2}{x}}\)log2(x)) (関数)
expm1expm1fexpm1l (C++11)(C++11)(C++11)	与えられたべき乗に累乗した e から 1 を引いた値を返す (\({\small e^x-1}\)ex-1) (関数)
C ドキュメント for log1p