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

#include <ArrayWrapper.h>

Inheritance diagram for Eigen::MatrixWrapper< ExpressionType >:

Collaboration diagram for Eigen::MatrixWrapper< ExpressionType >:

Public Types
typedef MatrixBase < MatrixWrapper < ExpressionType > >	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	MatrixWrapper (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)
EIGEN_DEVICE_FUNC const internal::remove_all < NestedExpressionType >::type &	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::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 184 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 187 of file ArrayWrapper.h.

template<typename ExpressionType >

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

Definition at line 190 of file ArrayWrapper.h.

template<typename ExpressionType >

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

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

Constructor & Destructor Documentation

template<typename ExpressionType >

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

Definition at line 201 of file ArrayWrapper.h.

: m_expression(matrix) {}

Member Function Documentation

template<typename ExpressionType >

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

Definition at line 218 of file ArrayWrapper.h.

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

template<typename ExpressionType >

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

Definition at line 236 of file ArrayWrapper.h.

    {
      return m_expression.coeff(index);
    }

template<typename ExpressionType >

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

Definition at line 224 of file ArrayWrapper.h.

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

template<typename ExpressionType >

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

Definition at line 230 of file ArrayWrapper.h.

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

template<typename ExpressionType >

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

Definition at line 242 of file ArrayWrapper.h.

    {
      return m_expression.coeffRef(index);
    }

template<typename ExpressionType >

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

Definition at line 248 of file ArrayWrapper.h.

    {
      return m_expression.coeffRef(index);
    }

template<typename ExpressionType >

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

Definition at line 206 of file ArrayWrapper.h.

{ return m_expression.cols(); }

template<typename ExpressionType >

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

Definition at line 213 of file ArrayWrapper.h.

{ return m_expression.data(); }

template<typename ExpressionType >

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

Definition at line 215 of file ArrayWrapper.h.

{ return m_expression.data(); }

template<typename ExpressionType >

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

Definition at line 210 of file ArrayWrapper.h.

{ return m_expression.innerStride(); }

template<typename ExpressionType >

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

Definition at line 279 of file ArrayWrapper.h.

    {
      return m_expression;
    }

template<typename ExpressionType >

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

Definition at line 208 of file ArrayWrapper.h.

{ return m_expression.outerStride(); }

template<typename ExpressionType >

template<int LoadMode>

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

Definition at line 254 of file ArrayWrapper.h.

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

template<typename ExpressionType >

template<int LoadMode>

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

Definition at line 266 of file ArrayWrapper.h.

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

template<typename ExpressionType >

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

{ m_expression.resize(newSize); }

template<typename ExpressionType >

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

Definition at line 291 of file ArrayWrapper.h.

{ m_expression.resize(rows,cols); }

template<typename ExpressionType >

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

Definition at line 204 of file ArrayWrapper.h.

{ return m_expression.rows(); }

template<typename ExpressionType >

template<int LoadMode>

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

Definition at line 260 of file ArrayWrapper.h.

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

template<typename ExpressionType >

template<int LoadMode>

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

Definition at line 272 of file ArrayWrapper.h.

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

Member Data Documentation

template<typename ExpressionType >

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

Definition at line 294 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::MatrixWrapper< ExpressionType >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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