Eigen::MatrixWrapper< ExpressionType > Class Template Reference

Expression of an array as a mathematical vector or matrix. More...

#include <ArrayWrapper.h>

Inheritance diagram for Eigen::MatrixWrapper< ExpressionType >:

List of all members.

Public Types
typedef MatrixBase < MatrixWrapper < ExpressionType > >	Base
typedef internal::nested < ExpressionType >::type	NestedExpressionType
typedef internal::conditional < internal::is_lvalue < ExpressionType >::value, Scalar, const Scalar >::type	ScalarWithConstIfNotLvalue
Public Member Functions
CoeffReturnType	coeff (Index row, Index col) const
CoeffReturnType	coeff (Index index) const
Scalar &	coeffRef (Index row, Index col)
const Scalar &	coeffRef (Index row, Index col) const
Scalar &	coeffRef (Index index)
const Scalar &	coeffRef (Index index) const
Index	cols () const
ScalarWithConstIfNotLvalue *	data ()
const Scalar *	data () const
Index	innerStride () const
	MatrixWrapper (ExpressionType &matrix)
const internal::remove_all < NestedExpressionType >::type &	nestedExpression () const
Index	outerStride () const
template<int LoadMode>
const PacketScalar	packet (Index row, Index col) const
template<int LoadMode>
const PacketScalar	packet (Index index) const
void	resize (Index newSize)
void	resize (Index nbRows, Index nbCols)
Index	rows () const
template<int LoadMode>
void	writePacket (Index row, Index col, const PacketScalar &x)
template<int LoadMode>
void	writePacket (Index index, const PacketScalar &x)
Protected Attributes
NestedExpressionType	m_expression

---

Detailed Description

template<typename ExpressionType>
class Eigen::MatrixWrapper< ExpressionType >

Expression of an array as a mathematical vector or matrix.

This class is the return type of ArrayBase::matrix(), and most of the time this is the only way it is use.

See also:

MatrixBase::matrix(), class ArrayWrapper

Definition at line 156 of file ArrayWrapper.h.

---

Member Typedef Documentation

template<typename ExpressionType >

typedef MatrixBase<MatrixWrapper<ExpressionType> > Eigen::MatrixWrapper< ExpressionType >::Base

Reimplemented from Eigen::MatrixBase< MatrixWrapper< ExpressionType > >.

Definition at line 159 of file ArrayWrapper.h.

template<typename ExpressionType >

typedef internal::nested<ExpressionType>::type Eigen::MatrixWrapper< ExpressionType >::NestedExpressionType

Definition at line 169 of file ArrayWrapper.h.

template<typename ExpressionType >

typedef internal::conditional< internal::is_lvalue<ExpressionType>::value, Scalar, const Scalar >::type Eigen::MatrixWrapper< ExpressionType >::ScalarWithConstIfNotLvalue

Definition at line 167 of file ArrayWrapper.h.

---

Constructor & Destructor Documentation

template<typename ExpressionType >

Eigen::MatrixWrapper< ExpressionType >::MatrixWrapper

(

ExpressionType &

matrix

)

[inline]

Definition at line 171 of file ArrayWrapper.h.

---

Member Function Documentation

template<typename ExpressionType >

CoeffReturnType Eigen::MatrixWrapper< ExpressionType >::coeff	(	Index	row,
		Index	col
	)		const [inline]

Definition at line 181 of file ArrayWrapper.h.

template<typename ExpressionType >

CoeffReturnType Eigen::MatrixWrapper< ExpressionType >::coeff

(

Index

index

)

const [inline]

Definition at line 196 of file ArrayWrapper.h.

template<typename ExpressionType >

Scalar& Eigen::MatrixWrapper< ExpressionType >::coeffRef	(	Index	row,
		Index	col
	)		[inline]

Definition at line 186 of file ArrayWrapper.h.

template<typename ExpressionType >

const Scalar& Eigen::MatrixWrapper< ExpressionType >::coeffRef	(	Index	row,
		Index	col
	)		const [inline]

Definition at line 191 of file ArrayWrapper.h.

template<typename ExpressionType >

Scalar& Eigen::MatrixWrapper< ExpressionType >::coeffRef

(

Index

index

)

[inline]

Definition at line 201 of file ArrayWrapper.h.

template<typename ExpressionType >

const Scalar& Eigen::MatrixWrapper< ExpressionType >::coeffRef

(

Index

index

)

const [inline]

Definition at line 206 of file ArrayWrapper.h.

template<typename ExpressionType >

Index Eigen::MatrixWrapper< ExpressionType >::cols

(

)

const [inline]

Definition at line 174 of file ArrayWrapper.h.

template<typename ExpressionType >

ScalarWithConstIfNotLvalue* Eigen::MatrixWrapper< ExpressionType >::data

(

)

[inline]

Definition at line 178 of file ArrayWrapper.h.

template<typename ExpressionType >

const Scalar* Eigen::MatrixWrapper< ExpressionType >::data

(

)

const [inline]

Definition at line 179 of file ArrayWrapper.h.

template<typename ExpressionType >

Index Eigen::MatrixWrapper< ExpressionType >::innerStride

(

)

const [inline]

Definition at line 176 of file ArrayWrapper.h.

template<typename ExpressionType >

const internal::remove_all<NestedExpressionType>::type& Eigen::MatrixWrapper< ExpressionType >::nestedExpression

(

)

const [inline]

Definition at line 236 of file ArrayWrapper.h.

template<typename ExpressionType >

Index Eigen::MatrixWrapper< ExpressionType >::outerStride

(

)

const [inline]

Definition at line 175 of file ArrayWrapper.h.

template<typename ExpressionType >

template<int LoadMode>

const PacketScalar Eigen::MatrixWrapper< ExpressionType >::packet	(	Index	row,
		Index	col
	)		const [inline]

Definition at line 212 of file ArrayWrapper.h.

template<typename ExpressionType >

template<int LoadMode>

const PacketScalar Eigen::MatrixWrapper< ExpressionType >::packet

(

Index

index

)

const [inline]

Definition at line 224 of file ArrayWrapper.h.

template<typename ExpressionType >

void Eigen::MatrixWrapper< ExpressionType >::resize

(

Index

newSize

)

[inline]

Forwards the resizing request to the nested expression

See also:

DenseBase::resize(Index)

Reimplemented from Eigen::DenseBase< MatrixWrapper< ExpressionType > >.

Definition at line 243 of file ArrayWrapper.h.

template<typename ExpressionType >

void Eigen::MatrixWrapper< ExpressionType >::resize	(	Index	nbRows,
		Index	nbCols
	)		[inline]

Forwards the resizing request to the nested expression

See also:

DenseBase::resize(Index,Index)

Reimplemented from Eigen::DenseBase< MatrixWrapper< ExpressionType > >.

Definition at line 246 of file ArrayWrapper.h.

template<typename ExpressionType >

Index Eigen::MatrixWrapper< ExpressionType >::rows

(

)

const [inline]

Definition at line 173 of file ArrayWrapper.h.

template<typename ExpressionType >

template<int LoadMode>

void Eigen::MatrixWrapper< ExpressionType >::writePacket	(	Index	row,
		Index	col,
		const PacketScalar &	x
	)		[inline]

Definition at line 218 of file ArrayWrapper.h.

template<typename ExpressionType >

template<int LoadMode>

void Eigen::MatrixWrapper< ExpressionType >::writePacket	(	Index	index,
		const PacketScalar &	x
	)		[inline]

Definition at line 230 of file ArrayWrapper.h.

---

Member Data Documentation

template<typename ExpressionType >

NestedExpressionType Eigen::MatrixWrapper< ExpressionType >::m_expression [protected]

Definition at line 249 of file ArrayWrapper.h.

---

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

• ArrayWrapper.h