inc

auto eve::inc = functor<inc_t>

inlineconstexpr

Header file

#include <eve/module/core.hpp>

Callable Signatures

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

Parameters

• x: SIMD or scalar value.
• c: Conditional expression masking the operation.
• m: Logical value masking the operation.
• p: modulo p operation. p must be flint less than maxflint.

Return value

1. The value of x + 1 is returned.
2. The operation is performed conditionally.
3. The saturated incrementation of x. More specifically, for signed integral, inc[saturated](valmax(as<T>{})) returns eve::valmax(as<T>{})). This has no effect on floating types.
4. The increment is computed in a 'round toward \(-\infty\) mode. The result is guaranteed to be less or equal to the exact one (except for Nans). Combined with strict the option ensures generally faster computation, but strict inequality. This has no effect on integral types.
5. The increment is computed in a 'round toward \(\infty\) mode. The result is guaranteed to be greater or equal to the exact one (except for Nans). Combined with strict the option ensures generally faster computation, but strict inequality. This has no effect on integral types.
6. Computes the result in modular arithmetic. The parameter must be flint positive and less than the modulus. The modulus itself must be positive and less than maxflint. The result of the operation is unspecified if these conditions are not met.

Example

// revision 0
#include <eve/module/core.hpp>
#include <iostream>
#include <iomanip>
 
int main()
{
  auto sml = eve::smallestposval(eve::as(1.0));
  eve::wide wf0{sml, -sml, 2.0, 3.0, -1.0, -2.0, -3.0, -4.0};
  eve::wide wf1{0.0, 34.0, 0.0, 72.0, 4.0, 3.0, 2.0, 96.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 << "<- wf1                      = " << wf1 << "\n";
  std::cout << "<- wi0                      = " << wi0 << "\n";
  std::cout << "<- wu0                      = " << wu0 << "\n";
 
  std::cout << "-> inc(wf0)                 = " << eve::inc(wf0) << "\n";
  std::cout << "-> inc[ignore_last(2)](wf0) = " << eve::inc[eve::ignore_last(2)](wf0) << "\n";
  std::cout << "-> inc[wf0 != 0](wf0)       = " << eve::inc[wf0 != 0](wf0) << "\n";
  std::cout << "-> inc(wu0)                 = " << eve::inc(wu0) << "\n";
  std::cout << "-> inc[ignore_last(2)](wu0) = " << eve::inc[eve::ignore_last(2)](wu0) << "\n";
  std::cout << "-> inc[wu0 != 0](wu0)       = " << eve::inc[wu0 != 0](wu0) << "\n";
  std::cout << "-> inc[saturated](wu0)      = " << eve::inc[eve::saturated](wu0) << "\n";
  std::cout << "-> inc(wi0)                 = " << eve::inc(wi0) << "\n";
  std::cout << "-> inc[ignore_last(2)](wi0) = " << eve::inc[eve::ignore_last(2)](wi0) << "\n";
  std::cout << "-> inc[wi0 != 0](wi0)       = " << eve::inc[wi0 != 0](wi0) << "\n";
  std::cout << "-> inc[saturated](wi0)      = " << eve::inc[eve::saturated](wi0) << "\n";
  std::cout << std::setprecision(20) << "-> inc[lower](wf0)         = " << eve::inc[eve::lower](wf0) << "\n";
  std::cout << std::setprecision(20) << "-> inc[upper](wf0)         = " << eve::inc[eve::upper](wf0) << "\n";
  std::cout << std::setprecision(20) << "-> inc[lower][strict](wf0)   = " << eve::inc[eve::lower][eve::strict](wf0) << "\n";
  std::cout << std::setprecision(20) << "-> inc[upper][strict](wf0)   = " << eve::inc[eve::upper][eve::strict](wf0) << "\n";
  std::cout << std::setprecision(20) << "-> inc[mod = 97](wf1)        = " << eve::inc[eve::mod = 97](wf1) << "\n";
}