sqr

auto eve::sqr = functor<sqr_t>

inlineconstexpr

Header file

#include <eve/module/core.hpp>

Callable Signatures

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

Parameters

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

Return value

1. value containing the elementwise square of x if it is representable in this type.
2. The operation is performed conditionnaly.
3. Contrary to the non-decorated case, it guarantees that the result is elementwise greater or equal than 0. More specifically, for any integer value x, the call evaluates to: valmax(as(x)) as soon as abs[saturated](x) is greater than sqrtvalmax(as(x)).
4. The square is done in a 'round toward \(-\infty\) mode. The product is guaranted to be less or equal to the exact one.
5. The square is done in a 'round toward \(\infty\) mode. The product is guaranted to be greater or equal to the exact one.

Note

For integral signed values if eve::abs[eve::saturated](x) is greater than eve::Sqrtvalmax(as(x)) the corresponding element result is undefined.

Example

// revision 0
#include <eve/module/core.hpp>
#include <iostream>
 
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 << "-> sqr(wf0)                 = " << eve::sqr(wf0) << "\n";
  std::cout << "-> sqr[ignore_last(2)](wf0) = " << eve::sqr[eve::ignore_last(2)](wf0) << "\n";
  std::cout << "-> sqr[wf0 != 0](wf0)       = " << eve::sqr[wf0 != 0](wf0) << "\n";
  std::cout << "-> sqr(wu0)                 = " << eve::sqr(wu0) << "\n";
  std::cout << "-> sqr[ignore_last(2)](wu0) = " << eve::sqr[eve::ignore_last(2)](wu0) << "\n";
  std::cout << "-> sqr[wu0 != 0](wu0)       = " << eve::sqr[wu0 != 0](wu0) << "\n";
  std::cout << "-> sqr[saturated](wu0)      = " << eve::sqr[eve::saturated](wu0) << "\n";
  std::cout << "-> sqr(wi0)                 = " << eve::sqr(wi0) << "\n";
  std::cout << "-> sqr[ignore_last(2)](wi0) = " << eve::sqr[eve::ignore_last(2)](wi0) << "\n";
  std::cout << "-> sqr[wi0 != 0](wi0)       = " << eve::sqr[wi0 != 0](wi0) << "\n";
  std::cout << "-> sqr[saturated](wi0)      = " << eve::sqr[eve::saturated](wi0) << "\n";
}