std::atanh,std::atanhf,std::atanhl
来自 cppreference.com
在头文件 <cmath> 中定义 |
||
(1) | ||
float atanh ( float num ); double atanh ( 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) |
其他重载 (自 C++11 起) |
||
在头文件 <cmath> 中定义 |
||
template< class Integer > double atanh ( Integer num ); |
(A) | (自 C++26 起为 constexpr) |
1-3) 计算 num 的反双曲正切。 库为所有 cv 无限定浮点类型提供了
std::atanh
的重载,作为参数的类型。(自 C++23 起)
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++ 为此函数引用了该标准)将此函数命名为“反双曲正切”,但双曲函数的反函数是面积函数。它们的论证是双曲扇形的面积,而不是弧长。正确名称是“反双曲正切”(POSIX 使用)或“面积双曲正切”。
POSIX 规定 在发生下溢的情况下,返回未修改的 num,如果该操作不受支持,则返回一个实现定义的值,该值不超过 DBL_MIN、FLT_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)) (函数) |
(C++11) |
计算复数的面积双曲正切 (artanh(z)) (函数模板) |
C 文档 for atanh
|
[编辑] 外部链接
Weisstein, Eric W. "反双曲正切." From MathWorld — A Wolfram Web Resource. |