min

eve::min = {}

inlineconstexpr

Computes the minimum of its arguments.

Defined in Header

#include <eve/module/core.hpp>

Callable Signatures

namespace eve
{
   template< eve::value T, eve::value... Ts >
   eve::common_compatible_t<T, Ts...> min(T x, Ts ... xs) noexcept;
 
}

Parameters

• x, xs... : arguments.

Return value

The value of the minimum of the arguments is returned.

Note

• If any element of the inputs is a Nan, the corresponding output element is system-dependent.

Example

#include <eve/module/core.hpp>
#include <eve/wide.hpp>
#include <iostream>
 
using wide_ft = eve::wide<float, eve::fixed<8>>;
using eve::pedantic;
 
int main()
{
  wide_ft pf = {0.0f, 1.0f, -1.0f, -2.0f, 2.0f,
                eve::inf(eve::as<float>()), eve::minf(eve::as<float>()), eve::nan(eve::as<float>())};
  wide_ft qf = {4.0f, 1.0f, -1.0f,  0.0f, eve::nan(eve::as<float>()),
                -0.0f, eve::nan(eve::as<float>()), -2.0f};
 
 
  std::cout << "---- simd" << '\n'
            << "<- pf                     = " << pf << '\n'
            << "<- qf                     = " << qf << '\n'
            << "-> min(pf, qf)            = " << eve::min(pf, qf) << '\n';
 
  float xf = 1.0f;
  float yf = eve::nan(eve::as<float>());
 
  std::cout << "---- scalar" << '\n'
            << "<- xf                     = " << xf << '\n'
            << "<- yf                     = " << yf << '\n'
            << "-> min(xf, yf) =          = " << eve::min(xf, yf) << '\n';
  return 0;
}

Semantic Modifiers

• Masked Call

  The call eve::min[mask](x, ...) provides a masked version of min which is equivalent to if_else(mask, min(x, ...), x)

  Example

  #include <eve/module/core.hpp>
  #include <eve/wide.hpp>
  #include <iostream>
   
  using wide_ft = eve::wide<float, eve::fixed<8>>;
  using eve::pedantic;
   
  int main()
  {
    wide_ft pf = {0.0f, 1.0f, -1.0f, -2.0f, 2.0f,
                  eve::inf(eve::as<float>()), eve::minf(eve::as<float>()), eve::nan(eve::as<float>())};
    wide_ft qf = {4.0f, 1.0f, -1.0f,  0.0f, eve::nan(eve::as<float>()),
                  -0.0f, eve::nan(eve::as<float>()), -2.0f};
   
   
    std::cout << "---- simd" << '\n'
              << "<- pf                      = " << pf << '\n'
              << "<- qf                      = " << qf << '\n'
              << "-> min[pf <  0](pf, qf) = " << eve::min[pf <  0](pf, qf) << '\n';
    return 0;
  }

• eve::pedantic, eve::numeric

  • The call pedantic(min)(x,args,...) ensures the conformity to the standard behaviour, that is for two parameters (on an elementwise basis) to be semantically equivalent to: (x < y) ? x : y and this behaviour is also ensured on n parameters calls as if this scheme was recursively used.
  • The call numeric(min)(x,args,...) ensures that if any element of the inputs is not a Nan, the corresponding output element will not be a Nan.

  Example