Eigen::MapBase< Derived, ReadOnlyAccessors > Class Template Reference

#include <MapBase.h>

Inheritance diagram for Eigen::MapBase< Derived, ReadOnlyAccessors >:

Public Types
enum	{ RowsAtCompileTime = internal::traits<Derived>::RowsAtCompileTime, ColsAtCompileTime = internal::traits<Derived>::ColsAtCompileTime, SizeAtCompileTime = Base::SizeAtCompileTime }
typedef internal::dense_xpr_base< Derived >::type	Base
typedef Base::CoeffReturnType	CoeffReturnType
typedef internal::traits< Derived >::Index	Index
typedef internal::packet_traits< Scalar >::type	PacketScalar
typedef internal::conditional< bool(internal::is_lvalue< Derived >::value), Scalar *, const Scalar * >::type	PointerType
typedef NumTraits< Scalar >::Real	RealScalar
typedef internal::traits< Derived >::Scalar	Scalar
typedef internal::traits< Derived >::StorageKind	StorageKind

Public Member Functions
const Scalar &	coeff (Index rowId, Index colId) const
const Scalar &	coeff (Index index) const
const Scalar &	coeffRef (Index rowId, Index colId) const
const Scalar &	coeffRef (Index index) const
Index	cols () const
const Scalar *	data () const
	MapBase (PointerType dataPtr)
	MapBase (PointerType dataPtr, Index vecSize)
	MapBase (PointerType dataPtr, Index nbRows, Index nbCols)
template<int LoadMode>
PacketScalar	packet (Index rowId, Index colId) const
template<int LoadMode>
PacketScalar	packet (Index index) const
Index	rows () const

Protected Member Functions
void	checkSanity () const

Protected Attributes
const internal::variable_if_dynamic< Index, ColsAtCompileTime >	m_cols
PointerType	m_data
const internal::variable_if_dynamic< Index, RowsAtCompileTime >	m_rows

Detailed Description

template<typename Derived>
class Eigen::MapBase< Derived, ReadOnlyAccessors >

Definition at line 27 of file MapBase.h.

Member Typedef Documentation

template<typename Derived >

typedef internal::dense_xpr_base<Derived>::type Eigen::MapBase< Derived, ReadOnlyAccessors >::Base

Definition at line 32 of file MapBase.h.

template<typename Derived >

typedef Base::CoeffReturnType Eigen::MapBase< Derived, ReadOnlyAccessors >::CoeffReturnType

Definition at line 77 of file MapBase.h.

template<typename Derived >

typedef internal::traits<Derived>::Index Eigen::MapBase< Derived, ReadOnlyAccessors >::Index

Definition at line 40 of file MapBase.h.

template<typename Derived >

typedef internal::packet_traits<Scalar>::type Eigen::MapBase< Derived, ReadOnlyAccessors >::PacketScalar

Definition at line 42 of file MapBase.h.

template<typename Derived >

typedef internal::conditional< bool(internal::is_lvalue<Derived>::value), Scalar *, const Scalar *>::type Eigen::MapBase< Derived, ReadOnlyAccessors >::PointerType

Definition at line 48 of file MapBase.h.

template<typename Derived >

typedef NumTraits<Scalar>::Real Eigen::MapBase< Derived, ReadOnlyAccessors >::RealScalar

Definition at line 43 of file MapBase.h.

template<typename Derived >

typedef internal::traits<Derived>::Scalar Eigen::MapBase< Derived, ReadOnlyAccessors >::Scalar

Definition at line 41 of file MapBase.h.

template<typename Derived >

typedef internal::traits<Derived>::StorageKind Eigen::MapBase< Derived, ReadOnlyAccessors >::StorageKind

Definition at line 39 of file MapBase.h.

Member Enumeration Documentation

template<typename Derived >

anonymous enum

Enumerator
RowsAtCompileTime
ColsAtCompileTime
SizeAtCompileTime

Definition at line 33 of file MapBase.h.

Constructor & Destructor Documentation

template<typename Derived >

Eigen::MapBase< Derived, ReadOnlyAccessors >::MapBase ( PointerType  dataPtr )

inline

Definition at line 126 of file MapBase.h.

template<typename Derived >

Eigen::MapBase< Derived, ReadOnlyAccessors >::MapBase ( PointerType  dataPtr, Index  vecSize  )

inline

Definition at line 132 of file MapBase.h.

template<typename Derived >

Eigen::MapBase< Derived, ReadOnlyAccessors >::MapBase ( PointerType  dataPtr, Index  nbRows, Index  nbCols  )

inline

Definition at line 143 of file MapBase.h.

Member Function Documentation

template<typename Derived >

void Eigen::MapBase< Derived, ReadOnlyAccessors >::checkSanity ( ) const

inlineprotected

Definition at line 154 of file MapBase.h.

template<typename Derived >

const Scalar& Eigen::MapBase< Derived, ReadOnlyAccessors >::coeff ( Index  rowId, Index  colId  ) const

inline

Definition at line 90 of file MapBase.h.

template<typename Derived >

const Scalar& Eigen::MapBase< Derived, ReadOnlyAccessors >::coeff ( Index  index ) const

inline

Definition at line 95 of file MapBase.h.

template<typename Derived >

const Scalar& Eigen::MapBase< Derived, ReadOnlyAccessors >::coeffRef ( Index  rowId, Index  colId  ) const

inline

Definition at line 101 of file MapBase.h.

template<typename Derived >

const Scalar& Eigen::MapBase< Derived, ReadOnlyAccessors >::coeffRef ( Index  index ) const

inline

Definition at line 106 of file MapBase.h.

template<typename Derived >

Index Eigen::MapBase< Derived, ReadOnlyAccessors >::cols ( void  ) const

inline

Definition at line 80 of file MapBase.h.

template<typename Derived >

const Scalar* Eigen::MapBase< Derived, ReadOnlyAccessors >::data ( ) const

inline

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().

See also

innerStride(), outerStride()

Definition at line 88 of file MapBase.h.

template<typename Derived >

template<int LoadMode>

PacketScalar Eigen::MapBase< Derived, ReadOnlyAccessors >::packet ( Index  rowId, Index  colId  ) const

inline

Definition at line 113 of file MapBase.h.

template<typename Derived >

template<int LoadMode>

PacketScalar Eigen::MapBase< Derived, ReadOnlyAccessors >::packet ( Index  index ) const

inline

Definition at line 120 of file MapBase.h.

template<typename Derived >

Index Eigen::MapBase< Derived, ReadOnlyAccessors >::rows ( void  ) const

inline

Definition at line 79 of file MapBase.h.

Member Data Documentation

template<typename Derived >

const internal::variable_if_dynamic<Index, ColsAtCompileTime> Eigen::MapBase< Derived, ReadOnlyAccessors >::m_cols

protected

Definition at line 165 of file MapBase.h.

template<typename Derived >

PointerType Eigen::MapBase< Derived, ReadOnlyAccessors >::m_data

protected

Definition at line 163 of file MapBase.h.

template<typename Derived >

const internal::variable_if_dynamic<Index, RowsAtCompileTime> Eigen::MapBase< Derived, ReadOnlyAccessors >::m_rows

protected

Definition at line 164 of file MapBase.h.

---

The documentation for this class was generated from the following file:

• MapBase.h