Map< MatrixType, PacketAccess > Class Template Reference

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

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 Eigen::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()

Member Function Documentation

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


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

Generated by  doxygen 1.6.2