std::tanh(std::complex)

 

C++

Language

Standard library headers

Concepts

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)

 

Numerics library

Common mathematical functions

Floating-point environment

Complex numbers

Numeric arrays

Pseudo-random number generation

Compile-time rational arithmetic (C++11)

Generic numeric operations

iota (C++11)

accumulate

inner_product

adjacent_difference

partial_sum

 

std::complex

Member functions
complex::complex
complex::operator=
complex::real
complex::imag
complex::operator+=complex::operator-=complex::operator*=complex::operator/=
Non-member functions
operator+operator- operator+operator-operator*operator/ operator==operator!= operator<<operator>>	real imag abs arg norm conj proj (C++11) polar operator""ioperator""ifoperator""il (C++14)(C++14)(C++14)
Exponential functions
exp
log
log10
Power functions
pow
sqrt
Trigonometric functions
sin cos tan	asin (C++11) acos (C++11) atan (C++11)
Hyperbolic functions
sinh cosh tanh	asinh (C++11) acosh (C++11) atanh (C++11)

 

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 finite x), the result is (NaN,NaN) and FE_INVALID is raised
• If z is (x,NaN) (for any 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)

Notes

Mathematical definition of hyperbolic tangent is cosh z =

ez -e-z

ez +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)

See also

sinh(std::complex)	computes hyperbolic sine of a complex number (sh(z)) (function template)
cosh(std::complex)	computes hyperbolic cosine of a complex number (ch(z)) (function template)
atanh(std::complex) (C++11)	computes area hyperbolic tangent of a complex number (function template)
tanh	hyperbolic tangent (function)
tanh(std::valarray)	applies the function std::tanh to each element of valarray (function template)
C documentation for ctanh