std::log2, std::log2f, std::log2l

 

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

1-3) Computes the binary (base-2) logarithm of num. The library provides overloads of std::log2 for all cv-unqualified floating-point types as the type of the parameter.(since C++23)

S) The SIMD overload performs an element-wise std::log2 on v_num. (定義については、math-floating-point および deduced-simd-t を参照してください。)

(C++26以降)

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

(C++11以降)

Parameters

num

-

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

Return value

If no errors occur, the base-2 logarithm of num (log2(num) or lb(num)) is returned.

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

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

Error handling

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

Domain error occurs if num is less than zero.

Pole error may occur if num is zero.

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

• If the argument is ±0, -∞ is returned and FE_DIVBYZERO is raised.
• If the argument is 1, +0 is returned.
• If the argument is negative, NaN is returned and FE_INVALID is raised.
• 引数が +∞ の場合、+∞ が返されます。
• 引数が NaN の場合、NaN が返されます。

Notes

For integer num, the binary logarithm can be interpreted as the zero-based index of the most significant 1 bit in the input.

The additional overloads are not required to be provided exactly as (A). They only need to be sufficient to ensure that for their argument num of integer type, std::log2(num) has the same effect as std::log2(static_cast<double>(num)).

Example

このコードを実行

#include <cerrno>
#include <cfenv>
#include <cmath>
#include <cstring>
#include <iostream>
// #pragma STDC FENV_ACCESS ON
 
int main()
{
    std::cout << "log2(65536) = " << std::log2(65536) << '\n'
              << "log2(0.125) = " << std::log2(0.125) << '\n'
              << "log2(0x020f) = " << std::log2(0x020f)
              << " (highest set bit is in position 9)\n"
              << "base-5 logarithm of 125 = "
              << std::log2(125) / std::log2(5) << '\n';
 
    // special values
    std::cout << "log2(1) = " << std::log2(1) << '\n'
              << "log2(+Inf) = " << std::log2(INFINITY) << '\n';
 
    // error handling
    errno = 0;
    std::feclearexcept(FE_ALL_EXCEPT);
 
    std::cout << "log2(0) = " << std::log2(0) << '\n';
 
    if (errno == ERANGE)
        std::cout << "    errno == ERANGE: " << std::strerror(errno) << '\n';
    if (std::fetestexcept(FE_DIVBYZERO))
        std::cout << "    FE_DIVBYZERO raised\n";
}

実行結果の例

log2(65536) = 16
log2(0.125) = -3
log2(0x020f) = 9.04166 (highest set bit is in position 9)
base-5 logarithm of 125 = 3
log2(1) = 0
log2(+Inf) = inf
log2(0) = -inf
    errno == ERANGE: Numerical result out of range
    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)) (関数)
log1plog1pflog1pl (C++11)(C++11)(C++11)	与えられた数値に 1 を足した値の自然対数 (e を底とする) (\({\small\ln{(1+x)}}\)ln(1+x)) (関数)
exp2exp2fexp2l (C++11)(C++11)(C++11)	与えられたべき乗に累乗した 2 を返す (\({\small 2^x}\)2x) (関数)
C documentation for log2