xfunctor_view

Warning

doxygengroup: Cannot find group “xt_xfunctor_view” in doxygen xml output for project “xtensor” from directory: ../xml

group xt_xcomplex

Defined in xtensor/xcomplex.hpp

Functions

template<class E>
decltype(auto) real(E &&e) noexcept

Return an xt::xexpression representing the real part of the given expression.

The returned expression either hold a const reference to e or a copy depending on whether e is an lvalue or an rvalue.

Template Parameters

e – The xt::xexpression

template<class E>
decltype(auto) imag(E &&e) noexcept

Return an xt::xexpression representing the imaginary part of the given expression.

The returned expression either hold a const reference to e or a copy depending on whether e is an lvalue or an rvalue.

Template Parameters

e – The xt::xexpression

template<class E>
inline auto conj(E &&e) noexcept

Return an xt::xfunction evaluating to the complex conjugate of the given expression.

Parameters

e – the xt::xexpression

template<class E>
inline auto arg(E &&e) noexcept

Calculates the phase angle (in radians) elementwise for the complex numbers in e.

Parameters

e – the xt::xexpression

template<class E>
inline auto angle(E &&e, bool deg = false) noexcept

Calculates the phase angle elementwise for the complex numbers in e.

Note that this function might be slightly less perfomant than xt::arg.

Parameters
  • e – the xt::xexpression

  • deg – calculate angle in degrees instead of radians

template<class E>
inline auto norm(E &&e) noexcept

Calculates the squared magnitude elementwise for the complex numbers in e.

Equivalent to xt::pow(xt::real(e), 2) + xt::pow(xt::imag(e), 2).

Parameters

e – the xt::xexpression