sulp

auto eve::sulp = functor<sulp_t>

inlineconstexpr

Header file

#include <eve/module/core.hpp>

Callable Signatures

namespace eve
{
   // Regular overload
   constexpr auto sulp(value auto x)                          noexcept; // 1
 
   // Lanes masking
   constexpr auto sulp[conditional_expr auto c](value auto x) noexcept; // 2
   constexpr auto sulp[logical_value auto m](value auto x)    noexcept; // 2
 
   // Semantic options
   constexpr auto sulp[kahan](value auto x)                    noexcept; // 1
   constexpr auto sulp[harrison](value auto x)                 noexcept; // 3
}

Parameters

• x: value.
• c: Conditional expression masking the operation.
• m: Logical value masking the operation.

Return value

1. The distance of x to the next representable element in the type of x in the x direction. (Kahan definition)
2. The operation is performed conditionnaly.
3. The distance of x to the nearest representable element in the type of x, not equal to x. (Harrisson definition).

Note

invalid entries return NaN

External references

• wikipedia
• HAL: On the definition of ulp(x)
• HAL: On various ways to split a floating-point number

Example

// revision 0
#include <eve/module/core.hpp>
#include <iostream>
 
int main()
{
  eve::wide wf0{0.0, 1.0, 2.0, 3.0, -1.0, -2.0, -3.0, 10*eve::mindenormal(eve::as(-4.0))};
  eve::wide wi0{0, 1, 2, 3, -1, -2, -3, -4};
  eve::wide wu0{0u, 1u, 2u, 3u, 4u, 5u, 6u, 7u};
 
  std::cout << "<- wf0                          = " << wf0 << "\n";
  std::cout << "<- wi0                          = " << wi0 << "\n";
  std::cout << "<- wu0                          = " << wu0 << "\n";
 
  std::cout << "-> sulp(wf0)                 = " << eve::sulp(wf0) << "\n";
  std::cout << "-> sulp[kahan](wf0)          = " << eve::sulp[eve::kahan](wf0) << "\n";
  std::cout << "-> sulp[harrisson](wf0)      = " << eve::sulp[eve::harrisson](wf0) << "\n";
  std::cout << "-> sulp[ignore_last(2)](wf0) = " << eve::sulp[eve::ignore_last(2)](wf0) << "\n";
  std::cout << "-> sulp[wf0 != 1.0f](wf0)    = " << eve::sulp[wf0 != 1](wf0) << "\n";
  std::cout << "-> sulp(wu0)                 = " << eve::sulp(wu0) << "\n";
  std::cout << "-> sulp[ignore_last(2)](wu0) = " << eve::sulp[eve::ignore_last(2)](wu0) << "\n";
  std::cout << "-> sulp[wu0 != 2](wu0)       = " << eve::sulp[wu0 != 2](wu0) << "\n";
  std::cout << "-> sulp(wi0)                 = " << eve::sulp(wi0) << "\n";
  std::cout << "-> sulp[ignore_last(2)](wi0) = " << eve::sulp[eve::ignore_last(2)](wi0) << "\n";
  std::cout << "-> sulp[wi0 != 3](wi0)       = " << eve::sulp[wi0 != 3](wi0) << "\n";
    std::cout << eve::sulp[eve::kahan](wf0)/eve::sulp(wf0) << std::endl;
 
}