名前空間
変種
操作

std::atanh, std::atanhf, std::atanhl

From cppreference.com
< cpp‎ | numeric‎ | math
 
 
 
 
ヘッダー <cmath> で定義
(1)
float       atanh ( float num );

double      atanh ( double num );

long double atanh ( long double num );
(C++23まで)
/*浮動小数点数型*/
            atanh ( /*浮動小数点型*/ num );
(C++23から)
(C++26 以降 constexpr)
float       atanhf( float num );
(2) (C++11以降)
(C++26 以降 constexpr)
long double atanhl( long double num );
(3) (C++11以降)
(C++26 以降 constexpr)
ヘッダー <simd> で定義
template< /*math-floating-point*/ V >

constexpr /*deduced-simd-t*/<V>

            atanh ( const V& v_num );
(S) (C++26以降)
ヘッダー <cmath> で定義
template< class Integer >
double      atanh ( Integer num );
(A) (C++26 以降 constexpr)
1-3) num の逆双曲線正接を計算します。ライブラリは、パラメータの型として、すべての cv 修飾されていない浮動小数点型に対する std::atanh のオーバーロードを提供します。(C++23 以降)
S) SIMD オーバーロードは、v_num に対して要素ごとの std::atanh を実行します。
(定義については、math-floating-point および deduced-simd-t を参照してください。)
(C++26以降)
A) すべての整数型に対する追加のオーバーロードが提供されます。これらは double として扱われます。
(C++11以降)

目次

[編集] パラメータ

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

[編集] 戻り値

エラーが発生しない場合、num の逆双曲線正接(tanh-1
(num)
または artanh(num))が返されます。

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

極値エラーが発生した場合、(正しい符号を持つ)±HUGE_VAL±HUGE_VALF、または ±HUGE_VALL が返されます。

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

[編集] エラー処理

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

引数が区間 [-1+1] にない場合、範囲エラーが発生します。

引数が ±1 の場合、極値エラーが発生します。

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

  • `±0` の場合、引数は変更されずに返されます。
  • 引数が ±1 の場合、±∞ が返され、FE_DIVBYZERO が発生します。
  • |num|>1 の場合、NaN が返され、FE_INVALID が発生します。
  • 引数が NaN の場合、NaN が返されます。

[編集] 注記

C++ がこの関数に関して参照する C 標準では、この関数は「逆双曲線正接(arc hyperbolic tangent)」と名付けられていますが、双曲線関数の逆関数は面積関数です。引数は円弧ではなく、双曲線扇形の面積です。正しい名称は「逆双曲線正接(inverse hyperbolic tangent)(POSIXで使用)」または「面積双曲線正接(area hyperbolic tangent)」です。

POSIX では、アンダーフローの場合、num は変更されずに返され、それがサポートされない場合は、DBL_MINFLT_MIN、および LDBL_MIN 以下の実装定義値が返されると指定されています。

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

[編集]

#include <cerrno>
#include <cfenv>
#include <cfloat>
#include <cmath>
#include <cstring>
#include <iostream>
// #pragma STDC FENV_ACCESS ON
 
int main()
{
    std::cout << "atanh(0) = " << std::atanh(0) << '\n'
              << "atanh(-0) = " << std::atanh(-0.0) << '\n'
              << "atanh(0.9) = " << std::atanh(0.9) << '\n';
 
    // error handling
    errno = 0;
    std::feclearexcept(FE_ALL_EXCEPT);
 
    std::cout << "atanh(-1) = " << std::atanh(-1) << '\n';
 
    if (errno == ERANGE)
        std::cout << "    errno == ERANGE: " << std::strerror(errno) << '\n';
    if (std::fetestexcept(FE_DIVBYZERO))
        std::cout << "    FE_DIVBYZERO raised\n";
}

実行結果の例

atanh(0) = 0
atanh(-0) = -0
atanh(0.9) = 1.47222
atanh(-1) = -inf
    errno == ERANGE: Numerical result out of range
    FE_DIVBYZERO raised

[編集] 関連項目

(C++11)(C++11)(C++11)
逆双曲線正弦を計算する (arsinh(x))
(関数) [編集]
(C++11)(C++11)(C++11)
逆双曲線余弦を計算する (arcosh(x))
(関数) [編集]
(C++11)(C++11)
双曲線正接を計算する (tanh(x))
(関数) [編集]
複素数の逆双曲線正接 (エリアハイパボリックタンジェント) を計算する (artanh(z))
(関数テンプレート) [編集]

[編集] 外部リンク

Weisstein, Eric W. "Inverse Hyperbolic Tangent." MathWorld — A Wolfram Web Resource より。
English 日本語 中文(简体) 中文(繁體)