CommonCwiseUnaryOps.inc

// This file is part of Eigen, a lightweight C++ template library
// for linear algebra.
//
// Copyright (C) 2008-2009 Gael Guennebaud <gael.guennebaud@inria.fr>
// Copyright (C) 2006-2008 Benoit Jacob <jacob.benoit.1@gmail.com>
//
// This Source Code Form is subject to the terms of the Mozilla
// Public License v. 2.0. If a copy of the MPL was not distributed
// with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
// SPDX-License-Identifier: MPL-2.0
 
// This file is a base class plugin containing common coefficient wise functions.
 
#ifndef EIGEN_PARSED_BY_DOXYGEN

using ConjugateReturnType =
    std::conditional_t<NumTraits<Scalar>::IsComplex,
                       const CwiseUnaryOp<internal::scalar_conjugate_op<Scalar>, const Derived>, const Derived&>;
using RealReturnType =
    std::conditional_t<NumTraits<Scalar>::IsComplex,
                       const CwiseUnaryOp<internal::scalar_real_op<Scalar>, const Derived>, const Derived&>;
using NonConstRealReturnType =
    std::conditional_t<NumTraits<Scalar>::IsComplex, CwiseUnaryView<internal::scalar_real_ref_op<Scalar>, Derived>,
                       Derived&>;
using ImagReturnType = CwiseUnaryOp<internal::scalar_imag_op<Scalar>, const Derived>;
using NonConstImagReturnType =
    std::conditional_t<NumTraits<Scalar>::IsComplex, CwiseUnaryView<internal::scalar_imag_ref_op<Scalar>, Derived>,
                       ImagReturnType>;
 
using NegativeReturnType = CwiseUnaryOp<internal::scalar_opposite_op<Scalar>, const Derived>;
 
#endif  // not EIGEN_PARSED_BY_DOXYGEN

EIGEN_DOC_UNARY_ADDONS(operator-, opposite)
EIGEN_DEVICE_FUNC constexpr inline const NegativeReturnType operator-() const { return NegativeReturnType(derived()); }
 
template <class NewType>
struct CastXpr {
  using Type = typename internal::cast_return_type<
      Derived, const CwiseUnaryOp<internal::core_cast_op<Scalar, NewType>, const Derived>>::type;
};

EIGEN_DOC_UNARY_ADDONS(cast, conversion function)
template <typename NewType>
EIGEN_DEVICE_FUNC constexpr typename CastXpr<NewType>::Type cast() const {
  return typename CastXpr<NewType>::Type(derived());
}

EIGEN_DOC_UNARY_ADDONS(conjugate, complex conjugate)
EIGEN_DEVICE_FUNC constexpr inline ConjugateReturnType conjugate() const { return ConjugateReturnType(derived()); }

EIGEN_DOC_UNARY_ADDONS(conjugate, complex conjugate)
template <bool Cond>
EIGEN_DEVICE_FUNC constexpr inline std::conditional_t<Cond, ConjugateReturnType, const Derived&> conjugateIf() const {
  typedef std::conditional_t<Cond, ConjugateReturnType, const Derived&> ReturnType;
  return ReturnType(derived());
}

EIGEN_DOC_UNARY_ADDONS(real, real part function)
EIGEN_DEVICE_FUNC constexpr inline RealReturnType real() const { return RealReturnType(derived()); }

EIGEN_DOC_UNARY_ADDONS(imag, imaginary part function)
EIGEN_DEVICE_FUNC constexpr inline const ImagReturnType imag() const { return ImagReturnType(derived()); }

EIGEN_DOC_UNARY_ADDONS(unaryExpr, unary function)
template <typename CustomUnaryOp>
EIGEN_DEVICE_FUNC constexpr inline const CwiseUnaryOp<CustomUnaryOp, const Derived> unaryExpr(
    const CustomUnaryOp& func = CustomUnaryOp()) const {
  return CwiseUnaryOp<CustomUnaryOp, const Derived>(derived(), func);
}

EIGEN_DOC_UNARY_ADDONS(unaryViewExpr, unary function)
template <typename CustomViewOp>
EIGEN_DEVICE_FUNC constexpr inline const CwiseUnaryView<CustomViewOp, const Derived> unaryViewExpr(
    const CustomViewOp& func = CustomViewOp()) const {
  return CwiseUnaryView<CustomViewOp, const Derived>(derived(), func);
}

EIGEN_DOC_UNARY_ADDONS(unaryViewExpr, unary function)
template <typename CustomViewOp>
EIGEN_DEVICE_FUNC constexpr inline CwiseUnaryView<CustomViewOp, Derived> unaryViewExpr(
    const CustomViewOp& func = CustomViewOp()) {
  return CwiseUnaryView<CustomViewOp, Derived>(derived(), func);
}

EIGEN_DOC_UNARY_ADDONS(real, real part function)
EIGEN_DEVICE_FUNC constexpr inline NonConstRealReturnType real() { return NonConstRealReturnType(derived()); }

EIGEN_DOC_UNARY_ADDONS(imag, imaginary part function)
EIGEN_DEVICE_FUNC constexpr inline NonConstImagReturnType imag() { return NonConstImagReturnType(derived()); }