abs

kyosu::abs = eve::functor<abs_t>

inlineconstexpr

Computes the absolute value of the parameter.

Header file

#include <kyosu/functions.hpp>

Callable Signatures

namespace kyosu
{
   //regular calls
   template<kyosu::concepts::cayley_dickson T> constexpr as_real_type_t<T> abs(T z) noexcept;       // 1
   template<kyosu::concepts::real T>           constexpr T                 abs(T z) noexcept;       // 1
 
   // Semantic modifyiers
   template<kyosu::concepts::cayley_dickson T> constexpr as_real_type_t<T> abs[raw](T z) noexcept;  // 2
   template<kyosu::concepts::real T>           constexpr T                 abs[raw](T z) noexcept;  // 2
}

Parameters

• z: Value to process.

Return value

1. The modulus of its parameter (always a floating ordered value). The modulus is the square root of the sum of the squares of the absolute value of each component.
2. With the raw option no provision is made to enhance accuracy and avoid overflows

External references

• C++ standard reference: complex abs

Example

#include <kyosu/kyosu.hpp>
#include <eve/wide.hpp>
#include <iostream>
 
int main()
{
  using kyosu::abs;
  using kyosu::complex_t;
  using kyosu::quaternion_t;
 
  std::cout << "Real:        ";
  std::cout << 72.9f << " -> " << abs(72.9f) << "\n";
 
  std::cout << "Complex:     ";
  std::cout << kyosu::complex_t<float>(3.5f,-2.9f) << " -> " << abs(kyosu::complex_t<float>(3.5f,-2.9f)) << "\n";
 
  std::cout << "Quaternion:  ";
  std::cout << kyosu::quaternion_t<double>(1.,2.,3.,4.) << " -> " << abs(kyosu::quaternion_t<double>(1.,2.,3.,4.)) << "\n";
 
  std::cout << "SIMD:        ";
  using wc_t = eve::wide<kyosu::complex_t<double>, eve::fixed<2>>;
  std::cout << wc_t(kyosu::complex_t<double>(1.3,-3.7)) << " -> " << abs(wc_t(kyosu::complex_t<double>(1.3,-3.7))) << "\n";
 
  return 0;
}