11 #ifndef EIGEN_MAPBASE_H
12 #define EIGEN_MAPBASE_H
14 #define EIGEN_STATIC_ASSERT_INDEX_BASED_ACCESS(Derived) \
15 EIGEN_STATIC_ASSERT((int(internal::evaluator<Derived>::Flags) & LinearAccessBit) || Derived::IsVectorAtCompileTime, \
16 YOU_ARE_TRYING_TO_USE_AN_INDEX_BASED_ACCESSOR_ON_AN_EXPRESSION_THAT_DOES_NOT_SUPPORT_THAT)
38 :
public internal::dense_xpr_base<Derived>::type
42 typedef typename internal::dense_xpr_base<Derived>::type Base;
44 RowsAtCompileTime = internal::traits<Derived>::RowsAtCompileTime,
45 ColsAtCompileTime = internal::traits<Derived>::ColsAtCompileTime,
46 InnerStrideAtCompileTime = internal::traits<Derived>::InnerStrideAtCompileTime,
47 SizeAtCompileTime = Base::SizeAtCompileTime
50 typedef typename internal::traits<Derived>::StorageKind StorageKind;
51 typedef typename internal::traits<Derived>::Scalar Scalar;
52 typedef typename internal::packet_traits<Scalar>::type PacketScalar;
54 typedef typename internal::conditional<
55 bool(internal::is_lvalue<Derived>::value),
64 using Base::MaxRowsAtCompileTime;
65 using Base::MaxColsAtCompileTime;
66 using Base::MaxSizeAtCompileTime;
67 using Base::IsVectorAtCompileTime;
69 using Base::IsRowMajor;
76 using Base::lazyAssign;
79 using Base::innerStride;
80 using Base::outerStride;
81 using Base::rowStride;
82 using Base::colStride;
85 using Base::operator=;
87 typedef typename Base::CoeffReturnType CoeffReturnType;
90 EIGEN_DEVICE_FUNC
inline Index rows()
const {
return m_rows.value(); }
92 EIGEN_DEVICE_FUNC
inline Index cols()
const {
return m_cols.value(); }
100 EIGEN_DEVICE_FUNC
inline const Scalar*
data()
const {
return m_data; }
106 return m_data[colId * colStride() + rowId * rowStride()];
113 EIGEN_STATIC_ASSERT_INDEX_BASED_ACCESS(Derived)
114 return m_data[index * innerStride()];
121 return this->m_data[colId * colStride() + rowId * rowStride()];
128 EIGEN_STATIC_ASSERT_INDEX_BASED_ACCESS(Derived)
129 return this->m_data[index * innerStride()];
133 template<
int LoadMode>
134 inline PacketScalar packet(
Index rowId,
Index colId)
const
136 return internal::ploadt<PacketScalar, LoadMode>
137 (m_data + (colId * colStride() + rowId * rowStride()));
141 template<
int LoadMode>
142 inline PacketScalar packet(
Index index)
const
144 EIGEN_STATIC_ASSERT_INDEX_BASED_ACCESS(Derived)
145 return internal::ploadt<PacketScalar, LoadMode>(m_data + index * innerStride());
150 explicit inline MapBase(PointerType dataPtr) : m_data(dataPtr), m_rows(RowsAtCompileTime), m_cols(ColsAtCompileTime)
152 EIGEN_STATIC_ASSERT_FIXED_SIZE(Derived)
153 checkSanity<Derived>();
158 inline MapBase(PointerType dataPtr,
Index vecSize)
160 m_rows(RowsAtCompileTime ==
Dynamic ? vecSize :
Index(RowsAtCompileTime)),
161 m_cols(ColsAtCompileTime ==
Dynamic ? vecSize :
Index(ColsAtCompileTime))
163 EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived)
164 eigen_assert(vecSize >= 0);
165 eigen_assert(dataPtr == 0 || SizeAtCompileTime ==
Dynamic || SizeAtCompileTime == vecSize);
166 checkSanity<Derived>();
171 inline MapBase(PointerType dataPtr,
Index rows,
Index cols)
172 : m_data(dataPtr), m_rows(rows), m_cols(cols)
174 eigen_assert( (dataPtr == 0)
175 || ( rows >= 0 && (RowsAtCompileTime ==
Dynamic || RowsAtCompileTime == rows)
176 && cols >= 0 && (ColsAtCompileTime ==
Dynamic || ColsAtCompileTime == cols)));
177 checkSanity<Derived>();
180 #ifdef EIGEN_MAPBASE_PLUGIN
181 #include EIGEN_MAPBASE_PLUGIN
188 void checkSanity(
typename internal::enable_if<(internal::traits<T>::Alignment>0),
void*>::type = 0)
const
190 #if EIGEN_MAX_ALIGN_BYTES>0
192 const Index minInnerStride = InnerStrideAtCompileTime ==
Dynamic ? 1 :
Index(InnerStrideAtCompileTime);
193 EIGEN_ONLY_USED_FOR_DEBUG(minInnerStride);
194 eigen_assert(( ((internal::UIntPtr(m_data) % internal::traits<Derived>::Alignment) == 0)
195 || (cols() * rows() * minInnerStride *
sizeof(Scalar)) < internal::traits<Derived>::Alignment ) &&
"data is not aligned");
201 void checkSanity(
typename internal::enable_if<internal::traits<T>::Alignment==0,
void*>::type = 0)
const
205 const internal::variable_if_dynamic<Index, RowsAtCompileTime> m_rows;
206 const internal::variable_if_dynamic<Index, ColsAtCompileTime> m_cols;
220 :
public MapBase<Derived, ReadOnlyAccessors>
227 typedef typename Base::Scalar Scalar;
228 typedef typename Base::PacketScalar PacketScalar;
229 typedef typename Base::StorageIndex StorageIndex;
230 typedef typename Base::PointerType PointerType;
237 using Base::coeffRef;
239 using Base::innerStride;
240 using Base::outerStride;
241 using Base::rowStride;
242 using Base::colStride;
244 typedef typename internal::conditional<
245 internal::is_lvalue<Derived>::value,
248 >::type ScalarWithConstIfNotLvalue;
251 inline const Scalar* data()
const {
return this->m_data; }
253 inline ScalarWithConstIfNotLvalue* data() {
return this->m_data; }
256 inline ScalarWithConstIfNotLvalue& coeffRef(
Index row,
Index col)
258 return this->m_data[col * colStride() + row * rowStride()];
262 inline ScalarWithConstIfNotLvalue& coeffRef(
Index index)
264 EIGEN_STATIC_ASSERT_INDEX_BASED_ACCESS(Derived)
265 return this->m_data[index * innerStride()];
268 template<
int StoreMode>
269 inline void writePacket(
Index row,
Index col,
const PacketScalar& val)
271 internal::pstoret<Scalar, PacketScalar, StoreMode>
272 (this->m_data + (col * colStride() + row * rowStride()), val);
275 template<
int StoreMode>
276 inline void writePacket(
Index index,
const PacketScalar& val)
278 EIGEN_STATIC_ASSERT_INDEX_BASED_ACCESS(Derived)
279 internal::pstoret<Scalar, PacketScalar, StoreMode>
280 (this->m_data + index * innerStride(), val);
283 EIGEN_DEVICE_FUNC
explicit inline MapBase(PointerType dataPtr) : Base(dataPtr) {}
284 EIGEN_DEVICE_FUNC
inline MapBase(PointerType dataPtr,
Index vecSize) : Base(dataPtr, vecSize) {}
285 EIGEN_DEVICE_FUNC
inline MapBase(PointerType dataPtr,
Index rows,
Index cols) : Base(dataPtr, rows, cols) {}
288 Derived& operator=(
const MapBase& other)
290 ReadOnlyMapBase::Base::operator=(other);
296 using ReadOnlyMapBase::Base::operator=;
299 #undef EIGEN_STATIC_ASSERT_INDEX_BASED_ACCESS
303 #endif // EIGEN_MAPBASE_H
Definition: Constants.h:368
Holds information about the various numeric (i.e. scalar) types allowed by Eigen. ...
Definition: NumTraits.h:150
const Scalar & coeff(Index index) const
const
Definition: MapBase.h:111
const Scalar * data() const
Definition: MapBase.h:100
const Scalar & coeffRef(Index rowId, Index colId) const
const
Definition: MapBase.h:119
Definition: Constants.h:366
const Scalar & coeff(Index rowId, Index colId) const
const
Definition: MapBase.h:104
Base class for dense Map and Block expression with direct access.
Definition: MapBase.h:37
EIGEN_DEFAULT_DENSE_INDEX_TYPE Index
The Index type as used for the API.
Definition: Meta.h:33
Index cols() const
Definition: MapBase.h:92
Index rows() const
Definition: MapBase.h:90
const int Dynamic
Definition: Constants.h:21
const Scalar & coeffRef(Index index) const
const
Definition: MapBase.h:126