is_infinite

eve::is_infinite = {}

inlineconstexpr

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

Defined in Header

#include <eve/module/core.hpp>

Callable Signatures

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

Parameters

• x : real or complex argument.

Return value

For real entries the call is_infinite(x) is semantically equivalent to eve::is_equal(eve::abs(x), eve::inf(as(x)), in particular this is always false for integral types.

For complex entries is_infinite(z) is semantically equivalent to eve::is_infinite(real(z)) || eve::is_infinite(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_infinite(pf) = " << eve::is_infinite(pf) << '\n';
 
  float xf = 1.0f;
 
  std::cout << "---- scalar" << '\n'
            << "<- xf              = " << xf << '\n'
            << "-> is_infinite(xf) = " << eve::is_infinite(xf) << '\n';
  return 0;
}

Semantic Modifiers

• Masked Call

  The call eve;is_infinite[mask](x) provides a masked version of eve::is_infinite which is equivalent to if_else (mask, is_infinite(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_infinite[pf > 0](pf) = " << eve::is_infinite[pf > 0](pf) << '\n';
    return 0;
  }