abs

kyosu::abs = {}

inlineconstexpr

Computes the absolute value of the parameter.

Defined in Header

#include <kyosu/functions.hpp>

Callable Signatures

namespace kyosu
{
   template<kyosu::concepts::cayley_dickson T> constexpr as_real_type_t<T>  abs(T z) noexcept;
   template<eve::floating_ordered_value T>     constexpr T                  abs(T z) noexcept;
}

Parameters

• z: Value to process.

Return value

• Returns the modulus of its argument which always is a floating ordered value. The modulus is the square root of the sum of the square of the absolute value of each component.

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;
}