sqrt

eve::sqrt = functor<sqrt_t>

inlineconstexpr

Header file

#include <eve/module/core.hpp>

Callable Signatures

namespace eve
{
   // Regular overload
   constexpr auto sqrt(floating_value auto x)                          noexcept; // 1
 
   // Lanes masking
   constexpr auto sqrt[conditional_expr auto c](floating_value auto x) noexcept; // 2
   constexpr auto sqrt[logical_value auto m](floating_value auto x)    noexcept; // 2
 
   // Semantic options
   constexpr auto sqrt[raw](floating_value auto x)                     noexcept; // 3
   constexpr auto sqrt[lower](floating_value auto x)                   noexcept; // 4
   constexpr auto sqrt[upper](floating_value auto x)                   noexcept; // 5
 
}

Parameters

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

Return value

1. A floating-point value containing the elementwise square root of x or NaN if x is less than zero.
2. The operation is performed conditionally.
3. Calls a proper system intrinsic if one exists, but with possibly very poor accuracy in return. Otherwise, the regular implementation is used.
4. The square root is computed in a 'round toward \(-\infty\) mode. The result is guaranteed to be less than or equal to the exact value (except for NaNs).
5. The square root is computed in a 'round toward \(\infty\) mode. The result is guaranteed to be greater than or equal to the exact value (except for NaNs).

Example

// revision 0
#include <eve/module/core.hpp>
#include <iostream>
#include <iomanip>
 
int main()
{
  eve::wide wf0{0.0, 1.0, 2.0, 3.0, -1.0, -2.0, -3.0, -4.0};
  eve::wide wi0{0, 1, 2, 3, -1, -2, -3, -4};
  eve::wide wu0{0u, 1u, 2u, 3u, 4u, 5u, 6u, 7u};
 
  std::cout << "<- wf0                       = " << wf0 << "\n";
  std::cout << "<- wi0                       = " << wi0 << "\n";
  std::cout << "<- wu0                       = " << wu0 << "\n";
 
  std::cout << "-> sqrt(wf0)                 = " << eve::sqrt(wf0) << "\n";
  std::cout << "-> sqrt[ignore_last(2)](wf0) = " << eve::sqrt[eve::ignore_last(2)](wf0) << "\n";
  std::cout << "-> sqrt[wf0 != 0](wf0)       = " << eve::sqrt[wf0 != 0](wf0) << "\n";
  std::cout << "-> sqrt[raw](wf0)            = " << eve::sqrt[eve::raw](wf0) << "\n";
  std::cout << "-> sqrt(wu0)                 = " << eve::sqrt(wu0) << "\n";
  std::cout << "-> sqrt[ignore_last(2)](wu0) = " << eve::sqrt[eve::ignore_last(2)](wu0) << "\n";
  std::cout << "-> sqrt[wu0 != 0](wu0)       = " << eve::sqrt[wu0 != 0](wu0) << "\n";
  std::cout << "-> sqrt[raw](wu0)            = " << eve::sqrt[eve::raw](wu0) << "\n";
  std::cout << "-> sqrt(wi0)                 = " << eve::sqrt(wi0) << "\n";
  std::cout << "-> sqrt[ignore_last(2)](wi0) = " << eve::sqrt[eve::ignore_last(2)](wi0) << "\n";
  std::cout << "-> sqrt[wi0 != 0](wi0)       = " << eve::sqrt[wi0 != 0](wi0) << "\n";
  std::cout << "-> sqrt[raw](wi0)            = " << eve::sqrt[eve::raw](wi0) << "\n";
  std::cout << std::setprecision(20) << "-> sqrt(wf0)                = " << eve::sqrt(wf0) << "\n";
  std::cout << std::setprecision(20) << "-> sqrt[lower](wf0)         = " << eve::sqrt[eve::lower](wf0) << "\n";
  std::cout << std::setprecision(20) << "-> sqrt[upper](wf0)         = " << eve::sqrt[eve::upper](wf0) << "\n";
  std::cout << std::setprecision(20) << "-> sqrt[lower][strict](wf0)   = " << eve::sqrt[eve::lower][eve::strict](wf0) << "\n";
  std::cout << std::setprecision(20) << "-> sqrt[upper][strict](wf0)   = " << eve::sqrt[eve::upper][eve::strict](wf0) << "\n";
}