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

来自cppreference.com
< cpp‎ | numeric‎ | math
 
 
 
常用数学函数
函数
基本运算
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)(C++11)(C++11)
指数函数
(C++11)
(C++11)
(C++11)
(C++11)
幂函数
(C++11)
(C++11)
三角与双曲函数
(C++11)
(C++11)
atanh
(C++11)
误差与伽马函数
(C++11)
(C++11)
(C++11)
(C++11)
临近整数的浮点运算
(C++11)(C++11)(C++11)
(C++11)
(C++11)
(C++11)(C++11)(C++11)
浮点操作函数
(C++11)(C++11)
(C++11)
(C++11)
(C++11)(C++11)
(C++11)
分类/比较
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
宏常量
(C++11)(C++11)(C++11)(C++11)(C++11)
 
在标头 <cmath> 定义
(1)
float       atanh ( float num );

double      atanh ( double num );

long double atanh ( long double num );
(C++11 起)
(C++23 前)
/* 浮点类型 */ atanh( /* 浮点类型 */ num );
(C++23 起)
float       atanhf( float num );
(2) (C++11 起)
long double atanhl( long double num );
(3) (C++11 起)
在标头 <cmath> 定义
template< class Integer >
double      atanh ( Integer num );
(A) (C++11 起)
1-3) 计算 num 的反双曲正切。标准库提供所有以无 cv 限定的浮点类型作为参数 num 的类型的 std::atanh 重载。 (C++23 起)
A) 为所有整数类型提供额外重载,将它们当做 double

参数

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';
 
    // 错误处理
    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\n";
}

可能的输出:

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

参阅

(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. “反双曲正切。”来自 MathWorld--A Wolfram Web Resource 。