diff options
Diffstat (limited to 'extern/Eigen2/Eigen/src/Core/MapBase.h')
| -rw-r--r-- | extern/Eigen2/Eigen/src/Core/MapBase.h | 202 |
1 files changed, 202 insertions, 0 deletions
diff --git a/extern/Eigen2/Eigen/src/Core/MapBase.h b/extern/Eigen2/Eigen/src/Core/MapBase.h new file mode 100644 index 00000000000..c923bc34034 --- /dev/null +++ b/extern/Eigen2/Eigen/src/Core/MapBase.h @@ -0,0 +1,202 @@ +// This file is part of Eigen, a lightweight C++ template library +// for linear algebra. Eigen itself is part of the KDE project. +// +// Copyright (C) 2006-2008 Benoit Jacob <jacob.benoit.1@gmail.com> +// Copyright (C) 2008 Gael Guennebaud <g.gael@free.fr> +// +// Eigen is free software; you can redistribute it and/or +// modify it under the terms of the GNU Lesser General Public +// License as published by the Free Software Foundation; either +// version 3 of the License, or (at your option) any later version. +// +// Alternatively, you can redistribute it and/or +// modify it under the terms of the GNU General Public License as +// published by the Free Software Foundation; either version 2 of +// the License, or (at your option) any later version. +// +// Eigen is distributed in the hope that it will be useful, but WITHOUT ANY +// WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS +// FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License or the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU Lesser General Public +// License and a copy of the GNU General Public License along with +// Eigen. If not, see <http://www.gnu.org/licenses/>. + +#ifndef EIGEN_MAPBASE_H +#define EIGEN_MAPBASE_H + +/** \class MapBase + * + * \brief Base class for Map and Block expression with direct access + * + * Expression classes inheriting MapBase must define the constant \c PacketAccess, + * and type \c AlignedDerivedType in their respective ei_traits<> specialization structure. + * The value of \c PacketAccess can be either: + * - \b ForceAligned which enforces both aligned loads and stores + * - \b AsRequested which is the default behavior + * The type \c AlignedDerivedType should correspond to the equivalent expression type + * with \c PacketAccess being \c ForceAligned. + * + * \sa class Map, class Block + */ +template<typename Derived> class MapBase + : public MatrixBase<Derived> +{ + public: + + typedef MatrixBase<Derived> Base; + enum { + IsRowMajor = (int(ei_traits<Derived>::Flags) & RowMajorBit) ? 1 : 0, + PacketAccess = ei_traits<Derived>::PacketAccess, + RowsAtCompileTime = ei_traits<Derived>::RowsAtCompileTime, + ColsAtCompileTime = ei_traits<Derived>::ColsAtCompileTime, + SizeAtCompileTime = Base::SizeAtCompileTime + }; + + typedef typename ei_traits<Derived>::AlignedDerivedType AlignedDerivedType; + typedef typename ei_traits<Derived>::Scalar Scalar; + typedef typename Base::PacketScalar PacketScalar; + using Base::derived; + + inline int rows() const { return m_rows.value(); } + inline int cols() const { return m_cols.value(); } + + inline int stride() const { return derived().stride(); } + inline const Scalar* data() const { return m_data; } + + template<bool IsForceAligned,typename Dummy> struct force_aligned_impl { + AlignedDerivedType static run(MapBase& a) { return a.derived(); } + }; + + template<typename Dummy> struct force_aligned_impl<false,Dummy> { + AlignedDerivedType static run(MapBase& a) { return a.derived()._convertToForceAligned(); } + }; + + /** \returns an expression equivalent to \c *this but having the \c PacketAccess constant + * set to \c ForceAligned. Must be reimplemented by the derived class. */ + AlignedDerivedType forceAligned() + { + return force_aligned_impl<int(PacketAccess)==int(ForceAligned),Derived>::run(*this); + } + + inline const Scalar& coeff(int row, int col) const + { + if(IsRowMajor) + return m_data[col + row * stride()]; + else // column-major + return m_data[row + col * stride()]; + } + + inline Scalar& coeffRef(int row, int col) + { + if(IsRowMajor) + return const_cast<Scalar*>(m_data)[col + row * stride()]; + else // column-major + return const_cast<Scalar*>(m_data)[row + col * stride()]; + } + + inline const Scalar coeff(int index) const + { + ei_assert(Derived::IsVectorAtCompileTime || (ei_traits<Derived>::Flags & LinearAccessBit)); + if ( ((RowsAtCompileTime == 1) == IsRowMajor) ) + return m_data[index]; + else + return m_data[index*stride()]; + } + + inline Scalar& coeffRef(int index) + { + ei_assert(Derived::IsVectorAtCompileTime || (ei_traits<Derived>::Flags & LinearAccessBit)); + if ( ((RowsAtCompileTime == 1) == IsRowMajor) ) + return const_cast<Scalar*>(m_data)[index]; + else + return const_cast<Scalar*>(m_data)[index*stride()]; + } + + template<int LoadMode> + inline PacketScalar packet(int row, int col) const + { + return ei_ploadt<Scalar, int(PacketAccess) == ForceAligned ? Aligned : LoadMode> + (m_data + (IsRowMajor ? col + row * stride() + : row + col * stride())); + } + + template<int LoadMode> + inline PacketScalar packet(int index) const + { + return ei_ploadt<Scalar, int(PacketAccess) == ForceAligned ? Aligned : LoadMode>(m_data + index); + } + + template<int StoreMode> + inline void writePacket(int row, int col, const PacketScalar& x) + { + ei_pstoret<Scalar, PacketScalar, int(PacketAccess) == ForceAligned ? Aligned : StoreMode> + (const_cast<Scalar*>(m_data) + (IsRowMajor ? col + row * stride() + : row + col * stride()), x); + } + + template<int StoreMode> + inline void writePacket(int index, const PacketScalar& x) + { + ei_pstoret<Scalar, PacketScalar, int(PacketAccess) == ForceAligned ? Aligned : StoreMode> + (const_cast<Scalar*>(m_data) + index, x); + } + + inline MapBase(const Scalar* data) : m_data(data), m_rows(RowsAtCompileTime), m_cols(ColsAtCompileTime) + { + EIGEN_STATIC_ASSERT_FIXED_SIZE(Derived) + } + + inline MapBase(const Scalar* data, int size) + : m_data(data), + m_rows(RowsAtCompileTime == Dynamic ? size : RowsAtCompileTime), + m_cols(ColsAtCompileTime == Dynamic ? size : ColsAtCompileTime) + { + EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived) + ei_assert(size > 0 || data == 0); + ei_assert(SizeAtCompileTime == Dynamic || SizeAtCompileTime == size); + } + + inline MapBase(const Scalar* data, int rows, int cols) + : m_data(data), m_rows(rows), m_cols(cols) + { + ei_assert( (data == 0) + || ( rows > 0 && (RowsAtCompileTime == Dynamic || RowsAtCompileTime == rows) + && cols > 0 && (ColsAtCompileTime == Dynamic || ColsAtCompileTime == cols))); + } + + Derived& operator=(const MapBase& other) + { + return Base::operator=(other); + } + + template<typename OtherDerived> + Derived& operator=(const MatrixBase<OtherDerived>& other) + { + return Base::operator=(other); + } + + using Base::operator*=; + + template<typename OtherDerived> + Derived& operator+=(const MatrixBase<OtherDerived>& other) + { return derived() = forceAligned() + other; } + + template<typename OtherDerived> + Derived& operator-=(const MatrixBase<OtherDerived>& other) + { return derived() = forceAligned() - other; } + + Derived& operator*=(const Scalar& other) + { return derived() = forceAligned() * other; } + + Derived& operator/=(const Scalar& other) + { return derived() = forceAligned() / other; } + + protected: + const Scalar* EIGEN_RESTRICT m_data; + const ei_int_if_dynamic<RowsAtCompileTime> m_rows; + const ei_int_if_dynamic<ColsAtCompileTime> m_cols; +}; + +#endif // EIGEN_MAPBASE_H |