Map< MatrixType, PacketAccess > Class Template Reference

A matrix or vector expression mapping an existing array of data. More...

#include <Map.h>

Inheritance diagram for Map< MatrixType, PacketAccess >:

[legend]

List of all members.

Public Types
typedef ei_traits< Map > ::AlignedDerivedType	AlignedDerivedType
Public Member Functions
AlignedDerivedType	_convertToForceAligned ()
	Map (const Scalar *data, int rows, int cols)
	Map (const Scalar *data, int size)
	Map (const Scalar *data)
void	resize (int size)
void	resize (int rows, int cols)
int	stride () const

---

Detailed Description

template<typename MatrixType, int PacketAccess>
class Map< MatrixType, PacketAccess >

A matrix or vector expression mapping an existing array of data.

Parameters:

	MatrixType	the equivalent matrix type of the mapped data
	_PacketAccess	allows to enforce aligned loads and stores if set to ForceAligned. The default is AsRequested. This parameter is internaly used by Eigen in expressions such as Map<...>(...) += other; and most of the time this is the only way it is used.

This class represents a matrix or vector expression mapping an existing array of data. It can be used to let Eigen interface without any overhead with non-Eigen data structures, such as plain C arrays or structures from other libraries.

This class is the return type of Matrix::Map() but can also be used directly.

See also:

Matrix::Map()

Definition at line 59 of file Map.h.

---

Member Typedef Documentation

template<typename MatrixType, int PacketAccess>

typedef ei_traits<Map>::AlignedDerivedType Map< MatrixType, PacketAccess >::AlignedDerivedType

Reimplemented from MapBase< Map< MatrixType, PacketAccess > >.

Definition at line 65 of file Map.h.

---

Constructor & Destructor Documentation

template<typename MatrixType, int PacketAccess>

Map< MatrixType, PacketAccess >::Map

(

const Scalar *

data

)

[inline]

Definition at line 74 of file Map.h.

template<typename MatrixType, int PacketAccess>

Map< MatrixType, PacketAccess >::Map	(	const Scalar *	data,
		int	size
	)			[inline]

Definition at line 76 of file Map.h.

template<typename MatrixType, int PacketAccess>

Map< MatrixType, PacketAccess >::Map	(	const Scalar *	data,
		int	rows,
		int	cols
	)			[inline]

Definition at line 78 of file Map.h.

---

Member Function Documentation

template<typename MatrixType, int PacketAccess>

AlignedDerivedType Map< MatrixType, PacketAccess >::_convertToForceAligned

(

)

[inline]

Definition at line 69 of file Map.h.

template<typename MatrixType, int PacketAccess>

void Map< MatrixType, PacketAccess >::resize

(

int

size

)

[inline]

Definition at line 88 of file Map.h.

template<typename MatrixType, int PacketAccess>

void Map< MatrixType, PacketAccess >::resize	(	int	rows,
		int	cols
	)			[inline]

Definition at line 80 of file Map.h.

template<typename MatrixType, int PacketAccess>

int Map< MatrixType, PacketAccess >::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 MapBase< Map< MatrixType, PacketAccess > >.

Definition at line 67 of file Map.h.

---

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

• Map.h