std::tanh(std::complex)

Defined in header `<complex>`
template< class T > complex<T> tanh( const complex<T>& z );		(since C++11)

Computes complex hyperbolic tangent of a complex value z.

Parameters

z

-

complex value

Return value

If no errors occur, complex hyperbolic tangent of z is returned

Error handling and special values

Errors are reported consistent with math_errhandling

If the implementation supports IEEE floating-point arithmetic,

std::tanh(std::conj(z)) == std::conj(std::tanh(z))
std::tanh(-z) == -std::tanh(z)
If z is (+0,+0), the result is (+0,+0)
If z is (x,+) (for any^[1] finite x), the result is (NaN,NaN) and FE_INVALID is raised
If z is (x,NaN) (for any^[2] finite x), the result is (NaN,NaN) and FE_INVALID may be raised
If z is (+,y) (for any finite positive y), the result is (1,+0)
If z is (+,+), the result is (1,0) (the sign of the imaginary part is unspecified)
If z is (+,NaN), the result is (1,0) (the sign of the imaginary part is unspecified)
If z is (NaN,+0), the result is (NaN,+0)
If z is (NaN,y) (for any non-zero y), the result is (NaN,NaN) and FE_INVALID may be raised
If z is (NaN,NaN), the result is (NaN,NaN)

per C11 DR471, this only holds for non-zero x. If z is (0,), the result should be (0,NaN)
per C11 DR471, this only holds for non-zero x. If z is (0,NaN), the result should be (0,NaN)

Notes

Mathematical definition of hyperbolic tangent is

tanh z = e z -e -z e z +e -z

Hyperbolic tangent is an analytical function on the complex plain and has no branch cuts. It is periodic with respect to the imaginary component, with period i, and has poles of the first order along the imaginary line, at coordinates $(0, (1/2 + n))$ . However no common floating-point representation is able to represent /2 exactly, thus there is no value of the argument for which a pole error occurs.

Example

Run this code

#include <iostream>
#include <cmath>
#include <complex>

int main()
{
    std::cout << std::fixed;
    std::complex<double> z(1, 0); // behaves like real tanh along the real line
    std::cout << "tanh" << z << " = " << std::tanh(z)
              << " (tanh(1) = " << std::tanh(1) << ")\n";

    std::complex<double> z2(0, 1); // behaves like tangent along the imaginary line
    std::cout << "tanh" << z2 << " = " << std::tanh(z2)
              << " ( tan(1) = " << std::tan(1) << ")\n";
}

Output:

tanh(1.000000,0.000000) = (0.761594,0.000000) (tanh(1) = 0.761594)
tanh(0.000000,1.000000) = (0.000000,1.557408) ( tan(1) = 1.557408)

Language
Headers
Freestanding and hosted implementations
Named requirements
Language support library
Concepts library (C++20)
Diagnostics library
Utilities library
Strings library
Containers library
Algorithms library
Iterators library
Numerics library
Input/output library
Localizations library
Regular expressions library (C++11)
Atomic operations library (C++11)
Thread support library (C++11)
Filesystem library (C++17)
Technical Specifications

Common mathematical functions
Special mathematical functions
Floating-point environment (C++11)
Complex numbers
Numeric arrays
Pseudo-random number generation
Compile-time rational arithmetic (C++11)
Numeric algorithms
gcd (C++17)
lcm (C++17)
Generic numeric operations
iota (C++11)
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)
ispow2 (C++20)
ceil2 (C++20)
floor2 (C++20)
log2p1 (C++20)