Michael Ernst Peter / Eigen

src/Core/MapBase.h@1:3b8049da21b8, 2019-09-24 (annotated)

Committer:
jsoh91
Date:
Tue Sep 24 00:18:23 2019 +0000
Revision:
1:3b8049da21b8
Parent:
0:13a5d365ba16 
ignore and revise some of error parts

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) 2007-2010 Benoit Jacob <jacob.benoit.1@gmail.com>
ykuroda 0:13a5d365ba16 5 // Copyright (C) 2008 Gael Guennebaud <gael.guennebaud@inria.fr>
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_MAPBASE_H
ykuroda 0:13a5d365ba16 12 #define EIGEN_MAPBASE_H
ykuroda 0:13a5d365ba16 13
ykuroda 0:13a5d365ba16 14 #define EIGEN_STATIC_ASSERT_INDEX_BASED_ACCESS(Derived) \
ykuroda 0:13a5d365ba16 15 EIGEN_STATIC_ASSERT((int(internal::traits<Derived>::Flags) & LinearAccessBit) || Derived::IsVectorAtCompileTime, \
ykuroda 0:13a5d365ba16 16 YOU_ARE_TRYING_TO_USE_AN_INDEX_BASED_ACCESSOR_ON_AN_EXPRESSION_THAT_DOES_NOT_SUPPORT_THAT)
ykuroda 0:13a5d365ba16 17
ykuroda 0:13a5d365ba16 18 namespace Eigen {
ykuroda 0:13a5d365ba16 19
ykuroda 0:13a5d365ba16 20 /** \class MapBase
ykuroda 0:13a5d365ba16 21 * \ingroup Core_Module
ykuroda 0:13a5d365ba16 22 *
ykuroda 0:13a5d365ba16 23 * \brief Base class for Map and Block expression with direct access
ykuroda 0:13a5d365ba16 24 *
ykuroda 0:13a5d365ba16 25 * \sa class Map, class Block
ykuroda 0:13a5d365ba16 26 */
ykuroda 0:13a5d365ba16 27 template<typename Derived> class MapBase<Derived, ReadOnlyAccessors>
ykuroda 0:13a5d365ba16 28 : public internal::dense_xpr_base<Derived>::type
ykuroda 0:13a5d365ba16 29 {
ykuroda 0:13a5d365ba16 30 public:
ykuroda 0:13a5d365ba16 31
ykuroda 0:13a5d365ba16 32 typedef typename internal::dense_xpr_base<Derived>::type Base;
ykuroda 0:13a5d365ba16 33 enum {
ykuroda 0:13a5d365ba16 34 RowsAtCompileTime = internal::traits<Derived>::RowsAtCompileTime,
ykuroda 0:13a5d365ba16 35 ColsAtCompileTime = internal::traits<Derived>::ColsAtCompileTime,
ykuroda 0:13a5d365ba16 36 SizeAtCompileTime = Base::SizeAtCompileTime
ykuroda 0:13a5d365ba16 37 };
ykuroda 0:13a5d365ba16 38
ykuroda 0:13a5d365ba16 39 typedef typename internal::traits<Derived>::StorageKind StorageKind;
ykuroda 0:13a5d365ba16 40 typedef typename internal::traits<Derived>::Index Index;
ykuroda 0:13a5d365ba16 41 typedef typename internal::traits<Derived>::Scalar Scalar;
ykuroda 0:13a5d365ba16 42 typedef typename internal::packet_traits<Scalar>::type PacketScalar;
ykuroda 0:13a5d365ba16 43 typedef typename NumTraits<Scalar>::Real RealScalar;
ykuroda 0:13a5d365ba16 44 typedef typename internal::conditional<
ykuroda 0:13a5d365ba16 45 bool(internal::is_lvalue<Derived>::value),
ykuroda 0:13a5d365ba16 46 Scalar *,
ykuroda 0:13a5d365ba16 47 const Scalar *>::type
ykuroda 0:13a5d365ba16 48 PointerType;
ykuroda 0:13a5d365ba16 49
ykuroda 0:13a5d365ba16 50 using Base::derived;
ykuroda 0:13a5d365ba16 51 // using Base::RowsAtCompileTime;
ykuroda 0:13a5d365ba16 52 // using Base::ColsAtCompileTime;
ykuroda 0:13a5d365ba16 53 // using Base::SizeAtCompileTime;
ykuroda 0:13a5d365ba16 54 using Base::MaxRowsAtCompileTime;
ykuroda 0:13a5d365ba16 55 using Base::MaxColsAtCompileTime;
ykuroda 0:13a5d365ba16 56 using Base::MaxSizeAtCompileTime;
ykuroda 0:13a5d365ba16 57 using Base::IsVectorAtCompileTime;
ykuroda 0:13a5d365ba16 58 using Base::Flags;
ykuroda 0:13a5d365ba16 59 using Base::IsRowMajor;
ykuroda 0:13a5d365ba16 60
ykuroda 0:13a5d365ba16 61 using Base::rows;
ykuroda 0:13a5d365ba16 62 using Base::cols;
ykuroda 0:13a5d365ba16 63 using Base::size;
ykuroda 0:13a5d365ba16 64 using Base::coeff;
ykuroda 0:13a5d365ba16 65 using Base::coeffRef;
ykuroda 0:13a5d365ba16 66 using Base::lazyAssign;
ykuroda 0:13a5d365ba16 67 using Base::eval;
ykuroda 0:13a5d365ba16 68
ykuroda 0:13a5d365ba16 69 using Base::innerStride;
ykuroda 0:13a5d365ba16 70 using Base::outerStride;
ykuroda 0:13a5d365ba16 71 using Base::rowStride;
ykuroda 0:13a5d365ba16 72 using Base::colStride;
ykuroda 0:13a5d365ba16 73
ykuroda 0:13a5d365ba16 74 // bug 217 - compile error on ICC 11.1
ykuroda 0:13a5d365ba16 75 using Base::operator=;
ykuroda 0:13a5d365ba16 76
ykuroda 0:13a5d365ba16 77 typedef typename Base::CoeffReturnType CoeffReturnType;
ykuroda 0:13a5d365ba16 78
ykuroda 0:13a5d365ba16 79 inline Index rows() const { return m_rows.value(); }
ykuroda 0:13a5d365ba16 80 inline Index cols() const { return m_cols.value(); }
ykuroda 0:13a5d365ba16 81
ykuroda 0:13a5d365ba16 82 /** Returns a pointer to the first coefficient of the matrix or vector.
ykuroda 0:13a5d365ba16 83 *
ykuroda 0:13a5d365ba16 84 * \note When addressing this data, make sure to honor the strides returned by innerStride() and outerStride().
ykuroda 0:13a5d365ba16 85 *
ykuroda 0:13a5d365ba16 86 * \sa innerStride(), outerStride()
ykuroda 0:13a5d365ba16 87 */
ykuroda 0:13a5d365ba16 88 inline const Scalar* data() const { return m_data; }
ykuroda 0:13a5d365ba16 89
ykuroda 0:13a5d365ba16 90 inline const Scalar& coeff(Index rowId, Index colId) const
ykuroda 0:13a5d365ba16 91 {
ykuroda 0:13a5d365ba16 92 return m_data[colId * colStride() + rowId * rowStride()];
ykuroda 0:13a5d365ba16 93 }
ykuroda 0:13a5d365ba16 94
ykuroda 0:13a5d365ba16 95 inline const Scalar& coeff(Index index) const
ykuroda 0:13a5d365ba16 96 {
ykuroda 0:13a5d365ba16 97 EIGEN_STATIC_ASSERT_INDEX_BASED_ACCESS(Derived)
ykuroda 0:13a5d365ba16 98 return m_data[index * innerStride()];
ykuroda 0:13a5d365ba16 99 }
ykuroda 0:13a5d365ba16 100
ykuroda 0:13a5d365ba16 101 inline const Scalar& coeffRef(Index rowId, Index colId) const
ykuroda 0:13a5d365ba16 102 {
ykuroda 0:13a5d365ba16 103 return this->m_data[colId * colStride() + rowId * rowStride()];
ykuroda 0:13a5d365ba16 104 }
ykuroda 0:13a5d365ba16 105
ykuroda 0:13a5d365ba16 106 inline const Scalar& coeffRef(Index index) const
ykuroda 0:13a5d365ba16 107 {
ykuroda 0:13a5d365ba16 108 EIGEN_STATIC_ASSERT_INDEX_BASED_ACCESS(Derived)
ykuroda 0:13a5d365ba16 109 return this->m_data[index * innerStride()];
ykuroda 0:13a5d365ba16 110 }
ykuroda 0:13a5d365ba16 111
ykuroda 0:13a5d365ba16 112 template<int LoadMode>
ykuroda 0:13a5d365ba16 113 inline PacketScalar packet(Index rowId, Index colId) const
ykuroda 0:13a5d365ba16 114 {
ykuroda 0:13a5d365ba16 115 return internal::ploadt<PacketScalar, LoadMode>
ykuroda 0:13a5d365ba16 116 (m_data + (colId * colStride() + rowId * rowStride()));
ykuroda 0:13a5d365ba16 117 }
ykuroda 0:13a5d365ba16 118
ykuroda 0:13a5d365ba16 119 template<int LoadMode>
ykuroda 0:13a5d365ba16 120 inline PacketScalar packet(Index index) const
ykuroda 0:13a5d365ba16 121 {
ykuroda 0:13a5d365ba16 122 EIGEN_STATIC_ASSERT_INDEX_BASED_ACCESS(Derived)
ykuroda 0:13a5d365ba16 123 return internal::ploadt<PacketScalar, LoadMode>(m_data + index * innerStride());
ykuroda 0:13a5d365ba16 124 }
ykuroda 0:13a5d365ba16 125
ykuroda 0:13a5d365ba16 126 explicit inline MapBase(PointerType dataPtr) : m_data(dataPtr), m_rows(RowsAtCompileTime), m_cols(ColsAtCompileTime)
ykuroda 0:13a5d365ba16 127 {
ykuroda 0:13a5d365ba16 128 EIGEN_STATIC_ASSERT_FIXED_SIZE(Derived)
ykuroda 0:13a5d365ba16 129 checkSanity();
ykuroda 0:13a5d365ba16 130 }
ykuroda 0:13a5d365ba16 131
ykuroda 0:13a5d365ba16 132 inline MapBase(PointerType dataPtr, Index vecSize)
ykuroda 0:13a5d365ba16 133 : m_data(dataPtr),
ykuroda 0:13a5d365ba16 134 m_rows(RowsAtCompileTime == Dynamic ? vecSize : Index(RowsAtCompileTime)),
ykuroda 0:13a5d365ba16 135 m_cols(ColsAtCompileTime == Dynamic ? vecSize : Index(ColsAtCompileTime))
ykuroda 0:13a5d365ba16 136 {
ykuroda 0:13a5d365ba16 137 EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived)
ykuroda 0:13a5d365ba16 138 eigen_assert(vecSize >= 0);
ykuroda 0:13a5d365ba16 139 eigen_assert(dataPtr == 0 || SizeAtCompileTime == Dynamic || SizeAtCompileTime == vecSize);
ykuroda 0:13a5d365ba16 140 checkSanity();
ykuroda 0:13a5d365ba16 141 }
ykuroda 0:13a5d365ba16 142
ykuroda 0:13a5d365ba16 143 inline MapBase(PointerType dataPtr, Index nbRows, Index nbCols)
ykuroda 0:13a5d365ba16 144 : m_data(dataPtr), m_rows(nbRows), m_cols(nbCols)
ykuroda 0:13a5d365ba16 145 {
ykuroda 0:13a5d365ba16 146 eigen_assert( (dataPtr == 0)
ykuroda 0:13a5d365ba16 147 || ( nbRows >= 0 && (RowsAtCompileTime == Dynamic || RowsAtCompileTime == nbRows)
ykuroda 0:13a5d365ba16 148 && nbCols >= 0 && (ColsAtCompileTime == Dynamic || ColsAtCompileTime == nbCols)));
ykuroda 0:13a5d365ba16 149 checkSanity();
ykuroda 0:13a5d365ba16 150 }
ykuroda 0:13a5d365ba16 151
ykuroda 0:13a5d365ba16 152 #ifdef EIGEN_MAPBASE_PLUGIN
ykuroda 0:13a5d365ba16 153 #include EIGEN_MAPBASE_PLUGIN
ykuroda 0:13a5d365ba16 154 #endif
ykuroda 0:13a5d365ba16 155
ykuroda 0:13a5d365ba16 156 protected:
ykuroda 0:13a5d365ba16 157
ykuroda 0:13a5d365ba16 158 void checkSanity() const
ykuroda 0:13a5d365ba16 159 {
ykuroda 0:13a5d365ba16 160 EIGEN_STATIC_ASSERT(EIGEN_IMPLIES(internal::traits<Derived>::Flags&PacketAccessBit,
ykuroda 0:13a5d365ba16 161 internal::inner_stride_at_compile_time<Derived>::ret==1),
ykuroda 0:13a5d365ba16 162 PACKET_ACCESS_REQUIRES_TO_HAVE_INNER_STRIDE_FIXED_TO_1);
ykuroda 0:13a5d365ba16 163 eigen_assert(EIGEN_IMPLIES(internal::traits<Derived>::Flags&AlignedBit, (size_t(m_data) % 16) == 0)
ykuroda 0:13a5d365ba16 164 && "input pointer is not aligned on a 16 byte boundary");
ykuroda 0:13a5d365ba16 165 }
ykuroda 0:13a5d365ba16 166
ykuroda 0:13a5d365ba16 167 PointerType m_data;
ykuroda 0:13a5d365ba16 168 const internal::variable_if_dynamic<Index, RowsAtCompileTime> m_rows;
ykuroda 0:13a5d365ba16 169 const internal::variable_if_dynamic<Index, ColsAtCompileTime> m_cols;
ykuroda 0:13a5d365ba16 170 };
ykuroda 0:13a5d365ba16 171
ykuroda 0:13a5d365ba16 172 template<typename Derived> class MapBase<Derived, WriteAccessors>
ykuroda 0:13a5d365ba16 173 : public MapBase<Derived, ReadOnlyAccessors>
ykuroda 0:13a5d365ba16 174 {
ykuroda 0:13a5d365ba16 175 typedef MapBase<Derived, ReadOnlyAccessors> ReadOnlyMapBase;
ykuroda 0:13a5d365ba16 176 public:
ykuroda 0:13a5d365ba16 177
ykuroda 0:13a5d365ba16 178 typedef MapBase<Derived, ReadOnlyAccessors> Base;
ykuroda 0:13a5d365ba16 179
ykuroda 0:13a5d365ba16 180 typedef typename Base::Scalar Scalar;
ykuroda 0:13a5d365ba16 181 typedef typename Base::PacketScalar PacketScalar;
ykuroda 0:13a5d365ba16 182 typedef typename Base::Index Index;
ykuroda 0:13a5d365ba16 183 typedef typename Base::PointerType PointerType;
ykuroda 0:13a5d365ba16 184
ykuroda 0:13a5d365ba16 185 using Base::derived;
ykuroda 0:13a5d365ba16 186 using Base::rows;
ykuroda 0:13a5d365ba16 187 using Base::cols;
ykuroda 0:13a5d365ba16 188 using Base::size;
ykuroda 0:13a5d365ba16 189 using Base::coeff;
ykuroda 0:13a5d365ba16 190 using Base::coeffRef;
ykuroda 0:13a5d365ba16 191
ykuroda 0:13a5d365ba16 192 using Base::innerStride;
ykuroda 0:13a5d365ba16 193 using Base::outerStride;
ykuroda 0:13a5d365ba16 194 using Base::rowStride;
ykuroda 0:13a5d365ba16 195 using Base::colStride;
ykuroda 0:13a5d365ba16 196
ykuroda 0:13a5d365ba16 197 typedef typename internal::conditional<
ykuroda 0:13a5d365ba16 198 internal::is_lvalue<Derived>::value,
ykuroda 0:13a5d365ba16 199 Scalar,
ykuroda 0:13a5d365ba16 200 const Scalar
ykuroda 0:13a5d365ba16 201 >::type ScalarWithConstIfNotLvalue;
ykuroda 0:13a5d365ba16 202
ykuroda 0:13a5d365ba16 203 inline const Scalar* data() const { return this->m_data; }
ykuroda 0:13a5d365ba16 204 inline ScalarWithConstIfNotLvalue* data() { return this->m_data; } // no const-cast here so non-const-correct code will give a compile error
ykuroda 0:13a5d365ba16 205
ykuroda 0:13a5d365ba16 206 inline ScalarWithConstIfNotLvalue& coeffRef(Index row, Index col)
ykuroda 0:13a5d365ba16 207 {
ykuroda 0:13a5d365ba16 208 return this->m_data[col * colStride() + row * rowStride()];
ykuroda 0:13a5d365ba16 209 }
ykuroda 0:13a5d365ba16 210
ykuroda 0:13a5d365ba16 211 inline ScalarWithConstIfNotLvalue& coeffRef(Index index)
ykuroda 0:13a5d365ba16 212 {
ykuroda 0:13a5d365ba16 213 EIGEN_STATIC_ASSERT_INDEX_BASED_ACCESS(Derived)
ykuroda 0:13a5d365ba16 214 return this->m_data[index * innerStride()];
ykuroda 0:13a5d365ba16 215 }
ykuroda 0:13a5d365ba16 216
ykuroda 0:13a5d365ba16 217 template<int StoreMode>
ykuroda 0:13a5d365ba16 218 inline void writePacket(Index row, Index col, const PacketScalar& val)
ykuroda 0:13a5d365ba16 219 {
ykuroda 0:13a5d365ba16 220 internal::pstoret<Scalar, PacketScalar, StoreMode>
ykuroda 0:13a5d365ba16 221 (this->m_data + (col * colStride() + row * rowStride()), val);
ykuroda 0:13a5d365ba16 222 }
ykuroda 0:13a5d365ba16 223
ykuroda 0:13a5d365ba16 224 template<int StoreMode>
ykuroda 0:13a5d365ba16 225 inline void writePacket(Index index, const PacketScalar& val)
ykuroda 0:13a5d365ba16 226 {
ykuroda 0:13a5d365ba16 227 EIGEN_STATIC_ASSERT_INDEX_BASED_ACCESS(Derived)
ykuroda 0:13a5d365ba16 228 internal::pstoret<Scalar, PacketScalar, StoreMode>
ykuroda 0:13a5d365ba16 229 (this->m_data + index * innerStride(), val);
ykuroda 0:13a5d365ba16 230 }
ykuroda 0:13a5d365ba16 231
ykuroda 0:13a5d365ba16 232 explicit inline MapBase(PointerType dataPtr) : Base(dataPtr) {}
ykuroda 0:13a5d365ba16 233 inline MapBase(PointerType dataPtr, Index vecSize) : Base(dataPtr, vecSize) {}
ykuroda 0:13a5d365ba16 234 inline MapBase(PointerType dataPtr, Index nbRows, Index nbCols) : Base(dataPtr, nbRows, nbCols) {}
ykuroda 0:13a5d365ba16 235
ykuroda 0:13a5d365ba16 236 Derived& operator=(const MapBase& other)
ykuroda 0:13a5d365ba16 237 {
ykuroda 0:13a5d365ba16 238 ReadOnlyMapBase::Base::operator=(other);
ykuroda 0:13a5d365ba16 239 return derived();
ykuroda 0:13a5d365ba16 240 }
ykuroda 0:13a5d365ba16 241
ykuroda 0:13a5d365ba16 242 // In theory we could simply refer to Base:Base::operator=, but MSVC does not like Base::Base,
ykuroda 0:13a5d365ba16 243 // see bugs 821 and 920.
ykuroda 0:13a5d365ba16 244 using ReadOnlyMapBase::Base::operator=;
ykuroda 0:13a5d365ba16 245 };
ykuroda 0:13a5d365ba16 246
ykuroda 0:13a5d365ba16 247 #undef EIGEN_STATIC_ASSERT_INDEX_BASED_ACCESS
ykuroda 0:13a5d365ba16 248
ykuroda 0:13a5d365ba16 249 } // end namespace Eigen
ykuroda 0:13a5d365ba16 250
ykuroda 0:13a5d365ba16 251 #endif // EIGEN_MAPBASE_H