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;
53 typedef typename NumTraits<Scalar>::Real RealScalar;
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 EIGEN_CONSTEXPR
91 inline Index rows() const EIGEN_NOEXCEPT {
return m_rows.value(); }
93 EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR
94 inline Index cols() const EIGEN_NOEXCEPT {
return m_cols.value(); }
102 EIGEN_DEVICE_FUNC
inline const Scalar*
data()
const {
return m_data; }
108 return m_data[colId * colStride() + rowId * rowStride()];
115 EIGEN_STATIC_ASSERT_INDEX_BASED_ACCESS(Derived)
116 return m_data[index * innerStride()];
123 return this->m_data[colId * colStride() + rowId * rowStride()];
130 EIGEN_STATIC_ASSERT_INDEX_BASED_ACCESS(Derived)
131 return this->m_data[index * innerStride()];
135 template<
int LoadMode>
136 inline PacketScalar packet(
Index rowId,
Index colId)
const
138 return internal::ploadt<PacketScalar, LoadMode>
139 (m_data + (colId * colStride() + rowId * rowStride()));
143 template<
int LoadMode>
144 inline PacketScalar packet(Index index)
const
146 EIGEN_STATIC_ASSERT_INDEX_BASED_ACCESS(Derived)
147 return internal::ploadt<PacketScalar, LoadMode>(m_data + index * innerStride());
152 explicit inline MapBase(PointerType dataPtr) : m_data(dataPtr), m_rows(RowsAtCompileTime), m_cols(ColsAtCompileTime)
154 EIGEN_STATIC_ASSERT_FIXED_SIZE(Derived)
155 checkSanity<Derived>();
160 inline MapBase(PointerType dataPtr, Index vecSize)
162 m_rows(RowsAtCompileTime ==
Dynamic ? vecSize :
Index(RowsAtCompileTime)),
163 m_cols(ColsAtCompileTime ==
Dynamic ? vecSize :
Index(ColsAtCompileTime))
165 EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived)
166 eigen_assert(vecSize >= 0);
167 eigen_assert(dataPtr == 0 || SizeAtCompileTime == Dynamic || SizeAtCompileTime == vecSize);
168 checkSanity<Derived>();
173 inline MapBase(PointerType dataPtr, Index rows, Index cols)
174 : m_data(dataPtr), m_rows(rows), m_cols(cols)
176 eigen_assert( (dataPtr == 0)
177 || ( rows >= 0 && (RowsAtCompileTime == Dynamic || RowsAtCompileTime == rows)
178 && cols >= 0 && (ColsAtCompileTime == Dynamic || ColsAtCompileTime == cols)));
179 checkSanity<Derived>();
182 #ifdef EIGEN_MAPBASE_PLUGIN
183 #include EIGEN_MAPBASE_PLUGIN
187 EIGEN_DEFAULT_COPY_CONSTRUCTOR(MapBase)
188 EIGEN_DEFAULT_EMPTY_CONSTRUCTOR_AND_DESTRUCTOR(MapBase)
192 void checkSanity(
typename internal::enable_if<(internal::traits<T>::Alignment>0),
void*>::type = 0)
const
194#if EIGEN_MAX_ALIGN_BYTES>0
196 const Index minInnerStride = InnerStrideAtCompileTime ==
Dynamic ? 1 :
Index(InnerStrideAtCompileTime);
197 EIGEN_ONLY_USED_FOR_DEBUG(minInnerStride);
198 eigen_assert(( ((internal::UIntPtr(m_data) % internal::traits<Derived>::Alignment) == 0)
199 || (cols() * rows() * minInnerStride *
sizeof(Scalar)) < internal::traits<Derived>::Alignment ) &&
"data is not aligned");
205 void checkSanity(
typename internal::enable_if<internal::traits<T>::Alignment==0,
void*>::type = 0)
const
209 const internal::variable_if_dynamic<Index, RowsAtCompileTime> m_rows;
210 const internal::variable_if_dynamic<Index, ColsAtCompileTime> m_cols;
224 :
public MapBase<Derived, ReadOnlyAccessors>
229 typedef MapBase<Derived, ReadOnlyAccessors>
Base;
231 typedef typename Base::Scalar Scalar;
232 typedef typename Base::PacketScalar PacketScalar;
233 typedef typename Base::StorageIndex StorageIndex;
234 typedef typename Base::PointerType PointerType;
241 using Base::coeffRef;
243 using Base::innerStride;
244 using Base::outerStride;
245 using Base::rowStride;
246 using Base::colStride;
248 typedef typename internal::conditional<
249 internal::is_lvalue<Derived>::value,
252 >::type ScalarWithConstIfNotLvalue;
255 inline const Scalar* data()
const {
return this->m_data; }
257 inline ScalarWithConstIfNotLvalue* data() {
return this->m_data; }
260 inline ScalarWithConstIfNotLvalue& coeffRef(
Index row,
Index col)
262 return this->m_data[col * colStride() + row * rowStride()];
266 inline ScalarWithConstIfNotLvalue& coeffRef(
Index index)
268 EIGEN_STATIC_ASSERT_INDEX_BASED_ACCESS(Derived)
269 return this->m_data[index * innerStride()];
272 template<
int StoreMode>
273 inline void writePacket(
Index row,
Index col,
const PacketScalar& val)
275 internal::pstoret<Scalar, PacketScalar, StoreMode>
276 (this->m_data + (col * colStride() + row * rowStride()), val);
279 template<
int StoreMode>
280 inline void writePacket(
Index index,
const PacketScalar& val)
282 EIGEN_STATIC_ASSERT_INDEX_BASED_ACCESS(Derived)
283 internal::pstoret<Scalar, PacketScalar, StoreMode>
284 (this->m_data + index * innerStride(), val);
287 EIGEN_DEVICE_FUNC
explicit inline MapBase(PointerType dataPtr) :
Base(dataPtr) {}
288 EIGEN_DEVICE_FUNC
inline MapBase(PointerType dataPtr,
Index vecSize) :
Base(dataPtr, vecSize) {}
289 EIGEN_DEVICE_FUNC
inline MapBase(PointerType dataPtr,
Index rows,
Index cols) :
Base(dataPtr, rows, cols) {}
292 Derived& operator=(
const MapBase& other)
294 ReadOnlyMapBase::Base::operator=(other);
300 using ReadOnlyMapBase::Base::operator=;
302 EIGEN_DEFAULT_COPY_CONSTRUCTOR(MapBase)
303 EIGEN_DEFAULT_EMPTY_CONSTRUCTOR_AND_DESTRUCTOR(MapBase)
306#undef EIGEN_STATIC_ASSERT_INDEX_BASED_ACCESS
Base class for dense Map and Block expression with direct access.
Definition: MapBase.h:39
const Scalar & coeff(Index index) const
Definition: MapBase.h:113
const Scalar & coeffRef(Index index) const
Definition: MapBase.h:128
const Scalar * data() const
Definition: MapBase.h:102
EIGEN_CONSTEXPR Index rows() const EIGEN_NOEXCEPT
Definition: MapBase.h:91
const Scalar & coeff(Index rowId, Index colId) const
Definition: MapBase.h:106
EIGEN_CONSTEXPR Index cols() const EIGEN_NOEXCEPT
Definition: MapBase.h:94
const Scalar & coeffRef(Index rowId, Index colId) const
Definition: MapBase.h:121
@ ReadOnlyAccessors
Definition: Constants.h:376
@ WriteAccessors
Definition: Constants.h:378
Namespace containing all symbols from the Eigen library.
Definition: Core:141
EIGEN_DEFAULT_DENSE_INDEX_TYPE Index
The Index type as used for the API.
Definition: Meta.h:74
const int Dynamic
Definition: Constants.h:22