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

Inheritance diagram for Eigen::MatrixWrapper< ExpressionType >:

Public Member Functions
void	resize (Index newSize)

void	resize (Index rows, Index cols)

Public Member Functions inherited from Eigen::MatrixBase< MatrixWrapper< ExpressionType > >
ArrayWrapper< MatrixWrapper< ExpressionType > >	array ()

const ArrayWrapper< const MatrixWrapper< ExpressionType > >	array () const

const CwiseBinaryOp< CustomBinaryOp, const MatrixWrapper< ExpressionType >, const OtherDerived >	binaryExpr (const Eigen::MatrixBase< OtherDerived > &other, const CustomBinaryOp &func=CustomBinaryOp()) const

CastXpr< NewType >::Type	cast () const

ConjugateReturnType	conjugate () const

const MatrixFunctionReturnValue< MatrixWrapper< ExpressionType > >	cos () const
	This function requires the unsupported MatrixFunctions module. To compute the coefficient-wise cosine use ArrayBase::cos . More...

const MatrixFunctionReturnValue< MatrixWrapper< ExpressionType > >	cosh () const
	This function requires the unsupported MatrixFunctions module. To compute the coefficient-wise hyperbolic cosine use ArrayBase::cosh . More...

const CwiseAbsReturnType	cwiseAbs () const

const CwiseAbs2ReturnType	cwiseAbs2 () const

const CwiseBinaryOp< std::equal_to< Scalar >, const MatrixWrapper< ExpressionType >, const OtherDerived >	cwiseEqual (const Eigen::MatrixBase< OtherDerived > &other) const

const CwiseScalarEqualReturnType	cwiseEqual (const Scalar &s) const

const CwiseInverseReturnType	cwiseInverse () const

const CwiseBinaryOp< internal::scalar_max_op< Scalar, Scalar >, const MatrixWrapper< ExpressionType >, const OtherDerived >	cwiseMax (const Eigen::MatrixBase< OtherDerived > &other) const

const CwiseBinaryOp< internal::scalar_max_op< Scalar, Scalar >, const MatrixWrapper< ExpressionType >, const ConstantReturnType >	cwiseMax (const Scalar &other) const

const CwiseBinaryOp< internal::scalar_min_op< Scalar, Scalar >, const MatrixWrapper< ExpressionType >, const OtherDerived >	cwiseMin (const Eigen::MatrixBase< OtherDerived > &other) const

const CwiseBinaryOp< internal::scalar_min_op< Scalar, Scalar >, const MatrixWrapper< ExpressionType >, const ConstantReturnType >	cwiseMin (const Scalar &other) const

const CwiseBinaryOp< std::not_equal_to< Scalar >, const MatrixWrapper< ExpressionType >, const OtherDerived >	cwiseNotEqual (const Eigen::MatrixBase< OtherDerived > &other) const

const CwiseBinaryOp< internal::scalar_product_op< MatrixWrapper< ExpressionType >::Scalar, OtherDerived::Scalar >, const MatrixWrapper< ExpressionType >, const OtherDerived >	cwiseProduct (const Eigen::MatrixBase< OtherDerived > &other) const

const CwiseBinaryOp< internal::scalar_quotient_op< Scalar >, const MatrixWrapper< ExpressionType >, const OtherDerived >	cwiseQuotient (const Eigen::MatrixBase< OtherDerived > &other) const

const CwiseSignReturnType	cwiseSign () const

const CwiseSqrtReturnType	cwiseSqrt () const

Index	diagonalSize () const

const MatrixExponentialReturnValue< MatrixWrapper< ExpressionType > >	exp () const
	This function requires the unsupported MatrixFunctions module. To compute the coefficient-wise exponential use ArrayBase::exp . More...

const ImagReturnType	imag () const

NonConstImagReturnType	imag ()

const MatrixLogarithmReturnValue< MatrixWrapper< ExpressionType > >	log () const
	This function requires the unsupported MatrixFunctions module. To compute the coefficient-wise logarithm use ArrayBase::log . More...

const MatrixFunctionReturnValue< MatrixWrapper< ExpressionType > >	matrixFunction (StemFunction f) const
	Helper function for the unsupported MatrixFunctions module.

bool	operator!= (const MatrixBase< OtherDerived > &other) const

const CwiseBinaryOp< internal::scalar_boolean_and_op, const MatrixWrapper< ExpressionType >, const OtherDerived >	operator&& (const Eigen::MatrixBase< OtherDerived > &other) const

const CwiseBinaryOp< internal::scalar_product_op< Scalar, T >, MatrixWrapper< ExpressionType >, Constant< T > >	operator* (const T &scalar) const

const CwiseBinaryOp< sum< Scalar >, const MatrixWrapper< ExpressionType >, const OtherDerived >	operator+ (const Eigen::MatrixBase< OtherDerived > &other) const

const CwiseBinaryOp< difference< Scalar >, const MatrixWrapper< ExpressionType >, const OtherDerived >	operator- (const Eigen::MatrixBase< OtherDerived > &other) const

const NegativeReturnType	operator- () const

const CwiseBinaryOp< internal::scalar_quotient_op< Scalar, T >, MatrixWrapper< ExpressionType >, Constant< T > >	operator/ (const T &scalar) const

MatrixWrapper< ExpressionType > &	operator= (const MatrixBase &other)

bool	operator== (const MatrixBase< OtherDerived > &other) const

const CwiseBinaryOp< internal::scalar_boolean_or_op, const MatrixWrapper< ExpressionType >, const OtherDerived >	operator\|\| (const Eigen::MatrixBase< OtherDerived > &other) const

const MatrixPowerReturnValue< MatrixWrapper< ExpressionType > >	pow (const RealScalar &p) const
	This function requires the unsupported MatrixFunctions module. To compute the coefficient-wise power to `p` use ArrayBase::pow . More...

const MatrixComplexPowerReturnValue< MatrixWrapper< ExpressionType > >	pow (const std::complex< RealScalar > &p) const
	This function requires the unsupported MatrixFunctions module. To compute the coefficient-wise power to `p` use ArrayBase::pow . More...

RealReturnType	real () const

NonConstRealReturnType	real ()

const MatrixFunctionReturnValue< MatrixWrapper< ExpressionType > >	sin () const
	This function requires the unsupported MatrixFunctions module. To compute the coefficient-wise sine use ArrayBase::sin . More...

const MatrixFunctionReturnValue< MatrixWrapper< ExpressionType > >	sinh () const
	This function requires the unsupported MatrixFunctions module. To compute the coefficient-wise hyperbolic sine use ArrayBase::sinh . More...

const MatrixSquareRootReturnValue< MatrixWrapper< ExpressionType > >	sqrt () const
	This function requires the unsupported MatrixFunctions module. To compute the coefficient-wise square root use ArrayBase::sqrt . More...

const CwiseUnaryOp< CustomUnaryOp, const MatrixWrapper< ExpressionType > >	unaryExpr (const CustomUnaryOp &func=CustomUnaryOp()) const
	Apply a unary operator coefficient-wise. More...

const CwiseUnaryView< CustomViewOp, const MatrixWrapper< ExpressionType > >	unaryViewExpr (const CustomViewOp &func=CustomViewOp()) const

Public Member Functions inherited from Eigen::DenseBase< MatrixWrapper< ExpressionType > >
BlockXpr	block (Index startRow, Index startCol, Index blockRows, Index blockCols)

const ConstBlockXpr	block (Index startRow, Index startCol, Index blockRows, Index blockCols) const
	This is the const version of block(Index,Index,Index,Index). */.

FixedBlockXpr< NRows, NCols >::Type	block (Index startRow, Index startCol)

const ConstFixedBlockXpr< NRows, NCols >::Type	block (Index startRow, Index startCol) const
	This is the const version of block<>(Index, Index). */.

FixedBlockXpr< NRows, NCols >::Type	block (Index startRow, Index startCol, Index blockRows, Index blockCols)

const ConstFixedBlockXpr< NRows, NCols >::Type	block (Index startRow, Index startCol, Index blockRows, Index blockCols) const
	This is the const version of block<>(Index, Index, Index, Index).

BlockXpr	bottomLeftCorner (Index cRows, Index cCols)

const ConstBlockXpr	bottomLeftCorner (Index cRows, Index cCols) const
	This is the const version of bottomLeftCorner(Index, Index).

FixedBlockXpr< CRows, CCols >::Type	bottomLeftCorner ()

const ConstFixedBlockXpr< CRows, CCols >::Type	bottomLeftCorner () const
	This is the const version of bottomLeftCorner<int, int>().

FixedBlockXpr< CRows, CCols >::Type	bottomLeftCorner (Index cRows, Index cCols)

const ConstFixedBlockXpr< CRows, CCols >::Type	bottomLeftCorner (Index cRows, Index cCols) const
	This is the const version of bottomLeftCorner<int, int>(Index, Index).

BlockXpr	bottomRightCorner (Index cRows, Index cCols)

const ConstBlockXpr	bottomRightCorner (Index cRows, Index cCols) const
	This is the const version of bottomRightCorner(Index, Index).

FixedBlockXpr< CRows, CCols >::Type	bottomRightCorner ()

const ConstFixedBlockXpr< CRows, CCols >::Type	bottomRightCorner () const
	This is the const version of bottomRightCorner<int, int>().

FixedBlockXpr< CRows, CCols >::Type	bottomRightCorner (Index cRows, Index cCols)

const ConstFixedBlockXpr< CRows, CCols >::Type	bottomRightCorner (Index cRows, Index cCols) const
	This is the const version of bottomRightCorner<int, int>(Index, Index).

RowsBlockXpr	bottomRows (Index n)

ConstRowsBlockXpr	bottomRows (Index n) const
	This is the const version of bottomRows(Index).

NRowsBlockXpr< N >::Type	bottomRows (Index n=N)

ConstNRowsBlockXpr< N >::Type	bottomRows (Index n=N) const
	This is the const version of bottomRows<int>().

ColXpr	col (Index i)

ConstColXpr	col (Index i) const
	This is the const version of col().

ConstColwiseReturnType	colwise () const

EvalReturnType	eval () const

EIGEN_DEPRECATED const MatrixWrapper< ExpressionType > &	flagged () const

const WithFormat< MatrixWrapper< ExpressionType > >	format (const IOFormat &fmt) const

SegmentReturnType	head (Index n)

ConstSegmentReturnType	head (Index n) const
	This is the const version of head(Index).

FixedSegmentReturnType< N >::Type	head (Index n=N)

ConstFixedSegmentReturnType< N >::Type	head (Index n=N) const
	This is the const version of head<int>().

Index	innerSize () const

ColsBlockXpr	leftCols (Index n)

ConstColsBlockXpr	leftCols (Index n) const
	This is the const version of leftCols(Index).

NColsBlockXpr< N >::Type	leftCols (Index n=N)

ConstNColsBlockXpr< N >::Type	leftCols (Index n=N) const
	This is the const version of leftCols<int>().

ColsBlockXpr	middleCols (Index startCol, Index numCols)

ConstColsBlockXpr	middleCols (Index startCol, Index numCols) const
	This is the const version of middleCols(Index,Index).

NColsBlockXpr< N >::Type	middleCols (Index startCol, Index n=N)

ConstNColsBlockXpr< N >::Type	middleCols (Index startCol, Index n=N) const
	This is the const version of middleCols<int>().

RowsBlockXpr	middleRows (Index startRow, Index n)

ConstRowsBlockXpr	middleRows (Index startRow, Index n) const
	This is the const version of middleRows(Index,Index).

NRowsBlockXpr< N >::Type	middleRows (Index startRow, Index n=N)

ConstNRowsBlockXpr< N >::Type	middleRows (Index startRow, Index n=N) const
	This is the const version of middleRows<int>().

Index	nonZeros () const

MatrixWrapper< ExpressionType > &	operator= (const DenseBase< OtherDerived > &other)

MatrixWrapper< ExpressionType > &	operator= (const DenseBase &other)

Index	outerSize () const

const Replicate< MatrixWrapper< ExpressionType >, Dynamic, Dynamic >	replicate (Index rowFactor, Index colFactor) const

void	resize (Index newSize)

void	resize (Index rows, Index cols)

ConstReverseReturnType	reverse () const

ColsBlockXpr	rightCols (Index n)

ConstColsBlockXpr	rightCols (Index n) const
	This is the const version of rightCols(Index).

NColsBlockXpr< N >::Type	rightCols (Index n=N)

ConstNColsBlockXpr< N >::Type	rightCols (Index n=N) const
	This is the const version of rightCols<int>().

RowXpr	row (Index i)

ConstRowXpr	row (Index i) const
	This is the const version of row(). */.

ConstRowwiseReturnType	rowwise () const

SegmentReturnType	segment (Index start, Index n)

ConstSegmentReturnType	segment (Index start, Index n) const
	This is the const version of segment(Index,Index).

FixedSegmentReturnType< N >::Type	segment (Index start, Index n=N)

ConstFixedSegmentReturnType< N >::Type	segment (Index start, Index n=N) const
	This is the const version of segment<int>(Index).

void	swap (const DenseBase< OtherDerived > &other)

void	swap (PlainObjectBase< OtherDerived > &other)

SegmentReturnType	tail (Index n)

ConstSegmentReturnType	tail (Index n) const
	This is the const version of tail(Index).

FixedSegmentReturnType< N >::Type	tail (Index n=N)

ConstFixedSegmentReturnType< N >::Type	tail (Index n=N) const
	This is the const version of tail<int>.

BlockXpr	topLeftCorner (Index cRows, Index cCols)

const ConstBlockXpr	topLeftCorner (Index cRows, Index cCols) const
	This is the const version of topLeftCorner(Index, Index).

FixedBlockXpr< CRows, CCols >::Type	topLeftCorner ()

const ConstFixedBlockXpr< CRows, CCols >::Type	topLeftCorner () const
	This is the const version of topLeftCorner<int, int>().

FixedBlockXpr< CRows, CCols >::Type	topLeftCorner (Index cRows, Index cCols)

const ConstFixedBlockXpr< CRows, CCols >::Type	topLeftCorner (Index cRows, Index cCols) const
	This is the const version of topLeftCorner<int, int>(Index, Index).

BlockXpr	topRightCorner (Index cRows, Index cCols)

const ConstBlockXpr	topRightCorner (Index cRows, Index cCols) const
	This is the const version of topRightCorner(Index, Index).

FixedBlockXpr< CRows, CCols >::Type	topRightCorner ()

const ConstFixedBlockXpr< CRows, CCols >::Type	topRightCorner () const
	This is the const version of topRightCorner<int, int>().

FixedBlockXpr< CRows, CCols >::Type	topRightCorner (Index cRows, Index cCols)

const ConstFixedBlockXpr< CRows, CCols >::Type	topRightCorner (Index cRows, Index cCols) const
	This is the const version of topRightCorner<int, int>(Index, Index).

RowsBlockXpr	topRows (Index n)

ConstRowsBlockXpr	topRows (Index n) const
	This is the const version of topRows(Index).

NRowsBlockXpr< N >::Type	topRows (Index n=N)

ConstNRowsBlockXpr< N >::Type	topRows (Index n=N) const
	This is the const version of topRows<int>().

CoeffReturnType	value () const

Additional Inherited Members
Public Types inherited from Eigen::DenseBase< MatrixWrapper< ExpressionType > >
typedef Array< typename internal::traits< MatrixWrapper< ExpressionType > >::Scalar, internal::traits< MatrixWrapper< ExpressionType > >::RowsAtCompileTime, internal::traits< MatrixWrapper< ExpressionType > >::ColsAtCompileTime, AutoAlign\|(internal::traits< MatrixWrapper< ExpressionType > >::Flags &RowMajorBit?RowMajor:ColMajor), internal::traits< MatrixWrapper< ExpressionType > >::MaxRowsAtCompileTime, internal::traits< MatrixWrapper< ExpressionType > >::MaxColsAtCompileTime >	PlainArray

typedef Matrix< typename internal::traits< MatrixWrapper< ExpressionType > >::Scalar, internal::traits< MatrixWrapper< ExpressionType > >::RowsAtCompileTime, internal::traits< MatrixWrapper< ExpressionType > >::ColsAtCompileTime, AutoAlign\|(internal::traits< MatrixWrapper< ExpressionType > >::Flags &RowMajorBit?RowMajor:ColMajor), internal::traits< MatrixWrapper< ExpressionType > >::MaxRowsAtCompileTime, internal::traits< MatrixWrapper< ExpressionType > >::MaxColsAtCompileTime >	PlainMatrix

typedef internal::conditional< internal::is_same< typename internal::traits< MatrixWrapper< ExpressionType > >::XprKind, MatrixXpr >::value, PlainMatrix, PlainArray >::type	PlainObject
	The plain matrix or array type corresponding to this expression. More...

typedef internal::traits< MatrixWrapper< ExpressionType > >::Scalar	Scalar

typedef internal::traits< MatrixWrapper< ExpressionType > >::StorageIndex	StorageIndex
	The type used to store indices. More...

typedef Scalar	value_type

Protected Member Functions inherited from Eigen::DenseBase< MatrixWrapper< ExpressionType > >
	DenseBase ()

Member Function Documentation

template<typename ExpressionType >

void Eigen::MatrixWrapper< ExpressionType >::resize ( Index newSize )

inline

Forwards the resizing request to the nested expression

See also: DenseBase::resize(Index)

template<typename ExpressionType >

void Eigen::MatrixWrapper< ExpressionType >::resize	(	Index	rows,
		Index	cols
	)

inline

Forwards the resizing request to the nested expression

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

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

Detailed Description

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

Public Member Functions

Additional Inherited Members

Member Function Documentation

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