Eigen  3.3.90 (mercurial changeset edbe6cfd4430)
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
CommonCwiseUnaryOps.h
1 // This file is part of Eigen, a lightweight C++ template library
2 // for linear algebra.
3 //
4 // Copyright (C) 2008-2009 Gael Guennebaud <gael.guennebaud@inria.fr>
5 // Copyright (C) 2006-2008 Benoit Jacob <jacob.benoit.1@gmail.com>
6 //
7 // This Source Code Form is subject to the terms of the Mozilla
8 // Public License v. 2.0. If a copy of the MPL was not distributed
9 // with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
10 
11 // This file is a base class plugin containing common coefficient wise functions.
12 
13 #ifndef EIGEN_PARSED_BY_DOXYGEN
14 
16 typedef typename internal::conditional<NumTraits<Scalar>::IsComplex,
17  const CwiseUnaryOp<internal::scalar_conjugate_op<Scalar>, const Derived>,
18  const Derived&
19  >::type ConjugateReturnType;
21 typedef typename internal::conditional<NumTraits<Scalar>::IsComplex,
22  const CwiseUnaryOp<internal::scalar_real_op<Scalar>, const Derived>,
23  const Derived&
24  >::type RealReturnType;
26 typedef typename internal::conditional<NumTraits<Scalar>::IsComplex,
27  CwiseUnaryView<internal::scalar_real_ref_op<Scalar>, Derived>,
28  Derived&
29  >::type NonConstRealReturnType;
31 typedef CwiseUnaryOp<internal::scalar_imag_op<Scalar>, const Derived> ImagReturnType;
33 typedef CwiseUnaryView<internal::scalar_imag_ref_op<Scalar>, Derived> NonConstImagReturnType;
34 
35 typedef CwiseUnaryOp<internal::scalar_opposite_op<Scalar>, const Derived> NegativeReturnType;
36 
37 #endif // not EIGEN_PARSED_BY_DOXYGEN
38 
41 EIGEN_DOC_UNARY_ADDONS(operator-,opposite)
43 EIGEN_DEVICE_FUNC
44 inline const NegativeReturnType
45 operator-() const { return NegativeReturnType(derived()); }
46 
47 
48 template<class NewType> struct CastXpr { typedef typename internal::cast_return_type<Derived,const CwiseUnaryOp<internal::scalar_cast_op<Scalar, NewType>, const Derived> >::type Type; };
49 
55 EIGEN_DOC_UNARY_ADDONS(cast,conversion function)
59 template<typename NewType>
60 EIGEN_DEVICE_FUNC
61 typename CastXpr<NewType>::Type
62 cast() const
63 {
64  return typename CastXpr<NewType>::Type(derived());
65 }
66 
69 EIGEN_DOC_UNARY_ADDONS(conjugate,complex conjugate)
72 EIGEN_DEVICE_FUNC
73 inline ConjugateReturnType
74 conjugate() const
75 {
76  return ConjugateReturnType(derived());
77 }
78 
81 EIGEN_DOC_UNARY_ADDONS(real,real part function)
84 EIGEN_DEVICE_FUNC
85 inline RealReturnType
86 real() const { return RealReturnType(derived()); }
87 
90 EIGEN_DOC_UNARY_ADDONS(imag,imaginary part function)
93 EIGEN_DEVICE_FUNC
94 inline const ImagReturnType
95 imag() const { return ImagReturnType(derived()); }
96 
114 EIGEN_DOC_UNARY_ADDONS(unaryExpr,unary function)
118 template<typename CustomUnaryOp>
119 EIGEN_DEVICE_FUNC
120 inline const CwiseUnaryOp<CustomUnaryOp, const Derived>
121 unaryExpr(const CustomUnaryOp& func = CustomUnaryOp()) const
122 {
123  return CwiseUnaryOp<CustomUnaryOp, const Derived>(derived(), func);
124 }
125 
135 EIGEN_DOC_UNARY_ADDONS(unaryViewExpr,unary function)
139 template<typename CustomViewOp>
140 EIGEN_DEVICE_FUNC
141 inline const CwiseUnaryView<CustomViewOp, const Derived>
142 unaryViewExpr(const CustomViewOp& func = CustomViewOp()) const
143 {
144  return CwiseUnaryView<CustomViewOp, const Derived>(derived(), func);
145 }
146 
149 EIGEN_DOC_UNARY_ADDONS(real,real part function)
152 EIGEN_DEVICE_FUNC
153 inline NonConstRealReturnType
154 real() { return NonConstRealReturnType(derived()); }
155 
158 EIGEN_DOC_UNARY_ADDONS(imag,imaginary part function)
161 EIGEN_DEVICE_FUNC
162 inline NonConstImagReturnType
163 imag() { return NonConstImagReturnType(derived()); }
const Eigen::CwiseUnaryOp< Eigen::internal::scalar_imag_op< typename Derived::Scalar >, const Derived > imag(const Eigen::ArrayBase< Derived > &x)
const Eigen::CwiseUnaryOp< Eigen::internal::scalar_real_op< typename Derived::Scalar >, const Derived > real(const Eigen::ArrayBase< Derived > &x)