saturate

auto eve::saturate = functor<saturate_t>

inlineconstexpr

Defined in Header

#include <eve/module/core.hpp>

Callable Signatures

namespace eve
{
   constexpr auto saturate(value auto  x, as<value> t) noexcept;
}

Parameters

• x : argument.
• t : Type wrapper instance embedding the clamping type.

Return value

For an x type U, the call saturate(x, as_<Target>{}) returns elementwise a value of element type U which is x clamped between the smallest and largest values of the Target

Note

Saturation operated by eve::saturate may lead to Undefined Behaviors if it implies conversions that are themselves Undefined Behavior.

Example

// revision 1
#include <eve/module/core.hpp>
#include <iostream>
 
int main()
{
  eve::wide wf0 = {-1.0f, 2.3f, 45000.7f, -64768.6f};
  eve::wide wi0 = {-1l, 2l, -3l, eve::valmax(eve::as<long>())};
 
 
  std::cout << "<- wf0                   = " << wf0 << "\n";
  std::cout << "<- wi0                   = " << wi0 << "\n";
 
  std::cout << "-> saturate(wf0, as(wu)) = " << eve::saturate(wf0, eve::as<std::int16_t>()) << "\n";
  std::cout << "-> saturate(wi, as(wu0)) = " << eve::saturate(wi0, eve::as<std::int16_t>()) << "\n";
}