dist

eve::dist = functor<dist_t>

inlineconstexpr

Header file

#include <eve/module/core.hpp>

Callable Signatures

namespace eve
{
   // Regular overloads
   constexpr auto dist(eve::value auto x, eve::value auto y)                          noexcept; // 1
 
   // Lanes masking
   constexpr auto dist[conditional_expr auto c](eve::value auto x, eve::value auto y) noexcept; // 2
   constexpr auto dist[logical_value auto m](eve::value auto x, eve::value auto y)    noexcept; // 2
 
   // Semantic options
   constexpr auto dist[saturated](eve::value auto x, eve::value auto y)               noexcept; // 3
   constexpr auto dist[pedantic](eve::value auto x, eve::value auto y)                noexcept; // 4
}

Parameters

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

Return value

1. The value of the distance of the arguments is returned, i.e. abs (x-y).
2. The operation is performed conditionnaly.
3. The call dist[saturated](x, y) computes a saturated distance. Contrary to the non decorated case, it guarantees that the result is always defined. If \(|x-y|\) is not representable, the greatest representable positive value is returned.
4. dist[pedantic](x, y)computes a distance wich is NaN if and only if one of the parameters is a NaN.

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, -4.0};
  eve::wide wf1{0.0, -4.0, 1.0, -1.0, 2.0, -2.0, 3.0, -3.0};
  eve::wide wi0{0, 1, 2, 3, -1, -2, -3, -4};
  eve::wide wi1{0, -4, 1, -1, 2, -2, 3, -3};
  eve::wide wu0{0u, 1u, 2u, 3u, 4u, 5u, 6u, 7u};
  eve::wide wu1{7u, 6u, 5u, 4u, 3u, 2u, 1u, 0u};
 
  std::cout << "<- wf0                            = " << wf0 << "\n";
  std::cout << "<- wf1                            = " << wf1 << "\n";
  std::cout << "<- wi0                            = " << wi0 << "\n";
  std::cout << "<- wi1                            = " << wi1 << "\n";
  std::cout << "<- wu0                            = " << wu0 << "\n";
  std::cout << "<- wu1                            = " << wu1 << "\n";
                                                  
  std::cout << "-> dist(wf0, wf1)                 = " << eve::dist(wf0, wf1) << "\n";
  std::cout << "-> dist[ignore_last(2)](wf0, wf1) = " << eve::dist[eve::ignore_last(2)](wf0, wf1) << "\n";
  std::cout << "-> dist[wf0 != 0](wf0, wf1)       = " << eve::dist[wf0 != 0](wf0, wf1) << "\n";
  std::cout << "-> dist[pedantic](wf0, wf1)       = " << eve::dist[eve::pedantic](wf0, wf1) << "\n";
  std::cout << "-> dist(wu0, wu1)                 = " << eve::dist(wu0, wu1) << "\n";
  std::cout << "-> dist[ignore_last(2)](wu0, wu1) = " << eve::dist[eve::ignore_last(2)](wu0, wu1) << "\n";
  std::cout << "-> dist[wu0 != 0](wu0, wu1)       = " << eve::dist[wu0 != 0](wu0, wu1) << "\n";
  std::cout << "-> dist[saturated](wu0, wu1)      = " << eve::dist[eve::saturated](wu0, wu1) << "\n";
  std::cout << "-> dist[pedantic](wu0, wu1)       = " << eve::dist[eve::pedantic](wu0, wu1) << "\n";
  std::cout << "-> dist(wi0, wi1)                 = " << eve::dist(wi0, wi1) << "\n";
  std::cout << "-> dist[ignore_last(2)](wi0, wi1) = " << eve::dist[eve::ignore_last(2)](wi0, wi1) << "\n";
  std::cout << "-> dist[wi0 != 0](wi0, wi1)       = " << eve::dist[wi0 != 0](wi0, wi1) << "\n";
  std::cout << "-> dist[saturated](wi0, wi1)      = " << eve::dist[eve::saturated](wi0, wi1) << "\n";
  std::cout << "-> dist[pedantic](wi0, wi1)       = " << eve::dist[eve::pedantic](wi0, wi1) << "\n";
}