atanh

auto eve::atanh = functor<atanh_t>

inlineconstexpr

Header file

#include <eve/module/math.hpp>

Callable Signatures

namespace eve
{
   // Regular overload
   constexpr auto atanh(floating_value auto x)                          noexcept; // 1
 
   // Lanes masking
   constexpr auto atanh[conditional_expr auto c](floating_value auto x) noexcept; // 2
   constexpr auto atanh[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 inverse hyperbolic tangent of the input. In particular:
   • If the element is \(\pm1\), \(\pm\infty\) is returned.
   • If the element is \(\pm0\), \(\pm0\) is returned.
   • If the absolute value of the element is greater than one or a NaN, NaN is returned.
2. The operation is performed conditionnaly.

External references

• C++ standard reference: atanh
• Wolfram MathWorld: Inverse Hyperbolic Tangent
• Wikipedia: Inverse hyperbolic functions
• DLMF: Inverse hyperbolic functions

Example

// revision 1
#include <eve/module/math.hpp>
#include <iostream>
 
int main()
{
  eve::wide wf = { 0.0f, 0.99f, -1.0f, -0.5f};
 
  std::cout << "<- wf                       = " << wf << "\n";
 
  std::cout << "-> atanh(wf)                = " << eve::atanh(wf) << "\n";
  std::cout << "-> atanh[ignore_last(2)](wf)= " << eve::atanh[eve::ignore_last(2)](wf) << "\n";
  std::cout << "-> atanh[wf != -1.0f](wf)   = " << eve::atanh[wf != -1.0f](wf) << "\n";
}