clamp

auto eve::clamp = functor<clamp_t>

inlineconstexpr

Defined in Header

#include <eve/module/core.hpp>

Callable Signatures

namespace eve
{
   // Regular overload
   constexpr auto clamp(value auto x, value auto lo,  value auto hi)  noexcept; // 1
 
   // Lanes masking
   constexpr auto clamp[conditional_expr auto c](value auto x,
                       value auto lo,  value auto hi) noexcept;                // 2
   constexpr auto clamp[logical_value auto m](value auto x,
                       value auto lo,  value auto hi)    noexcept;             // 2
}

Parameters

• x: value to clamp.
• lo, hi: the boundary values to clamp x to.
• c: Conditional expression masking the operation.
• m: Logical value masking the operation.

Return value

1. Each element of the result contains:
   • lo, if x is less than lo.
   • hi, if hi is less than x.
   • otherwise x.
2. The operation is performed conditionnaly.

Note

If some lo are not less or equal to the corresponding hi the routine asserts.

External references

• C++ standard reference

Example

// revision 2 TODO investigate last result
#include <eve/module/core.hpp>
#include <iostream>
 
int main()
{
  eve::wide wi = {2, -3, 0, 4};
  eve::wide mi = {3, -2, -10, 0};
  eve::wide ma = {4, -1, 0, 5};
 
  std::cout << "<- wi                                 = " << wi << "\n";
  std::cout << "<- mi                                 = " << mi << "\n";
  std::cout << "<- ma                                 = " << ma << "\n";
 
  std::cout << "-> clamp(wi, mi, ma)                  = " << eve::clamp(wi, mi, ma)  << "\n";
  std::cout << "-> clamp[ignore_last(2)](wi, mi, ma)  = " << eve::clamp[eve::ignore_last(2)](wi, mi, ma)  << "\n";
  std::cout << "-> clamp[wi != -4.0f](wi, mi, ma)     = " << eve::clamp[wi != -2.0f](wi, mi, ma)  << "\n";
}