remainder

eve::remainder = functor<remainder_t>

inlineconstexpr

Header file

#include <eve/module/core.hpp>

Callable Signatures

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

Parameters

• x, y: real arguments.
• c: Conditional expression masking the operation.
• m: Logical value masking the operation.

Return value

1. Returns the remainder after division division of x by y and is equivalent to x- eve::nearest(eve:div(x, y))*y. In particular:
   • If x is $\pm\inf$ or NaN, NaN is returned.
   • If y is $\pm0$ $\pm0$ is returned
   • If y is NaN, NaN is returned.
2. The operation is performed conditionnaly.

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 wf1{0.0, -4.0, 1.0, -1.0, 2.0, -2.0, 3.0, -3.0};
 
  std::cout << "<- wf0                                 = " << wf0 << "\n";
  std::cout << "<- wf1                                 = " << wf1 << "\n";
                                                       
  std::cout << "-> remainder(wf0, wf1)                 = " << eve::remainder(wf0, wf1) << "\n";
  std::cout << "-> remainder[ignore_last(2)](wf0, wf1) = " << eve::remainder[eve::ignore_last(2)](wf0, wf1) << "\n";
  std::cout << "-> remainder[wf0 != 0](wf0, wf1)       = " << eve::remainder[wf0 != 0](wf0, wf1) << "\n";
}

Output:

<- wf0 = (0, 1, 2, 3, -1, -2, -3, -4)
<- wf1 = (0, -4, 1, -1, 2, -2, 3, -3)
-> remainder(wf0, wf1) = (0, 1, 0, 0, -1, 0, 0, -1)
-> remainder[ignore_last(2)](wf0, wf1) = (0, 1, 0, 0, -1, 0, -3, -4)
-> remainder[wf0 != 0](wf0, wf1) = (0, 1, 0, 0, -1, 0, 0, -1)