252 lines
8.5 KiB
C
252 lines
8.5 KiB
C
|
// This file is part of Eigen, a lightweight C++ template library
|
||
|
|
// for linear algebra.
|
||
|
|
//
|
||
|
|
// Copyright (C) 2007-2010 Benoit Jacob <jacob.benoit.1@gmail.com>
|
||
|
|
// Copyright (C) 2008 Gael Guennebaud <gael.guennebaud@inria.fr>
|
||
|
|
//
|
||
|
|
// This Source Code Form is subject to the terms of the Mozilla
|
||
|
|
// Public License v. 2.0. If a copy of the MPL was not distributed
|
||
|
|
// with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||
|
|
|
||
|
|
#ifndef EIGEN_MAPBASE_H
|
||
|
|
#define EIGEN_MAPBASE_H
|
||
|
|
|
||
|
|
#define EIGEN_STATIC_ASSERT_INDEX_BASED_ACCESS(Derived) \
|
||
|
|
EIGEN_STATIC_ASSERT((int(internal::traits<Derived>::Flags) & LinearAccessBit) || Derived::IsVectorAtCompileTime, \
|
||
|
|
YOU_ARE_TRYING_TO_USE_AN_INDEX_BASED_ACCESSOR_ON_AN_EXPRESSION_THAT_DOES_NOT_SUPPORT_THAT)
|
||
|
|
|
||
|
|
namespace Eigen {
|
||
|
|
|
||
|
|
/** \class MapBase
|
||
|
|
* \ingroup Core_Module
|
||
|
|
*
|
||
|
|
* \brief Base class for Map and Block expression with direct access
|
||
|
|
*
|
||
|
|
* \sa class Map, class Block
|
||
|
|
*/
|
||
|
|
template<typename Derived> class MapBase<Derived, ReadOnlyAccessors>
|
||
|
|
: public internal::dense_xpr_base<Derived>::type
|
||
|
|
{
|
||
|
|
public:
|
||
|
|
|
||
|
|
typedef typename internal::dense_xpr_base<Derived>::type Base;
|
||
|
|
enum {
|
||
|
|
RowsAtCompileTime = internal::traits<Derived>::RowsAtCompileTime,
|
||
|
|
ColsAtCompileTime = internal::traits<Derived>::ColsAtCompileTime,
|
||
|
|
SizeAtCompileTime = Base::SizeAtCompileTime
|
||
|
|
};
|
||
|
|
|
||
|
|
typedef typename internal::traits<Derived>::StorageKind StorageKind;
|
||
|
|
typedef typename internal::traits<Derived>::Index Index;
|
||
|
|
typedef typename internal::traits<Derived>::Scalar Scalar;
|
||
|
|
typedef typename internal::packet_traits<Scalar>::type PacketScalar;
|
||
|
|
typedef typename NumTraits<Scalar>::Real RealScalar;
|
||
|
|
typedef typename internal::conditional<
|
||
|
|
bool(internal::is_lvalue<Derived>::value),
|
||
|
|
Scalar *,
|
||
|
|
const Scalar *>::type
|
||
|
|
PointerType;
|
||
|
|
|
||
|
|
using Base::derived;
|
||
|
|
// using Base::RowsAtCompileTime;
|
||
|
|
// using Base::ColsAtCompileTime;
|
||
|
|
// using Base::SizeAtCompileTime;
|
||
|
|
using Base::MaxRowsAtCompileTime;
|
||
|
|
using Base::MaxColsAtCompileTime;
|
||
|
|
using Base::MaxSizeAtCompileTime;
|
||
|
|
using Base::IsVectorAtCompileTime;
|
||
|
|
using Base::Flags;
|
||
|
|
using Base::IsRowMajor;
|
||
|
|
|
||
|
|
using Base::rows;
|
||
|
|
using Base::cols;
|
||
|
|
using Base::size;
|
||
|
|
using Base::coeff;
|
||
|
|
using Base::coeffRef;
|
||
|
|
using Base::lazyAssign;
|
||
|
|
using Base::eval;
|
||
|
|
|
||
|
|
using Base::innerStride;
|
||
|
|
using Base::outerStride;
|
||
|
|
using Base::rowStride;
|
||
|
|
using Base::colStride;
|
||
|
|
|
||
|
|
// bug 217 - compile error on ICC 11.1
|
||
|
|
using Base::operator=;
|
||
|
|
|
||
|
|
typedef typename Base::CoeffReturnType CoeffReturnType;
|
||
|
|
|
||
|
|
inline Index rows() const { return m_rows.value(); }
|
||
|
|
inline Index cols() const { return m_cols.value(); }
|
||
|
|
|
||
|
|
/** Returns a pointer to the first coefficient of the matrix or vector.
|
||
|
|
*
|
||
|
|
* \note When addressing this data, make sure to honor the strides returned by innerStride() and outerStride().
|
||
|
|
*
|
||
|
|
* \sa innerStride(), outerStride()
|
||
|
|
*/
|
||
|
|
inline const Scalar* data() const { return m_data; }
|
||
|
|
|
||
|
|
inline const Scalar& coeff(Index rowId, Index colId) const
|
||
|
|
{
|
||
|
|
return m_data[colId * colStride() + rowId * rowStride()];
|
||
|
|
}
|
||
|
|
|
||
|
|
inline const Scalar& coeff(Index index) const
|
||
|
|
{
|
||
|
|
EIGEN_STATIC_ASSERT_INDEX_BASED_ACCESS(Derived)
|
||
|
|
return m_data[index * innerStride()];
|
||
|
|
}
|
||
|
|
|
||
|
|
inline const Scalar& coeffRef(Index rowId, Index colId) const
|
||
|
|
{
|
||
|
|
return this->m_data[colId * colStride() + rowId * rowStride()];
|
||
|
|
}
|
||
|
|
|
||
|
|
inline const Scalar& coeffRef(Index index) const
|
||
|
|
{
|
||
|
|
EIGEN_STATIC_ASSERT_INDEX_BASED_ACCESS(Derived)
|
||
|
|
return this->m_data[index * innerStride()];
|
||
|
|
}
|
||
|
|
|
||
|
|
template<int LoadMode>
|
||
|
|
inline PacketScalar packet(Index rowId, Index colId) const
|
||
|
|
{
|
||
|
|
return internal::ploadt<PacketScalar, LoadMode>
|
||
|
|
(m_data + (colId * colStride() + rowId * rowStride()));
|
||
|
|
}
|
||
|
|
|
||
|
|
template<int LoadMode>
|
||
|
|
inline PacketScalar packet(Index index) const
|
||
|
|
{
|
||
|
|
EIGEN_STATIC_ASSERT_INDEX_BASED_ACCESS(Derived)
|
||
|
|
return internal::ploadt<PacketScalar, LoadMode>(m_data + index * innerStride());
|
||
|
|
}
|
||
|
|
|
||
|
|
explicit inline MapBase(PointerType dataPtr) : m_data(dataPtr), m_rows(RowsAtCompileTime), m_cols(ColsAtCompileTime)
|
||
|
|
{
|
||
|
|
EIGEN_STATIC_ASSERT_FIXED_SIZE(Derived)
|
||
|
|
checkSanity();
|
||
|
|
}
|
||
|
|
|
||
|
|
inline MapBase(PointerType dataPtr, Index vecSize)
|
||
|
|
: m_data(dataPtr),
|
||
|
|
m_rows(RowsAtCompileTime == Dynamic ? vecSize : Index(RowsAtCompileTime)),
|
||
|
|
m_cols(ColsAtCompileTime == Dynamic ? vecSize : Index(ColsAtCompileTime))
|
||
|
|
{
|
||
|
|
EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived)
|
||
|
|
eigen_assert(vecSize >= 0);
|
||
|
|
eigen_assert(dataPtr == 0 || SizeAtCompileTime == Dynamic || SizeAtCompileTime == vecSize);
|
||
|
|
checkSanity();
|
||
|
|
}
|
||
|
|
|
||
|
|
inline MapBase(PointerType dataPtr, Index nbRows, Index nbCols)
|
||
|
|
: m_data(dataPtr), m_rows(nbRows), m_cols(nbCols)
|
||
|
|
{
|
||
|
|
eigen_assert( (dataPtr == 0)
|
||
|
|
|| ( nbRows >= 0 && (RowsAtCompileTime == Dynamic || RowsAtCompileTime == nbRows)
|
||
|
|
&& nbCols >= 0 && (ColsAtCompileTime == Dynamic || ColsAtCompileTime == nbCols)));
|
||
|
|
checkSanity();
|
||
|
|
}
|
||
|
|
|
||
|
|
#ifdef EIGEN_MAPBASE_PLUGIN
|
||
|
|
#include EIGEN_MAPBASE_PLUGIN
|
||
|
|
#endif
|
||
|
|
|
||
|
|
protected:
|
||
|
|
|
||
|
|
void checkSanity() const
|
||
|
|
{
|
||
|
|
EIGEN_STATIC_ASSERT(EIGEN_IMPLIES(internal::traits<Derived>::Flags&PacketAccessBit,
|
||
|
|
internal::inner_stride_at_compile_time<Derived>::ret==1),
|
||
|
|
PACKET_ACCESS_REQUIRES_TO_HAVE_INNER_STRIDE_FIXED_TO_1);
|
||
|
|
eigen_assert(EIGEN_IMPLIES(internal::traits<Derived>::Flags&AlignedBit, (size_t(m_data) % 16) == 0)
|
||
|
|
&& "input pointer is not aligned on a 16 byte boundary");
|
||
|
|
}
|
||
|
|
|
||
|
|
PointerType m_data;
|
||
|
|
const internal::variable_if_dynamic<Index, RowsAtCompileTime> m_rows;
|
||
|
|
const internal::variable_if_dynamic<Index, ColsAtCompileTime> m_cols;
|
||
|
|
};
|
||
|
|
|
||
|
|
template<typename Derived> class MapBase<Derived, WriteAccessors>
|
||
|
|
: public MapBase<Derived, ReadOnlyAccessors>
|
||
|
|
{
|
||
|
|
typedef MapBase<Derived, ReadOnlyAccessors> ReadOnlyMapBase;
|
||
|
|
public:
|
||
|
|
|
||
|
|
typedef MapBase<Derived, ReadOnlyAccessors> Base;
|
||
|
|
|
||
|
|
typedef typename Base::Scalar Scalar;
|
||
|
|
typedef typename Base::PacketScalar PacketScalar;
|
||
|
|
typedef typename Base::Index Index;
|
||
|
|
typedef typename Base::PointerType PointerType;
|
||
|
|
|
||
|
|
using Base::derived;
|
||
|
|
using Base::rows;
|
||
|
|
using Base::cols;
|
||
|
|
using Base::size;
|
||
|
|
using Base::coeff;
|
||
|
|
using Base::coeffRef;
|
||
|
|
|
||
|
|
using Base::innerStride;
|
||
|
|
using Base::outerStride;
|
||
|
|
using Base::rowStride;
|
||
|
|
using Base::colStride;
|
||
|
|
|
||
|
|
typedef typename internal::conditional<
|
||
|
|
internal::is_lvalue<Derived>::value,
|
||
|
|
Scalar,
|
||
|
|
const Scalar
|
||
|
|
>::type ScalarWithConstIfNotLvalue;
|
||
|
|
|
||
|
|
inline const Scalar* data() const { return this->m_data; }
|
||
|
|
inline ScalarWithConstIfNotLvalue* data() { return this->m_data; } // no const-cast here so non-const-correct code will give a compile error
|
||
|
|
|
||
|
|
inline ScalarWithConstIfNotLvalue& coeffRef(Index row, Index col)
|
||
|
|
{
|
||
|
|
return this->m_data[col * colStride() + row * rowStride()];
|
||
|
|
}
|
||
|
|
|
||
|
|
inline ScalarWithConstIfNotLvalue& coeffRef(Index index)
|
||
|
|
{
|
||
|
|
EIGEN_STATIC_ASSERT_INDEX_BASED_ACCESS(Derived)
|
||
|
|
return this->m_data[index * innerStride()];
|
||
|
|
}
|
||
|
|
|
||
|
|
template<int StoreMode>
|
||
|
|
inline void writePacket(Index row, Index col, const PacketScalar& val)
|
||
|
|
{
|
||
|
|
internal::pstoret<Scalar, PacketScalar, StoreMode>
|
||
|
|
(this->m_data + (col * colStride() + row * rowStride()), val);
|
||
|
|
}
|
||
|
|
|
||
|
|
template<int StoreMode>
|
||
|
|
inline void writePacket(Index index, const PacketScalar& val)
|
||
|
|
{
|
||
|
|
EIGEN_STATIC_ASSERT_INDEX_BASED_ACCESS(Derived)
|
||
|
|
internal::pstoret<Scalar, PacketScalar, StoreMode>
|
||
|
|
(this->m_data + index * innerStride(), val);
|
||
|
|
}
|
||
|
|
|
||
|
|
explicit inline MapBase(PointerType dataPtr) : Base(dataPtr) {}
|
||
|
|
inline MapBase(PointerType dataPtr, Index vecSize) : Base(dataPtr, vecSize) {}
|
||
|
|
inline MapBase(PointerType dataPtr, Index nbRows, Index nbCols) : Base(dataPtr, nbRows, nbCols) {}
|
||
|
|
|
||
|
|
Derived& operator=(const MapBase& other)
|
||
|
|
{
|
||
|
|
ReadOnlyMapBase::Base::operator=(other);
|
||
|
|
return derived();
|
||
|
|
}
|
||
|
|
|
||
|
|
// In theory we could simply refer to Base:Base::operator=, but MSVC does not like Base::Base,
|
||
|
|
// see bugs 821 and 920.
|
||
|
|
using ReadOnlyMapBase::Base::operator=;
|
||
|
|
};
|
||
|
|
|
||
|
|
#undef EIGEN_STATIC_ASSERT_INDEX_BASED_ACCESS
|
||
|
|
|
||
|
|
} // end namespace Eigen
|
||
|
|
|
||
|
|
#endif // EIGEN_MAPBASE_H
|