std::tanh(std::valarray)
From cppreference.com
Defined in header <valarray>
|
||
template< class T > valarray<T> tanh( const valarray<T>& va ); |
||
For each element in va
computes hyperbolic tangent of the value of the element.
Parameters
va | - | value array to apply the operation to |
Return value
Value array containing hyperbolic tangent of the values in va
.
Notes
Unqualified function (tanh) is used to perform the computation. If such function is not available, std::tanh is used due to argument dependent lookup.
The function can be implemented with the return type different from std::valarray. In this case, the replacement type has the following properties:
- All const member functions of std::valarray are provided.
- std::valarray, std::slice_array, std::gslice_array, std::mask_array and std::indirect_array can be constructed from the replacement type.
- All functions accepting an argument of type const std::valarray& except begin() and end() (since C++11) should also accept the replacement type.
- All functions accepting two arguments of type const std::valarray& should accept every combination of const std::valarray& and the replacement type.
- The return type does not add more than two levels of template nesting over the most deeply-nested argument type.
Possible implementation
template<class T> valarray<T> tanh(const valarray<T>& va) { valarray<T> other = va; for (T &i : other) { i = tanh(i); } return other; } |
Example
This section is incomplete Reason: no example |
See also
applies the function std::sinh to each element of valarray (function template) | |
applies the function std::cosh to each element of valarray (function template) | |
(C++11)(C++11) |
hyperbolic tangent (function) |
computes hyperbolic tangent of a complex number (function template) |