fmod

auto eve::fmod = functor<fmod_t>

inlineconstexpr

Header file

#include <eve/module/core.hpp>

Callable Signatures

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

Parameters

• x, y: real argumentx.
• 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 mimick the behaviour of std::fmod. In particular:
   • If x is \(\pm0\), \(\pm0\) is returned.
   • If x is \(\pm\inf\) or NaN, NaN is returned.
   • If y is \(\pm0\), NaN is returned.
   • If y is \(\pm\inf\) and x is finite, xis returned.
2. The operation is performed conditionnaly.

External references

• C++ standard reference

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 << "-> fmod(wf0, wf1)                 = " << eve::fmod(wf0, wf1) << "\n";
  std::cout << "-> fmod[ignore_last(2)](wf0, wf1) = " << eve::fmod[eve::ignore_last(2)](wf0, wf1) << "\n";
  std::cout << "-> fmod[wf0 != 0](wf0, wf1)       = " << eve::fmod[wf0 != 0](wf0, wf1) << "\n";
}