std::atanh, std::atanhf, std::atanhl
来自 cppreference.cn
定义于头文件 <cmath> |
||
(1) | ||
float atanh ( float num ); double atanh ( double num ); |
(直到 C++23) | |
/*floating-point-type*/ atanh ( /*floating-point-type*/ num ); |
(自 C++23 起) (constexpr 自 C++26 起) |
|
float atanhf( float num ); |
(2) | (自 C++11 起) (constexpr 自 C++26 起) |
long double atanhl( long double num ); |
(3) | (自 C++11 起) (constexpr 自 C++26 起) |
SIMD 重载 (自 C++26 起) |
||
定义于头文件 <simd> |
||
template< /*math-floating-point*/ V > constexpr /*deduced-simd-t*/<V> |
(S) | (自 C++26 起) |
附加重载 (自 C++11 起) |
||
定义于头文件 <cmath> |
||
template< class Integer > double atanh ( Integer num ); |
(A) | (constexpr 自 C++26 起) |
1-3) 计算 num 的反双曲正切。 库为所有 cv 无限定浮点类型作为参数类型提供了
std::atanh
的重载。(自 C++23 起)
S) SIMD 重载对 v_num 执行元素wise
std::atanh 操作。
|
(自 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_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 文档 关于 atanh
|
[编辑] 外部链接
Weisstein, Eric W. "Inverse Hyperbolic Tangent." 来自 MathWorld — Wolfram Web Resource。 |