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

float       atanh ( float num );
double      atanh ( double num );
long double atanh ( long double num );

/*floating-point-type*/
            atanh ( /*floating-point-type*/ num );

float       atanhf( float num );

long double atanhl( long double num );

template< /*math-floating-point*/ V >
constexpr /*deduced-simd-t*/<V> 
            atanh ( const V& v_num );

template< class Integer >
double      atanh ( Integer 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

См. также

Внешние ссылки