pure

auto kyosu::pure = eve::functor<pure_t>

inlineconstexpr

Extracts the imaginary part of a value.

Header file

#include <kyosu/functions.hpp>

Callable Signatures

namespace kyosu
{
   template<kyosu::concepts::cayley_dickson T> constexpr T pure(T const& z)  noexcept;
   template<kyosu::real T>                     constexpr T pure(T const& z)  noexcept;
}

Parameters

• z: Original value.

Return value

Returns the pure (also called imaginary) part of its argument. For real inputs, the call returns 0. It is an alias of imag.

Example

#include <eve/wide.hpp>
#include <iostream>
#include <kyosu/kyosu.hpp>
 
int main()
{
 
  using wide_ft = eve::wide<float, eve::fixed<4>>;
  wide_ft ref1 = {3.0f, 2.0f, 1.0f, 0.5f};
  wide_ft imf1 = {2.0f, -1.0, -5.0, 0.0};
  wide_ft ref2 = {0.0, 1.0, 2.0, 3.0};
  auto zc = kyosu::complex_t<wide_ft>(ref1, imf1);
 
  std::cout << "---- simd" << std::endl
            << "<- zc            = " << zc << std::endl
            << "-> imag(zc)      = " << kyosu::imag(zc) << std::endl
            << "-> imag(ref2)    = " << kyosu::imag(ref2) << std::endl;
 
  return 0;
}