Public Types | Public Member Functions
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 Types inherited from MapBase< Map< MatrixType, PacketAccess > >
enum  
typedef MatrixBase< Map
< MatrixType, PacketAccess > > 
Base
typedef Base::PacketScalar PacketScalar
typedef ei_traits< Map
< MatrixType, PacketAccess >
>::Scalar 
Scalar
- Public Types inherited from MatrixBase< Map< MatrixType, PacketAccess > >
enum  

Public Member Functions

AlignedDerivedType _convertToForceAligned ()
 Map (const Scalar *data)
 Map (const Scalar *data, int size)
 Map (const Scalar *data, int rows, int cols)
void resize (int rows, int cols)
void resize (int size)
int stride () const
- Public Member Functions inherited from MapBase< Map< MatrixType, PacketAccess > >
const Scalar & coeff (int row, int col) const
const Scalar coeff (int index) const
Scalar & coeffRef (int row, int col)
Scalar & coeffRef (int index)
int cols () const
const Scalar * data () const
AlignedDerivedType forceAligned ()
 MapBase (const Scalar *data)
 MapBase (const Scalar *data, int size)
 MapBase (const Scalar *data, int rows, int cols)
Map< MatrixType, PacketAccess > & operator*= (const Scalar &other)
Map< MatrixType, PacketAccess > & operator+= (const MatrixBase< OtherDerived > &other)
Map< MatrixType, PacketAccess > & operator-= (const MatrixBase< OtherDerived > &other)
Map< MatrixType, PacketAccess > & operator/= (const Scalar &other)
Map< MatrixType, PacketAccess > & operator= (const MapBase &other)
Map< MatrixType, PacketAccess > & operator= (const MatrixBase< OtherDerived > &other)
PacketScalar packet (int row, int col) const
PacketScalar packet (int index) const
int rows () const
void writePacket (int row, int col, const PacketScalar &x)
void writePacket (int index, const PacketScalar &x)
- Public Member Functions inherited from MatrixBase< Map< MatrixType, PacketAccess > >
const AdjointReturnType adjoint () const
bool all (void) const
bool any (void) const
const DiagonalMatrix< Map
< MatrixType, PacketAccess > > 
asDiagonal () const
const CwiseBinaryOp
< CustomBinaryOp, Map
< MatrixType, PacketAccess >
, OtherDerived > 
binaryExpr (const MatrixBase< OtherDerived > &other, const CustomBinaryOp &func=CustomBinaryOp()) const
BlockReturnType< Map
< MatrixType, PacketAccess >
>::Type 
block (int startRow, int startCol, int blockRows, int blockCols)
const BlockReturnType< Map
< MatrixType, PacketAccess >
>::Type 
block (int startRow, int startCol, int blockRows, int blockCols) const
BlockReturnType< Map
< MatrixType, PacketAccess >
, BlockRows, BlockCols >::Type 
block (int startRow, int startCol)
const BlockReturnType< Map
< MatrixType, PacketAccess >
, BlockRows, BlockCols >::Type 
block (int startRow, int startCol) const
const CwiseUnaryOp
< ei_scalar_cast_op< typename
ei_traits< Map< MatrixType,
PacketAccess > >::Scalar,
NewType >, Map< MatrixType,
PacketAccess > > 
cast () const
ColXpr col (int i)
const ColXpr col (int i) const
const PartialRedux< Map
< MatrixType, PacketAccess >
, Vertical > 
colwise () const
void computeInverse (MatrixBase< ResultType > *result) const
ConjugateReturnType conjugate () const
BlockReturnType< Map
< MatrixType, PacketAccess >
>::Type 
corner (CornerType type, int cRows, int cCols)
const BlockReturnType< Map
< MatrixType, PacketAccess >
>::Type 
corner (CornerType type, int cRows, int cCols) const
BlockReturnType< Map
< MatrixType, PacketAccess >
, CRows, CCols >::Type 
corner (CornerType type)
const BlockReturnType< Map
< MatrixType, PacketAccess >
, CRows, CCols >::Type 
corner (CornerType type) const
int count () const
PlainMatrixType cross (const MatrixBase< OtherDerived > &other) const
const Cwise< Map< MatrixType,
PacketAccess > > 
cwise () const
Cwise< Map< MatrixType,
PacketAccess > > 
cwise ()
Scalar determinant () const
DiagonalCoeffs< Map
< MatrixType, PacketAccess > > 
diagonal ()
const DiagonalCoeffs< Map
< MatrixType, PacketAccess > > 
diagonal () const
Scalar dot (const MatrixBase< OtherDerived > &other) const
EigenvaluesReturnType eigenvalues () const
BlockReturnType< Map
< MatrixType, PacketAccess >
, Dynamic >::SubVectorType 
end (int size)
const BlockReturnType< Map
< MatrixType, PacketAccess >
, Dynamic >::SubVectorType 
end (int size) const
BlockReturnType< Map
< MatrixType, PacketAccess >
, Size >::SubVectorType 
end ()
const BlockReturnType< Map
< MatrixType, PacketAccess >
, Size >::SubVectorType 
end () const
Matrix< Scalar, 3, 1 > eulerAngles (int a0, int a1, int a2) const
const ei_eval< Map< MatrixType,
PacketAccess > >::type 
eval () const
void fill (const Scalar &value)
const WithFormat< Map
< MatrixType, PacketAccess > > 
format (const IOFormat &fmt) const
const ImagReturnType imag () const
int innerSize () const
const PlainMatrixType inverse () const
bool isApprox (const MatrixBase< OtherDerived > &other, RealScalar prec=precision< Scalar >()) const
bool isApproxToConstant (const Scalar &value, RealScalar prec=precision< Scalar >()) const
bool isConstant (const Scalar &value, RealScalar prec=precision< Scalar >()) const
bool isDiagonal (RealScalar prec=precision< Scalar >()) const
bool isIdentity (RealScalar prec=precision< Scalar >()) const
bool isLowerTriangular (RealScalar prec=precision< Scalar >()) const
bool isMuchSmallerThan (const RealScalar &other, RealScalar prec=precision< Scalar >()) const
bool isMuchSmallerThan (const MatrixBase< OtherDerived > &other, RealScalar prec=precision< Scalar >()) const
bool isOnes (RealScalar prec=precision< Scalar >()) const
bool isOrthogonal (const MatrixBase< OtherDerived > &other, RealScalar prec=precision< Scalar >()) const
bool isUnitary (RealScalar prec=precision< Scalar >()) const
bool isUpperTriangular (RealScalar prec=precision< Scalar >()) const
bool isVector () const
bool isZero (RealScalar prec=precision< Scalar >()) const
const Flagged< Map< MatrixType,
PacketAccess >
, 0, EvalBeforeNestingBit|EvalBeforeAssigningBit > 
lazy () const
Map< MatrixType, PacketAccess > & lazyAssign (const SparseProduct< Derived1, Derived2, SparseTimeDenseProduct > &product)
Map< MatrixType, PacketAccess > & lazyAssign (const SparseProduct< Derived1, Derived2, DenseTimeSparseProduct > &product)
const LDLT< PlainMatrixType > ldlt () const
const LLT< PlainMatrixType > llt () const
RealScalar lpNorm () const
const LU< PlainMatrixType > lu () const
const Flagged< Map< MatrixType,
PacketAccess >, Added, 0 > 
marked () const
ei_traits< Map< MatrixType,
PacketAccess > >::Scalar 
maxCoeff () const
ei_traits< Map< MatrixType,
PacketAccess > >::Scalar 
maxCoeff (int *row, int *col) const
ei_traits< Map< MatrixType,
PacketAccess > >::Scalar 
maxCoeff (int *index) const
ei_traits< Map< MatrixType,
PacketAccess > >::Scalar 
minCoeff () const
ei_traits< Map< MatrixType,
PacketAccess > >::Scalar 
minCoeff (int *row, int *col) const
ei_traits< Map< MatrixType,
PacketAccess > >::Scalar 
minCoeff (int *index) const
Minor< Map< MatrixType,
PacketAccess > > 
minor (int row, int col)
const Minor< Map< MatrixType,
PacketAccess > > 
minor (int row, int col) const
const NestByValue< Map
< MatrixType, PacketAccess > > 
nestByValue () const
int nonZeros () const
RealScalar norm () const
void normalize ()
const PlainMatrixType normalized () const
bool operator!= (const MatrixBase< OtherDerived > &other) const
const Scalar operator() (int row, int col) const
Scalar & operator() (int row, int col)
const Scalar operator() (int index) const
Scalar & operator() (int index)
const ScalarMultipleReturnType operator* (const Scalar &scalar) const
const ProductReturnType< Map
< MatrixType, PacketAccess >
, OtherDerived >::Type 
operator* (const MatrixBase< OtherDerived > &other) const
Map< MatrixType, PacketAccess > & operator*= (const Scalar &other)
Map< MatrixType, PacketAccess > & operator*= (const MatrixBase< OtherDerived > &other)
const CwiseBinaryOp
< ei_scalar_sum_op< typename
ei_traits< Map< MatrixType,
PacketAccess > >::Scalar >
, Map< MatrixType,
PacketAccess >, OtherDerived > 
operator+ (const MatrixBase< OtherDerived > &other) const
Map< MatrixType, PacketAccess > & operator+= (const Flagged< Product< Lhs, Rhs, CacheFriendlyProduct >, 0, EvalBeforeNestingBit|EvalBeforeAssigningBit > &other)
const CwiseUnaryOp
< ei_scalar_opposite_op
< typename ei_traits< Map
< MatrixType, PacketAccess >
>::Scalar >, Map< MatrixType,
PacketAccess > > 
operator- () const
const CwiseBinaryOp
< ei_scalar_difference_op
< typename ei_traits< Map
< MatrixType, PacketAccess >
>::Scalar >, Map< MatrixType,
PacketAccess >, OtherDerived > 
operator- (const MatrixBase< OtherDerived > &other) const
const CwiseUnaryOp
< ei_scalar_quotient1_op
< typename ei_traits< Map
< MatrixType, PacketAccess >
>::Scalar >, Map< MatrixType,
PacketAccess > > 
operator/ (const Scalar &scalar) const
Map< MatrixType, PacketAccess > & operator/= (const Scalar &other)
CommaInitializer< Map
< MatrixType, PacketAccess > > 
operator<< (const Scalar &s)
CommaInitializer< Map
< MatrixType, PacketAccess > > 
operator<< (const MatrixBase< OtherDerived > &other)
Map< MatrixType, PacketAccess > & operator= (const MatrixBase &other)
bool operator== (const MatrixBase< OtherDerived > &other) const
const Scalar operator[] (int index) const
Scalar & operator[] (int index)
RealScalar operatorNorm () const
int outerSize () const
Part< Map< MatrixType,
PacketAccess >, Mode > 
part ()
const Part< Map< MatrixType,
PacketAccess >, Mode > 
part () const
const QR< PlainMatrixType > qr () const
const RealReturnType real () const
ei_result_of< BinaryOp(typename
ei_traits< Map< MatrixType,
PacketAccess > >::Scalar)>
::type 
redux (const BinaryOp &func) const
RowXpr row (int i)
const RowXpr row (int i) const
const PartialRedux< Map
< MatrixType, PacketAccess >
, Horizontal > 
rowwise () const
BlockReturnType< Map
< MatrixType, PacketAccess >
>::SubVectorType 
segment (int start, int size)
const BlockReturnType< Map
< MatrixType, PacketAccess >
>::SubVectorType 
segment (int start, int size) const
BlockReturnType< Map
< MatrixType, PacketAccess >
, Size >::SubVectorType 
segment (int start)
const BlockReturnType< Map
< MatrixType, PacketAccess >
, Size >::SubVectorType 
segment (int start) const
const Select< Map< MatrixType,
PacketAccess >, ThenDerived,
ElseDerived > 
select (const MatrixBase< ThenDerived > &thenMatrix, const MatrixBase< ElseDerived > &elseMatrix) const
const Select< Map< MatrixType,
PacketAccess >, ThenDerived,
NestByValue< typename
ThenDerived::ConstantReturnType > > 
select (const MatrixBase< ThenDerived > &thenMatrix, typename ThenDerived::Scalar elseScalar) const
const Select< Map< MatrixType,
PacketAccess >, NestByValue
< typename
ElseDerived::ConstantReturnType >
, ElseDerived > 
select (typename ElseDerived::Scalar thenScalar, const MatrixBase< ElseDerived > &elseMatrix) const
Map< MatrixType, PacketAccess > & setConstant (const Scalar &value)
Map< MatrixType, PacketAccess > & setIdentity ()
Map< MatrixType, PacketAccess > & setOnes ()
Map< MatrixType, PacketAccess > & setRandom ()
Map< MatrixType, PacketAccess > & setZero ()
int size () const
ei_plain_matrix_type_column_major
< OtherDerived >::type 
solveTriangular (const MatrixBase< OtherDerived > &other) const
void solveTriangularInPlace (const MatrixBase< OtherDerived > &other) const
RealScalar squaredNorm () const
BlockReturnType< Map
< MatrixType, PacketAccess >
, Dynamic >::SubVectorType 
start (int size)
const BlockReturnType< Map
< MatrixType, PacketAccess >
, Dynamic >::SubVectorType 
start (int size) const
BlockReturnType< Map
< MatrixType, PacketAccess >
, Size >::SubVectorType 
start (void)
const BlockReturnType< Map
< MatrixType, PacketAccess >
, Size >::SubVectorType 
start () const
Scalar sum () const
SVD< PlainMatrixType > svd () const
void swap (const MatrixBase< OtherDerived > &other)
Scalar trace () const
Eigen::Transpose< Map
< MatrixType, PacketAccess > > 
transpose ()
const Eigen::Transpose< Map
< MatrixType, PacketAccess > > 
transpose () const
void transposeInPlace ()
const CwiseUnaryOp
< CustomUnaryOp, Map
< MatrixType, PacketAccess > > 
unaryExpr (const CustomUnaryOp &func=CustomUnaryOp()) const
PlainMatrixType unitOrthogonal (void) const
void visit (Visitor &func) const
const Scalar w () const
Scalar & w ()
void writePacket (int row, int col, const PacketScalar &x)
void writePacket (int index, const PacketScalar &x)
const Scalar x () const
Scalar & x ()
const Scalar y () const
Scalar & y ()
const Scalar z () const
Scalar & z ()

Additional Inherited Members

- Protected Attributes inherited from MapBase< Map< MatrixType, PacketAccess > >
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 MatrixType, int PacketAccess>
class Eigen::Map< MatrixType, PacketAccess >

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

Parameters:
MatrixTypethe equivalent matrix type of the mapped data
_PacketAccessallows 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: