Eigen::MatrixWrapper Class Reference

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

#include <ArrayBase.h>

Public Types
typedef MatrixBase< MatrixWrapper< ExpressionType > >	Base
typedef internal::remove_all< ExpressionType >::type	NestedExpression
typedef internal::ref_selector< ExpressionType >::non_const_type	NestedExpressionType
typedef internal::conditional< internal::is_lvalue< ExpressionType >::value, Scalar, const Scalar >::type	ScalarWithConstIfNotLvalue

Public Member Functions
const EIGEN_DEVICE_FUNC Scalar &	coeffRef (Index index) const
const EIGEN_DEVICE_FUNC Scalar &	coeffRef (Index rowId, Index colId) const
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT
EIGEN_DEVICE_FUNC ScalarWithConstIfNotLvalue *	data ()
const EIGEN_DEVICE_FUNC Scalar *	data () const
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	innerStride () const EIGEN_NOEXCEPT
EIGEN_DEVICE_FUNC	MatrixWrapper (ExpressionType &matrix)
const EIGEN_DEVICE_FUNC internal::remove_all< NestedExpressionType >::type &	nestedExpression () const
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	outerStride () const EIGEN_NOEXCEPT
EIGEN_DEVICE_FUNC void	resize (Index newSize)
EIGEN_DEVICE_FUNC void	resize (Index rows, Index cols)
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT

Protected Attributes
NestedExpressionType	m_expression

Detailed Description

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 15 of file ArrayBase.h.

Member Typedef Documentation

Base

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

Definition at line 143 of file ArrayWrapper.h.

NestedExpression

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

Definition at line 146 of file ArrayWrapper.h.

NestedExpressionType

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

Definition at line 154 of file ArrayWrapper.h.

ScalarWithConstIfNotLvalue

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

Definition at line 152 of file ArrayWrapper.h.

Constructor & Destructor Documentation

MatrixWrapper()

EIGEN_DEVICE_FUNC Eigen::MatrixWrapper::MatrixWrapper ( ExpressionType &  matrix )

inlineexplicit

Definition at line 159 of file ArrayWrapper.h.

Member Function Documentation

coeffRef() [1/2]

const EIGEN_DEVICE_FUNC Scalar& Eigen::MatrixWrapper::coeffRef ( Index  index ) const

inline

Definition at line 182 of file ArrayWrapper.h.

coeffRef() [2/2]

const EIGEN_DEVICE_FUNC Scalar& Eigen::MatrixWrapper::coeffRef ( Index  rowId, Index  colId  ) const

inline

Definition at line 176 of file ArrayWrapper.h.

cols()

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::MatrixWrapper::cols ( ) const

inline

Definition at line 164 of file ArrayWrapper.h.

data() [1/2]

EIGEN_DEVICE_FUNC ScalarWithConstIfNotLvalue* Eigen::MatrixWrapper::data ( )

inline

Definition at line 171 of file ArrayWrapper.h.

data() [2/2]

const EIGEN_DEVICE_FUNC Scalar* Eigen::MatrixWrapper::data ( ) const

inline

Definition at line 173 of file ArrayWrapper.h.

innerStride()

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::MatrixWrapper::innerStride ( ) const

inline

Definition at line 168 of file ArrayWrapper.h.

nestedExpression()

const EIGEN_DEVICE_FUNC internal::remove_all<NestedExpressionType>::type& Eigen::MatrixWrapper::nestedExpression ( ) const

inline

Definition at line 189 of file ArrayWrapper.h.

outerStride()

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::MatrixWrapper::outerStride ( ) const

inline

Definition at line 166 of file ArrayWrapper.h.

resize() [1/2]

EIGEN_DEVICE_FUNC void Eigen::MatrixWrapper::resize ( Index  newSize )

inline

Forwards the resizing request to the nested expression

See also

DenseBase::resize(Index)

Definition at line 197 of file ArrayWrapper.h.

resize() [2/2]

EIGEN_DEVICE_FUNC void Eigen::MatrixWrapper::resize ( Index  rows, Index  cols  )

inline

Forwards the resizing request to the nested expression

See also

DenseBase::resize(Index,Index)

Definition at line 201 of file ArrayWrapper.h.

rows()

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::MatrixWrapper::rows ( ) const

inline

Definition at line 162 of file ArrayWrapper.h.

Member Data Documentation

m_expression

NestedExpressionType Eigen::MatrixWrapper::m_expression

protected

Definition at line 204 of file ArrayWrapper.h.

---

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

• ArrayBase.h
• ArrayWrapper.h