std::lgamma, std::lgammaf, std::lgammal

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

1-3) num のガンマ関数の絶対値の自然対数を計算します。ライブラリは、パラメータの型として、すべての cv 修飾されていない浮動小数点型に対する std::lgamma のオーバーロードを提供します。(since C++23)

S) SIMD オーバーロードは、v_num に対して要素ごとの std::lgamma を実行します。

(定義については、math-floating-point および deduced-simd-t を参照してください。)

(C++26以降)

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

(C++11以降)

If the argument is 1, +0 is returned.
引数が 2 の場合、+0 が返されます。
引数が ±0 の場合、+∞ が返され、FE_DIVBYZERO が発生します。
引数が負の整数の場合、+∞ が返され、FE_DIVBYZERO が発生します。
引数が ±∞ の場合、+∞ が返されます。
引数が NaN の場合、NaN が返されます。

[編集] 注

num が自然数である場合、std::lgamma(num) は num - 1 の階乗の対数です。

POSIX 版の lgamma はスレッドセーフではありません。関数の各実行は、ガンマ関数の num における符号を静的外部変数 signgam に格納します。一部の実装では、signgam 用のユーザー提供ストレージへのポインタを 2 番目のパラメータとして受け取る lgamma_r が提供されており、これはスレッドセーフです。

様々な実装に gamma という名前の非標準関数がありますが、その定義は一貫性がありません。例えば、glibc と 4.2BSD 版の gamma は lgamma を実行しますが、4.4BSD 版の gamma は tgamma を実行します。

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

[編集] 例

このコードを実行

#include <cerrno>
#include <cfenv>
#include <cmath>
#include <cstring>
#include <iostream>
 
// #pragma STDC FENV_ACCESS ON
 
const double pi = std::acos(-1); // or std::numbers::pi since C++20
 
int main()
{
    std::cout << "lgamma(10) = " << std::lgamma(10)
              << ", log(9!) = " << std::log(std::tgamma(10))
              << ", exp(lgamma(10)) = " << std::exp(std::lgamma(10)) << '\n'
              << "lgamma(0.5) = " << std::lgamma(0.5)
              << ", log(sqrt(pi)) = " << std::log(std::sqrt(pi)) << '\n';
 
    // special values
    std::cout << "lgamma(1) = " << std::lgamma(1) << '\n'
              << "lgamma(+Inf) = " << std::lgamma(INFINITY) << '\n';
 
    // error handling
    errno = 0;
    std::feclearexcept(FE_ALL_EXCEPT);
 
    std::cout << "lgamma(0) = " << std::lgamma(0) << '\n';
 
    if (errno == ERANGE)
        std::cout << "    errno == ERANGE: " << std::strerror(errno) << '\n';
    if (std::fetestexcept(FE_DIVBYZERO))
        std::cout << "    FE_DIVBYZERO raised\n";
}

出力

lgamma(10) = 12.8018, log(9!) = 12.8018, exp(lgamma(10)) = 362880
lgamma(0.5) = 0.572365, log(sqrt(pi)) = 0.572365
lgamma(1) = 0
lgamma(+Inf) = inf
lgamma(0) = inf
    errno == ERANGE: Numerical result out of range
    FE_DIVBYZERO raised

[編集] 関連項目

tgammatgammaftgammal (C++11)(C++11)(C++11)	ガンマ関数 (関数) [編集]
C ドキュメント (lgamma)

[編集] 外部リンク

Weisstein, Eric W. "Log Gamma Function." MathWorld — A Wolfram Web Resource より。

コンパイラサポート
フリースタンディングとホスト
言語
標準ライブラリ
標準ライブラリヘッダー
名前付き要件
機能テストマクロ (C++20)
言語サポートライブラリ
コンセプトライブラリ (C++20)
診断ライブラリ
メモリ管理ライブラリ
メタプログラミングライブラリ (C++11)
汎用ユーティリティライブラリ
コンテナライブラリ
イテレータライブラリ
Rangesライブラリ (C++20)
アルゴリズムライブラリ
文字列ライブラリ
テキスト処理ライブラリ
数値ライブラリ
日付と時刻ライブラリ
入出力ライブラリ
ファイルシステムライブラリ (C++17)
並行サポートライブラリ (C++11)
実行制御ライブラリ (C++26)
Technical specifications (技術仕様)
シンボルインデックス
外部ライブラリ

cppreference.com

名前空間

変種

表示

操作

std::lgamma, std::lgammaf, std::lgammal

目次

[編集] パラメータ

[編集] 戻り値

[編集] エラー処理

[編集] 注

[編集] 例

[編集] 関連項目

[編集] 外部リンク

ナビゲーション

ツールボックス