is_finite

eve::is_finite = {}

inlineconstexpr

Returns a logical true if and only if the element is a finite value.

Defined in Header

#include <eve/module/core.hpp>

Callable Signatures

namespace eve
{
   template< eve::value T >
   eve::as_logical<T> is_finite(T x) noexcept;
}

Parameters

• x : real or complex argument.

Return value

For real entries the call is_finite(x) is semantically equivalent to eve::is_not_nan(x-x), in particular this is always true for integral types.

For complex entries is_infinite(z) is semantically equivalent to eve::is_finite(real(z)) && eve::is_finite(imag(z)),

Example

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

Semantic Modifiers

• Masked Call

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

  Example

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