tanh

auto eve::tanh = functor<tanh_t>

inlineconstexpr

Header file

#include <eve/module/math.hpp>

Callable Signatures

namespace eve
{
   // Regular overload
   constexpr auto tanh(floating_value auto x)                          noexcept; // 1
 
   // Lanes masking
   constexpr auto tanh[conditional_expr auto c](floating_value auto x) noexcept; // 2
   constexpr auto tanh[logical_value auto m](floating_value auto x)    noexcept; // 2
}

Parameters

• x: floating value.
• c: Conditional expression masking the operation.
• m: Logical value masking the operation.

Return value

1. Returns the elementwise hyperbolic tangent of the input. In particular:
   • If the element is \(\pm0\), \(\pm0\) is returned.
   • If the element is \(\pm\infty\), \(\pm1\) returned.
   • If the element is a NaN, NaN is returned.

External references

• C++ standard reference
• Wikipedia
• Wolfram MathWorld

Example

// revision 1
#include <eve/module/math.hpp>
#include <iostream>
 
int main()
{
  eve::wide wf = {0.0, 0.25, 0.5, 2.0, -0.0, -0.25,
                  eve::minf(eve::as<double>()), eve::nan(eve::as<double>())};
 
  std::cout << "<- wf = " << wf << "\n";
 
  std::cout << "-> tanh(wf)                = " << eve::tanh(wf) << "\n";
  std::cout << "-> tanh[ignore_last(2)](wf)= " << eve::tanh[eve::ignore_last(2)](wf) << "\n";
  std::cout << "-> tanh[wf != -2.0f](wf)   = " << eve::tanh[wf != -2.0f](wf) << "\n";
}