1c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath// This file is part of Eigen, a lightweight C++ template library 2c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath// for linear algebra. 3c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath// 4c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath// Copyright (C) 2007-2010 Benoit Jacob <jacob.benoit.1@gmail.com> 5c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath// Copyright (C) 2008 Gael Guennebaud <gael.guennebaud@inria.fr> 6c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath// 7c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath// This Source Code Form is subject to the terms of the Mozilla 8c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath// Public License v. 2.0. If a copy of the MPL was not distributed 9c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath// with this file, You can obtain one at http://mozilla.org/MPL/2.0/. 10c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 11c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath#ifndef EIGEN_MAPBASE_H 12c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath#define EIGEN_MAPBASE_H 13c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 14c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath#define EIGEN_STATIC_ASSERT_INDEX_BASED_ACCESS(Derived) \ 152b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang EIGEN_STATIC_ASSERT((int(internal::evaluator<Derived>::Flags) & LinearAccessBit) || Derived::IsVectorAtCompileTime, \ 16c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath YOU_ARE_TRYING_TO_USE_AN_INDEX_BASED_ACCESSOR_ON_AN_EXPRESSION_THAT_DOES_NOT_SUPPORT_THAT) 17c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 18c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamathnamespace Eigen { 19c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 202b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang/** \ingroup Core_Module 21c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * 222b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang * \brief Base class for dense Map and Block expression with direct access 232b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang * 242b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang * This base class provides the const low-level accessors (e.g. coeff, coeffRef) of dense 252b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang * Map and Block objects with direct access. 262b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang * Typical users do not have to directly deal with this class. 272b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang * 282b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang * This class can be extended by through the macro plugin \c EIGEN_MAPBASE_PLUGIN. 292b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang * See \link TopicCustomizing_Plugins customizing Eigen \endlink for details. 302b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang * 312b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang * The \c Derived class has to provide the following two methods describing the memory layout: 322b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang * \code Index innerStride() const; \endcode 332b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang * \code Index outerStride() const; \endcode 34c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * 35c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * \sa class Map, class Block 36c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath */ 37c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamathtemplate<typename Derived> class MapBase<Derived, ReadOnlyAccessors> 38c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath : public internal::dense_xpr_base<Derived>::type 39c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath{ 40c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath public: 41c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 42c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath typedef typename internal::dense_xpr_base<Derived>::type Base; 43c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath enum { 44c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath RowsAtCompileTime = internal::traits<Derived>::RowsAtCompileTime, 45c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath ColsAtCompileTime = internal::traits<Derived>::ColsAtCompileTime, 46c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath SizeAtCompileTime = Base::SizeAtCompileTime 47c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath }; 48c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 49c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath typedef typename internal::traits<Derived>::StorageKind StorageKind; 50c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath typedef typename internal::traits<Derived>::Scalar Scalar; 51c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath typedef typename internal::packet_traits<Scalar>::type PacketScalar; 52c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath typedef typename NumTraits<Scalar>::Real RealScalar; 53c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath typedef typename internal::conditional< 54c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath bool(internal::is_lvalue<Derived>::value), 55c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath Scalar *, 56c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath const Scalar *>::type 57c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath PointerType; 58c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 59c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath using Base::derived; 60c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath// using Base::RowsAtCompileTime; 61c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath// using Base::ColsAtCompileTime; 62c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath// using Base::SizeAtCompileTime; 63c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath using Base::MaxRowsAtCompileTime; 64c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath using Base::MaxColsAtCompileTime; 65c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath using Base::MaxSizeAtCompileTime; 66c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath using Base::IsVectorAtCompileTime; 67c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath using Base::Flags; 68c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath using Base::IsRowMajor; 69c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 70c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath using Base::rows; 71c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath using Base::cols; 72c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath using Base::size; 73c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath using Base::coeff; 74c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath using Base::coeffRef; 75c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath using Base::lazyAssign; 76c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath using Base::eval; 77c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 78c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath using Base::innerStride; 79c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath using Base::outerStride; 80c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath using Base::rowStride; 81c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath using Base::colStride; 82c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 83c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath // bug 217 - compile error on ICC 11.1 84c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath using Base::operator=; 85c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 86c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath typedef typename Base::CoeffReturnType CoeffReturnType; 87c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 882b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang /** \copydoc DenseBase::rows() */ 892b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang EIGEN_DEVICE_FUNC inline Index rows() const { return m_rows.value(); } 902b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang /** \copydoc DenseBase::cols() */ 912b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang EIGEN_DEVICE_FUNC inline Index cols() const { return m_cols.value(); } 92c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 93c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath /** Returns a pointer to the first coefficient of the matrix or vector. 94c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * 95c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * \note When addressing this data, make sure to honor the strides returned by innerStride() and outerStride(). 96c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * 97c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath * \sa innerStride(), outerStride() 98c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath */ 992b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang EIGEN_DEVICE_FUNC inline const Scalar* data() const { return m_data; } 100c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 1012b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang /** \copydoc PlainObjectBase::coeff(Index,Index) const */ 1022b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang EIGEN_DEVICE_FUNC 1037faaa9f3f0df9d23790277834d426c3d992ac3baCarlos Hernandez inline const Scalar& coeff(Index rowId, Index colId) const 104c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath { 1057faaa9f3f0df9d23790277834d426c3d992ac3baCarlos Hernandez return m_data[colId * colStride() + rowId * rowStride()]; 106c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath } 107c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 1082b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang /** \copydoc PlainObjectBase::coeff(Index) const */ 1092b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang EIGEN_DEVICE_FUNC 110c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath inline const Scalar& coeff(Index index) const 111c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath { 112c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath EIGEN_STATIC_ASSERT_INDEX_BASED_ACCESS(Derived) 113c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath return m_data[index * innerStride()]; 114c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath } 115c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 1162b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang /** \copydoc PlainObjectBase::coeffRef(Index,Index) const */ 1172b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang EIGEN_DEVICE_FUNC 1187faaa9f3f0df9d23790277834d426c3d992ac3baCarlos Hernandez inline const Scalar& coeffRef(Index rowId, Index colId) const 119c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath { 1207faaa9f3f0df9d23790277834d426c3d992ac3baCarlos Hernandez return this->m_data[colId * colStride() + rowId * rowStride()]; 121c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath } 122c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 1232b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang /** \copydoc PlainObjectBase::coeffRef(Index) const */ 1242b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang EIGEN_DEVICE_FUNC 125c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath inline const Scalar& coeffRef(Index index) const 126c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath { 127c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath EIGEN_STATIC_ASSERT_INDEX_BASED_ACCESS(Derived) 128c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath return this->m_data[index * innerStride()]; 129c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath } 130c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 1312b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang /** \internal */ 132c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath template<int LoadMode> 1337faaa9f3f0df9d23790277834d426c3d992ac3baCarlos Hernandez inline PacketScalar packet(Index rowId, Index colId) const 134c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath { 135c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath return internal::ploadt<PacketScalar, LoadMode> 1367faaa9f3f0df9d23790277834d426c3d992ac3baCarlos Hernandez (m_data + (colId * colStride() + rowId * rowStride())); 137c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath } 138c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 1392b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang /** \internal */ 140c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath template<int LoadMode> 141c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath inline PacketScalar packet(Index index) const 142c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath { 143c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath EIGEN_STATIC_ASSERT_INDEX_BASED_ACCESS(Derived) 144c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath return internal::ploadt<PacketScalar, LoadMode>(m_data + index * innerStride()); 145c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath } 146c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 1472b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang /** \internal Constructor for fixed size matrices or vectors */ 1482b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang EIGEN_DEVICE_FUNC 1492b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang explicit inline MapBase(PointerType dataPtr) : m_data(dataPtr), m_rows(RowsAtCompileTime), m_cols(ColsAtCompileTime) 150c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath { 151c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath EIGEN_STATIC_ASSERT_FIXED_SIZE(Derived) 1522b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang checkSanity<Derived>(); 153c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath } 154c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 1552b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang /** \internal Constructor for dynamically sized vectors */ 1562b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang EIGEN_DEVICE_FUNC 1577faaa9f3f0df9d23790277834d426c3d992ac3baCarlos Hernandez inline MapBase(PointerType dataPtr, Index vecSize) 1587faaa9f3f0df9d23790277834d426c3d992ac3baCarlos Hernandez : m_data(dataPtr), 1597faaa9f3f0df9d23790277834d426c3d992ac3baCarlos Hernandez m_rows(RowsAtCompileTime == Dynamic ? vecSize : Index(RowsAtCompileTime)), 1607faaa9f3f0df9d23790277834d426c3d992ac3baCarlos Hernandez m_cols(ColsAtCompileTime == Dynamic ? vecSize : Index(ColsAtCompileTime)) 161c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath { 162c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived) 1637faaa9f3f0df9d23790277834d426c3d992ac3baCarlos Hernandez eigen_assert(vecSize >= 0); 1647faaa9f3f0df9d23790277834d426c3d992ac3baCarlos Hernandez eigen_assert(dataPtr == 0 || SizeAtCompileTime == Dynamic || SizeAtCompileTime == vecSize); 1652b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang checkSanity<Derived>(); 166c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath } 167c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 1682b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang /** \internal Constructor for dynamically sized matrices */ 1692b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang EIGEN_DEVICE_FUNC 1702b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang inline MapBase(PointerType dataPtr, Index rows, Index cols) 1712b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang : m_data(dataPtr), m_rows(rows), m_cols(cols) 172c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath { 1737faaa9f3f0df9d23790277834d426c3d992ac3baCarlos Hernandez eigen_assert( (dataPtr == 0) 1742b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang || ( rows >= 0 && (RowsAtCompileTime == Dynamic || RowsAtCompileTime == rows) 1752b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang && cols >= 0 && (ColsAtCompileTime == Dynamic || ColsAtCompileTime == cols))); 1762b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang checkSanity<Derived>(); 177c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath } 178c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 1792b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang #ifdef EIGEN_MAPBASE_PLUGIN 1802b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang #include EIGEN_MAPBASE_PLUGIN 1812b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang #endif 1822b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang 183c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath protected: 184c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 1852b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang template<typename T> 1862b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang EIGEN_DEVICE_FUNC 1872b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang void checkSanity(typename internal::enable_if<(internal::traits<T>::Alignment>0),void*>::type = 0) const 188c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath { 1892b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang#if EIGEN_MAX_ALIGN_BYTES>0 1902b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang eigen_assert(( ((internal::UIntPtr(m_data) % internal::traits<Derived>::Alignment) == 0) 1912b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang || (cols() * rows() * innerStride() * sizeof(Scalar)) < internal::traits<Derived>::Alignment ) && "data is not aligned"); 1922b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang#endif 193c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath } 194c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 1952b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang template<typename T> 1962b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang EIGEN_DEVICE_FUNC 1972b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang void checkSanity(typename internal::enable_if<internal::traits<T>::Alignment==0,void*>::type = 0) const 1982b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang {} 1992b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang 200c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath PointerType m_data; 201c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath const internal::variable_if_dynamic<Index, RowsAtCompileTime> m_rows; 202c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath const internal::variable_if_dynamic<Index, ColsAtCompileTime> m_cols; 203c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath}; 204c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 2052b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang/** \ingroup Core_Module 2062b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang * 2072b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang * \brief Base class for non-const dense Map and Block expression with direct access 2082b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang * 2092b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang * This base class provides the non-const low-level accessors (e.g. coeff and coeffRef) of 2102b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang * dense Map and Block objects with direct access. 2112b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang * It inherits MapBase<Derived, ReadOnlyAccessors> which defines the const variant for reading specific entries. 2122b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang * 2132b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang * \sa class Map, class Block 2142b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang */ 215c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamathtemplate<typename Derived> class MapBase<Derived, WriteAccessors> 216c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath : public MapBase<Derived, ReadOnlyAccessors> 217c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath{ 218615d816d068b4d0f5e8df601930b5f160bf7eda1Tim Murray typedef MapBase<Derived, ReadOnlyAccessors> ReadOnlyMapBase; 219c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath public: 220c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 221c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath typedef MapBase<Derived, ReadOnlyAccessors> Base; 222c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 223c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath typedef typename Base::Scalar Scalar; 224c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath typedef typename Base::PacketScalar PacketScalar; 2252b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang typedef typename Base::StorageIndex StorageIndex; 226c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath typedef typename Base::PointerType PointerType; 227c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 228c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath using Base::derived; 229c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath using Base::rows; 230c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath using Base::cols; 231c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath using Base::size; 232c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath using Base::coeff; 233c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath using Base::coeffRef; 234c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 235c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath using Base::innerStride; 236c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath using Base::outerStride; 237c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath using Base::rowStride; 238c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath using Base::colStride; 239c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 240c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath typedef typename internal::conditional< 241c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath internal::is_lvalue<Derived>::value, 242c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath Scalar, 243c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath const Scalar 244c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath >::type ScalarWithConstIfNotLvalue; 245c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 2462b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang EIGEN_DEVICE_FUNC 247c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath inline const Scalar* data() const { return this->m_data; } 2482b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang EIGEN_DEVICE_FUNC 249c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath inline ScalarWithConstIfNotLvalue* data() { return this->m_data; } // no const-cast here so non-const-correct code will give a compile error 250c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 2512b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang EIGEN_DEVICE_FUNC 252c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath inline ScalarWithConstIfNotLvalue& coeffRef(Index row, Index col) 253c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath { 254c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath return this->m_data[col * colStride() + row * rowStride()]; 255c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath } 256c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 2572b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang EIGEN_DEVICE_FUNC 258c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath inline ScalarWithConstIfNotLvalue& coeffRef(Index index) 259c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath { 260c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath EIGEN_STATIC_ASSERT_INDEX_BASED_ACCESS(Derived) 261c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath return this->m_data[index * innerStride()]; 262c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath } 263c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 264c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath template<int StoreMode> 2657faaa9f3f0df9d23790277834d426c3d992ac3baCarlos Hernandez inline void writePacket(Index row, Index col, const PacketScalar& val) 266c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath { 267c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath internal::pstoret<Scalar, PacketScalar, StoreMode> 2687faaa9f3f0df9d23790277834d426c3d992ac3baCarlos Hernandez (this->m_data + (col * colStride() + row * rowStride()), val); 269c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath } 270c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 271c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath template<int StoreMode> 2727faaa9f3f0df9d23790277834d426c3d992ac3baCarlos Hernandez inline void writePacket(Index index, const PacketScalar& val) 273c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath { 274c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath EIGEN_STATIC_ASSERT_INDEX_BASED_ACCESS(Derived) 275c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath internal::pstoret<Scalar, PacketScalar, StoreMode> 2767faaa9f3f0df9d23790277834d426c3d992ac3baCarlos Hernandez (this->m_data + index * innerStride(), val); 277c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath } 278c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 2792b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang EIGEN_DEVICE_FUNC explicit inline MapBase(PointerType dataPtr) : Base(dataPtr) {} 2802b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang EIGEN_DEVICE_FUNC inline MapBase(PointerType dataPtr, Index vecSize) : Base(dataPtr, vecSize) {} 2812b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang EIGEN_DEVICE_FUNC inline MapBase(PointerType dataPtr, Index rows, Index cols) : Base(dataPtr, rows, cols) {} 282c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 2832b8756b6f1de65d3f8bffab45be6c44ceb7411fcMiao Wang EIGEN_DEVICE_FUNC 284c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath Derived& operator=(const MapBase& other) 285c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath { 286615d816d068b4d0f5e8df601930b5f160bf7eda1Tim Murray ReadOnlyMapBase::Base::operator=(other); 287c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath return derived(); 288c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath } 289c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 290615d816d068b4d0f5e8df601930b5f160bf7eda1Tim Murray // In theory we could simply refer to Base:Base::operator=, but MSVC does not like Base::Base, 291615d816d068b4d0f5e8df601930b5f160bf7eda1Tim Murray // see bugs 821 and 920. 292615d816d068b4d0f5e8df601930b5f160bf7eda1Tim Murray using ReadOnlyMapBase::Base::operator=; 293c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath}; 294c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 2957faaa9f3f0df9d23790277834d426c3d992ac3baCarlos Hernandez#undef EIGEN_STATIC_ASSERT_INDEX_BASED_ACCESS 2967faaa9f3f0df9d23790277834d426c3d992ac3baCarlos Hernandez 297c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath} // end namespace Eigen 298c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath 299c981c48f5bc9aefeffc0bcb0cc3934c2fae179ddNarayan Kamath#endif // EIGEN_MAPBASE_H 300