MapBase< Derived > Class Template Reference

Base class for Map and Block expression with direct access. More...

List of all members.

Public Types
enum	{   IsRowMajor,   PacketAccess,   RowsAtCompileTime,   ColsAtCompileTime,   SizeAtCompileTime }
typedef ei_traits< Derived > ::AlignedDerivedType	AlignedDerivedType
typedef MatrixBase< Derived >	Base
typedef Base::PacketScalar	PacketScalar
typedef ei_traits< Derived > ::Scalar	Scalar
Public Member Functions
const Scalar	coeff (int index) const
const Scalar &	coeff (int row, int col) const
Scalar &	coeffRef (int index)
Scalar &	coeffRef (int row, int col)
int	cols () const
const Scalar *	data () const
AlignedDerivedType	forceAligned ()
	MapBase (const Scalar *data, int rows, int cols)
	MapBase (const Scalar *data, int size)
	MapBase (const Scalar *data)
Derived &	operator*= (const Scalar &other)
template<typename OtherDerived >
Derived &	operator+= (const MatrixBase< OtherDerived > &other)
template<typename OtherDerived >
Derived &	operator-= (const MatrixBase< OtherDerived > &other)
Derived &	operator/= (const Scalar &other)
template<typename OtherDerived >
Derived &	operator= (const MatrixBase< OtherDerived > &other)
Derived &	operator= (const MapBase &other)
template<int LoadMode>
PacketScalar	packet (int index) const
template<int LoadMode>
PacketScalar	packet (int row, int col) const
int	rows () const
int	stride () const
template<int StoreMode>
void	writePacket (int index, const PacketScalar &x)
template<int StoreMode>
void	writePacket (int row, int col, const PacketScalar &x)
Protected Attributes
const ei_int_if_dynamic < ColsAtCompileTime >	m_cols
const Scalar *EIGEN_RESTRICT	m_data
const ei_int_if_dynamic < RowsAtCompileTime >	m_rows

---

Detailed Description

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

Base class for Map and Block expression with direct access.

Expression classes inheriting MapBase must define the constant PacketAccess, and type AlignedDerivedType in their respective ei_traits<> specialization structure. The value of PacketAccess can be either:

• ForceAligned which enforces both aligned loads and stores
• AsRequested which is the default behavior The type AlignedDerivedType should correspond to the equivalent expression type with PacketAccess being ForceAligned.

See also:

class Map, class Block

---

Member Function Documentation

int cols

(

void

)

const [inline]

Returns:

the number of columns.

See also:

rows(), ColsAtCompileTime

Reimplemented from MatrixBase< Derived >.

AlignedDerivedType forceAligned

(

)

[inline]

Returns:

an expression equivalent to *this but having the PacketAccess constant set to ForceAligned. Must be reimplemented by the derived class.

Derived& operator=

(

const MatrixBase< OtherDerived > &

other

)

[inline]

Copies other into *this.

Returns:

a reference to *this.

Reimplemented from MatrixBase< Derived >.

int rows

(

void

)

const [inline]

Returns:

the number of rows.

See also:

cols(), RowsAtCompileTime

Reimplemented from MatrixBase< Derived >.

int stride

(

void

)

const [inline]

Returns:

number of elements to skip to pass from one row (resp. column) to another for a row-major (resp. column-major) matrix. Combined with coeffRef() and the flags flags, it allows a direct access to the data of the underlying matrix.

Reimplemented from MatrixBase< Derived >.

Reimplemented in Map< MatrixType, PacketAccess >.

---

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

• Core