hypot

eve::hypot = functor<hypot_t>

inlineconstexpr

Defined in Header

#include <eve/module/math.hpp>

Callable Signatures

namespace eve
{
   template< value T, value ... Ts>
   auto hypot( T x,Ts ... args ) const noexcept
}

Parameters

x, ... args: floating real values

Return value

\(\sqrt{\sum_1^n |x_i|^2}\) is returned. The result type is the common value type of the absolute values of the parameters.

Example

#include <eve/module/math.hpp>
#include <eve/module/math.hpp>
#include <eve/wide.hpp>
#include <iomanip>
#include <iostream>
#include <cmath>
 
using wide_ft = eve::wide<float, eve::fixed<4>>;
 
int main()
{
  wide_ft pf = {-1.0f, 2.0f, -3.0f, eve::valmax(eve::as<float>())/2};
  wide_ft qf = {-4, 3, -2, -12};
 
  std::cout << "---- simd" << std::setprecision(10) << '\n'
            << "<- pf                       = " << pf << '\n'
            << "<- qf                       = " << qf << '\n'
            << "-> hypot(pf, qf)            = " << eve::hypot(pf, qf) << '\n'
            << "-> hypot[pedantic](pf, qf)  = " << eve::hypot[eve::pedantic](pf, qf) << '\n';
 
  double        xf = -327680000;
  double        yf = 10;
 
  std::cout << "---- scalar"  << std::setprecision(15) << '\n'
            << "<- xf                       = " << xf << '\n'
            << "<- yf                       = " << yf << '\n'
            << "-> hypot(xf, yf)            = " << eve::hypot(xf, yf) << '\n'
            << "-> hypot[pedantic](xf, yf)  = " << eve::hypot[eve::pedantic](xf, yf) << '\n';
 
  return 0;
}

Semantic Modifiers

• eve::pedantic

  The call pedantic(hypot)(x,args...) computes the square root of the sum of the absolute squares of the parameters without undue overflow or underflow at intermediate stages of the computation and can be more accurate than the non-decorated call.

  Morever it returns \(\infty\) as soon as one of its parameter is infinite, regardless of possible Nan values.

  Example

  #include <eve/module/math.hpp>
  #include <eve/wide.hpp>
  #include <iomanip>
  #include <iostream>
  #include <cmath>
   
  using wide_ft = eve::wide<float, eve::fixed<4>>;
   
  int main()
  {
    wide_ft pf = {-1.0f, eve::inf(eve::as(1.0f)), -3.0f, eve::smallestposval(eve::as<float>())/2};
    wide_ft qf = {-4,    eve::nan(eve::as(1.0f)), -2, -12};
   
    std::cout << "---- simd" << std::setprecision(10) << '\n'
              << "<- pf                       = " << pf << '\n'
              << "<- qf                       = " << qf << '\n'
              << "-> hypot[pedantic](pf, qf)  = " << eve::hypot[eve::pedantic](pf, qf) << '\n';
   
   
    std::cout << eve::hypot[eve::pedantic](5.0, 1.0e-305) << std::endl;
    return 0;
  }