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

#include <ArrayWrapper.h>

Inheritance diagram for Eigen::ArrayWrapper< ExpressionType >:

Collaboration diagram for Eigen::ArrayWrapper< ExpressionType >:

Public Types
typedef ArrayBase< ArrayWrapper >	Base
typedef internal::remove_all < ExpressionType >::type	NestedExpression
typedef internal::conditional < internal::is_lvalue < ExpressionType >::value, Scalar, const Scalar >::type	ScalarWithConstIfNotLvalue
typedef internal::ref_selector < ExpressionType > ::non_const_type	NestedExpressionType
Public Member Functions
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE	ArrayWrapper (ExpressionType &matrix)
EIGEN_DEVICE_FUNC Index	rows () const
EIGEN_DEVICE_FUNC Index	cols () const
EIGEN_DEVICE_FUNC Index	outerStride () const
EIGEN_DEVICE_FUNC Index	innerStride () const
EIGEN_DEVICE_FUNC ScalarWithConstIfNotLvalue *	data ()
EIGEN_DEVICE_FUNC const Scalar *	data () const
EIGEN_DEVICE_FUNC CoeffReturnType	coeff (Index rowId, Index colId) const
EIGEN_DEVICE_FUNC Scalar &	coeffRef (Index rowId, Index colId)
EIGEN_DEVICE_FUNC const Scalar &	coeffRef (Index rowId, Index colId) const
EIGEN_DEVICE_FUNC CoeffReturnType	coeff (Index index) const
EIGEN_DEVICE_FUNC Scalar &	coeffRef (Index index)
EIGEN_DEVICE_FUNC const Scalar &	coeffRef (Index index) const
template<int LoadMode>
const PacketScalar	packet (Index rowId, Index colId) const
template<int LoadMode>
void	writePacket (Index rowId, Index colId, const PacketScalar &val)
template<int LoadMode>
const PacketScalar	packet (Index index) const
template<int LoadMode>
void	writePacket (Index index, const PacketScalar &val)
template<typename Dest >
EIGEN_DEVICE_FUNC void	evalTo (Dest &dst) const
const internal::remove_all < NestedExpressionType >::type &EIGEN_DEVICE_FUNC	nestedExpression () const
EIGEN_DEVICE_FUNC void	resize (Index newSize)
EIGEN_DEVICE_FUNC void	resize (Index rows, Index cols)
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 41 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 44 of file ArrayWrapper.h.

template<typename ExpressionType >

typedef internal::remove_all<ExpressionType>::type Eigen::ArrayWrapper< ExpressionType >::NestedExpression

Definition at line 47 of file ArrayWrapper.h.

template<typename ExpressionType >

typedef internal::ref_selector<ExpressionType>::non_const_type Eigen::ArrayWrapper< ExpressionType >::NestedExpressionType

Definition at line 55 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 53 of file ArrayWrapper.h.

Constructor & Destructor Documentation

template<typename ExpressionType >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Eigen::ArrayWrapper< ExpressionType >::ArrayWrapper ( ExpressionType & matrix ) [inline, explicit]

Definition at line 58 of file ArrayWrapper.h.

: m_expression(matrix) {}

Member Function Documentation

template<typename ExpressionType >

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

Definition at line 75 of file ArrayWrapper.h.

    {
      return m_expression.coeff(rowId, colId);
    }

template<typename ExpressionType >

EIGEN_DEVICE_FUNC CoeffReturnType Eigen::ArrayWrapper< ExpressionType >::coeff ( Index index ) const [inline]

Definition at line 93 of file ArrayWrapper.h.

    {
      return m_expression.coeff(index);
    }

template<typename ExpressionType >

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

Definition at line 81 of file ArrayWrapper.h.

    {
      return m_expression.coeffRef(rowId, colId);
    }

template<typename ExpressionType >

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

Definition at line 87 of file ArrayWrapper.h.

    {
      return m_expression.coeffRef(rowId, colId);
    }

template<typename ExpressionType >

EIGEN_DEVICE_FUNC Scalar& Eigen::ArrayWrapper< ExpressionType >::coeffRef ( Index index ) [inline]

Definition at line 99 of file ArrayWrapper.h.

    {
      return m_expression.coeffRef(index);
    }

template<typename ExpressionType >

EIGEN_DEVICE_FUNC const Scalar& Eigen::ArrayWrapper< ExpressionType >::coeffRef ( Index index ) const [inline]

Definition at line 105 of file ArrayWrapper.h.

    {
      return m_expression.coeffRef(index);
    }

template<typename ExpressionType >

EIGEN_DEVICE_FUNC Index Eigen::ArrayWrapper< ExpressionType >::cols ( ) const [inline]

Definition at line 63 of file ArrayWrapper.h.

{ return m_expression.cols(); }

template<typename ExpressionType >

EIGEN_DEVICE_FUNC ScalarWithConstIfNotLvalue* Eigen::ArrayWrapper< ExpressionType >::data ( ) [inline]

Definition at line 70 of file ArrayWrapper.h.

{ return m_expression.data(); }

template<typename ExpressionType >

EIGEN_DEVICE_FUNC const Scalar* Eigen::ArrayWrapper< ExpressionType >::data ( ) const [inline]

Definition at line 72 of file ArrayWrapper.h.

{ return m_expression.data(); }

template<typename ExpressionType >

template<typename Dest >

EIGEN_DEVICE_FUNC void Eigen::ArrayWrapper< ExpressionType >::evalTo ( Dest & dst ) const [inline]

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

Definition at line 136 of file ArrayWrapper.h.

{ dst = m_expression; }

template<typename ExpressionType >

EIGEN_DEVICE_FUNC Index Eigen::ArrayWrapper< ExpressionType >::innerStride ( ) const [inline]

Definition at line 67 of file ArrayWrapper.h.

{ return m_expression.innerStride(); }

template<typename ExpressionType >

const internal::remove_all<NestedExpressionType>::type& EIGEN_DEVICE_FUNC Eigen::ArrayWrapper< ExpressionType >::nestedExpression ( ) const [inline]

Definition at line 140 of file ArrayWrapper.h.

    {
      return m_expression;
    }

template<typename ExpressionType >

EIGEN_DEVICE_FUNC Index Eigen::ArrayWrapper< ExpressionType >::outerStride ( ) const [inline]

Definition at line 65 of file ArrayWrapper.h.

{ return m_expression.outerStride(); }

template<typename ExpressionType >

template<int LoadMode>

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

Definition at line 111 of file ArrayWrapper.h.

    {
      return m_expression.template packet<LoadMode>(rowId, colId);
    }

template<typename ExpressionType >

template<int LoadMode>

const PacketScalar Eigen::ArrayWrapper< ExpressionType >::packet ( Index index ) const [inline]

Definition at line 123 of file ArrayWrapper.h.

    {
      return m_expression.template packet<LoadMode>(index);
    }

template<typename ExpressionType >

EIGEN_DEVICE_FUNC 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 148 of file ArrayWrapper.h.

{ m_expression.resize(newSize); }

template<typename ExpressionType >

EIGEN_DEVICE_FUNC void Eigen::ArrayWrapper< ExpressionType >::resize	(	Index	rows,
		Index	cols
	)		`[inline]`

Forwards the resizing request to the nested expression

See also:: DenseBase::resize(Index,Index)

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

Definition at line 152 of file ArrayWrapper.h.

{ m_expression.resize(rows,cols); }

template<typename ExpressionType >

EIGEN_DEVICE_FUNC Index Eigen::ArrayWrapper< ExpressionType >::rows ( ) const [inline]

Definition at line 61 of file ArrayWrapper.h.

{ return m_expression.rows(); }

template<typename ExpressionType >

template<int LoadMode>

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

Definition at line 117 of file ArrayWrapper.h.

    {
      m_expression.template writePacket<LoadMode>(rowId, colId, val);
    }

template<typename ExpressionType >

template<int LoadMode>

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

Definition at line 129 of file ArrayWrapper.h.

    {
      m_expression.template writePacket<LoadMode>(index, val);
    }

Member Data Documentation

template<typename ExpressionType >

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

Definition at line 155 of file ArrayWrapper.h.

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

ArrayWrapper.h

Public Types

Public Member Functions

Protected Attributes

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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