Eigen::ArrayWrapper< ExpressionType > Class Template Reference

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

#include <ArrayWrapper.h>

Inheritance diagram for Eigen::ArrayWrapper< ExpressionType >:

List of all members.

Public Types
typedef ArrayBase< ArrayWrapper >	Base
typedef internal::nested < ExpressionType >::type	NestedExpressionType
typedef internal::conditional < internal::is_lvalue < ExpressionType >::value, Scalar, const Scalar >::type	ScalarWithConstIfNotLvalue
Public Member Functions
	ArrayWrapper (ExpressionType &matrix)
CoeffReturnType	coeff (Index rowId, Index colId) const
CoeffReturnType	coeff (Index index) const
Scalar &	coeffRef (Index rowId, Index colId)
const Scalar &	coeffRef (Index rowId, Index colId) const
Scalar &	coeffRef (Index index)
const Scalar &	coeffRef (Index index) const
Index	cols () const
ScalarWithConstIfNotLvalue *	data ()
const Scalar *	data () const
template<typename Dest >
void	evalTo (Dest &dst) const
Index	innerStride () const
const internal::remove_all < NestedExpressionType >::type &	nestedExpression () const
Index	outerStride () const
template<int LoadMode>
const PacketScalar	packet (Index rowId, Index colId) 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 rowId, Index colId, const PacketScalar &val)
template<int LoadMode>
void	writePacket (Index index, const PacketScalar &val)
Protected Attributes
NestedExpressionType	m_expression

---

Detailed Description

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

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

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

See also:

MatrixBase::array(), class MatrixWrapper

Definition at line 36 of file ArrayWrapper.h.

---

Member Typedef Documentation

template<typename ExpressionType >

typedef ArrayBase<ArrayWrapper> Eigen::ArrayWrapper< ExpressionType >::Base

Reimplemented from Eigen::ArrayBase< ArrayWrapper< ExpressionType > >.

Definition at line 39 of file ArrayWrapper.h.

template<typename ExpressionType >

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

Definition at line 49 of file ArrayWrapper.h.

template<typename ExpressionType >

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

Definition at line 47 of file ArrayWrapper.h.

---

Constructor & Destructor Documentation

template<typename ExpressionType >

Eigen::ArrayWrapper< ExpressionType >::ArrayWrapper

(

ExpressionType &

matrix

)

[inline]

Definition at line 51 of file ArrayWrapper.h.

---

Member Function Documentation

template<typename ExpressionType >

CoeffReturnType Eigen::ArrayWrapper< ExpressionType >::coeff	(	Index	rowId,
		Index	colId
	)		const [inline]

Definition at line 61 of file ArrayWrapper.h.

template<typename ExpressionType >

CoeffReturnType Eigen::ArrayWrapper< ExpressionType >::coeff

(

Index

index

)

const [inline]

Definition at line 76 of file ArrayWrapper.h.

template<typename ExpressionType >

Scalar& Eigen::ArrayWrapper< ExpressionType >::coeffRef	(	Index	rowId,
		Index	colId
	)		[inline]

Definition at line 66 of file ArrayWrapper.h.

template<typename ExpressionType >

const Scalar& Eigen::ArrayWrapper< ExpressionType >::coeffRef	(	Index	rowId,
		Index	colId
	)		const [inline]

Definition at line 71 of file ArrayWrapper.h.

template<typename ExpressionType >

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

(

Index

index

)

[inline]

Definition at line 81 of file ArrayWrapper.h.

template<typename ExpressionType >

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

(

Index

index

)

const [inline]

Definition at line 86 of file ArrayWrapper.h.

template<typename ExpressionType >

Index Eigen::ArrayWrapper< ExpressionType >::cols

(

)

const [inline]

Definition at line 54 of file ArrayWrapper.h.

template<typename ExpressionType >

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

(

)

[inline]

Definition at line 58 of file ArrayWrapper.h.

template<typename ExpressionType >

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

(

)

const [inline]

Definition at line 59 of file ArrayWrapper.h.

template<typename ExpressionType >

template<typename Dest >

void Eigen::ArrayWrapper< ExpressionType >::evalTo

(

Dest &

dst

)

const [inline]

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

Definition at line 116 of file ArrayWrapper.h.

template<typename ExpressionType >

Index Eigen::ArrayWrapper< ExpressionType >::innerStride

(

)

const [inline]

Definition at line 56 of file ArrayWrapper.h.

template<typename ExpressionType >

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

(

)

const [inline]

Definition at line 119 of file ArrayWrapper.h.

template<typename ExpressionType >

Index Eigen::ArrayWrapper< ExpressionType >::outerStride

(

)

const [inline]

Definition at line 55 of file ArrayWrapper.h.

template<typename ExpressionType >

template<int LoadMode>

const PacketScalar Eigen::ArrayWrapper< ExpressionType >::packet	(	Index	rowId,
		Index	colId
	)		const [inline]

Definition at line 92 of file ArrayWrapper.h.

template<typename ExpressionType >

template<int LoadMode>

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

(

Index

index

)

const [inline]

Definition at line 104 of file ArrayWrapper.h.

template<typename ExpressionType >

void Eigen::ArrayWrapper< ExpressionType >::resize

(

Index

newSize

)

[inline]

Forwards the resizing request to the nested expression

See also:

DenseBase::resize(Index)

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

Definition at line 126 of file ArrayWrapper.h.

template<typename ExpressionType >

void Eigen::ArrayWrapper< 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< ArrayWrapper< ExpressionType > >.

Definition at line 129 of file ArrayWrapper.h.

template<typename ExpressionType >

Index Eigen::ArrayWrapper< ExpressionType >::rows

(

)

const [inline]

Definition at line 53 of file ArrayWrapper.h.

template<typename ExpressionType >

template<int LoadMode>

void Eigen::ArrayWrapper< ExpressionType >::writePacket	(	Index	rowId,
		Index	colId,
		const PacketScalar &	val
	)		[inline]

Definition at line 98 of file ArrayWrapper.h.

template<typename ExpressionType >

template<int LoadMode>

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

Definition at line 110 of file ArrayWrapper.h.

---

Member Data Documentation

template<typename ExpressionType >

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

Definition at line 132 of file ArrayWrapper.h.

---

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

• ArrayWrapper.h