Michael Ernst Peter / Eigen

src/Core/util/XprHelper.h@0:13a5d365ba16, 2016-10-13 (annotated)

Committer:
ykuroda
Date:
Thu Oct 13 04:07:23 2016 +0000
Revision:
0:13a5d365ba16
First commint, Eigne Matrix Class Library

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ykuroda 0:13a5d365ba16 1 // This file is part of Eigen, a lightweight C++ template library
ykuroda 0:13a5d365ba16 2 // for linear algebra.
ykuroda 0:13a5d365ba16 3 //
ykuroda 0:13a5d365ba16 4 // Copyright (C) 2008 Gael Guennebaud <gael.guennebaud@inria.fr>
ykuroda 0:13a5d365ba16 5 // Copyright (C) 2006-2008 Benoit Jacob <jacob.benoit.1@gmail.com>
ykuroda 0:13a5d365ba16 6 //
ykuroda 0:13a5d365ba16 7 // This Source Code Form is subject to the terms of the Mozilla
ykuroda 0:13a5d365ba16 8 // Public License v. 2.0. If a copy of the MPL was not distributed
ykuroda 0:13a5d365ba16 9 // with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
ykuroda 0:13a5d365ba16 10
ykuroda 0:13a5d365ba16 11 #ifndef EIGEN_XPRHELPER_H
ykuroda 0:13a5d365ba16 12 #define EIGEN_XPRHELPER_H
ykuroda 0:13a5d365ba16 13
ykuroda 0:13a5d365ba16 14 // just a workaround because GCC seems to not really like empty structs
ykuroda 0:13a5d365ba16 15 // FIXME: gcc 4.3 generates bad code when strict-aliasing is enabled
ykuroda 0:13a5d365ba16 16 // so currently we simply disable this optimization for gcc 4.3
ykuroda 0:13a5d365ba16 17 #if (defined __GNUG__) && !((__GNUC__==4) && (__GNUC_MINOR__==3))
ykuroda 0:13a5d365ba16 18 #define EIGEN_EMPTY_STRUCT_CTOR(X) \
ykuroda 0:13a5d365ba16 19 EIGEN_STRONG_INLINE X() {} \
ykuroda 0:13a5d365ba16 20 EIGEN_STRONG_INLINE X(const X& ) {}
ykuroda 0:13a5d365ba16 21 #else
ykuroda 0:13a5d365ba16 22 #define EIGEN_EMPTY_STRUCT_CTOR(X)
ykuroda 0:13a5d365ba16 23 #endif
ykuroda 0:13a5d365ba16 24
ykuroda 0:13a5d365ba16 25 namespace Eigen {
ykuroda 0:13a5d365ba16 26
ykuroda 0:13a5d365ba16 27 typedef EIGEN_DEFAULT_DENSE_INDEX_TYPE DenseIndex;
ykuroda 0:13a5d365ba16 28
ykuroda 0:13a5d365ba16 29 namespace internal {
ykuroda 0:13a5d365ba16 30
ykuroda 0:13a5d365ba16 31 //classes inheriting no_assignment_operator don't generate a default operator=.
ykuroda 0:13a5d365ba16 32 class no_assignment_operator
ykuroda 0:13a5d365ba16 33 {
ykuroda 0:13a5d365ba16 34 private:
ykuroda 0:13a5d365ba16 35 no_assignment_operator& operator=(const no_assignment_operator&);
ykuroda 0:13a5d365ba16 36 };
ykuroda 0:13a5d365ba16 37
ykuroda 0:13a5d365ba16 38 /** \internal return the index type with the largest number of bits */
ykuroda 0:13a5d365ba16 39 template<typename I1, typename I2>
ykuroda 0:13a5d365ba16 40 struct promote_index_type
ykuroda 0:13a5d365ba16 41 {
ykuroda 0:13a5d365ba16 42 typedef typename conditional<(sizeof(I1)<sizeof(I2)), I2, I1>::type type;
ykuroda 0:13a5d365ba16 43 };
ykuroda 0:13a5d365ba16 44
ykuroda 0:13a5d365ba16 45 /** \internal If the template parameter Value is Dynamic, this class is just a wrapper around a T variable that
ykuroda 0:13a5d365ba16 46 * can be accessed using value() and setValue().
ykuroda 0:13a5d365ba16 47 * Otherwise, this class is an empty structure and value() just returns the template parameter Value.
ykuroda 0:13a5d365ba16 48 */
ykuroda 0:13a5d365ba16 49 template<typename T, int Value> class variable_if_dynamic
ykuroda 0:13a5d365ba16 50 {
ykuroda 0:13a5d365ba16 51 public:
ykuroda 0:13a5d365ba16 52 EIGEN_EMPTY_STRUCT_CTOR(variable_if_dynamic)
ykuroda 0:13a5d365ba16 53 explicit variable_if_dynamic(T v) { EIGEN_ONLY_USED_FOR_DEBUG(v); assert(v == T(Value)); }
ykuroda 0:13a5d365ba16 54 static T value() { return T(Value); }
ykuroda 0:13a5d365ba16 55 void setValue(T) {}
ykuroda 0:13a5d365ba16 56 };
ykuroda 0:13a5d365ba16 57
ykuroda 0:13a5d365ba16 58 template<typename T> class variable_if_dynamic<T, Dynamic>
ykuroda 0:13a5d365ba16 59 {
ykuroda 0:13a5d365ba16 60 T m_value;
ykuroda 0:13a5d365ba16 61 variable_if_dynamic() { assert(false); }
ykuroda 0:13a5d365ba16 62 public:
ykuroda 0:13a5d365ba16 63 explicit variable_if_dynamic(T value) : m_value(value) {}
ykuroda 0:13a5d365ba16 64 T value() const { return m_value; }
ykuroda 0:13a5d365ba16 65 void setValue(T value) { m_value = value; }
ykuroda 0:13a5d365ba16 66 };
ykuroda 0:13a5d365ba16 67
ykuroda 0:13a5d365ba16 68 /** \internal like variable_if_dynamic but for DynamicIndex
ykuroda 0:13a5d365ba16 69 */
ykuroda 0:13a5d365ba16 70 template<typename T, int Value> class variable_if_dynamicindex
ykuroda 0:13a5d365ba16 71 {
ykuroda 0:13a5d365ba16 72 public:
ykuroda 0:13a5d365ba16 73 EIGEN_EMPTY_STRUCT_CTOR(variable_if_dynamicindex)
ykuroda 0:13a5d365ba16 74 explicit variable_if_dynamicindex(T v) { EIGEN_ONLY_USED_FOR_DEBUG(v); assert(v == T(Value)); }
ykuroda 0:13a5d365ba16 75 static T value() { return T(Value); }
ykuroda 0:13a5d365ba16 76 void setValue(T) {}
ykuroda 0:13a5d365ba16 77 };
ykuroda 0:13a5d365ba16 78
ykuroda 0:13a5d365ba16 79 template<typename T> class variable_if_dynamicindex<T, DynamicIndex>
ykuroda 0:13a5d365ba16 80 {
ykuroda 0:13a5d365ba16 81 T m_value;
ykuroda 0:13a5d365ba16 82 variable_if_dynamicindex() { assert(false); }
ykuroda 0:13a5d365ba16 83 public:
ykuroda 0:13a5d365ba16 84 explicit variable_if_dynamicindex(T value) : m_value(value) {}
ykuroda 0:13a5d365ba16 85 T value() const { return m_value; }
ykuroda 0:13a5d365ba16 86 void setValue(T value) { m_value = value; }
ykuroda 0:13a5d365ba16 87 };
ykuroda 0:13a5d365ba16 88
ykuroda 0:13a5d365ba16 89 template<typename T> struct functor_traits
ykuroda 0:13a5d365ba16 90 {
ykuroda 0:13a5d365ba16 91 enum
ykuroda 0:13a5d365ba16 92 {
ykuroda 0:13a5d365ba16 93 Cost = 10,
ykuroda 0:13a5d365ba16 94 PacketAccess = false,
ykuroda 0:13a5d365ba16 95 IsRepeatable = false
ykuroda 0:13a5d365ba16 96 };
ykuroda 0:13a5d365ba16 97 };
ykuroda 0:13a5d365ba16 98
ykuroda 0:13a5d365ba16 99 template<typename T> struct packet_traits;
ykuroda 0:13a5d365ba16 100
ykuroda 0:13a5d365ba16 101 template<typename T> struct unpacket_traits
ykuroda 0:13a5d365ba16 102 {
ykuroda 0:13a5d365ba16 103 typedef T type;
ykuroda 0:13a5d365ba16 104 enum {size=1};
ykuroda 0:13a5d365ba16 105 };
ykuroda 0:13a5d365ba16 106
ykuroda 0:13a5d365ba16 107 template<typename _Scalar, int _Rows, int _Cols,
ykuroda 0:13a5d365ba16 108 int _Options = AutoAlign |
ykuroda 0:13a5d365ba16 109 ( (_Rows==1 && _Cols!=1) ? RowMajor
ykuroda 0:13a5d365ba16 110 : (_Cols==1 && _Rows!=1) ? ColMajor
ykuroda 0:13a5d365ba16 111 : EIGEN_DEFAULT_MATRIX_STORAGE_ORDER_OPTION ),
ykuroda 0:13a5d365ba16 112 int _MaxRows = _Rows,
ykuroda 0:13a5d365ba16 113 int _MaxCols = _Cols
ykuroda 0:13a5d365ba16 114 > class make_proper_matrix_type
ykuroda 0:13a5d365ba16 115 {
ykuroda 0:13a5d365ba16 116 enum {
ykuroda 0:13a5d365ba16 117 IsColVector = _Cols==1 && _Rows!=1,
ykuroda 0:13a5d365ba16 118 IsRowVector = _Rows==1 && _Cols!=1,
ykuroda 0:13a5d365ba16 119 Options = IsColVector ? (_Options | ColMajor) & ~RowMajor
ykuroda 0:13a5d365ba16 120 : IsRowVector ? (_Options | RowMajor) & ~ColMajor
ykuroda 0:13a5d365ba16 121 : _Options
ykuroda 0:13a5d365ba16 122 };
ykuroda 0:13a5d365ba16 123 public:
ykuroda 0:13a5d365ba16 124 typedef Matrix<_Scalar, _Rows, _Cols, Options, _MaxRows, _MaxCols> type;
ykuroda 0:13a5d365ba16 125 };
ykuroda 0:13a5d365ba16 126
ykuroda 0:13a5d365ba16 127 template<typename Scalar, int Rows, int Cols, int Options, int MaxRows, int MaxCols>
ykuroda 0:13a5d365ba16 128 class compute_matrix_flags
ykuroda 0:13a5d365ba16 129 {
ykuroda 0:13a5d365ba16 130 enum {
ykuroda 0:13a5d365ba16 131 row_major_bit = Options&RowMajor ? RowMajorBit : 0,
ykuroda 0:13a5d365ba16 132 is_dynamic_size_storage = MaxRows==Dynamic || MaxCols==Dynamic,
ykuroda 0:13a5d365ba16 133
ykuroda 0:13a5d365ba16 134 aligned_bit =
ykuroda 0:13a5d365ba16 135 (
ykuroda 0:13a5d365ba16 136 ((Options&DontAlign)==0)
ykuroda 0:13a5d365ba16 137 && (
ykuroda 0:13a5d365ba16 138 #if EIGEN_ALIGN_STATICALLY
ykuroda 0:13a5d365ba16 139 ((!is_dynamic_size_storage) && (((MaxCols*MaxRows*int(sizeof(Scalar))) % 16) == 0))
ykuroda 0:13a5d365ba16 140 #else
ykuroda 0:13a5d365ba16 141 0
ykuroda 0:13a5d365ba16 142 #endif
ykuroda 0:13a5d365ba16 143
ykuroda 0:13a5d365ba16 144 ||
ykuroda 0:13a5d365ba16 145
ykuroda 0:13a5d365ba16 146 #if EIGEN_ALIGN
ykuroda 0:13a5d365ba16 147 is_dynamic_size_storage
ykuroda 0:13a5d365ba16 148 #else
ykuroda 0:13a5d365ba16 149 0
ykuroda 0:13a5d365ba16 150 #endif
ykuroda 0:13a5d365ba16 151
ykuroda 0:13a5d365ba16 152 )
ykuroda 0:13a5d365ba16 153 ) ? AlignedBit : 0,
ykuroda 0:13a5d365ba16 154 packet_access_bit = packet_traits<Scalar>::Vectorizable && aligned_bit ? PacketAccessBit : 0
ykuroda 0:13a5d365ba16 155 };
ykuroda 0:13a5d365ba16 156
ykuroda 0:13a5d365ba16 157 public:
ykuroda 0:13a5d365ba16 158 enum { ret = LinearAccessBit | LvalueBit | DirectAccessBit | NestByRefBit | packet_access_bit | row_major_bit | aligned_bit };
ykuroda 0:13a5d365ba16 159 };
ykuroda 0:13a5d365ba16 160
ykuroda 0:13a5d365ba16 161 template<int _Rows, int _Cols> struct size_at_compile_time
ykuroda 0:13a5d365ba16 162 {
ykuroda 0:13a5d365ba16 163 enum { ret = (_Rows==Dynamic || _Cols==Dynamic) ? Dynamic : _Rows * _Cols };
ykuroda 0:13a5d365ba16 164 };
ykuroda 0:13a5d365ba16 165
ykuroda 0:13a5d365ba16 166 /* plain_matrix_type : the difference from eval is that plain_matrix_type is always a plain matrix type,
ykuroda 0:13a5d365ba16 167 * whereas eval is a const reference in the case of a matrix
ykuroda 0:13a5d365ba16 168 */
ykuroda 0:13a5d365ba16 169
ykuroda 0:13a5d365ba16 170 template<typename T, typename StorageKind = typename traits<T>::StorageKind> struct plain_matrix_type;
ykuroda 0:13a5d365ba16 171 template<typename T, typename BaseClassType> struct plain_matrix_type_dense;
ykuroda 0:13a5d365ba16 172 template<typename T> struct plain_matrix_type<T,Dense>
ykuroda 0:13a5d365ba16 173 {
ykuroda 0:13a5d365ba16 174 typedef typename plain_matrix_type_dense<T,typename traits<T>::XprKind>::type type;
ykuroda 0:13a5d365ba16 175 };
ykuroda 0:13a5d365ba16 176
ykuroda 0:13a5d365ba16 177 template<typename T> struct plain_matrix_type_dense<T,MatrixXpr>
ykuroda 0:13a5d365ba16 178 {
ykuroda 0:13a5d365ba16 179 typedef Matrix<typename traits<T>::Scalar,
ykuroda 0:13a5d365ba16 180 traits<T>::RowsAtCompileTime,
ykuroda 0:13a5d365ba16 181 traits<T>::ColsAtCompileTime,
ykuroda 0:13a5d365ba16 182 AutoAlign | (traits<T>::Flags&RowMajorBit ? RowMajor : ColMajor),
ykuroda 0:13a5d365ba16 183 traits<T>::MaxRowsAtCompileTime,
ykuroda 0:13a5d365ba16 184 traits<T>::MaxColsAtCompileTime
ykuroda 0:13a5d365ba16 185 > type;
ykuroda 0:13a5d365ba16 186 };
ykuroda 0:13a5d365ba16 187
ykuroda 0:13a5d365ba16 188 template<typename T> struct plain_matrix_type_dense<T,ArrayXpr>
ykuroda 0:13a5d365ba16 189 {
ykuroda 0:13a5d365ba16 190 typedef Array<typename traits<T>::Scalar,
ykuroda 0:13a5d365ba16 191 traits<T>::RowsAtCompileTime,
ykuroda 0:13a5d365ba16 192 traits<T>::ColsAtCompileTime,
ykuroda 0:13a5d365ba16 193 AutoAlign | (traits<T>::Flags&RowMajorBit ? RowMajor : ColMajor),
ykuroda 0:13a5d365ba16 194 traits<T>::MaxRowsAtCompileTime,
ykuroda 0:13a5d365ba16 195 traits<T>::MaxColsAtCompileTime
ykuroda 0:13a5d365ba16 196 > type;
ykuroda 0:13a5d365ba16 197 };
ykuroda 0:13a5d365ba16 198
ykuroda 0:13a5d365ba16 199 /* eval : the return type of eval(). For matrices, this is just a const reference
ykuroda 0:13a5d365ba16 200 * in order to avoid a useless copy
ykuroda 0:13a5d365ba16 201 */
ykuroda 0:13a5d365ba16 202
ykuroda 0:13a5d365ba16 203 template<typename T, typename StorageKind = typename traits<T>::StorageKind> struct eval;
ykuroda 0:13a5d365ba16 204
ykuroda 0:13a5d365ba16 205 template<typename T> struct eval<T,Dense>
ykuroda 0:13a5d365ba16 206 {
ykuroda 0:13a5d365ba16 207 typedef typename plain_matrix_type<T>::type type;
ykuroda 0:13a5d365ba16 208 // typedef typename T::PlainObject type;
ykuroda 0:13a5d365ba16 209 // typedef T::Matrix<typename traits<T>::Scalar,
ykuroda 0:13a5d365ba16 210 // traits<T>::RowsAtCompileTime,
ykuroda 0:13a5d365ba16 211 // traits<T>::ColsAtCompileTime,
ykuroda 0:13a5d365ba16 212 // AutoAlign | (traits<T>::Flags&RowMajorBit ? RowMajor : ColMajor),
ykuroda 0:13a5d365ba16 213 // traits<T>::MaxRowsAtCompileTime,
ykuroda 0:13a5d365ba16 214 // traits<T>::MaxColsAtCompileTime
ykuroda 0:13a5d365ba16 215 // > type;
ykuroda 0:13a5d365ba16 216 };
ykuroda 0:13a5d365ba16 217
ykuroda 0:13a5d365ba16 218 // for matrices, no need to evaluate, just use a const reference to avoid a useless copy
ykuroda 0:13a5d365ba16 219 template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
ykuroda 0:13a5d365ba16 220 struct eval<Matrix<_Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols>, Dense>
ykuroda 0:13a5d365ba16 221 {
ykuroda 0:13a5d365ba16 222 typedef const Matrix<_Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols>& type;
ykuroda 0:13a5d365ba16 223 };
ykuroda 0:13a5d365ba16 224
ykuroda 0:13a5d365ba16 225 template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
ykuroda 0:13a5d365ba16 226 struct eval<Array<_Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols>, Dense>
ykuroda 0:13a5d365ba16 227 {
ykuroda 0:13a5d365ba16 228 typedef const Array<_Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols>& type;
ykuroda 0:13a5d365ba16 229 };
ykuroda 0:13a5d365ba16 230
ykuroda 0:13a5d365ba16 231
ykuroda 0:13a5d365ba16 232
ykuroda 0:13a5d365ba16 233 /* plain_matrix_type_column_major : same as plain_matrix_type but guaranteed to be column-major
ykuroda 0:13a5d365ba16 234 */
ykuroda 0:13a5d365ba16 235 template<typename T> struct plain_matrix_type_column_major
ykuroda 0:13a5d365ba16 236 {
ykuroda 0:13a5d365ba16 237 enum { Rows = traits<T>::RowsAtCompileTime,
ykuroda 0:13a5d365ba16 238 Cols = traits<T>::ColsAtCompileTime,
ykuroda 0:13a5d365ba16 239 MaxRows = traits<T>::MaxRowsAtCompileTime,
ykuroda 0:13a5d365ba16 240 MaxCols = traits<T>::MaxColsAtCompileTime
ykuroda 0:13a5d365ba16 241 };
ykuroda 0:13a5d365ba16 242 typedef Matrix<typename traits<T>::Scalar,
ykuroda 0:13a5d365ba16 243 Rows,
ykuroda 0:13a5d365ba16 244 Cols,
ykuroda 0:13a5d365ba16 245 (MaxRows==1&&MaxCols!=1) ? RowMajor : ColMajor,
ykuroda 0:13a5d365ba16 246 MaxRows,
ykuroda 0:13a5d365ba16 247 MaxCols
ykuroda 0:13a5d365ba16 248 > type;
ykuroda 0:13a5d365ba16 249 };
ykuroda 0:13a5d365ba16 250
ykuroda 0:13a5d365ba16 251 /* plain_matrix_type_row_major : same as plain_matrix_type but guaranteed to be row-major
ykuroda 0:13a5d365ba16 252 */
ykuroda 0:13a5d365ba16 253 template<typename T> struct plain_matrix_type_row_major
ykuroda 0:13a5d365ba16 254 {
ykuroda 0:13a5d365ba16 255 enum { Rows = traits<T>::RowsAtCompileTime,
ykuroda 0:13a5d365ba16 256 Cols = traits<T>::ColsAtCompileTime,
ykuroda 0:13a5d365ba16 257 MaxRows = traits<T>::MaxRowsAtCompileTime,
ykuroda 0:13a5d365ba16 258 MaxCols = traits<T>::MaxColsAtCompileTime
ykuroda 0:13a5d365ba16 259 };
ykuroda 0:13a5d365ba16 260 typedef Matrix<typename traits<T>::Scalar,
ykuroda 0:13a5d365ba16 261 Rows,
ykuroda 0:13a5d365ba16 262 Cols,
ykuroda 0:13a5d365ba16 263 (MaxCols==1&&MaxRows!=1) ? RowMajor : ColMajor,
ykuroda 0:13a5d365ba16 264 MaxRows,
ykuroda 0:13a5d365ba16 265 MaxCols
ykuroda 0:13a5d365ba16 266 > type;
ykuroda 0:13a5d365ba16 267 };
ykuroda 0:13a5d365ba16 268
ykuroda 0:13a5d365ba16 269 // we should be able to get rid of this one too
ykuroda 0:13a5d365ba16 270 template<typename T> struct must_nest_by_value { enum { ret = false }; };
ykuroda 0:13a5d365ba16 271
ykuroda 0:13a5d365ba16 272 /** \internal The reference selector for template expressions. The idea is that we don't
ykuroda 0:13a5d365ba16 273 * need to use references for expressions since they are light weight proxy
ykuroda 0:13a5d365ba16 274 * objects which should generate no copying overhead. */
ykuroda 0:13a5d365ba16 275 template <typename T>
ykuroda 0:13a5d365ba16 276 struct ref_selector
ykuroda 0:13a5d365ba16 277 {
ykuroda 0:13a5d365ba16 278 typedef typename conditional<
ykuroda 0:13a5d365ba16 279 bool(traits<T>::Flags & NestByRefBit),
ykuroda 0:13a5d365ba16 280 T const&,
ykuroda 0:13a5d365ba16 281 const T
ykuroda 0:13a5d365ba16 282 >::type type;
ykuroda 0:13a5d365ba16 283 };
ykuroda 0:13a5d365ba16 284
ykuroda 0:13a5d365ba16 285 /** \internal Adds the const qualifier on the value-type of T2 if and only if T1 is a const type */
ykuroda 0:13a5d365ba16 286 template<typename T1, typename T2>
ykuroda 0:13a5d365ba16 287 struct transfer_constness
ykuroda 0:13a5d365ba16 288 {
ykuroda 0:13a5d365ba16 289 typedef typename conditional<
ykuroda 0:13a5d365ba16 290 bool(internal::is_const<T1>::value),
ykuroda 0:13a5d365ba16 291 typename internal::add_const_on_value_type<T2>::type,
ykuroda 0:13a5d365ba16 292 T2
ykuroda 0:13a5d365ba16 293 >::type type;
ykuroda 0:13a5d365ba16 294 };
ykuroda 0:13a5d365ba16 295
ykuroda 0:13a5d365ba16 296 /** \internal Determines how a given expression should be nested into another one.
ykuroda 0:13a5d365ba16 297 * For example, when you do a * (b+c), Eigen will determine how the expression b+c should be
ykuroda 0:13a5d365ba16 298 * nested into the bigger product expression. The choice is between nesting the expression b+c as-is, or
ykuroda 0:13a5d365ba16 299 * evaluating that expression b+c into a temporary variable d, and nest d so that the resulting expression is
ykuroda 0:13a5d365ba16 300 * a*d. Evaluating can be beneficial for example if every coefficient access in the resulting expression causes
ykuroda 0:13a5d365ba16 301 * many coefficient accesses in the nested expressions -- as is the case with matrix product for example.
ykuroda 0:13a5d365ba16 302 *
ykuroda 0:13a5d365ba16 303 * \param T the type of the expression being nested
ykuroda 0:13a5d365ba16 304 * \param n the number of coefficient accesses in the nested expression for each coefficient access in the bigger expression.
ykuroda 0:13a5d365ba16 305 *
ykuroda 0:13a5d365ba16 306 * Note that if no evaluation occur, then the constness of T is preserved.
ykuroda 0:13a5d365ba16 307 *
ykuroda 0:13a5d365ba16 308 * Example. Suppose that a, b, and c are of type Matrix3d. The user forms the expression a*(b+c).
ykuroda 0:13a5d365ba16 309 * b+c is an expression "sum of matrices", which we will denote by S. In order to determine how to nest it,
ykuroda 0:13a5d365ba16 310 * the Product expression uses: nested<S, 3>::ret, which turns out to be Matrix3d because the internal logic of
ykuroda 0:13a5d365ba16 311 * nested determined that in this case it was better to evaluate the expression b+c into a temporary. On the other hand,
ykuroda 0:13a5d365ba16 312 * since a is of type Matrix3d, the Product expression nests it as nested<Matrix3d, 3>::ret, which turns out to be
ykuroda 0:13a5d365ba16 313 * const Matrix3d&, because the internal logic of nested determined that since a was already a matrix, there was no point
ykuroda 0:13a5d365ba16 314 * in copying it into another matrix.
ykuroda 0:13a5d365ba16 315 */
ykuroda 0:13a5d365ba16 316 template<typename T, int n=1, typename PlainObject = typename eval<T>::type> struct nested
ykuroda 0:13a5d365ba16 317 {
ykuroda 0:13a5d365ba16 318 enum {
ykuroda 0:13a5d365ba16 319 // for the purpose of this test, to keep it reasonably simple, we arbitrarily choose a value of Dynamic values.
ykuroda 0:13a5d365ba16 320 // the choice of 10000 makes it larger than any practical fixed value and even most dynamic values.
ykuroda 0:13a5d365ba16 321 // in extreme cases where these assumptions would be wrong, we would still at worst suffer performance issues
ykuroda 0:13a5d365ba16 322 // (poor choice of temporaries).
ykuroda 0:13a5d365ba16 323 // it's important that this value can still be squared without integer overflowing.
ykuroda 0:13a5d365ba16 324 DynamicAsInteger = 10000,
ykuroda 0:13a5d365ba16 325 ScalarReadCost = NumTraits<typename traits<T>::Scalar>::ReadCost,
ykuroda 0:13a5d365ba16 326 ScalarReadCostAsInteger = ScalarReadCost == Dynamic ? int(DynamicAsInteger) : int(ScalarReadCost),
ykuroda 0:13a5d365ba16 327 CoeffReadCost = traits<T>::CoeffReadCost,
ykuroda 0:13a5d365ba16 328 CoeffReadCostAsInteger = CoeffReadCost == Dynamic ? int(DynamicAsInteger) : int(CoeffReadCost),
ykuroda 0:13a5d365ba16 329 NAsInteger = n == Dynamic ? int(DynamicAsInteger) : n,
ykuroda 0:13a5d365ba16 330 CostEvalAsInteger = (NAsInteger+1) * ScalarReadCostAsInteger + CoeffReadCostAsInteger,
ykuroda 0:13a5d365ba16 331 CostNoEvalAsInteger = NAsInteger * CoeffReadCostAsInteger
ykuroda 0:13a5d365ba16 332 };
ykuroda 0:13a5d365ba16 333
ykuroda 0:13a5d365ba16 334 typedef typename conditional<
ykuroda 0:13a5d365ba16 335 ( (int(traits<T>::Flags) & EvalBeforeNestingBit) ||
ykuroda 0:13a5d365ba16 336 int(CostEvalAsInteger) < int(CostNoEvalAsInteger)
ykuroda 0:13a5d365ba16 337 ),
ykuroda 0:13a5d365ba16 338 PlainObject,
ykuroda 0:13a5d365ba16 339 typename ref_selector<T>::type
ykuroda 0:13a5d365ba16 340 >::type type;
ykuroda 0:13a5d365ba16 341 };
ykuroda 0:13a5d365ba16 342
ykuroda 0:13a5d365ba16 343 template<typename T>
ykuroda 0:13a5d365ba16 344 inline T* const_cast_ptr(const T* ptr)
ykuroda 0:13a5d365ba16 345 {
ykuroda 0:13a5d365ba16 346 return const_cast<T*>(ptr);
ykuroda 0:13a5d365ba16 347 }
ykuroda 0:13a5d365ba16 348
ykuroda 0:13a5d365ba16 349 template<typename Derived, typename XprKind = typename traits<Derived>::XprKind>
ykuroda 0:13a5d365ba16 350 struct dense_xpr_base
ykuroda 0:13a5d365ba16 351 {
ykuroda 0:13a5d365ba16 352 /* dense_xpr_base should only ever be used on dense expressions, thus falling either into the MatrixXpr or into the ArrayXpr cases */
ykuroda 0:13a5d365ba16 353 };
ykuroda 0:13a5d365ba16 354
ykuroda 0:13a5d365ba16 355 template<typename Derived>
ykuroda 0:13a5d365ba16 356 struct dense_xpr_base<Derived, MatrixXpr>
ykuroda 0:13a5d365ba16 357 {
ykuroda 0:13a5d365ba16 358 typedef MatrixBase<Derived> type;
ykuroda 0:13a5d365ba16 359 };
ykuroda 0:13a5d365ba16 360
ykuroda 0:13a5d365ba16 361 template<typename Derived>
ykuroda 0:13a5d365ba16 362 struct dense_xpr_base<Derived, ArrayXpr>
ykuroda 0:13a5d365ba16 363 {
ykuroda 0:13a5d365ba16 364 typedef ArrayBase<Derived> type;
ykuroda 0:13a5d365ba16 365 };
ykuroda 0:13a5d365ba16 366
ykuroda 0:13a5d365ba16 367 /** \internal Helper base class to add a scalar multiple operator
ykuroda 0:13a5d365ba16 368 * overloads for complex types */
ykuroda 0:13a5d365ba16 369 template<typename Derived, typename Scalar, typename OtherScalar, typename BaseType,
ykuroda 0:13a5d365ba16 370 bool EnableIt = !is_same<Scalar,OtherScalar>::value >
ykuroda 0:13a5d365ba16 371 struct special_scalar_op_base : public BaseType
ykuroda 0:13a5d365ba16 372 {
ykuroda 0:13a5d365ba16 373 // dummy operator* so that the
ykuroda 0:13a5d365ba16 374 // "using special_scalar_op_base::operator*" compiles
ykuroda 0:13a5d365ba16 375 void operator*() const;
ykuroda 0:13a5d365ba16 376 };
ykuroda 0:13a5d365ba16 377
ykuroda 0:13a5d365ba16 378 template<typename Derived,typename Scalar,typename OtherScalar, typename BaseType>
ykuroda 0:13a5d365ba16 379 struct special_scalar_op_base<Derived,Scalar,OtherScalar,BaseType,true> : public BaseType
ykuroda 0:13a5d365ba16 380 {
ykuroda 0:13a5d365ba16 381 const CwiseUnaryOp<scalar_multiple2_op<Scalar,OtherScalar>, Derived>
ykuroda 0:13a5d365ba16 382 operator*(const OtherScalar& scalar) const
ykuroda 0:13a5d365ba16 383 {
ykuroda 0:13a5d365ba16 384 return CwiseUnaryOp<scalar_multiple2_op<Scalar,OtherScalar>, Derived>
ykuroda 0:13a5d365ba16 385 (*static_cast<const Derived*>(this), scalar_multiple2_op<Scalar,OtherScalar>(scalar));
ykuroda 0:13a5d365ba16 386 }
ykuroda 0:13a5d365ba16 387
ykuroda 0:13a5d365ba16 388 inline friend const CwiseUnaryOp<scalar_multiple2_op<Scalar,OtherScalar>, Derived>
ykuroda 0:13a5d365ba16 389 operator*(const OtherScalar& scalar, const Derived& matrix)
ykuroda 0:13a5d365ba16 390 { return static_cast<const special_scalar_op_base&>(matrix).operator*(scalar); }
ykuroda 0:13a5d365ba16 391 };
ykuroda 0:13a5d365ba16 392
ykuroda 0:13a5d365ba16 393 template<typename XprType, typename CastType> struct cast_return_type
ykuroda 0:13a5d365ba16 394 {
ykuroda 0:13a5d365ba16 395 typedef typename XprType::Scalar CurrentScalarType;
ykuroda 0:13a5d365ba16 396 typedef typename remove_all<CastType>::type _CastType;
ykuroda 0:13a5d365ba16 397 typedef typename _CastType::Scalar NewScalarType;
ykuroda 0:13a5d365ba16 398 typedef typename conditional<is_same<CurrentScalarType,NewScalarType>::value,
ykuroda 0:13a5d365ba16 399 const XprType&,CastType>::type type;
ykuroda 0:13a5d365ba16 400 };
ykuroda 0:13a5d365ba16 401
ykuroda 0:13a5d365ba16 402 template <typename A, typename B> struct promote_storage_type;
ykuroda 0:13a5d365ba16 403
ykuroda 0:13a5d365ba16 404 template <typename A> struct promote_storage_type<A,A>
ykuroda 0:13a5d365ba16 405 {
ykuroda 0:13a5d365ba16 406 typedef A ret;
ykuroda 0:13a5d365ba16 407 };
ykuroda 0:13a5d365ba16 408
ykuroda 0:13a5d365ba16 409 /** \internal gives the plain matrix or array type to store a row/column/diagonal of a matrix type.
ykuroda 0:13a5d365ba16 410 * \param Scalar optional parameter allowing to pass a different scalar type than the one of the MatrixType.
ykuroda 0:13a5d365ba16 411 */
ykuroda 0:13a5d365ba16 412 template<typename ExpressionType, typename Scalar = typename ExpressionType::Scalar>
ykuroda 0:13a5d365ba16 413 struct plain_row_type
ykuroda 0:13a5d365ba16 414 {
ykuroda 0:13a5d365ba16 415 typedef Matrix<Scalar, 1, ExpressionType::ColsAtCompileTime,
ykuroda 0:13a5d365ba16 416 ExpressionType::PlainObject::Options | RowMajor, 1, ExpressionType::MaxColsAtCompileTime> MatrixRowType;
ykuroda 0:13a5d365ba16 417 typedef Array<Scalar, 1, ExpressionType::ColsAtCompileTime,
ykuroda 0:13a5d365ba16 418 ExpressionType::PlainObject::Options | RowMajor, 1, ExpressionType::MaxColsAtCompileTime> ArrayRowType;
ykuroda 0:13a5d365ba16 419
ykuroda 0:13a5d365ba16 420 typedef typename conditional<
ykuroda 0:13a5d365ba16 421 is_same< typename traits<ExpressionType>::XprKind, MatrixXpr >::value,
ykuroda 0:13a5d365ba16 422 MatrixRowType,
ykuroda 0:13a5d365ba16 423 ArrayRowType
ykuroda 0:13a5d365ba16 424 >::type type;
ykuroda 0:13a5d365ba16 425 };
ykuroda 0:13a5d365ba16 426
ykuroda 0:13a5d365ba16 427 template<typename ExpressionType, typename Scalar = typename ExpressionType::Scalar>
ykuroda 0:13a5d365ba16 428 struct plain_col_type
ykuroda 0:13a5d365ba16 429 {
ykuroda 0:13a5d365ba16 430 typedef Matrix<Scalar, ExpressionType::RowsAtCompileTime, 1,
ykuroda 0:13a5d365ba16 431 ExpressionType::PlainObject::Options & ~RowMajor, ExpressionType::MaxRowsAtCompileTime, 1> MatrixColType;
ykuroda 0:13a5d365ba16 432 typedef Array<Scalar, ExpressionType::RowsAtCompileTime, 1,
ykuroda 0:13a5d365ba16 433 ExpressionType::PlainObject::Options & ~RowMajor, ExpressionType::MaxRowsAtCompileTime, 1> ArrayColType;
ykuroda 0:13a5d365ba16 434
ykuroda 0:13a5d365ba16 435 typedef typename conditional<
ykuroda 0:13a5d365ba16 436 is_same< typename traits<ExpressionType>::XprKind, MatrixXpr >::value,
ykuroda 0:13a5d365ba16 437 MatrixColType,
ykuroda 0:13a5d365ba16 438 ArrayColType
ykuroda 0:13a5d365ba16 439 >::type type;
ykuroda 0:13a5d365ba16 440 };
ykuroda 0:13a5d365ba16 441
ykuroda 0:13a5d365ba16 442 template<typename ExpressionType, typename Scalar = typename ExpressionType::Scalar>
ykuroda 0:13a5d365ba16 443 struct plain_diag_type
ykuroda 0:13a5d365ba16 444 {
ykuroda 0:13a5d365ba16 445 enum { diag_size = EIGEN_SIZE_MIN_PREFER_DYNAMIC(ExpressionType::RowsAtCompileTime, ExpressionType::ColsAtCompileTime),
ykuroda 0:13a5d365ba16 446 max_diag_size = EIGEN_SIZE_MIN_PREFER_FIXED(ExpressionType::MaxRowsAtCompileTime, ExpressionType::MaxColsAtCompileTime)
ykuroda 0:13a5d365ba16 447 };
ykuroda 0:13a5d365ba16 448 typedef Matrix<Scalar, diag_size, 1, ExpressionType::PlainObject::Options & ~RowMajor, max_diag_size, 1> MatrixDiagType;
ykuroda 0:13a5d365ba16 449 typedef Array<Scalar, diag_size, 1, ExpressionType::PlainObject::Options & ~RowMajor, max_diag_size, 1> ArrayDiagType;
ykuroda 0:13a5d365ba16 450
ykuroda 0:13a5d365ba16 451 typedef typename conditional<
ykuroda 0:13a5d365ba16 452 is_same< typename traits<ExpressionType>::XprKind, MatrixXpr >::value,
ykuroda 0:13a5d365ba16 453 MatrixDiagType,
ykuroda 0:13a5d365ba16 454 ArrayDiagType
ykuroda 0:13a5d365ba16 455 >::type type;
ykuroda 0:13a5d365ba16 456 };
ykuroda 0:13a5d365ba16 457
ykuroda 0:13a5d365ba16 458 template<typename ExpressionType>
ykuroda 0:13a5d365ba16 459 struct is_lvalue
ykuroda 0:13a5d365ba16 460 {
ykuroda 0:13a5d365ba16 461 enum { value = !bool(is_const<ExpressionType>::value) &&
ykuroda 0:13a5d365ba16 462 bool(traits<ExpressionType>::Flags & LvalueBit) };
ykuroda 0:13a5d365ba16 463 };
ykuroda 0:13a5d365ba16 464
ykuroda 0:13a5d365ba16 465 } // end namespace internal
ykuroda 0:13a5d365ba16 466
ykuroda 0:13a5d365ba16 467 } // end namespace Eigen
ykuroda 0:13a5d365ba16 468
ykuroda 0:13a5d365ba16 469 #endif // EIGEN_XPRHELPER_H