std::tanh, std::tanhf, std::tanhl

Defined in header `<cmath>`
	(1)
float tanh ( float num ); double tanh ( double num ); long double tanh ( long double num );			(until C++23)
/* floating-point-type / tanh ( / floating-point-type */ num );			(since C++23) (constexpr since C++26)
float tanhf( float num );		(2)	(since C++11) (constexpr since C++26)
long double tanhl( long double num );		(3)	(since C++11) (constexpr since C++26)
Additional overloads (since C++11)
Defined in header `<cmath>`
template< class Integer > double tanh ( Integer num );		(A)	(constexpr since C++26)

1-3) Computes the hyperbolic tangent of num. The library provides overloads of std::tanh for all cv-unqualified floating-point types as the type of the parameter. (since C++23)

A) Additional overloads are provided for all integer types, which are treated as double.

(since C++11)

Parameters

num

-

floating-point or integer value

Return value

If no errors occur, the hyperbolic tangent of num (

tanh(num)

, or

e num -e -num e num +e -num

) is returned.

If a range error occurs due to underflow, the correct result (after rounding) is returned.

Error handling

Errors are reported as specified in math_errhandling.

If the implementation supports IEEE floating-point arithmetic (IEC 60559),

if the argument is ±0, ±0 is returned
If the argument is ±∞, ±1 is returned
if the argument is NaN, NaN is returned

Notes

POSIX specifies that in case of underflow, num is returned unmodified, and if that is not supported, and implementation-defined value no greater than DBL_MIN, FLT_MIN, and LDBL_MIN is returned.

The additional overloads are not required to be provided exactly as (A). They only need to be sufficient to ensure that for their argument num of integer type, std::tanh(num) has the same effect as std::tanh(static_cast<double>(num)).

Examples

Run this code

#include <cmath>
#include <iostream>
#include <random>
 
double get_random_between(double min, double max)
{
    std::random_device rd;
    std::mt19937 gen(rd());
    return std::uniform_real_distribution<>(min, max)(gen);
}
 
int main()
{
    const double x = get_random_between(-1.0, 1.0);
 
    std::cout << std::showpos
              << "tanh(+1) = " << std::tanh(+1) << '\n'
              << "tanh(-1) = " << std::tanh(-1) << '\n'
              << "tanh(x)*sinh(2*x)-cos(2*x) = "
              << std::tanh(x) * std::sinh(2 * x) - std::cosh(2 * x) << '\n'
              // special values:
              << "tanh(+0) = " << std::tanh(+0.0) << '\n'
              << "tanh(-0) = " << std::tanh(-0.0) << '\n';
}

Output:

tanh(+1) = +0.761594
tanh(-1) = -0.761594
tanh(x)*sinh(2*x)-cos(2*x) = -1
tanh(+0) = +0
tanh(-0) = -0

Compiler support
Freestanding and hosted
Language
Standard library
Standard library headers
Named requirements
Feature test macros (C++20)
Language support library
Concepts library (C++20)
Metaprogramming library (C++11)
Diagnostics library
General utilities library
Strings library
Containers library
Iterators library
Ranges library (C++20)
Algorithms library
Numerics library
Localizations library
Input/output library
Filesystem library (C++17)
Regular expressions library (C++11)
Concurrency support library (C++11)
Technical specifications
Symbols index
External libraries

Common mathematical functions
Mathematical special functions (C++17)
Mathematical constants (C++20)
Floating-point environment (C++11)
Complex numbers
Numeric arrays
Pseudo-random number generation
Factor operations
gcd (C++17)
lcm (C++17)
Interpolations
midpoint (C++20)
lerp (C++20)
Generic numeric operations
iota (C++11)
ranges::iota (C++23)
accumulate
inner_product
adjacent_difference
partial_sum
reduce (C++17)
transform_reduce (C++17)
inclusive_scan (C++17)
exclusive_scan (C++17)
transform_inclusive_scan (C++17)
transform_exclusive_scan (C++17)
Bit operations
bit_cast (C++20)
byteswap (C++23)
has_single_bit (C++20)
bit_ceil (C++20)
bit_floor (C++20)
bit_width (C++20)
rotl (C++20)
rotr (C++20)
countl_zero (C++20)
countl_one (C++20)
countr_zero (C++20)
countr_one (C++20)
popcount (C++20)
endian (C++20)

sinhsinhfsinhl (C++11)(C++11)	computes hyperbolic sine (\({\small\sinh{x} }\) $sinh(x)$ ) (function)
coshcoshfcoshl (C++11)(C++11)	computes hyperbolic cosine (\({\small\cosh{x} }\) $cosh(x)$ ) (function)
atanhatanhfatanhl (C++11)(C++11)(C++11)	computes the inverse hyperbolic tangent (\({\small\operatorname{artanh}{x} }\) $artanh(x)$ ) (function)
tanh(std::complex)	computes hyperbolic tangent of a complex number (\({\small\tanh{z} }\) $tanh(z)$ ) (function template)
tanh(std::valarray)	applies the function std::tanh to each element of valarray (function template)