Base class for all dense matrices, vectors, and arrays. More...

#include <DenseBase.h>

Inheritance diagram for Eigen::DenseBase< Derived >:

Collaboration diagram for Eigen::DenseBase< Derived >:

Classes
struct	ConstFixedBlockXpr
struct	ConstFixedSegmentReturnType
struct	ConstNColsBlockXpr
struct	ConstNRowsBlockXpr
struct	FixedBlockXpr
struct	FixedSegmentReturnType
struct	NColsBlockXpr
struct	NRowsBlockXpr
Public Types
enum	{ RowsAtCompileTime = internal::traits<Derived>::RowsAtCompileTime, ColsAtCompileTime = internal::traits<Derived>::ColsAtCompileTime, SizeAtCompileTime, MaxRowsAtCompileTime = internal::traits<Derived>::MaxRowsAtCompileTime, MaxColsAtCompileTime = internal::traits<Derived>::MaxColsAtCompileTime, MaxSizeAtCompileTime, IsVectorAtCompileTime, Flags = internal::traits<Derived>::Flags, IsRowMajor = int(Flags) & RowMajorBit, InnerSizeAtCompileTime, InnerStrideAtCompileTime = internal::inner_stride_at_compile_time<Derived>::ret, OuterStrideAtCompileTime = internal::outer_stride_at_compile_time<Derived>::ret }
enum	{ IsPlainObjectBase = 0 }
typedef Eigen::InnerIterator < Derived >	InnerIterator
typedef internal::traits < Derived >::StorageKind	StorageKind
typedef internal::traits < Derived >::StorageIndex	StorageIndex
	The type used to store indices.
typedef internal::traits < Derived >::Scalar	Scalar
typedef Scalar	value_type
typedef NumTraits< Scalar >::Real	RealScalar
typedef internal::special_scalar_op_base < Derived, Scalar, RealScalar, DenseCoeffsBase< Derived > >	Base
typedef Base::CoeffReturnType	CoeffReturnType
typedef internal::find_best_packet < Scalar, SizeAtCompileTime > ::type	PacketScalar
typedef Matrix< typename internal::traits< Derived > ::Scalar, internal::traits < Derived >::RowsAtCompileTime, internal::traits< Derived > ::ColsAtCompileTime, AutoAlign\|(internal::traits < Derived >::Flags &RowMajorBit?RowMajor:ColMajor), internal::traits< Derived > ::MaxRowsAtCompileTime, internal::traits< Derived > ::MaxColsAtCompileTime >	PlainMatrix
typedef Array< typename internal::traits< Derived > ::Scalar, internal::traits < Derived >::RowsAtCompileTime, internal::traits< Derived > ::ColsAtCompileTime, AutoAlign\|(internal::traits < Derived >::Flags &RowMajorBit?RowMajor:ColMajor), internal::traits< Derived > ::MaxRowsAtCompileTime, internal::traits< Derived > ::MaxColsAtCompileTime >	PlainArray
typedef internal::conditional < internal::is_same< typename internal::traits< Derived > ::XprKind, MatrixXpr >::value, PlainMatrix, PlainArray > ::type	PlainObject
	The plain matrix or array type corresponding to this expression.
typedef CwiseNullaryOp < internal::scalar_constant_op < Scalar >, PlainObject >	ConstantReturnType
typedef CwiseNullaryOp < internal::linspaced_op < Scalar, PacketScalar, false > , PlainObject >	SequentialLinSpacedReturnType
typedef CwiseNullaryOp < internal::linspaced_op < Scalar, PacketScalar, true > , PlainObject >	RandomAccessLinSpacedReturnType
typedef Matrix< typename NumTraits< typename internal::traits< Derived > ::Scalar >::Real, internal::traits< Derived > ::ColsAtCompileTime, 1 >	EigenvaluesReturnType
typedef Transpose< Derived >	TransposeReturnType
typedef internal::add_const < Transpose< const Derived > >::type	ConstTransposeReturnType
typedef internal::add_const_on_value_type < typename internal::eval < Derived >::type >::type	EvalReturnType
typedef VectorwiseOp< Derived, Horizontal >	RowwiseReturnType
typedef const VectorwiseOp < const Derived, Horizontal >	ConstRowwiseReturnType
typedef VectorwiseOp< Derived, Vertical >	ColwiseReturnType
typedef const VectorwiseOp < const Derived, Vertical >	ConstColwiseReturnType
typedef CwiseNullaryOp < internal::scalar_random_op < Scalar >, PlainObject >	RandomReturnType
typedef Reverse< Derived, BothDirections >	ReverseReturnType
typedef const Reverse< const Derived, BothDirections >	ConstReverseReturnType
typedef Block< Derived, internal::traits< Derived > ::RowsAtCompileTime, 1,!IsRowMajor >	ColXpr
typedef const Block< const Derived, internal::traits < Derived >::RowsAtCompileTime, 1,!IsRowMajor >	ConstColXpr
typedef Block< Derived, 1, internal::traits< Derived > ::ColsAtCompileTime, IsRowMajor >	RowXpr
typedef const Block< const Derived, 1, internal::traits < Derived >::ColsAtCompileTime, IsRowMajor >	ConstRowXpr
typedef Block< Derived, internal::traits< Derived > ::RowsAtCompileTime, Dynamic,!IsRowMajor >	ColsBlockXpr
typedef const Block< const Derived, internal::traits < Derived >::RowsAtCompileTime, Dynamic,!IsRowMajor >	ConstColsBlockXpr
typedef Block< Derived, Dynamic, internal::traits < Derived >::ColsAtCompileTime, IsRowMajor >	RowsBlockXpr
typedef const Block< const Derived, Dynamic, internal::traits< Derived > ::ColsAtCompileTime, IsRowMajor >	ConstRowsBlockXpr
typedef Block< Derived >	BlockXpr
typedef const Block< const Derived >	ConstBlockXpr
typedef VectorBlock< Derived >	SegmentReturnType
typedef const VectorBlock < const Derived >	ConstSegmentReturnType
Public Member Functions
EIGEN_DEVICE_FUNC Index	nonZeros () const
EIGEN_DEVICE_FUNC Index	outerSize () const
EIGEN_DEVICE_FUNC Index	innerSize () const
EIGEN_DEVICE_FUNC void	resize (Index newSize)
EIGEN_DEVICE_FUNC void	resize (Index p_rows, Index p_cols)
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived &	operator= (const DenseBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived &	operator= (const DenseBase &other)
template<typename OtherDerived >
EIGEN_DEVICE_FUNC Derived &	operator= (const EigenBase< OtherDerived > &other)
	Copies the generic expression other into *this.
template<typename OtherDerived >
EIGEN_DEVICE_FUNC Derived &	operator+= (const EigenBase< OtherDerived > &other)
template<typename OtherDerived >
EIGEN_DEVICE_FUNC Derived &	operator-= (const EigenBase< OtherDerived > &other)
template<typename OtherDerived >
EIGEN_DEVICE_FUNC Derived &	operator= (const ReturnByValue< OtherDerived > &func)
template<typename OtherDerived >
EIGEN_DEVICE_FUNC Derived &	lazyAssign (const DenseBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC CommaInitializer< Derived >	operator<< (const Scalar &s)
template<unsigned int Added, unsigned int Removed>
EIGEN_DEPRECATED const Derived &	flagged () const
template<typename OtherDerived >
EIGEN_DEVICE_FUNC CommaInitializer< Derived >	operator<< (const DenseBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC TransposeReturnType	transpose ()
EIGEN_DEVICE_FUNC ConstTransposeReturnType	transpose () const
EIGEN_DEVICE_FUNC void	transposeInPlace ()
EIGEN_DEVICE_FUNC void	fill (const Scalar &value)
EIGEN_DEVICE_FUNC Derived &	setConstant (const Scalar &value)
EIGEN_DEVICE_FUNC Derived &	setLinSpaced (Index size, const Scalar &low, const Scalar &high)
	Sets a linearly spaced vector.
EIGEN_DEVICE_FUNC Derived &	setLinSpaced (const Scalar &low, const Scalar &high)
	Sets a linearly spaced vector.
EIGEN_DEVICE_FUNC Derived &	setZero ()
EIGEN_DEVICE_FUNC Derived &	setOnes ()
EIGEN_DEVICE_FUNC Derived &	setRandom ()
template<typename OtherDerived >
EIGEN_DEVICE_FUNC bool	isApprox (const DenseBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
EIGEN_DEVICE_FUNC bool	isMuchSmallerThan (const RealScalar &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
template<typename OtherDerived >
EIGEN_DEVICE_FUNC bool	isMuchSmallerThan (const DenseBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
EIGEN_DEVICE_FUNC bool	isApproxToConstant (const Scalar &value, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
EIGEN_DEVICE_FUNC bool	isConstant (const Scalar &value, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
EIGEN_DEVICE_FUNC bool	isZero (const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
EIGEN_DEVICE_FUNC bool	isOnes (const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
bool	hasNaN () const
bool	allFinite () const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived &	operator*= (const Scalar &other)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived &	operator/= (const Scalar &other)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EvalReturnType	eval () const
template<typename OtherDerived >
EIGEN_DEVICE_FUNC void	swap (const DenseBase< OtherDerived > &other)
template<typename OtherDerived >
EIGEN_DEVICE_FUNC void	swap (PlainObjectBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC const NestByValue< Derived >	nestByValue () const
EIGEN_DEVICE_FUNC const ForceAlignedAccess< Derived >	forceAlignedAccess () const
EIGEN_DEVICE_FUNC ForceAlignedAccess< Derived >	forceAlignedAccess ()
template<bool Enable>
EIGEN_DEVICE_FUNC const internal::conditional< Enable, ForceAlignedAccess< Derived > , Derived & >::type	forceAlignedAccessIf () const
template<bool Enable>
EIGEN_DEVICE_FUNC internal::conditional< Enable, ForceAlignedAccess< Derived > , Derived & >::type	forceAlignedAccessIf ()
EIGEN_DEVICE_FUNC Scalar	sum () const
EIGEN_DEVICE_FUNC Scalar	mean () const
EIGEN_DEVICE_FUNC Scalar	trace () const
EIGEN_DEVICE_FUNC Scalar	prod () const
EIGEN_DEVICE_FUNC internal::traits< Derived > ::Scalar	minCoeff () const
EIGEN_DEVICE_FUNC internal::traits< Derived > ::Scalar	maxCoeff () const
template<typename IndexType >
EIGEN_DEVICE_FUNC internal::traits< Derived > ::Scalar	minCoeff (IndexType row, IndexType col) const
template<typename IndexType >
EIGEN_DEVICE_FUNC internal::traits< Derived > ::Scalar	maxCoeff (IndexType row, IndexType col) const
template<typename IndexType >
EIGEN_DEVICE_FUNC internal::traits< Derived > ::Scalar	minCoeff (IndexType *index) const
template<typename IndexType >
EIGEN_DEVICE_FUNC internal::traits< Derived > ::Scalar	maxCoeff (IndexType *index) const
template<typename BinaryOp >
EIGEN_DEVICE_FUNC Scalar	redux (const BinaryOp &func) const
template<typename Visitor >
EIGEN_DEVICE_FUNC void	visit (Visitor &func) const
const WithFormat< Derived >	format (const IOFormat &fmt) const
EIGEN_DEVICE_FUNC CoeffReturnType	value () const
bool	all () const
bool	any () const
Index	count () const
EIGEN_DEVICE_FUNC ConstRowwiseReturnType	rowwise () const
EIGEN_DEVICE_FUNC RowwiseReturnType	rowwise ()
EIGEN_DEVICE_FUNC ConstColwiseReturnType	colwise () const
EIGEN_DEVICE_FUNC ColwiseReturnType	colwise ()
template<typename ThenDerived , typename ElseDerived >
const Select< Derived, ThenDerived, ElseDerived >	select (const DenseBase< ThenDerived > &thenMatrix, const DenseBase< ElseDerived > &elseMatrix) const
template<typename ThenDerived >
const Select< Derived, ThenDerived, typename ThenDerived::ConstantReturnType >	select (const DenseBase< ThenDerived > &thenMatrix, const typename ThenDerived::Scalar &elseScalar) const
template<typename ElseDerived >
const Select< Derived, typename ElseDerived::ConstantReturnType, ElseDerived >	select (const typename ElseDerived::Scalar &thenScalar, const DenseBase< ElseDerived > &elseMatrix) const
template<int p>
RealScalar	lpNorm () const
template<int RowFactor, int ColFactor>
EIGEN_DEVICE_FUNC const Replicate< Derived, RowFactor, ColFactor >	replicate () const
EIGEN_DEVICE_FUNC const Replicate< Derived, Dynamic, Dynamic >	replicate (Index rowFactor, Index colFactor) const
EIGEN_DEVICE_FUNC ReverseReturnType	reverse ()
EIGEN_DEVICE_FUNC ConstReverseReturnType	reverse () const
EIGEN_DEVICE_FUNC void	reverseInPlace ()
EIGEN_DEVICE_FUNC BlockXpr	block (Index startRow, Index startCol, Index blockRows, Index blockCols)
EIGEN_DEVICE_FUNC const ConstBlockXpr	block (Index startRow, Index startCol, Index blockRows, Index blockCols) const
EIGEN_DEVICE_FUNC BlockXpr	topRightCorner (Index cRows, Index cCols)
EIGEN_DEVICE_FUNC const ConstBlockXpr	topRightCorner (Index cRows, Index cCols) const
template<int CRows, int CCols>
EIGEN_DEVICE_FUNC FixedBlockXpr< CRows, CCols > ::Type	topRightCorner ()
template<int CRows, int CCols>
EIGEN_DEVICE_FUNC const ConstFixedBlockXpr< CRows, CCols >::Type	topRightCorner () const
template<int CRows, int CCols>
FixedBlockXpr< CRows, CCols >::Type	topRightCorner (Index cRows, Index cCols)
template<int CRows, int CCols>
const ConstFixedBlockXpr < CRows, CCols >::Type	topRightCorner (Index cRows, Index cCols) const
EIGEN_DEVICE_FUNC BlockXpr	topLeftCorner (Index cRows, Index cCols)
EIGEN_DEVICE_FUNC const ConstBlockXpr	topLeftCorner (Index cRows, Index cCols) const
template<int CRows, int CCols>
EIGEN_DEVICE_FUNC FixedBlockXpr< CRows, CCols > ::Type	topLeftCorner ()
template<int CRows, int CCols>
EIGEN_DEVICE_FUNC const ConstFixedBlockXpr< CRows, CCols >::Type	topLeftCorner () const
template<int CRows, int CCols>
FixedBlockXpr< CRows, CCols >::Type	topLeftCorner (Index cRows, Index cCols)
template<int CRows, int CCols>
const ConstFixedBlockXpr < CRows, CCols >::Type	topLeftCorner (Index cRows, Index cCols) const
EIGEN_DEVICE_FUNC BlockXpr	bottomRightCorner (Index cRows, Index cCols)
EIGEN_DEVICE_FUNC const ConstBlockXpr	bottomRightCorner (Index cRows, Index cCols) const
template<int CRows, int CCols>
EIGEN_DEVICE_FUNC FixedBlockXpr< CRows, CCols > ::Type	bottomRightCorner ()
template<int CRows, int CCols>
EIGEN_DEVICE_FUNC const ConstFixedBlockXpr< CRows, CCols >::Type	bottomRightCorner () const
template<int CRows, int CCols>
FixedBlockXpr< CRows, CCols >::Type	bottomRightCorner (Index cRows, Index cCols)
template<int CRows, int CCols>
const ConstFixedBlockXpr < CRows, CCols >::Type	bottomRightCorner (Index cRows, Index cCols) const
EIGEN_DEVICE_FUNC BlockXpr	bottomLeftCorner (Index cRows, Index cCols)
EIGEN_DEVICE_FUNC const ConstBlockXpr	bottomLeftCorner (Index cRows, Index cCols) const
template<int CRows, int CCols>
EIGEN_DEVICE_FUNC FixedBlockXpr< CRows, CCols > ::Type	bottomLeftCorner ()
template<int CRows, int CCols>
EIGEN_DEVICE_FUNC const ConstFixedBlockXpr< CRows, CCols >::Type	bottomLeftCorner () const
template<int CRows, int CCols>
FixedBlockXpr< CRows, CCols >::Type	bottomLeftCorner (Index cRows, Index cCols)
template<int CRows, int CCols>
const ConstFixedBlockXpr < CRows, CCols >::Type	bottomLeftCorner (Index cRows, Index cCols) const
EIGEN_DEVICE_FUNC RowsBlockXpr	topRows (Index n)
EIGEN_DEVICE_FUNC ConstRowsBlockXpr	topRows (Index n) const
template<int N>
EIGEN_DEVICE_FUNC NRowsBlockXpr< N >::Type	topRows (Index n=N)
template<int N>
EIGEN_DEVICE_FUNC ConstNRowsBlockXpr< N >::Type	topRows (Index n=N) const
EIGEN_DEVICE_FUNC RowsBlockXpr	bottomRows (Index n)
EIGEN_DEVICE_FUNC ConstRowsBlockXpr	bottomRows (Index n) const
template<int N>
EIGEN_DEVICE_FUNC NRowsBlockXpr< N >::Type	bottomRows (Index n=N)
template<int N>
EIGEN_DEVICE_FUNC ConstNRowsBlockXpr< N >::Type	bottomRows (Index n=N) const
EIGEN_DEVICE_FUNC RowsBlockXpr	middleRows (Index startRow, Index n)
EIGEN_DEVICE_FUNC ConstRowsBlockXpr	middleRows (Index startRow, Index n) const
template<int N>
EIGEN_DEVICE_FUNC NRowsBlockXpr< N >::Type	middleRows (Index startRow, Index n=N)
template<int N>
EIGEN_DEVICE_FUNC ConstNRowsBlockXpr< N >::Type	middleRows (Index startRow, Index n=N) const
EIGEN_DEVICE_FUNC ColsBlockXpr	leftCols (Index n)
EIGEN_DEVICE_FUNC ConstColsBlockXpr	leftCols (Index n) const
template<int N>
EIGEN_DEVICE_FUNC NColsBlockXpr< N >::Type	leftCols (Index n=N)
template<int N>
EIGEN_DEVICE_FUNC ConstNColsBlockXpr< N >::Type	leftCols (Index n=N) const
EIGEN_DEVICE_FUNC ColsBlockXpr	rightCols (Index n)
EIGEN_DEVICE_FUNC ConstColsBlockXpr	rightCols (Index n) const
template<int N>
EIGEN_DEVICE_FUNC NColsBlockXpr< N >::Type	rightCols (Index n=N)
template<int N>
EIGEN_DEVICE_FUNC ConstNColsBlockXpr< N >::Type	rightCols (Index n=N) const
EIGEN_DEVICE_FUNC ColsBlockXpr	middleCols (Index startCol, Index numCols)
EIGEN_DEVICE_FUNC ConstColsBlockXpr	middleCols (Index startCol, Index numCols) const
template<int N>
EIGEN_DEVICE_FUNC NColsBlockXpr< N >::Type	middleCols (Index startCol, Index n=N)
template<int N>
EIGEN_DEVICE_FUNC ConstNColsBlockXpr< N >::Type	middleCols (Index startCol, Index n=N) const
template<int NRows, int NCols>
EIGEN_DEVICE_FUNC FixedBlockXpr< NRows, NCols > ::Type	block (Index startRow, Index startCol)
template<int NRows, int NCols>
EIGEN_DEVICE_FUNC const ConstFixedBlockXpr< NRows, NCols >::Type	block (Index startRow, Index startCol) const
template<int NRows, int NCols>
FixedBlockXpr< NRows, NCols >::Type	block (Index startRow, Index startCol, Index blockRows, Index blockCols)
template<int NRows, int NCols>
const ConstFixedBlockXpr < NRows, NCols >::Type	block (Index startRow, Index startCol, Index blockRows, Index blockCols) const
EIGEN_DEVICE_FUNC ColXpr	col (Index i)
EIGEN_DEVICE_FUNC ConstColXpr	col (Index i) const
EIGEN_DEVICE_FUNC RowXpr	row (Index i)
EIGEN_DEVICE_FUNC ConstRowXpr	row (Index i) const
EIGEN_DEVICE_FUNC SegmentReturnType	segment (Index start, Index n)
EIGEN_DEVICE_FUNC ConstSegmentReturnType	segment (Index start, Index n) const
EIGEN_DEVICE_FUNC SegmentReturnType	head (Index n)
EIGEN_DEVICE_FUNC ConstSegmentReturnType	head (Index n) const
EIGEN_DEVICE_FUNC SegmentReturnType	tail (Index n)
EIGEN_DEVICE_FUNC ConstSegmentReturnType	tail (Index n) const
template<int N>
EIGEN_DEVICE_FUNC FixedSegmentReturnType< N > ::Type	segment (Index start, Index n=N)
template<int N>
EIGEN_DEVICE_FUNC ConstFixedSegmentReturnType< N > ::Type	segment (Index start, Index n=N) const
template<int N>
EIGEN_DEVICE_FUNC FixedSegmentReturnType< N > ::Type	head (Index n=N)
template<int N>
EIGEN_DEVICE_FUNC ConstFixedSegmentReturnType< N > ::Type	head (Index n=N) const
template<int N>
EIGEN_DEVICE_FUNC FixedSegmentReturnType< N > ::Type	tail (Index n=N)
template<int N>
EIGEN_DEVICE_FUNC ConstFixedSegmentReturnType< N > ::Type	tail (Index n=N) const
template<typename Dest >
EIGEN_DEVICE_FUNC void	evalTo (Dest &) const
template<typename Derived >
bool	isMuchSmallerThan (const typename NumTraits< Scalar >::Real &other, const RealScalar &prec) const
template<typename Func >
internal::traits< Derived >::Scalar	redux (const Func &func) const
Static Public Member Functions
static EIGEN_DEVICE_FUNC const ConstantReturnType	Constant (Index rows, Index cols, const Scalar &value)
static EIGEN_DEVICE_FUNC const ConstantReturnType	Constant (Index size, const Scalar &value)
static EIGEN_DEVICE_FUNC const ConstantReturnType	Constant (const Scalar &value)
static EIGEN_DEVICE_FUNC const SequentialLinSpacedReturnType	LinSpaced (Sequential_t, Index size, const Scalar &low, const Scalar &high)
	Sets a linearly spaced vector.
static EIGEN_DEVICE_FUNC const RandomAccessLinSpacedReturnType	LinSpaced (Index size, const Scalar &low, const Scalar &high)
	Sets a linearly spaced vector.
static EIGEN_DEVICE_FUNC const SequentialLinSpacedReturnType	LinSpaced (Sequential_t, const Scalar &low, const Scalar &high)
static EIGEN_DEVICE_FUNC const RandomAccessLinSpacedReturnType	LinSpaced (const Scalar &low, const Scalar &high)
template<typename CustomNullaryOp >
static EIGEN_DEVICE_FUNC const CwiseNullaryOp < CustomNullaryOp, PlainObject >	NullaryExpr (Index rows, Index cols, const CustomNullaryOp &func)
template<typename CustomNullaryOp >
static EIGEN_DEVICE_FUNC const CwiseNullaryOp < CustomNullaryOp, PlainObject >	NullaryExpr (Index size, const CustomNullaryOp &func)
template<typename CustomNullaryOp >
static EIGEN_DEVICE_FUNC const CwiseNullaryOp < CustomNullaryOp, PlainObject >	NullaryExpr (const CustomNullaryOp &func)
static EIGEN_DEVICE_FUNC const ConstantReturnType	Zero (Index rows, Index cols)
static EIGEN_DEVICE_FUNC const ConstantReturnType	Zero (Index size)
static EIGEN_DEVICE_FUNC const ConstantReturnType	Zero ()
static EIGEN_DEVICE_FUNC const ConstantReturnType	Ones (Index rows, Index cols)
static EIGEN_DEVICE_FUNC const ConstantReturnType	Ones (Index size)
static EIGEN_DEVICE_FUNC const ConstantReturnType	Ones ()
static const RandomReturnType	Random (Index rows, Index cols)
static const RandomReturnType	Random (Index size)
static const RandomReturnType	Random ()
Protected Member Functions
EIGEN_DEVICE_FUNC	DenseBase ()
Private Member Functions
EIGEN_DEVICE_FUNC	DenseBase (int)
EIGEN_DEVICE_FUNC	DenseBase (int, int)
template<typename OtherDerived >
EIGEN_DEVICE_FUNC	DenseBase (const DenseBase< OtherDerived > &)
Related Functions
(Note that these are not member functions.)
template<typename Derived >
std::ostream &	operator<< (std::ostream &s, const DenseBase< Derived > &m)

Detailed Description

template<typename Derived>
class Eigen::DenseBase< Derived >

Base class for all dense matrices, vectors, and arrays.

This class is the base that is inherited by all dense objects (matrix, vector, arrays, and related expression types). The common Eigen API for dense objects is contained in this class.

Template Parameters:

Derived is the derived type, e.g., a matrix type or an expression.

This class can be extended with the help of the plugin mechanism described on the page TopicCustomizingEigen by defining the preprocessor symbol EIGEN_DENSEBASE_PLUGIN.

See also:: TopicClassHierarchy

Definition at line 41 of file DenseBase.h.

Member Typedef Documentation

template<typename Derived>

typedef internal::special_scalar_op_base<Derived,Scalar,RealScalar, DenseCoeffsBase<Derived> > Eigen::DenseBase< Derived >::Base

Reimplemented in Eigen::MatrixWrapper< ExpressionType >, Eigen::SolveImpl< Decomposition, RhsType, Dense >, Eigen::Homogeneous< MatrixType, _Direction >, Eigen::MatrixBase< Derived >, Eigen::MatrixBase< MatrixWrapper< ExpressionType > >, Eigen::MatrixBase< Homogeneous< MatrixType, _Direction > >, Eigen::MatrixBase< Solve< Decomposition, RhsType > >, Eigen::ArrayBase< Derived >, Eigen::ArrayBase< ArrayWrapper< ExpressionType > >, and Eigen::ArrayWrapper< ExpressionType >.

Definition at line 76 of file DenseBase.h.

template<typename Derived>

typedef Block<Derived> Eigen::DenseBase< Derived >::BlockXpr

expression of a block

Definition at line 33 of file DenseBase.h.

template<typename Derived>

typedef Base::CoeffReturnType Eigen::DenseBase< Derived >::CoeffReturnType

Reimplemented in Eigen::MatrixBase< Derived >, Eigen::MatrixBase< MatrixWrapper< ExpressionType > >, Eigen::MatrixBase< Homogeneous< MatrixType, _Direction > >, Eigen::MatrixBase< Solve< Decomposition, RhsType > >, Eigen::ArrayBase< Derived >, and Eigen::ArrayBase< ArrayWrapper< ExpressionType > >.

Definition at line 100 of file DenseBase.h.

template<typename Derived>

typedef Block<Derived, internal::traits<Derived>::RowsAtCompileTime, Dynamic, !IsRowMajor> Eigen::DenseBase< Derived >::ColsBlockXpr

expression type of a block of whole columns

Definition at line 21 of file DenseBase.h.

template<typename Derived>

typedef VectorwiseOp<Derived, Vertical> Eigen::DenseBase< Derived >::ColwiseReturnType

Definition at line 487 of file DenseBase.h.

template<typename Derived>

typedef Block<Derived, internal::traits<Derived>::RowsAtCompileTime, 1, !IsRowMajor> Eigen::DenseBase< Derived >::ColXpr

expression type of a column

Reimplemented in Eigen::MatrixBase< Derived >, Eigen::MatrixBase< MatrixWrapper< ExpressionType > >, Eigen::MatrixBase< Homogeneous< MatrixType, _Direction > >, and Eigen::MatrixBase< Solve< Decomposition, RhsType > >.

Definition at line 15 of file DenseBase.h.

template<typename Derived>

typedef CwiseNullaryOp<internal::scalar_constant_op<Scalar>,PlainObject> Eigen::DenseBase< Derived >::ConstantReturnType

Represents a matrix with all coefficients equal to one another

Reimplemented in Eigen::MatrixBase< Derived >, Eigen::MatrixBase< MatrixWrapper< ExpressionType > >, Eigen::MatrixBase< Homogeneous< MatrixType, _Direction > >, Eigen::MatrixBase< Solve< Decomposition, RhsType > >, Eigen::ArrayBase< Derived >, and Eigen::ArrayBase< ArrayWrapper< ExpressionType > >.

Definition at line 266 of file DenseBase.h.

template<typename Derived>

typedef const Block<const Derived> Eigen::DenseBase< Derived >::ConstBlockXpr

Definition at line 34 of file DenseBase.h.

template<typename Derived>

typedef const Block<const Derived, internal::traits<Derived>::RowsAtCompileTime, Dynamic, !IsRowMajor> Eigen::DenseBase< Derived >::ConstColsBlockXpr

Definition at line 22 of file DenseBase.h.

template<typename Derived>

typedef const VectorwiseOp<const Derived, Vertical> Eigen::DenseBase< Derived >::ConstColwiseReturnType

Definition at line 488 of file DenseBase.h.

template<typename Derived>

typedef const Block<const Derived, internal::traits<Derived>::RowsAtCompileTime, 1, !IsRowMajor> Eigen::DenseBase< Derived >::ConstColXpr

Definition at line 16 of file DenseBase.h.

template<typename Derived>

typedef const Reverse<const Derived, BothDirections> Eigen::DenseBase< Derived >::ConstReverseReturnType

Definition at line 554 of file DenseBase.h.

template<typename Derived>

typedef const Block<const Derived, Dynamic, internal::traits<Derived>::ColsAtCompileTime, IsRowMajor> Eigen::DenseBase< Derived >::ConstRowsBlockXpr

Definition at line 25 of file DenseBase.h.

template<typename Derived>

typedef const VectorwiseOp<const Derived, Horizontal> Eigen::DenseBase< Derived >::ConstRowwiseReturnType

Definition at line 486 of file DenseBase.h.

template<typename Derived>

typedef const Block<const Derived, 1, internal::traits<Derived>::ColsAtCompileTime, IsRowMajor> Eigen::DenseBase< Derived >::ConstRowXpr

Definition at line 19 of file DenseBase.h.

template<typename Derived>

typedef const VectorBlock<const Derived> Eigen::DenseBase< Derived >::ConstSegmentReturnType

Definition at line 40 of file DenseBase.h.

template<typename Derived>

typedef internal::add_const<Transpose<const Derived> >::type Eigen::DenseBase< Derived >::ConstTransposeReturnType

Reimplemented in Eigen::MatrixBase< Derived >, Eigen::MatrixBase< MatrixWrapper< ExpressionType > >, Eigen::MatrixBase< Homogeneous< MatrixType, _Direction > >, and Eigen::MatrixBase< Solve< Decomposition, RhsType > >.

Definition at line 326 of file DenseBase.h.

template<typename Derived>

typedef Matrix<typename NumTraits<typename internal::traits<Derived>::Scalar>::Real, internal::traits<Derived>::ColsAtCompileTime, 1> Eigen::DenseBase< Derived >::EigenvaluesReturnType

the return type of MatrixBase::eigenvalues()

Reimplemented in Eigen::MatrixBase< Derived >, Eigen::MatrixBase< MatrixWrapper< ExpressionType > >, Eigen::MatrixBase< Homogeneous< MatrixType, _Direction > >, and Eigen::MatrixBase< Solve< Decomposition, RhsType > >.

Definition at line 272 of file DenseBase.h.

template<typename Derived>

typedef internal::add_const_on_value_type<typename internal::eval<Derived>::type>::type Eigen::DenseBase< Derived >::EvalReturnType

Definition at line 396 of file DenseBase.h.

template<typename Derived>

typedef Eigen::InnerIterator<Derived> Eigen::DenseBase< Derived >::InnerIterator

Inner iterator type to iterate over the coefficients of a row or column.

See also:: class InnerIterator

Definition at line 55 of file DenseBase.h.

template<typename Derived>

typedef internal::find_best_packet<Scalar,SizeAtCompileTime>::type Eigen::DenseBase< Derived >::PacketScalar

Reimplemented in Eigen::MatrixBase< Derived >, Eigen::MatrixBase< MatrixWrapper< ExpressionType > >, Eigen::MatrixBase< Homogeneous< MatrixType, _Direction > >, Eigen::MatrixBase< Solve< Decomposition, RhsType > >, Eigen::ArrayBase< Derived >, and Eigen::ArrayBase< ArrayWrapper< ExpressionType > >.

Definition at line 178 of file DenseBase.h.

template<typename Derived>

typedef Array<typename internal::traits<Derived>::Scalar, internal::traits<Derived>::RowsAtCompileTime, internal::traits<Derived>::ColsAtCompileTime, AutoAlign | (internal::traits<Derived>::Flags&RowMajorBit ? RowMajor : ColMajor), internal::traits<Derived>::MaxRowsAtCompileTime, internal::traits<Derived>::MaxColsAtCompileTime > Eigen::DenseBase< Derived >::PlainArray

The plain array type corresponding to this expression.

See also:: PlainObject

Definition at line 200 of file DenseBase.h.

template<typename Derived>

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

The plain matrix type corresponding to this expression.

See also:: PlainObject

Definition at line 190 of file DenseBase.h.

template<typename Derived>

typedef internal::conditional<internal::is_same<typename internal::traits<Derived>::XprKind,MatrixXpr >::value, PlainMatrix, PlainArray>::type Eigen::DenseBase< Derived >::PlainObject

The plain matrix or array type corresponding to this expression.

This is not necessarily exactly the return type of eval(). In the case of plain matrices, the return type of eval() is a const reference to a matrix, not a matrix! It is however guaranteed that the return type of eval() is either PlainObject or const PlainObject&.

Reimplemented in Eigen::MatrixBase< Derived >, Eigen::MatrixBase< MatrixWrapper< ExpressionType > >, Eigen::MatrixBase< Homogeneous< MatrixType, _Direction > >, Eigen::MatrixBase< Solve< Decomposition, RhsType > >, Eigen::ArrayBase< Derived >, and Eigen::ArrayBase< ArrayWrapper< ExpressionType > >.

Definition at line 209 of file DenseBase.h.

template<typename Derived>

typedef CwiseNullaryOp<internal::linspaced_op<Scalar,PacketScalar,true>,PlainObject> Eigen::DenseBase< Derived >::RandomAccessLinSpacedReturnType

Represents a vector with linearly spaced coefficients that allows random access.

Definition at line 270 of file DenseBase.h.

template<typename Derived>

typedef CwiseNullaryOp<internal::scalar_random_op<Scalar>,PlainObject> Eigen::DenseBase< Derived >::RandomReturnType

Definition at line 515 of file DenseBase.h.

template<typename Derived>

typedef NumTraits<Scalar>::Real Eigen::DenseBase< Derived >::RealScalar

Reimplemented in Eigen::MatrixBase< Derived >, Eigen::MatrixBase< MatrixWrapper< ExpressionType > >, Eigen::MatrixBase< Homogeneous< MatrixType, _Direction > >, Eigen::MatrixBase< Solve< Decomposition, RhsType > >, Eigen::ArrayBase< Derived >, and Eigen::ArrayBase< ArrayWrapper< ExpressionType > >.

Definition at line 75 of file DenseBase.h.

template<typename Derived>

typedef Reverse<Derived, BothDirections> Eigen::DenseBase< Derived >::ReverseReturnType

Definition at line 553 of file DenseBase.h.

template<typename Derived>

typedef Block<Derived, Dynamic, internal::traits<Derived>::ColsAtCompileTime, IsRowMajor> Eigen::DenseBase< Derived >::RowsBlockXpr

expression type of a block of whole rows

Definition at line 24 of file DenseBase.h.

template<typename Derived>

typedef VectorwiseOp<Derived, Horizontal> Eigen::DenseBase< Derived >::RowwiseReturnType

Definition at line 485 of file DenseBase.h.

template<typename Derived>

typedef Block<Derived, 1, internal::traits<Derived>::ColsAtCompileTime, IsRowMajor> Eigen::DenseBase< Derived >::RowXpr

expression type of a row

Reimplemented in Eigen::MatrixBase< Derived >, Eigen::MatrixBase< MatrixWrapper< ExpressionType > >, Eigen::MatrixBase< Homogeneous< MatrixType, _Direction > >, and Eigen::MatrixBase< Solve< Decomposition, RhsType > >.

Definition at line 18 of file DenseBase.h.

template<typename Derived>

typedef internal::traits<Derived>::Scalar Eigen::DenseBase< Derived >::Scalar

The numeric type of the expression' coefficients, e.g. float, double, int or std::complex<float>, etc.

Reimplemented in Eigen::MatrixBase< Derived >, Eigen::MatrixBase< MatrixWrapper< ExpressionType > >, Eigen::MatrixBase< Homogeneous< MatrixType, _Direction > >, Eigen::MatrixBase< Solve< Decomposition, RhsType > >, Eigen::ArrayBase< Derived >, and Eigen::ArrayBase< ArrayWrapper< ExpressionType > >.

Definition at line 68 of file DenseBase.h.

template<typename Derived>

typedef VectorBlock<Derived> Eigen::DenseBase< Derived >::SegmentReturnType

Definition at line 39 of file DenseBase.h.

template<typename Derived>

typedef CwiseNullaryOp<internal::linspaced_op<Scalar,PacketScalar,false>,PlainObject> Eigen::DenseBase< Derived >::SequentialLinSpacedReturnType

Represents a vector with linearly spaced coefficients that allows sequential access only.

Definition at line 268 of file DenseBase.h.

template<typename Derived>

typedef internal::traits<Derived>::StorageIndex Eigen::DenseBase< Derived >::StorageIndex

The type used to store indices.

This typedef is relevant for types that store multiple indices such as PermutationMatrix or Transpositions, otherwise it defaults to Eigen::Index

See also:: TopicPreprocessorDirectives, Eigen::Index, SparseMatrixBase.

Reimplemented in Eigen::MatrixBase< Derived >, Eigen::MatrixBase< MatrixWrapper< ExpressionType > >, Eigen::MatrixBase< Homogeneous< MatrixType, _Direction > >, and Eigen::MatrixBase< Solve< Decomposition, RhsType > >.

Definition at line 65 of file DenseBase.h.

template<typename Derived>

typedef internal::traits<Derived>::StorageKind Eigen::DenseBase< Derived >::StorageKind

Reimplemented in Eigen::MatrixBase< Derived >, Eigen::MatrixBase< MatrixWrapper< ExpressionType > >, Eigen::MatrixBase< Homogeneous< MatrixType, _Direction > >, Eigen::MatrixBase< Solve< Decomposition, RhsType > >, Eigen::ArrayBase< Derived >, and Eigen::ArrayBase< ArrayWrapper< ExpressionType > >.

Definition at line 57 of file DenseBase.h.

template<typename Derived>

typedef Transpose<Derived> Eigen::DenseBase< Derived >::TransposeReturnType

Definition at line 323 of file DenseBase.h.

template<typename Derived>

typedef Scalar Eigen::DenseBase< Derived >::value_type

The numeric type of the expression' coefficients, e.g. float, double, int or std::complex<float>, etc.

It is an alias for the Scalar type

Definition at line 73 of file DenseBase.h.

Member Enumeration Documentation

template<typename Derived>

anonymous enum

Enumerator:

RowsAtCompileTime	The number of rows at compile-time. This is just a copy of the value provided by the Derived type. If a value is not known at compile-time, it is set to the Dynamic constant. See also: MatrixBase::rows(), MatrixBase::cols(), ColsAtCompileTime, SizeAtCompileTime
ColsAtCompileTime	The number of columns at compile-time. This is just a copy of the value provided by the Derived type. If a value is not known at compile-time, it is set to the Dynamic constant. See also: MatrixBase::rows(), MatrixBase::cols(), RowsAtCompileTime, SizeAtCompileTime
SizeAtCompileTime	This is equal to the number of coefficients, i.e. the number of rows times the number of columns, or to Dynamic if this is not known at compile-time. See also: RowsAtCompileTime, ColsAtCompileTime
MaxRowsAtCompileTime	This value is equal to the maximum possible number of rows that this expression might have. If this expression might have an arbitrarily high number of rows, this value is set to Dynamic. This value is useful to know when evaluating an expression, in order to determine whether it is possible to avoid doing a dynamic memory allocation. See also: RowsAtCompileTime, MaxColsAtCompileTime, MaxSizeAtCompileTime
MaxColsAtCompileTime	This value is equal to the maximum possible number of columns that this expression might have. If this expression might have an arbitrarily high number of columns, this value is set to Dynamic. This value is useful to know when evaluating an expression, in order to determine whether it is possible to avoid doing a dynamic memory allocation. See also: ColsAtCompileTime, MaxRowsAtCompileTime, MaxSizeAtCompileTime
MaxSizeAtCompileTime	This value is equal to the maximum possible number of coefficients that this expression might have. If this expression might have an arbitrarily high number of coefficients, this value is set to Dynamic. This value is useful to know when evaluating an expression, in order to determine whether it is possible to avoid doing a dynamic memory allocation. See also: SizeAtCompileTime, MaxRowsAtCompileTime, MaxColsAtCompileTime
IsVectorAtCompileTime	This is set to true if either the number of rows or the number of columns is known at compile-time to be equal to 1. Indeed, in that case, we are dealing with a column-vector (if there is only one column) or with a row-vector (if there is only one row).
Flags	This stores expression Flags flags which may or may not be inherited by new expressions constructed from this one. See the list of flags.
IsRowMajor	True if this expression has row-major storage order.
InnerSizeAtCompileTime
InnerStrideAtCompileTime
OuterStrideAtCompileTime

Definition at line 102 of file DenseBase.h.

         {

      RowsAtCompileTime = internal::traits<Derived>::RowsAtCompileTime,
      ColsAtCompileTime = internal::traits<Derived>::ColsAtCompileTime,
      SizeAtCompileTime = (internal::size_at_compile_time<internal::traits<Derived>::RowsAtCompileTime,
                                                   internal::traits<Derived>::ColsAtCompileTime>::ret),
      MaxRowsAtCompileTime = internal::traits<Derived>::MaxRowsAtCompileTime,
      MaxColsAtCompileTime = internal::traits<Derived>::MaxColsAtCompileTime,
      MaxSizeAtCompileTime = (internal::size_at_compile_time<internal::traits<Derived>::MaxRowsAtCompileTime,
                                                      internal::traits<Derived>::MaxColsAtCompileTime>::ret),
      IsVectorAtCompileTime = internal::traits<Derived>::MaxRowsAtCompileTime == 1
                           || internal::traits<Derived>::MaxColsAtCompileTime == 1,
      Flags = internal::traits<Derived>::Flags,
      IsRowMajor = int(Flags) & RowMajorBit, 
      InnerSizeAtCompileTime = int(IsVectorAtCompileTime) ? int(SizeAtCompileTime)
                             : int(IsRowMajor) ? int(ColsAtCompileTime) : int(RowsAtCompileTime),

      InnerStrideAtCompileTime = internal::inner_stride_at_compile_time<Derived>::ret,
      OuterStrideAtCompileTime = internal::outer_stride_at_compile_time<Derived>::ret
    };

template<typename Derived>

anonymous enum

Enumerator:

IsPlainObjectBase

Definition at line 180 of file DenseBase.h.

{ IsPlainObjectBase = 0 };

Constructor & Destructor Documentation

template<typename Derived>

EIGEN_DEVICE_FUNC Eigen::DenseBase< Derived >::DenseBase ( ) [inline, protected]

Default constructor. Do nothing.

Definition at line 582 of file DenseBase.h.

    {
      /* Just checks for self-consistency of the flags.
       * Only do it when debugging Eigen, as this borders on paranoiac and could slow compilation down
       */
#ifdef EIGEN_INTERNAL_DEBUGGING
      EIGEN_STATIC_ASSERT((EIGEN_IMPLIES(MaxRowsAtCompileTime==1 && MaxColsAtCompileTime!=1, int(IsRowMajor))
                        && EIGEN_IMPLIES(MaxColsAtCompileTime==1 && MaxRowsAtCompileTime!=1, int(!IsRowMajor))),
                          INVALID_STORAGE_ORDER_FOR_THIS_VECTOR_EXPRESSION)
#endif
    }

template<typename Derived>

EIGEN_DEVICE_FUNC Eigen::DenseBase< Derived >::DenseBase ( int ) [explicit, private]

template<typename Derived>

EIGEN_DEVICE_FUNC Eigen::DenseBase< Derived >::DenseBase	(	int	,
		int
	)		`[private]`

template<typename Derived>

template<typename OtherDerived >

EIGEN_DEVICE_FUNC Eigen::DenseBase< Derived >::DenseBase ( const DenseBase< OtherDerived > & ) [explicit, private]

Member Function Documentation

template<typename Derived >

bool Eigen::DenseBase< Derived >::all ( ) const [inline]

Returns:: true if all coefficients are true

Example:

Output:

See also:: any(), Cwise::operator<()

Definition at line 81 of file BooleanRedux.h.

{
  typedef internal::evaluator<Derived> Evaluator;
  enum {
    unroll = SizeAtCompileTime != Dynamic
          && SizeAtCompileTime * (Evaluator::CoeffReadCost + NumTraits<Scalar>::AddCost) <= EIGEN_UNROLLING_LIMIT
  };
  Evaluator evaluator(derived());
  if(unroll)
    return internal::all_unroller<Evaluator, unroll ? int(SizeAtCompileTime) : Dynamic>::run(evaluator);
  else
  {
    for(Index j = 0; j < cols(); ++j)
      for(Index i = 0; i < rows(); ++i)
        if (!evaluator.coeff(i, j)) return false;
    return true;
  }
}

template<typename Derived >

bool Eigen::DenseBase< Derived >::allFinite ( ) const [inline]

Returns:: true if *this contains only finite numbers, i.e., no NaN and no +/-INF values.

See also:: hasNaN()

Definition at line 153 of file BooleanRedux.h.

{
#if EIGEN_COMP_MSVC || (defined __FAST_MATH__)
  return derived().array().isFinite().all();
#else
  return !((derived()-derived()).hasNaN());
#endif
}

template<typename Derived >

bool Eigen::DenseBase< Derived >::any ( ) const [inline]

Returns:: true if at least one coefficient is true

See also:: all()

Definition at line 105 of file BooleanRedux.h.

{
  typedef internal::evaluator<Derived> Evaluator;
  enum {
    unroll = SizeAtCompileTime != Dynamic
          && SizeAtCompileTime * (Evaluator::CoeffReadCost + NumTraits<Scalar>::AddCost) <= EIGEN_UNROLLING_LIMIT
  };
  Evaluator evaluator(derived());
  if(unroll)
    return internal::any_unroller<Evaluator, unroll ? int(SizeAtCompileTime) : Dynamic>::run(evaluator);
  else
  {
    for(Index j = 0; j < cols(); ++j)
      for(Index i = 0; i < rows(); ++i)
        if (evaluator.coeff(i, j)) return true;
    return false;
  }
}

template<typename Derived>

EIGEN_DEVICE_FUNC BlockXpr Eigen::DenseBase< Derived >::block	(	Index	startRow,
		Index	startCol,
		Index	blockRows,
		Index	blockCols
	)		`[inline]`

Returns:: a dynamic-size expression of a block in *this.

Parameters:

startRow	the first row in the block
startCol	the first column in the block
blockRows	the number of rows in the block
blockCols	the number of columns in the block

Example:

Output:

Note:: Even though the returned expression has dynamic size, in the case when it is applied to a fixed-size matrix, it inherits a fixed maximal size, which means that evaluating it does not cause a dynamic memory allocation.

See also:: class Block, block(Index,Index)

Definition at line 63 of file DenseBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const ConstBlockXpr Eigen::DenseBase< Derived >::block	(	Index	startRow,
		Index	startCol,
		Index	blockRows,
		Index	blockCols
	)		const `[inline]`

This is the const version of block(Index,Index,Index,Index).

Definition at line 70 of file DenseBase.h.

template<typename Derived>

template<int NRows, int NCols>

EIGEN_DEVICE_FUNC FixedBlockXpr<NRows,NCols>::Type Eigen::DenseBase< Derived >::block	(	Index	startRow,
		Index	startCol
	)		`[inline]`

Returns:: a fixed-size expression of a block in *this.

The template parameters NRows and NCols are the number of rows and columns in the block.

Parameters:

startRow	the first row in the block
startCol	the first column in the block

Example:

Output:

Note:

since block is a templated member, the keyword template has to be used if the matrix type is also a template parameter:

 m.template block<3,3>(1,1);

See also:: class Block, block(Index,Index,Index,Index)

Definition at line 729 of file DenseBase.h.

template<typename Derived>

template<int NRows, int NCols>

EIGEN_DEVICE_FUNC const ConstFixedBlockXpr<NRows,NCols>::Type Eigen::DenseBase< Derived >::block	(	Index	startRow,
		Index	startCol
	)		const `[inline]`

This is the const version of block<>(Index, Index).

Definition at line 737 of file DenseBase.h.

template<typename Derived>

template<int NRows, int NCols>

FixedBlockXpr<NRows,NCols>::Type Eigen::DenseBase< Derived >::block	(	Index	startRow,
		Index	startCol,
		Index	blockRows,
		Index	blockCols
	)		`[inline]`

Returns:: an expression of a block in *this.

Template Parameters:

NRows	number of rows in block as specified at compile-time
NCols	number of columns in block as specified at compile-time

Parameters:

startRow	the first row in the block
startCol	the first column in the block
blockRows	number of rows in block as specified at run-time
blockCols	number of columns in block as specified at run-time

This function is mainly useful for blocks where the number of rows is specified at compile-time and the number of columns is specified at run-time, or vice versa. The compile-time and run-time information should not contradict. In other words, blockRows should equal NRows unless NRows is Dynamic, and the same for the number of columns.

Example:

Output:

See also:: class Block, block(Index,Index,Index,Index)

Definition at line 762 of file DenseBase.h.

template<typename Derived>

template<int NRows, int NCols>

const ConstFixedBlockXpr<NRows,NCols>::Type Eigen::DenseBase< Derived >::block	(	Index	startRow,
		Index	startCol,
		Index	blockRows,
		Index	blockCols
	)		const `[inline]`

This is the const version of block<>(Index, Index, Index, Index).

Definition at line 770 of file DenseBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC BlockXpr Eigen::DenseBase< Derived >::bottomLeftCorner	(	Index	cRows,
		Index	cCols
	)		`[inline]`

Returns:: a dynamic-size expression of a bottom-left corner of *this.

Parameters:

cRows	the number of rows in the corner
cCols	the number of columns in the corner

Example:

Output:

See also:: class Block, block(Index,Index,Index,Index)

Definition at line 327 of file DenseBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const ConstBlockXpr Eigen::DenseBase< Derived >::bottomLeftCorner	(	Index	cRows,
		Index	cCols
	)		const `[inline]`

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

Definition at line 334 of file DenseBase.h.

template<typename Derived>

template<int CRows, int CCols>

EIGEN_DEVICE_FUNC FixedBlockXpr<CRows,CCols>::Type Eigen::DenseBase< Derived >::bottomLeftCorner ( ) [inline]

Returns:: an expression of a fixed-size bottom-left corner of *this.

The template parameters CRows and CCols are the number of rows and columns in the corner.

Example:

Output:

See also:: class Block, block(Index,Index,Index,Index)

Definition at line 350 of file DenseBase.h.

template<typename Derived>

template<int CRows, int CCols>

EIGEN_DEVICE_FUNC const ConstFixedBlockXpr<CRows,CCols>::Type Eigen::DenseBase< Derived >::bottomLeftCorner ( ) const [inline]

This is the const version of bottomLeftCorner<int, int>().

Definition at line 358 of file DenseBase.h.

template<typename Derived>

template<int CRows, int CCols>

FixedBlockXpr<CRows,CCols>::Type Eigen::DenseBase< Derived >::bottomLeftCorner	(	Index	cRows,
		Index	cCols
	)		`[inline]`

Returns:: an expression of a bottom-left corner of *this.

Template Parameters:

CRows	number of rows in corner as specified at compile-time
CCols	number of columns in corner as specified at compile-time

Parameters:

cRows	number of rows in corner as specified at run-time
cCols	number of columns in corner as specified at run-time

This function is mainly useful for corners where the number of rows is specified at compile-time and the number of columns is specified at run-time, or vice versa. The compile-time and run-time information should not contradict. In other words, cRows should equal CRows unless CRows is Dynamic, and the same for the number of columns.

Example:

Output:

See also:: class Block

Definition at line 381 of file DenseBase.h.

template<typename Derived>

template<int CRows, int CCols>

const ConstFixedBlockXpr<CRows,CCols>::Type Eigen::DenseBase< Derived >::bottomLeftCorner	(	Index	cRows,
		Index	cCols
	)		const `[inline]`

This is the const version of bottomLeftCorner<int, int>(Index, Index).

Definition at line 388 of file DenseBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC BlockXpr Eigen::DenseBase< Derived >::bottomRightCorner	(	Index	cRows,
		Index	cCols
	)		`[inline]`

Returns:: a dynamic-size expression of a bottom-right corner of *this.

Parameters:

cRows	the number of rows in the corner
cCols	the number of columns in the corner

Example:

Output:

See also:: class Block, block(Index,Index,Index,Index)

Definition at line 248 of file DenseBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const ConstBlockXpr Eigen::DenseBase< Derived >::bottomRightCorner	(	Index	cRows,
		Index	cCols
	)		const `[inline]`

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

Definition at line 255 of file DenseBase.h.

    {
      EIGEN_ONLY_USED_FOR_DEBUG(p_rows);

template<typename Derived>

template<int CRows, int CCols>

EIGEN_DEVICE_FUNC FixedBlockXpr<CRows,CCols>::Type Eigen::DenseBase< Derived >::bottomRightCorner ( ) [inline]

Returns:: an expression of a fixed-size bottom-right corner of *this.

The template parameters CRows and CCols are the number of rows and columns in the corner.

Example:

Output:

See also:: class Block, block(Index,Index,Index,Index)

Definition at line 271 of file DenseBase.h.

    { return derived(); }

template<typename Derived>

template<int CRows, int CCols>

EIGEN_DEVICE_FUNC const ConstFixedBlockXpr<CRows,CCols>::Type Eigen::DenseBase< Derived >::bottomRightCorner ( ) const [inline]

This is the const version of bottomRightCorner<int, int>().

Definition at line 279 of file DenseBase.h.

    { return derived(); }

template<typename Derived>

template<int CRows, int CCols>

FixedBlockXpr<CRows,CCols>::Type Eigen::DenseBase< Derived >::bottomRightCorner	(	Index	cRows,
		Index	cCols
	)		`[inline]`

Returns:: an expression of a bottom-right corner of *this.

Template Parameters:

CRows	number of rows in corner as specified at compile-time
CCols	number of columns in corner as specified at compile-time

Parameters:

cRows	number of rows in corner as specified at run-time
cCols	number of columns in corner as specified at run-time

This function is mainly useful for corners where the number of rows is specified at compile-time and the number of columns is specified at run-time, or vice versa. The compile-time and run-time information should not contradict. In other words, cRows should equal CRows unless CRows is Dynamic, and the same for the number of columns.

Example:

Output:

See also:: class Block

Definition at line 302 of file DenseBase.h.

    { return derived(); }

template<typename Derived>

template<int CRows, int CCols>

const ConstFixedBlockXpr<CRows,CCols>::Type Eigen::DenseBase< Derived >::bottomRightCorner	(	Index	cRows,
		Index	cCols
	)		const `[inline]`

This is the const version of bottomRightCorner<int, int>(Index, Index).

Definition at line 309 of file DenseBase.h.

    { return derived(); }

template<typename Derived>

EIGEN_DEVICE_FUNC RowsBlockXpr Eigen::DenseBase< Derived >::bottomRows ( Index n ) [inline]

Returns:: a block consisting of the bottom rows of *this.

Parameters:

n	the number of rows in the block

Example:

Output:

See also:: class Block, block(Index,Index,Index,Index)

Definition at line 457 of file DenseBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC ConstRowsBlockXpr Eigen::DenseBase< Derived >::bottomRows ( Index n ) const [inline]

This is the const version of bottomRows(Index).

Definition at line 464 of file DenseBase.h.

template<typename Derived>

template<int N>

EIGEN_DEVICE_FUNC NRowsBlockXpr<N>::Type Eigen::DenseBase< Derived >::bottomRows ( Index n = N ) [inline]

Returns:: a block consisting of the bottom rows of *this.

Template Parameters:

N	the number of rows in the block as specified at compile-time

Parameters:

n	the number of rows in the block as specified at run-time

The compile-time and run-time information should not contradict. In other words, n should equal N unless N is Dynamic.

Example:

Output:

See also:: class Block, block(Index,Index,Index,Index)

Definition at line 484 of file DenseBase.h.

template<typename Derived>

template<int N>

EIGEN_DEVICE_FUNC ConstNRowsBlockXpr<N>::Type Eigen::DenseBase< Derived >::bottomRows ( Index n = N ) const [inline]

This is the const version of bottomRows<int>().

Definition at line 492 of file DenseBase.h.

             : \include MatrixBase_rowwise.cpp
    * Output: \verbinclude MatrixBase_rowwise.out
    *
    * \sa colwise(), class VectorwiseOp, \ref TutorialReductionsVisitorsBroadcasting

template<typename Derived>

EIGEN_DEVICE_FUNC ColXpr Eigen::DenseBase< Derived >::col ( Index i ) [inline]

Returns:: an expression of the i-th column of *this. Note that the numbering starts at 0.

Example:

Output:

See also:: row(), class Block

Definition at line 783 of file DenseBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC ConstColXpr Eigen::DenseBase< Derived >::col ( Index i ) const [inline]

This is the const version of col().

Definition at line 790 of file DenseBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC ConstColwiseReturnType Eigen::DenseBase< Derived >::colwise ( ) const [inline]

Returns:: a VectorwiseOp wrapper of *this providing additional partial reduction operations

Example:

Output:

See also:: rowwise(), class VectorwiseOp, TutorialReductionsVisitorsBroadcasting

Definition at line 510 of file DenseBase.h.

                                                                    {
      return ConstColwiseReturnType(derived());
    }

template<typename Derived >

DenseBase< Derived >::ColwiseReturnType Eigen::DenseBase< Derived >::colwise ( ) [inline]

Returns:: a writable VectorwiseOp wrapper of *this providing additional partial reduction operations

See also:: rowwise(), class VectorwiseOp, TutorialReductionsVisitorsBroadcasting

Definition at line 663 of file VectorwiseOp.h.

{
  return ColwiseReturnType(derived());
}

template<typename Derived >

EIGEN_STRONG_INLINE const DenseBase< Derived >::ConstantReturnType Eigen::DenseBase< Derived >::Constant	(	Index	rows,
		Index	cols,
		const Scalar &	value
	)		`[static]`

Returns:: an expression of a constant matrix of value value

The parameters rows and cols are the number of rows and of columns of the returned matrix. Must be compatible with this DenseBase type.

This variant is meant to be used for dynamic-size matrix types. For fixed-size types, it is redundant to pass rows and cols as arguments, so Zero() should be used instead.

The template parameter CustomNullaryOp is the type of the functor.

See also:: class CwiseNullaryOp

Definition at line 181 of file CwiseNullaryOp.h.

{
  return DenseBase<Derived>::NullaryExpr(rows, cols, internal::scalar_constant_op<Scalar>(value));
}

template<typename Derived >

EIGEN_STRONG_INLINE const DenseBase< Derived >::ConstantReturnType Eigen::DenseBase< Derived >::Constant	(	Index	size,
		const Scalar &	value
	)		`[static]`

Returns:: an expression of a constant matrix of value value

The parameter size is the size of the returned vector. Must be compatible with this DenseBase type.

This variant is meant to be used for dynamic-size vector types. For fixed-size types, it is redundant to pass size as argument, so Zero() should be used instead.

The template parameter CustomNullaryOp is the type of the functor.

See also:: class CwiseNullaryOp

Definition at line 203 of file CwiseNullaryOp.h.

{
  return DenseBase<Derived>::NullaryExpr(size, internal::scalar_constant_op<Scalar>(value));
}

template<typename Derived >

EIGEN_STRONG_INLINE const DenseBase< Derived >::ConstantReturnType Eigen::DenseBase< Derived >::Constant ( const Scalar & value ) [static]

Returns:: an expression of a constant matrix of value value

This variant is only for fixed-size DenseBase types. For dynamic-size types, you need to use the variants taking size arguments.

The template parameter CustomNullaryOp is the type of the functor.

See also:: class CwiseNullaryOp

Definition at line 219 of file CwiseNullaryOp.h.

{
  EIGEN_STATIC_ASSERT_FIXED_SIZE(Derived)
  return DenseBase<Derived>::NullaryExpr(RowsAtCompileTime, ColsAtCompileTime, internal::scalar_constant_op<Scalar>(value));
}

template<typename Derived >

Eigen::Index Eigen::DenseBase< Derived >::count ( ) const [inline]

Returns:: the number of coefficients which evaluate to true

See also:: all(), any()

Definition at line 129 of file BooleanRedux.h.

{
  return derived().template cast<bool>().template cast<Index>().sum();
}

template<typename Derived>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EvalReturnType Eigen::DenseBase< Derived >::eval ( ) const [inline]

Returns:: the matrix or vector obtained by evaluating this expression.

Notice that in the case of a plain matrix or vector (not an expression) this function just returns a const reference, in order to avoid a useless copy.

Warning:: Be carefull with eval() and the auto C++ keyword, as detailed in this page .

Definition at line 405 of file DenseBase.h.

    {
      // Even though MSVC does not honor strong inlining when the return type
      // is a dynamic matrix, we desperately need strong inlining for fixed
      // size types on MSVC.
      return typename internal::eval<Derived>::type(derived());
    }

template<typename Derived>

template<typename Dest >

EIGEN_DEVICE_FUNC void Eigen::DenseBase< Derived >::evalTo ( Dest & ) const [inline]

Reimplemented in Eigen::ArrayWrapper< ExpressionType >.

Definition at line 575 of file DenseBase.h.

    {
      EIGEN_STATIC_ASSERT((internal::is_same<Dest,void>::value),THE_EVAL_EVALTO_FUNCTION_SHOULD_NEVER_BE_CALLED_FOR_DENSE_OBJECTS);
    }

template<typename Derived >

EIGEN_STRONG_INLINE void Eigen::DenseBase< Derived >::fill ( const Scalar & val )

Alias for setConstant(): sets all coefficients in this expression to val.

See also:: setConstant(), Constant(), class CwiseNullaryOp

Definition at line 325 of file CwiseNullaryOp.h.

{
  setConstant(val);
}

template<typename Derived>

template<unsigned int Added, unsigned int Removed>

EIGEN_DEPRECATED const Derived& Eigen::DenseBase< Derived >::flagged ( ) const [inline]

Deprecated:: it now returns *this

Definition at line 316 of file DenseBase.h.

    { return derived(); }

template<typename Derived>

EIGEN_DEVICE_FUNC const ForceAlignedAccess<Derived> Eigen::DenseBase< Derived >::forceAlignedAccess ( ) const [inline]

Reimplemented in Eigen::MatrixBase< Derived >, Eigen::MatrixBase< MatrixWrapper< ExpressionType > >, Eigen::MatrixBase< Homogeneous< MatrixType, _Direction > >, and Eigen::MatrixBase< Solve< Decomposition, RhsType > >.

template<typename Derived>

EIGEN_DEVICE_FUNC ForceAlignedAccess<Derived> Eigen::DenseBase< Derived >::forceAlignedAccess ( ) [inline]

Reimplemented in Eigen::MatrixBase< Derived >, Eigen::MatrixBase< MatrixWrapper< ExpressionType > >, Eigen::MatrixBase< Homogeneous< MatrixType, _Direction > >, and Eigen::MatrixBase< Solve< Decomposition, RhsType > >.

template<typename Derived>

template<bool Enable>

EIGEN_DEVICE_FUNC const internal::conditional<Enable,ForceAlignedAccess<Derived>,Derived&>::type Eigen::DenseBase< Derived >::forceAlignedAccessIf ( ) const [inline]

Reimplemented in Eigen::MatrixBase< Derived >, Eigen::MatrixBase< MatrixWrapper< ExpressionType > >, Eigen::MatrixBase< Homogeneous< MatrixType, _Direction > >, and Eigen::MatrixBase< Solve< Decomposition, RhsType > >.

template<typename Derived>

template<bool Enable>

EIGEN_DEVICE_FUNC internal::conditional<Enable,ForceAlignedAccess<Derived>,Derived&>::type Eigen::DenseBase< Derived >::forceAlignedAccessIf ( ) [inline]

Reimplemented in Eigen::MatrixBase< Derived >, Eigen::MatrixBase< MatrixWrapper< ExpressionType > >, Eigen::MatrixBase< Homogeneous< MatrixType, _Direction > >, and Eigen::MatrixBase< Solve< Decomposition, RhsType > >.

template<typename Derived >

const WithFormat< Derived > Eigen::DenseBase< Derived >::format ( const IOFormat & fmt ) const [inline]

Returns:: a WithFormat proxy object allowing to print a matrix the with given format fmt.

See class IOFormat for some examples.

See also:: class IOFormat, class WithFormat

Definition at line 121 of file IO.h.

{
  return WithFormat<Derived>(derived(), fmt);
}

template<typename Derived >

bool Eigen::DenseBase< Derived >::hasNaN ( ) const [inline]

Returns:: true is *this contains at least one Not A Number (NaN).

See also:: allFinite()

Definition at line 139 of file BooleanRedux.h.

{
#if EIGEN_COMP_MSVC || (defined __FAST_MATH__)
  return derived().array().isNaN().any();
#else
  return !((derived().array()==derived().array()).all());
#endif
}

template<typename Derived>

EIGEN_DEVICE_FUNC SegmentReturnType Eigen::DenseBase< Derived >::head ( Index n ) [inline]

Returns:: a dynamic-size expression of the first coefficients of *this.

Parameters:

n	the number of coefficients in the segment

Example:

Output:

Note:: Even though the returned expression has dynamic size, in the case when it is applied to a fixed-size vector, it inherits a fixed maximal size, which means that evaluating it does not cause a dynamic memory allocation.

See also:: class Block, block(Index,Index)

Definition at line 862 of file DenseBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC ConstSegmentReturnType Eigen::DenseBase< Derived >::head ( Index n ) const [inline]

This is the const version of head(Index).

Definition at line 870 of file DenseBase.h.

template<typename Derived>

template<int N>

EIGEN_DEVICE_FUNC FixedSegmentReturnType<N>::Type Eigen::DenseBase< Derived >::head ( Index n = N ) [inline]

Returns:: a fixed-size expression of the first coefficients of *this.

Template Parameters:

N	the number of coefficients in the segment as specified at compile-time

Parameters:

n	the number of coefficients in the segment as specified at run-time

The compile-time and run-time information should not contradict. In other words, n should equal N unless N is Dynamic.

Example:

Output:

See also:: class Block

Definition at line 956 of file DenseBase.h.

template<typename Derived>

template<int N>

EIGEN_DEVICE_FUNC ConstFixedSegmentReturnType<N>::Type Eigen::DenseBase< Derived >::head ( Index n = N ) const [inline]

This is the const version of head<int>().

Definition at line 965 of file DenseBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC Index Eigen::DenseBase< Derived >::innerSize ( ) const [inline]

Returns:: the inner size.

Note:: For a vector, this is just the size. For a matrix (non-vector), this is the minor dimension with respect to the storage order, i.e., the number of rows for a column-major matrix, and the number of columns for a row-major matrix.

Definition at line 234 of file DenseBase.h.

    {
      return IsVectorAtCompileTime ? this->size()
           : int(IsRowMajor) ? this->cols() : this->rows();
    }

template<typename Derived >

template<typename OtherDerived >

bool Eigen::DenseBase< Derived >::isApprox	(	const DenseBase< OtherDerived > &	other,
		const RealScalar &	prec = `NumTraits<Scalar>::dummy_precision()`
	)		const

Returns:: true if *this is approximately equal to other, within the precision determined by prec.

Note:: The fuzzy compares are done multiplicatively. Two vectors and are considered to be approximately equal within precision if
$\Vert v - w \Vert \leqslant p\,\min(\Vert v\Vert, \Vert w\Vert).$
For matrices, the comparison is done using the Hilbert-Schmidt norm (aka Frobenius norm L2 norm).; Because of the multiplicativeness of this comparison, one can't use this function to check whether *this is approximately equal to the zero matrix or vector. Indeed, isApprox(zero) returns false unless *this itself is exactly the zero matrix or vector. If you want to test whether *this is zero, use internal::isMuchSmallerThan(const RealScalar&, RealScalar) instead.

See also:: internal::isMuchSmallerThan(const RealScalar&, RealScalar) const

Definition at line 103 of file Fuzzy.h.

{
  return internal::isApprox_selector<Derived, OtherDerived>::run(derived(), other.derived(), prec);
}

template<typename Derived >

bool Eigen::DenseBase< Derived >::isApproxToConstant	(	const Scalar &	val,
		const RealScalar &	prec = `NumTraits<Scalar>::dummy_precision()`
	)		const

Returns:: true if all coefficients in this matrix are approximately equal to val, to within precision prec

Definition at line 300 of file CwiseNullaryOp.h.

{
  typename internal::nested_eval<Derived,1>::type self(derived());
  for(Index j = 0; j < cols(); ++j)
    for(Index i = 0; i < rows(); ++i)
      if(!internal::isApprox(self.coeff(i, j), val, prec))
        return false;
  return true;
}

template<typename Derived >

bool Eigen::DenseBase< Derived >::isConstant	(	const Scalar &	val,
		const RealScalar &	prec = `NumTraits<Scalar>::dummy_precision()`
	)		const

This is just an alias for isApproxToConstant().

Returns:: true if all coefficients in this matrix are approximately equal to value, to within precision prec

Definition at line 315 of file CwiseNullaryOp.h.

{
  return isApproxToConstant(val, prec);
}

template<typename Derived>

template<typename Derived >

bool Eigen::DenseBase< Derived >::isMuchSmallerThan	(	const typename NumTraits< Scalar >::Real &	other,
		const RealScalar &	prec
	)		const

Returns:: true if the norm of *this is much smaller than other, within the precision determined by prec.

Note:: The fuzzy compares are done multiplicatively. A vector is considered to be much smaller than within precision if
$\Vert v \Vert \leqslant p\,\vert x\vert.$

For matrices, the comparison is done using the Hilbert-Schmidt norm. For this reason, the value of the reference scalar other should come from the Hilbert-Schmidt norm of a reference matrix of same dimensions.

See also:: isApprox(), isMuchSmallerThan(const DenseBase<OtherDerived>&, RealScalar) const

Definition at line 125 of file Fuzzy.h.

{
  return internal::isMuchSmallerThan_scalar_selector<Derived>::run(derived(), other, prec);
}

template<typename Derived>

EIGEN_DEVICE_FUNC bool Eigen::DenseBase< Derived >::isMuchSmallerThan	(	const RealScalar &	other,
		const RealScalar &	prec = `NumTraits< Scalar >::dummy_precision()`
	)		const

template<typename Derived >

template<typename OtherDerived >

bool Eigen::DenseBase< Derived >::isMuchSmallerThan	(	const DenseBase< OtherDerived > &	other,
		const RealScalar &	prec = `NumTraits<Scalar>::dummy_precision()`
	)		const

Returns:: true if the norm of *this is much smaller than the norm of other, within the precision determined by prec.

Note:: The fuzzy compares are done multiplicatively. A vector is considered to be much smaller than a vector within precision if
$\Vert v \Vert \leqslant p\,\Vert w\Vert.$
For matrices, the comparison is done using the Hilbert-Schmidt norm.

See also:: isApprox(), isMuchSmallerThan(const RealScalar&, RealScalar) const

Definition at line 145 of file Fuzzy.h.

{
  return internal::isMuchSmallerThan_object_selector<Derived, OtherDerived>::run(derived(), other.derived(), prec);
}

template<typename Derived >

bool Eigen::DenseBase< Derived >::isOnes ( const RealScalar & prec = NumTraits<Scalar>::dummy_precision() ) const

Returns:: true if *this is approximately equal to the matrix where all coefficients are equal to 1, within the precision given by prec.

Example:

Output:

See also:: class CwiseNullaryOp, Ones()

Definition at line 616 of file CwiseNullaryOp.h.

{
  return isApproxToConstant(Scalar(1), prec);
}

template<typename Derived >

bool Eigen::DenseBase< Derived >::isZero ( const RealScalar & prec = NumTraits<Scalar>::dummy_precision() ) const

Returns:: true if *this is approximately equal to the zero matrix, within the precision given by prec.

Example:

Output:

See also:: class CwiseNullaryOp, Zero()

Definition at line 485 of file CwiseNullaryOp.h.

{
  typename internal::nested_eval<Derived,1>::type self(derived());
  for(Index j = 0; j < cols(); ++j)
    for(Index i = 0; i < rows(); ++i)
      if(!internal::isMuchSmallerThan(self.coeff(i, j), static_cast<Scalar>(1), prec))
        return false;
  return true;
}

template<typename Derived >

template<typename OtherDerived >

EIGEN_STRONG_INLINE Derived & Eigen::DenseBase< Derived >::lazyAssign ( const DenseBase< OtherDerived > & other )

\ínternal Copies other into *this without evaluating other.

Returns:: a reference to *this.

Deprecated:

Definition at line 20 of file Assign.h.

{
  enum{
    SameType = internal::is_same<typename Derived::Scalar,typename OtherDerived::Scalar>::value
  };

  EIGEN_STATIC_ASSERT_LVALUE(Derived)
  EIGEN_STATIC_ASSERT_SAME_MATRIX_SIZE(Derived,OtherDerived)
  EIGEN_STATIC_ASSERT(SameType,YOU_MIXED_DIFFERENT_NUMERIC_TYPES__YOU_NEED_TO_USE_THE_CAST_METHOD_OF_MATRIXBASE_TO_CAST_NUMERIC_TYPES_EXPLICITLY)

  eigen_assert(rows() == other.rows() && cols() == other.cols());
  internal::call_assignment_no_alias(derived(),other.derived());
  
  return derived();
}

template<typename Derived>

EIGEN_DEVICE_FUNC ColsBlockXpr Eigen::DenseBase< Derived >::leftCols ( Index n ) [inline]

Returns:: a block consisting of the left columns of *this.

Parameters:

n	the number of columns in the block

Example:

Output:

See also:: class Block, block(Index,Index,Index,Index)

Definition at line 563 of file DenseBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC ConstColsBlockXpr Eigen::DenseBase< Derived >::leftCols ( Index n ) const [inline]

This is the const version of leftCols(Index).

Definition at line 570 of file DenseBase.h.

template<typename Derived>

template<int N>

EIGEN_DEVICE_FUNC NColsBlockXpr<N>::Type Eigen::DenseBase< Derived >::leftCols ( Index n = N ) [inline]

Returns:: a block consisting of the left columns of *this.

Template Parameters:

N	the number of columns in the block as specified at compile-time

Parameters:

n	the number of columns in the block as specified at run-time

The compile-time and run-time information should not contradict. In other words, n should equal N unless N is Dynamic.

Example:

Output:

See also:: class Block, block(Index,Index,Index,Index)

Definition at line 590 of file DenseBase.h.

         :
    EIGEN_DEVICE_FUNC explicit DenseBase(int);

template<typename Derived>

template<int N>

EIGEN_DEVICE_FUNC ConstNColsBlockXpr<N>::Type Eigen::DenseBase< Derived >::leftCols ( Index n = N ) const [inline]

This is the const version of leftCols<int>().

Definition at line 598 of file DenseBase.h.

template<typename Derived >

EIGEN_STRONG_INLINE const DenseBase< Derived >::SequentialLinSpacedReturnType Eigen::DenseBase< Derived >::LinSpaced	(	Sequential_t	,
		Index	size,
		const Scalar &	low,
		const Scalar &	high
	)		`[static]`

Sets a linearly spaced vector.

The function generates 'size' equally spaced values in the closed interval [low,high]. This particular version of LinSpaced() uses sequential access, i.e. vector access is assumed to be a(0), a(1), ..., a(size). This assumption allows for better vectorization and yields faster code than the random access version.

When size is set to 1, a vector of length 1 containing 'high' is returned.

Example:

Output:

See also:: setLinSpaced(Index,const Scalar&,const Scalar&), LinSpaced(Index,Scalar,Scalar), CwiseNullaryOp

Definition at line 244 of file CwiseNullaryOp.h.

{
  EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived)
  return DenseBase<Derived>::NullaryExpr(size, internal::linspaced_op<Scalar,PacketScalar,false>(low,high,size));
}

template<typename Derived >

EIGEN_STRONG_INLINE const DenseBase< Derived >::RandomAccessLinSpacedReturnType Eigen::DenseBase< Derived >::LinSpaced	(	Index	size,
		const Scalar &	low,
		const Scalar &	high
	)		`[static]`

Sets a linearly spaced vector.

The function generates 'size' equally spaced values in the closed interval [low,high]. When size is set to 1, a vector of length 1 containing 'high' is returned.

Example:

Output:

See also:: setLinSpaced(Index,const Scalar&,const Scalar&), LinSpaced(Sequential_t,Index,const Scalar&,const Scalar&,Index), CwiseNullaryOp

Definition at line 278 of file CwiseNullaryOp.h.

{
  EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived)
  return DenseBase<Derived>::NullaryExpr(size, internal::linspaced_op<Scalar,PacketScalar,true>(low,high,size));
}

template<typename Derived >

EIGEN_STRONG_INLINE const DenseBase< Derived >::SequentialLinSpacedReturnType Eigen::DenseBase< Derived >::LinSpaced	(	Sequential_t	,
		const Scalar &	low,
		const Scalar &	high
	)		`[static]`

Sets a linearly spaced vector.

The function generates 'size' equally spaced values in the closed interval [low,high]. This particular version of LinSpaced() uses sequential access, i.e. vector access is assumed to be a(0), a(1), ..., a(size). This assumption allows for better vectorization and yields faster code than the random access version.

When size is set to 1, a vector of length 1 containing 'high' is returned.

Example:

Output:

See also:: setLinSpaced(Index,const Scalar&,const Scalar&), LinSpaced(Index,Scalar,Scalar), CwiseNullaryOp

Special version for fixed size types which does not require the size parameter.

Definition at line 256 of file CwiseNullaryOp.h.

{
  EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived)
  EIGEN_STATIC_ASSERT_FIXED_SIZE(Derived)
  return DenseBase<Derived>::NullaryExpr(Derived::SizeAtCompileTime, internal::linspaced_op<Scalar,PacketScalar,false>(low,high,Derived::SizeAtCompileTime));
}

template<typename Derived >

EIGEN_STRONG_INLINE const DenseBase< Derived >::RandomAccessLinSpacedReturnType Eigen::DenseBase< Derived >::LinSpaced	(	const Scalar &	low,
		const Scalar &	high
	)		`[static]`

Sets a linearly spaced vector.

The function generates 'size' equally spaced values in the closed interval [low,high]. When size is set to 1, a vector of length 1 containing 'high' is returned.

Example:

Output:

See also:: setLinSpaced(Index,const Scalar&,const Scalar&), LinSpaced(Sequential_t,Index,const Scalar&,const Scalar&,Index), CwiseNullaryOp

Special version for fixed size types which does not require the size parameter.

Definition at line 290 of file CwiseNullaryOp.h.

{
  EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived)
  EIGEN_STATIC_ASSERT_FIXED_SIZE(Derived)
  return DenseBase<Derived>::NullaryExpr(Derived::SizeAtCompileTime, internal::linspaced_op<Scalar,PacketScalar,true>(low,high,Derived::SizeAtCompileTime));
}

template<typename Derived>

template<int p>

RealScalar Eigen::DenseBase< Derived >::lpNorm ( ) const

Reimplemented in Eigen::MatrixBase< Derived >, Eigen::MatrixBase< MatrixWrapper< ExpressionType > >, Eigen::MatrixBase< Homogeneous< MatrixType, _Direction > >, and Eigen::MatrixBase< Solve< Decomposition, RhsType > >.

template<typename Derived >

EIGEN_STRONG_INLINE internal::traits< Derived >::Scalar Eigen::DenseBase< Derived >::maxCoeff ( ) const

Returns:: the maximum of all coefficients of *this.

Warning:: the result is undefined if *this contains NaN.

Definition at line 434 of file Redux.h.

{
  return derived().redux(Eigen::internal::scalar_max_op<Scalar>());
}

template<typename Derived >

template<typename IndexType >

EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar Eigen::DenseBase< Derived >::maxCoeff	(	IndexType *	rowPtr,
		IndexType *	colPtr
	)		const

Returns:: the maximum of all coefficients of *this and puts in *row and *col its location.

Warning:: the result is undefined if *this contains NaN.

See also:: DenseBase::minCoeff(IndexType*,IndexType*), DenseBase::visit(), DenseBase::maxCoeff()

Definition at line 242 of file Visitor.h.

{
  internal::max_coeff_visitor<Derived> maxVisitor;
  this->visit(maxVisitor);
  *rowPtr = maxVisitor.row;
  if (colPtr) *colPtr = maxVisitor.col;
  return maxVisitor.res;
}

template<typename Derived >

template<typename IndexType >

EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar Eigen::DenseBase< Derived >::maxCoeff ( IndexType * index ) const

Returns:: the maximum of all coefficients of *this and puts in *index its location.

Warning:: the result is undefined if *this contains NaN.

See also:: DenseBase::maxCoeff(IndexType*,IndexType*), DenseBase::minCoeff(IndexType*,IndexType*), DenseBase::visitor(), DenseBase::maxCoeff()

Definition at line 260 of file Visitor.h.

{
  EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived)
  internal::max_coeff_visitor<Derived> maxVisitor;
  this->visit(maxVisitor);
  *index = (RowsAtCompileTime==1) ? maxVisitor.col : maxVisitor.row;
  return maxVisitor.res;
}

template<typename Derived >

EIGEN_STRONG_INLINE internal::traits< Derived >::Scalar Eigen::DenseBase< Derived >::mean ( ) const

Returns:: the mean of all coefficients of *this

See also:: trace(), prod(), sum()

Definition at line 458 of file Redux.h.

{
  return Scalar(derived().redux(Eigen::internal::scalar_sum_op<Scalar>())) / Scalar(this->size());
}

template<typename Derived>

EIGEN_DEVICE_FUNC ColsBlockXpr Eigen::DenseBase< Derived >::middleCols	(	Index	startCol,
		Index	numCols
	)		`[inline]`

Returns:: a block consisting of a range of columns of *this.

Parameters:

startCol	the index of the first column in the block
numCols	the number of columns in the block

Example:

Output:

See also:: class Block, block(Index,Index,Index,Index)

Definition at line 668 of file DenseBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC ConstColsBlockXpr Eigen::DenseBase< Derived >::middleCols	(	Index	startCol,
		Index	numCols
	)		const `[inline]`

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

Definition at line 675 of file DenseBase.h.

template<typename Derived>

template<int N>

EIGEN_DEVICE_FUNC NColsBlockXpr<N>::Type Eigen::DenseBase< Derived >::middleCols	(	Index	startCol,
		Index	n = `N`
	)		`[inline]`

Returns:: a block consisting of a range of columns of *this.

Template Parameters:

N	the number of columns in the block as specified at compile-time

Parameters:

startCol	the index of the first column in the block
n	the number of columns in the block as specified at run-time

The compile-time and run-time information should not contradict. In other words, n should equal N unless N is Dynamic.

Example:

Output:

See also:: class Block, block(Index,Index,Index,Index)

Definition at line 696 of file DenseBase.h.

template<typename Derived>

template<int N>

EIGEN_DEVICE_FUNC ConstNColsBlockXpr<N>::Type Eigen::DenseBase< Derived >::middleCols	(	Index	startCol,
		Index	n = `N`
	)		const `[inline]`

This is the const version of middleCols<int>().

Definition at line 704 of file DenseBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC RowsBlockXpr Eigen::DenseBase< Derived >::middleRows	(	Index	startRow,
		Index	n
	)		`[inline]`

Returns:: a block consisting of a range of rows of *this.

Parameters:

startRow	the index of the first row in the block
n	the number of rows in the block

Example:

Output:

See also:: class Block, block(Index,Index,Index,Index)

Definition at line 510 of file DenseBase.h.

                                                                    {
      return ConstColwiseReturnType(derived());
    }
    EIGEN_DEVICE_FUNC ColwiseReturnType colwise();

template<typename Derived>

EIGEN_DEVICE_FUNC ConstRowsBlockXpr Eigen::DenseBase< Derived >::middleRows	(	Index	startRow,
		Index	n
	)		const `[inline]`

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

Definition at line 517 of file DenseBase.h.

template<typename Derived>

template<int N>

EIGEN_DEVICE_FUNC NRowsBlockXpr<N>::Type Eigen::DenseBase< Derived >::middleRows	(	Index	startRow,
		Index	n = `N`
	)		`[inline]`

Returns:: a block consisting of a range of rows of *this.

Template Parameters:

N	the number of rows in the block as specified at compile-time

Parameters:

startRow	the index of the first row in the block
n	the number of rows in the block as specified at run-time

The compile-time and run-time information should not contradict. In other words, n should equal N unless N is Dynamic.

Example:

Output:

See also:: class Block, block(Index,Index,Index,Index)

Definition at line 538 of file DenseBase.h.

template<typename Derived>

template<int N>

EIGEN_DEVICE_FUNC ConstNRowsBlockXpr<N>::Type Eigen::DenseBase< Derived >::middleRows	(	Index	startRow,
		Index	n = `N`
	)		const `[inline]`

This is the const version of middleRows<int>().

Definition at line 546 of file DenseBase.h.

template<typename Derived >

EIGEN_STRONG_INLINE internal::traits< Derived >::Scalar Eigen::DenseBase< Derived >::minCoeff ( ) const

Returns:: the minimum of all coefficients of *this.

Warning:: the result is undefined if *this contains NaN.

Definition at line 424 of file Redux.h.

{
  return derived().redux(Eigen::internal::scalar_min_op<Scalar>());
}

template<typename Derived >

template<typename IndexType >

EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar Eigen::DenseBase< Derived >::minCoeff	(	IndexType *	rowId,
		IndexType *	colId
	)		const

Returns:: the minimum of all coefficients of *this and puts in *row and *col its location.

Warning:: the result is undefined if *this contains NaN.

See also:: DenseBase::minCoeff(Index*), DenseBase::maxCoeff(Index*,Index*), DenseBase::visit(), DenseBase::minCoeff()

Definition at line 206 of file Visitor.h.

{
  internal::min_coeff_visitor<Derived> minVisitor;
  this->visit(minVisitor);
  *rowId = minVisitor.row;
  if (colId) *colId = minVisitor.col;
  return minVisitor.res;
}

template<typename Derived >

template<typename IndexType >

EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar Eigen::DenseBase< Derived >::minCoeff ( IndexType * index ) const

Returns:: the minimum of all coefficients of *this and puts in *index its location.

Warning:: the result is undefined if *this contains NaN.

See also:: DenseBase::minCoeff(IndexType*,IndexType*), DenseBase::maxCoeff(IndexType*,IndexType*), DenseBase::visit(), DenseBase::minCoeff()

Definition at line 224 of file Visitor.h.

{
  EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived)
  internal::min_coeff_visitor<Derived> minVisitor;
  this->visit(minVisitor);
  *index = IndexType((RowsAtCompileTime==1) ? minVisitor.col : minVisitor.row);
  return minVisitor.res;
}

template<typename Derived >

const NestByValue< Derived > Eigen::DenseBase< Derived >::nestByValue ( ) const [inline]

Returns:: an expression of the temporary version of *this.

Definition at line 103 of file NestByValue.h.

{
  return NestByValue<Derived>(derived());
}

template<typename Derived>

EIGEN_DEVICE_FUNC Index Eigen::DenseBase< Derived >::nonZeros ( ) const [inline]

Returns:: the number of nonzero coefficients which is in practice the number of stored coefficients.

Definition at line 214 of file DenseBase.h.

{ return size(); }

template<typename Derived >

template<typename CustomNullaryOp >

EIGEN_STRONG_INLINE const CwiseNullaryOp< CustomNullaryOp, typename DenseBase< Derived >::PlainObject > Eigen::DenseBase< Derived >::NullaryExpr	(	Index	rows,
		Index	cols,
		const CustomNullaryOp &	func
	)		`[static]`

Returns:: an expression of a matrix defined by a custom functor func

The parameters rows and cols are the number of rows and of columns of the returned matrix. Must be compatible with this MatrixBase type.

This variant is meant to be used for dynamic-size matrix types. For fixed-size types, it is redundant to pass rows and cols as arguments, so Zero() should be used instead.

The template parameter CustomNullaryOp is the type of the functor.

See also:: class CwiseNullaryOp

Definition at line 116 of file CwiseNullaryOp.h.

{
  return CwiseNullaryOp<CustomNullaryOp, PlainObject>(rows, cols, func);
}

template<typename Derived >

template<typename CustomNullaryOp >

EIGEN_STRONG_INLINE const CwiseNullaryOp< CustomNullaryOp, typename DenseBase< Derived >::PlainObject > Eigen::DenseBase< Derived >::NullaryExpr	(	Index	size,
		const CustomNullaryOp &	func
	)		`[static]`

Returns:: an expression of a matrix defined by a custom functor func

The parameter size is the size of the returned vector. Must be compatible with this MatrixBase type.

This variant is meant to be used for dynamic-size vector types. For fixed-size types, it is redundant to pass size as argument, so Zero() should be used instead.

The template parameter CustomNullaryOp is the type of the functor.

Here is an example with C++11 random generators:

Output:

See also:: class CwiseNullaryOp

Definition at line 142 of file CwiseNullaryOp.h.

{
  EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived)
  if(RowsAtCompileTime == 1) return CwiseNullaryOp<CustomNullaryOp, PlainObject>(1, size, func);
  else return CwiseNullaryOp<CustomNullaryOp, PlainObject>(size, 1, func);
}

template<typename Derived >

template<typename CustomNullaryOp >

EIGEN_STRONG_INLINE const CwiseNullaryOp< CustomNullaryOp, typename DenseBase< Derived >::PlainObject > Eigen::DenseBase< Derived >::NullaryExpr ( const CustomNullaryOp & func ) [static]

Returns:: an expression of a matrix defined by a custom functor func

This variant is only for fixed-size DenseBase types. For dynamic-size types, you need to use the variants taking size arguments.

The template parameter CustomNullaryOp is the type of the functor.

See also:: class CwiseNullaryOp

Definition at line 161 of file CwiseNullaryOp.h.

{
  return CwiseNullaryOp<CustomNullaryOp, PlainObject>(RowsAtCompileTime, ColsAtCompileTime, func);
}

template<typename Derived >

EIGEN_STRONG_INLINE const DenseBase< Derived >::ConstantReturnType Eigen::DenseBase< Derived >::Ones	(	Index	rows,
		Index	cols
	)		`[static]`

Returns:: an expression of a matrix where all coefficients equal one.

The parameters rows and cols are the number of rows and of columns of the returned matrix. Must be compatible with this MatrixBase type.

This variant is meant to be used for dynamic-size matrix types. For fixed-size types, it is redundant to pass rows and cols as arguments, so Ones() should be used instead.

Example:

Output:

See also:: Ones(), Ones(Index), isOnes(), class Ones

Definition at line 561 of file CwiseNullaryOp.h.

{
  return Constant(rows, cols, Scalar(1));
}

template<typename Derived >

EIGEN_STRONG_INLINE const DenseBase< Derived >::ConstantReturnType Eigen::DenseBase< Derived >::Ones ( Index newSize ) [static]

Returns:: an expression of a vector where all coefficients equal one.

The parameter newSize is the size of the returned vector. Must be compatible with this MatrixBase type.

This variant is meant to be used for dynamic-size vector types. For fixed-size types, it is redundant to pass size as argument, so Ones() should be used instead.

Example:

Output:

See also:: Ones(), Ones(Index,Index), isOnes(), class Ones

Definition at line 584 of file CwiseNullaryOp.h.

{
  return Constant(newSize, Scalar(1));
}

template<typename Derived >

EIGEN_STRONG_INLINE const DenseBase< Derived >::ConstantReturnType Eigen::DenseBase< Derived >::Ones ( ) [static]

Returns:: an expression of a fixed-size matrix or vector where all coefficients equal one.

This variant is only for fixed-size MatrixBase types. For dynamic-size types, you need to use the variants taking size arguments.

Example:

Output:

See also:: Ones(Index), Ones(Index,Index), isOnes(), class Ones

Definition at line 601 of file CwiseNullaryOp.h.

{
  return Constant(Scalar(1));
}

template<typename Derived >

EIGEN_STRONG_INLINE Derived & Eigen::DenseBase< Derived >::operator*= ( const Scalar & other )

Definition at line 16 of file SelfCwiseBinaryOp.h.

{
  typedef typename Derived::PlainObject PlainObject;
  internal::call_assignment(this->derived(), PlainObject::Constant(rows(),cols(),other), internal::mul_assign_op<Scalar>());
  return derived();
}

template<typename Derived >

template<typename OtherDerived >

Derived & Eigen::DenseBase< Derived >::operator+= ( const EigenBase< OtherDerived > & other )

Definition at line 139 of file EigenBase.h.

{
  call_assignment(derived(), other.derived(), internal::add_assign_op<Scalar>());
  return derived();
}

template<typename Derived >

template<typename OtherDerived >

Derived & Eigen::DenseBase< Derived >::operator-= ( const EigenBase< OtherDerived > & other )

Definition at line 147 of file EigenBase.h.

{
  call_assignment(derived(), other.derived(), internal::sub_assign_op<Scalar>());
  return derived();
}

template<typename Derived >

EIGEN_STRONG_INLINE Derived & Eigen::DenseBase< Derived >::operator/= ( const Scalar & other )

Definition at line 40 of file SelfCwiseBinaryOp.h.

{
  typedef typename Derived::PlainObject PlainObject;
  internal::call_assignment(this->derived(), PlainObject::Constant(rows(),cols(),other), internal::div_assign_op<Scalar>());
  return derived();
}

template<typename Derived >

CommaInitializer< Derived > Eigen::DenseBase< Derived >::operator<< ( const Scalar & s ) [inline]

Convenient operator to set the coefficients of a matrix.

The coefficients must be provided in a row major order and exactly match the size of the matrix. Otherwise an assertion is raised.

Example:

Output:

Note:: According the c++ standard, the argument expressions of this comma initializer are evaluated in arbitrary order.

See also:: CommaInitializer::finished(), class CommaInitializer

Definition at line 147 of file CommaInitializer.h.

{
  return CommaInitializer<Derived>(*static_cast<Derived*>(this), s);
}

template<typename Derived >

template<typename OtherDerived >

CommaInitializer< Derived > Eigen::DenseBase< Derived >::operator<< ( const DenseBase< OtherDerived > & other ) [inline]

See also:: operator<<(const Scalar&)

Definition at line 156 of file CommaInitializer.h.

{
  return CommaInitializer<Derived>(*static_cast<Derived *>(this), other);
}

template<typename Derived >

template<typename OtherDerived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & Eigen::DenseBase< Derived >::operator= ( const DenseBase< OtherDerived > & other )

Copies other into *this.

Returns:: a reference to *this.

Reimplemented in Eigen::MatrixBase< Derived >, Eigen::MatrixBase< MatrixWrapper< ExpressionType > >, Eigen::MatrixBase< Homogeneous< MatrixType, _Direction > >, and Eigen::MatrixBase< Solve< Decomposition, RhsType > >.

Definition at line 39 of file Assign.h.

{
  internal::call_assignment(derived(), other.derived());
  return derived();
}

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & Eigen::DenseBase< Derived >::operator= ( const DenseBase< Derived > & other )

Special case of the template operator=, in order to prevent the compiler from generating a default operator= (issue hit with g++ 4.1)

Definition at line 47 of file Assign.h.

{
  internal::call_assignment(derived(), other.derived());
  return derived();
}

template<typename Derived >

template<typename OtherDerived >

Derived & Eigen::DenseBase< Derived >::operator= ( const EigenBase< OtherDerived > & other )

Copies the generic expression other into *this.

The expression must provide a (templated) evalTo(Derived& dst) const function which does the actual job. In practice, this allows any user to write its own special matrix without having to modify MatrixBase

Returns:: a reference to *this.

Reimplemented in Eigen::MatrixBase< Derived >, Eigen::MatrixBase< MatrixWrapper< ExpressionType > >, Eigen::MatrixBase< Homogeneous< MatrixType, _Direction > >, and Eigen::MatrixBase< Solve< Decomposition, RhsType > >.

Definition at line 131 of file EigenBase.h.

{
  call_assignment(derived(), other.derived());
  return derived();
}

template<typename Derived >

template<typename OtherDerived >

Derived & Eigen::DenseBase< Derived >::operator= ( const ReturnByValue< OtherDerived > & func )

Reimplemented in Eigen::MatrixBase< Derived >, Eigen::MatrixBase< MatrixWrapper< ExpressionType > >, Eigen::MatrixBase< Homogeneous< MatrixType, _Direction > >, and Eigen::MatrixBase< Solve< Decomposition, RhsType > >.

Definition at line 82 of file ReturnByValue.h.

{
  other.evalTo(derived());
  return derived();
}

template<typename Derived>

EIGEN_DEVICE_FUNC Index Eigen::DenseBase< Derived >::outerSize ( ) const [inline]

Returns:: the outer size.

Note:: For a vector, this returns just 1. For a matrix (non-vector), this is the major dimension with respect to the storage order, i.e., the number of columns for a column-major matrix, and the number of rows for a row-major matrix.

Definition at line 222 of file DenseBase.h.

    {
      return IsVectorAtCompileTime ? 1
           : int(IsRowMajor) ? this->rows() : this->cols();
    }

template<typename Derived >

EIGEN_STRONG_INLINE internal::traits< Derived >::Scalar Eigen::DenseBase< Derived >::prod ( ) const

Returns:: the product of all coefficients of *this

Example:

Output:

See also:: sum(), mean(), trace()

Definition at line 472 of file Redux.h.

{
  if(SizeAtCompileTime==0 || (SizeAtCompileTime==Dynamic && size()==0))
    return Scalar(1);
  return derived().redux(Eigen::internal::scalar_product_op<Scalar>());
}

template<typename Derived >

const DenseBase< Derived >::RandomReturnType Eigen::DenseBase< Derived >::Random	(	Index	rows,
		Index	cols
	)		`[inline, static]`

Returns:: a random matrix expression

Numbers are uniformly spread through their whole definition range for integer types, and in the [-1:1] range for floating point scalar types.

The parameters rows and cols are the number of rows and of columns of the returned matrix. Must be compatible with this MatrixBase type.

This variant is meant to be used for dynamic-size matrix types. For fixed-size types, it is redundant to pass rows and cols as arguments, so Random() should be used instead.

Example:

Output:

This expression has the "evaluate before nesting" flag so that it will be evaluated into a temporary matrix whenever it is nested in a larger expression. This prevents unexpected behavior with expressions involving random matrices.

See DenseBase::NullaryExpr(Index, const CustomNullaryOp&) for an example using C++11 random generators.

See also:: DenseBase::setRandom(), DenseBase::Random(Index), DenseBase::Random()

Definition at line 57 of file Random.h.

{
  return NullaryExpr(rows, cols, internal::scalar_random_op<Scalar>());
}

template<typename Derived >

const DenseBase< Derived >::RandomReturnType Eigen::DenseBase< Derived >::Random ( Index size ) [inline, static]

Returns:: a random vector expression

Numbers are uniformly spread through their whole definition range for integer types, and in the [-1:1] range for floating point scalar types.

The parameter size is the size of the returned vector. Must be compatible with this MatrixBase type.

This variant is meant to be used for dynamic-size vector types. For fixed-size types, it is redundant to pass size as argument, so Random() should be used instead.

Example:

Output:

This expression has the "evaluate before nesting" flag so that it will be evaluated into a temporary vector whenever it is nested in a larger expression. This prevents unexpected behavior with expressions involving random matrices.

See also:: DenseBase::setRandom(), DenseBase::Random(Index,Index), DenseBase::Random()

Definition at line 88 of file Random.h.

{
  return NullaryExpr(size, internal::scalar_random_op<Scalar>());
}

template<typename Derived >

const DenseBase< Derived >::RandomReturnType Eigen::DenseBase< Derived >::Random ( ) [inline, static]

Returns:: a fixed-size random matrix or vector expression

Numbers are uniformly spread through their whole definition range for integer types, and in the [-1:1] range for floating point scalar types.

This variant is only for fixed-size MatrixBase types. For dynamic-size types, you need to use the variants taking size arguments.

Example:

Output:

This expression has the "evaluate before nesting" flag so that it will be evaluated into a temporary matrix whenever it is nested in a larger expression. This prevents unexpected behavior with expressions involving random matrices.

See also:: DenseBase::setRandom(), DenseBase::Random(Index,Index), DenseBase::Random(Index)

Definition at line 114 of file Random.h.

{
  return NullaryExpr(RowsAtCompileTime, ColsAtCompileTime, internal::scalar_random_op<Scalar>());
}

template<typename Derived>

template<typename Func >

internal::traits<Derived>::Scalar Eigen::DenseBase< Derived >::redux ( const Func & func ) const

Returns:: the result of a full redux operation on the whole matrix or vector using func

The template parameter BinaryOp is the type of the functor func which must be an associative operator. Both current C++98 and C++11 functor styles are handled.

See also:: DenseBase::sum(), DenseBase::minCoeff(), DenseBase::maxCoeff(), MatrixBase::colwise(), MatrixBase::rowwise()

Definition at line 409 of file Redux.h.

{
  eigen_assert(this->rows()>0 && this->cols()>0 && "you are using an empty matrix");

  typedef typename internal::redux_evaluator<Derived> ThisEvaluator;
  ThisEvaluator thisEval(derived());
  
  return internal::redux_impl<Func, ThisEvaluator>::run(thisEval, func);
}

template<typename Derived>

template<typename BinaryOp >

EIGEN_DEVICE_FUNC Scalar Eigen::DenseBase< Derived >::redux ( const BinaryOp & func ) const

template<typename Derived >

template<int RowFactor, int ColFactor>

const Replicate< Derived, RowFactor, ColFactor > Eigen::DenseBase< Derived >::replicate ( ) const

Returns:: an expression of the replication of *this

Example:

Output:

See also:: VectorwiseOp::replicate(), DenseBase::replicate(Index,Index), class Replicate

Definition at line 119 of file Replicate.h.

{
  return Replicate<Derived,RowFactor,ColFactor>(derived());
}

template<typename Derived>

EIGEN_DEVICE_FUNC const Replicate<Derived, Dynamic, Dynamic> Eigen::DenseBase< Derived >::replicate	(	Index	rowFactor,
		Index	colFactor
	)		const `[inline]`

Returns:: an expression of the replication of *this

Example:

Output:

See also:: VectorwiseOp::replicate(), DenseBase::replicate<int,int>(), class Replicate

Definition at line 548 of file DenseBase.h.

    {
      return Replicate<Derived, Dynamic, Dynamic>(derived(), rowFactor, colFactor);
    }

template<typename Derived>

EIGEN_DEVICE_FUNC void Eigen::DenseBase< Derived >::resize ( Index newSize ) [inline]

Only plain matrices/arrays, not expressions, may be resized; therefore the only useful resize methods are Matrix::resize() and Array::resize(). The present method only asserts that the new size equals the old size, and does nothing else.

Reimplemented in Eigen::MatrixWrapper< ExpressionType >, and Eigen::ArrayWrapper< ExpressionType >.

Definition at line 245 of file DenseBase.h.

    {
      EIGEN_ONLY_USED_FOR_DEBUG(newSize);
      eigen_assert(newSize == this->size()
                && "DenseBase::resize() does not actually allow to resize.");
    }

template<typename Derived>

EIGEN_DEVICE_FUNC void Eigen::DenseBase< Derived >::resize	(	Index	p_rows,
		Index	p_cols
	)		`[inline]`

Only plain matrices/arrays, not expressions, may be resized; therefore the only useful resize methods are Matrix::resize() and Array::resize(). The present method only asserts that the new size equals the old size, and does nothing else.

Reimplemented in Eigen::MatrixWrapper< ExpressionType >, and Eigen::ArrayWrapper< ExpressionType >.

Definition at line 256 of file DenseBase.h.

    {
      EIGEN_ONLY_USED_FOR_DEBUG(p_rows);
      EIGEN_ONLY_USED_FOR_DEBUG(p_cols);
      eigen_assert(p_rows == this->rows() && p_cols == this->cols()
                && "DenseBase::resize() does not actually allow to resize.");
    }

template<typename Derived >

DenseBase< Derived >::ReverseReturnType Eigen::DenseBase< Derived >::reverse ( ) [inline]

Returns:: an expression of the reverse of *this.

Example:

Output:

Definition at line 118 of file Reverse.h.

{
  return ReverseReturnType(derived());
}

template<typename Derived>

EIGEN_DEVICE_FUNC ConstReverseReturnType Eigen::DenseBase< Derived >::reverse ( ) const [inline]

This is the const version of reverse().

Definition at line 558 of file DenseBase.h.

    {
      return ConstReverseReturnType(derived());
    }

template<typename Derived >

void Eigen::DenseBase< Derived >::reverseInPlace ( ) [inline]

This is the "in place" version of reverse: it reverses *this.

In most cases it is probably better to simply use the reversed expression of a matrix. However, when reversing the matrix data itself is really needed, then this "in-place" version is probably the right choice because it provides the following additional benefits:

less error prone: doing the same operation with .reverse() requires special care:
```
 m = m.reverse().eval(); 
```
this API enables reverse operations without the need for a temporary
it allows future optimizations (cache friendliness, etc.)

See also:: VectorwiseOp::reverseInPlace(), reverse()

Definition at line 139 of file Reverse.h.

{
  if(cols()>rows())
  {
    Index half = cols()/2;
    leftCols(half).swap(rightCols(half).reverse());
    if((cols()%2)==1)
    {
      Index half2 = rows()/2;
      col(half).head(half2).swap(col(half).tail(half2).reverse());
    }
  }
  else
  {
    Index half = rows()/2;
    topRows(half).swap(bottomRows(half).reverse());
    if((rows()%2)==1)
    {
      Index half2 = cols()/2;
      row(half).head(half2).swap(row(half).tail(half2).reverse());
    }
  }
}

template<typename Derived>

EIGEN_DEVICE_FUNC ColsBlockXpr Eigen::DenseBase< Derived >::rightCols ( Index n ) [inline]

Returns:: a block consisting of the right columns of *this.

Parameters:

n	the number of columns in the block

Example:

Output:

See also:: class Block, block(Index,Index,Index,Index)

Definition at line 615 of file DenseBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC ConstColsBlockXpr Eigen::DenseBase< Derived >::rightCols ( Index n ) const [inline]

This is the const version of rightCols(Index).

Definition at line 622 of file DenseBase.h.

template<typename Derived>

template<int N>

EIGEN_DEVICE_FUNC NColsBlockXpr<N>::Type Eigen::DenseBase< Derived >::rightCols ( Index n = N ) [inline]

Returns:: a block consisting of the right columns of *this.

Template Parameters:

N	the number of columns in the block as specified at compile-time

Parameters:

n	the number of columns in the block as specified at run-time

The compile-time and run-time information should not contradict. In other words, n should equal N unless N is Dynamic.

Example:

Output:

See also:: class Block, block(Index,Index,Index,Index)

Definition at line 642 of file DenseBase.h.

template<typename Derived>

template<int N>

EIGEN_DEVICE_FUNC ConstNColsBlockXpr<N>::Type Eigen::DenseBase< Derived >::rightCols ( Index n = N ) const [inline]

This is the const version of rightCols<int>().

Definition at line 650 of file DenseBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC RowXpr Eigen::DenseBase< Derived >::row ( Index i ) [inline]

Returns:: an expression of the i-th row of *this. Note that the numbering starts at 0.

Example:

Output:

See also:: col(), class Block

Definition at line 802 of file DenseBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC ConstRowXpr Eigen::DenseBase< Derived >::row ( Index i ) const [inline]

This is the const version of row().

Definition at line 809 of file DenseBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC ConstRowwiseReturnType Eigen::DenseBase< Derived >::rowwise ( ) const [inline]

Returns:: a VectorwiseOp wrapper of *this providing additional partial reduction operations

Example:

Output:

See also:: colwise(), class VectorwiseOp, TutorialReductionsVisitorsBroadcasting

Definition at line 498 of file DenseBase.h.

                                                                    {
      return ConstRowwiseReturnType(derived());
    }

template<typename Derived >

DenseBase< Derived >::RowwiseReturnType Eigen::DenseBase< Derived >::rowwise ( ) [inline]

Returns:: a writable VectorwiseOp wrapper of *this providing additional partial reduction operations

See also:: colwise(), class VectorwiseOp, TutorialReductionsVisitorsBroadcasting

Definition at line 677 of file VectorwiseOp.h.

{
  return RowwiseReturnType(derived());
}

template<typename Derived>

EIGEN_DEVICE_FUNC SegmentReturnType Eigen::DenseBase< Derived >::segment	(	Index	start,
		Index	n
	)		`[inline]`

Returns:: a dynamic-size expression of a segment (i.e. a vector block) in *this.

Parameters:

start	the first coefficient in the segment
n	the number of coefficients in the segment

Example:

Output:

Note:: Even though the returned expression has dynamic size, in the case when it is applied to a fixed-size vector, it inherits a fixed maximal size, which means that evaluating it does not cause a dynamic memory allocation.

See also:: class Block, segment(Index)

Definition at line 831 of file DenseBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC ConstSegmentReturnType Eigen::DenseBase< Derived >::segment	(	Index	start,
		Index	n
	)		const `[inline]`

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

Definition at line 840 of file DenseBase.h.

template<typename Derived>

template<int N>

EIGEN_DEVICE_FUNC FixedSegmentReturnType<N>::Type Eigen::DenseBase< Derived >::segment	(	Index	start,
		Index	n = `N`
	)		`[inline]`

Returns:: a fixed-size expression of a segment (i.e. a vector block) in *this

Template Parameters:

N	the number of coefficients in the segment as specified at compile-time

Parameters:

start	the index of the first element in the segment
n	the number of coefficients in the segment as specified at compile-time

The compile-time and run-time information should not contradict. In other words, n should equal N unless N is Dynamic.

Example:

Output:

See also:: class Block

Definition at line 924 of file DenseBase.h.

template<typename Derived>

template<int N>

EIGEN_DEVICE_FUNC ConstFixedSegmentReturnType<N>::Type Eigen::DenseBase< Derived >::segment	(	Index	start,
		Index	n = `N`
	)		const `[inline]`

This is the const version of segment<int>(Index).

Definition at line 933 of file DenseBase.h.

template<typename Derived >

template<typename ThenDerived , typename ElseDerived >

const Select< Derived, ThenDerived, ElseDerived > Eigen::DenseBase< Derived >::select	(	const DenseBase< ThenDerived > &	thenMatrix,
		const DenseBase< ElseDerived > &	elseMatrix
	)		const `[inline]`

Returns:: a matrix where each coefficient (i,j) is equal to thenMatrix(i,j) if *this(i,j), and elseMatrix(i,j) otherwise.

Example:

Output:

See also:: class Select

Definition at line 124 of file Select.h.

{
  return Select<Derived,ThenDerived,ElseDerived>(derived(), thenMatrix.derived(), elseMatrix.derived());
}

template<typename Derived >

template<typename ThenDerived >

const Select< Derived, ThenDerived, typename ThenDerived::ConstantReturnType > Eigen::DenseBase< Derived >::select	(	const DenseBase< ThenDerived > &	thenMatrix,
		const typename ThenDerived::Scalar &	elseScalar
	)		const `[inline]`

Version of DenseBase::select(const DenseBase&, const DenseBase&) with the else expression being a scalar value.

See also:: DenseBase::select(const DenseBase<ThenDerived>&, const DenseBase<ElseDerived>&) const, class Select

Definition at line 138 of file Select.h.

{
  return Select<Derived,ThenDerived,typename ThenDerived::ConstantReturnType>(
    derived(), thenMatrix.derived(), ThenDerived::Constant(rows(),cols(),elseScalar));
}

template<typename Derived >

template<typename ElseDerived >

const Select< Derived, typename ElseDerived::ConstantReturnType, ElseDerived > Eigen::DenseBase< Derived >::select	(	const typename ElseDerived::Scalar &	thenScalar,
		const DenseBase< ElseDerived > &	elseMatrix
	)		const `[inline]`

Version of DenseBase::select(const DenseBase&, const DenseBase&) with the then expression being a scalar value.

See also:: DenseBase::select(const DenseBase<ThenDerived>&, const DenseBase<ElseDerived>&) const, class Select

Definition at line 153 of file Select.h.

{
  return Select<Derived,typename ElseDerived::ConstantReturnType,ElseDerived>(
    derived(), ElseDerived::Constant(rows(),cols(),thenScalar), elseMatrix.derived());
}

template<typename Derived >

EIGEN_STRONG_INLINE Derived & Eigen::DenseBase< Derived >::setConstant ( const Scalar & val )

Sets all coefficients in this expression to value val.

See also:: fill(), setConstant(Index,const Scalar&), setConstant(Index,Index,const Scalar&), setZero(), setOnes(), Constant(), class CwiseNullaryOp, setZero(), setOnes()

Definition at line 335 of file CwiseNullaryOp.h.

{
  return derived() = Constant(rows(), cols(), val);
}

template<typename Derived >

EIGEN_STRONG_INLINE Derived & Eigen::DenseBase< Derived >::setLinSpaced	(	Index	newSize,
		const Scalar &	low,
		const Scalar &	high
	)

Sets a linearly spaced vector.

The function generates 'size' equally spaced values in the closed interval [low,high]. When size is set to 1, a vector of length 1 containing 'high' is returned.

Example:

Output:

See also:: CwiseNullaryOp

Definition at line 390 of file CwiseNullaryOp.h.

{
  EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived)
  return derived() = Derived::NullaryExpr(newSize, internal::linspaced_op<Scalar,PacketScalar,false>(low,high,newSize));
}

template<typename Derived >

EIGEN_STRONG_INLINE Derived & Eigen::DenseBase< Derived >::setLinSpaced	(	const Scalar &	low,
		const Scalar &	high
	)

Sets a linearly spaced vector.

The function fill *this with equally spaced values in the closed interval [low,high]. When size is set to 1, a vector of length 1 containing 'high' is returned.

See also:: setLinSpaced(Index, const Scalar&, const Scalar&), CwiseNullaryOp

Definition at line 407 of file CwiseNullaryOp.h.

{
  EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived)
  return setLinSpaced(size(), low, high);
}

template<typename Derived >

EIGEN_STRONG_INLINE Derived & Eigen::DenseBase< Derived >::setOnes ( )

Sets all coefficients in this expression to one.

Example:

Output:

See also:: class CwiseNullaryOp, Ones()

Definition at line 629 of file CwiseNullaryOp.h.

{
  return setConstant(Scalar(1));
}

template<typename Derived >

Derived & Eigen::DenseBase< Derived >::setRandom ( ) [inline]

Sets all coefficients in this expression to random values.

Numbers are uniformly spread through their whole definition range for integer types, and in the [-1:1] range for floating point scalar types.

Example:

Output:

See also:: class CwiseNullaryOp, setRandom(Index), setRandom(Index,Index)

Definition at line 132 of file Random.h.

{
  return *this = Random(rows(), cols());
}

template<typename Derived >

EIGEN_STRONG_INLINE Derived & Eigen::DenseBase< Derived >::setZero ( )

Sets all coefficients in this expression to zero.

Example:

Output:

See also:: class CwiseNullaryOp, Zero()

Definition at line 503 of file CwiseNullaryOp.h.

{
  return setConstant(Scalar(0));
}

template<typename Derived >

EIGEN_STRONG_INLINE internal::traits< Derived >::Scalar Eigen::DenseBase< Derived >::sum ( ) const

Returns:: the sum of all coefficients of *this

See also:: trace(), prod(), mean()

Definition at line 445 of file Redux.h.

{
  if(SizeAtCompileTime==0 || (SizeAtCompileTime==Dynamic && size()==0))
    return Scalar(0);
  return derived().redux(Eigen::internal::scalar_sum_op<Scalar>());
}

template<typename Derived>

template<typename OtherDerived >

EIGEN_DEVICE_FUNC void Eigen::DenseBase< Derived >::swap ( const DenseBase< OtherDerived > & other ) [inline]

swaps *this with the expression other.

Definition at line 418 of file DenseBase.h.

    {
      EIGEN_STATIC_ASSERT(!OtherDerived::IsPlainObjectBase,THIS_EXPRESSION_IS_NOT_A_LVALUE__IT_IS_READ_ONLY);
      eigen_assert(rows()==other.rows() && cols()==other.cols());
      call_assignment(derived(), other.const_cast_derived(), internal::swap_assign_op<Scalar>());
    }

template<typename Derived>

template<typename OtherDerived >

EIGEN_DEVICE_FUNC void Eigen::DenseBase< Derived >::swap ( PlainObjectBase< OtherDerived > & other ) [inline]

swaps *this with the matrix or array other.

Definition at line 430 of file DenseBase.h.

    {
      eigen_assert(rows()==other.rows() && cols()==other.cols());
      call_assignment(derived(), other.derived(), internal::swap_assign_op<Scalar>());
    }

template<typename Derived>

EIGEN_DEVICE_FUNC SegmentReturnType Eigen::DenseBase< Derived >::tail ( Index n ) [inline]

Returns:: a dynamic-size expression of the last coefficients of *this.

Parameters:

n	the number of coefficients in the segment

Example:

Output:

Note:: Even though the returned expression has dynamic size, in the case when it is applied to a fixed-size vector, it inherits a fixed maximal size, which means that evaluating it does not cause a dynamic memory allocation.

See also:: class Block, block(Index,Index)

Definition at line 892 of file DenseBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC ConstSegmentReturnType Eigen::DenseBase< Derived >::tail ( Index n ) const [inline]

This is the const version of tail(Index).

Definition at line 900 of file DenseBase.h.

template<typename Derived>

template<int N>

EIGEN_DEVICE_FUNC FixedSegmentReturnType<N>::Type Eigen::DenseBase< Derived >::tail ( Index n = N ) [inline]

Returns:: a fixed-size expression of the last coefficients of *this.

Template Parameters:

N	the number of coefficients in the segment as specified at compile-time

Parameters:

n	the number of coefficients in the segment as specified at run-time

The compile-time and run-time information should not contradict. In other words, n should equal N unless N is Dynamic.

Example:

Output:

See also:: class Block

Definition at line 988 of file DenseBase.h.

template<typename Derived>

template<int N>

EIGEN_DEVICE_FUNC ConstFixedSegmentReturnType<N>::Type Eigen::DenseBase< Derived >::tail ( Index n = N ) const [inline]

This is the const version of tail<int>.

Definition at line 997 of file DenseBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC BlockXpr Eigen::DenseBase< Derived >::topLeftCorner	(	Index	cRows,
		Index	cCols
	)		`[inline]`

Returns:: a dynamic-size expression of a top-left corner of *this.

Parameters:

cRows	the number of rows in the corner
cCols	the number of columns in the corner

Example:

Output:

See also:: class Block, block(Index,Index,Index,Index)

Definition at line 169 of file DenseBase.h.

                             : int(IsRowMajor) ? int(ColsAtCompileTime) : int(RowsAtCompileTime),

template<typename Derived>

EIGEN_DEVICE_FUNC const ConstBlockXpr Eigen::DenseBase< Derived >::topLeftCorner	(	Index	cRows,
		Index	cCols
	)		const `[inline]`

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

Definition at line 176 of file DenseBase.h.

         { IsPlainObjectBase = 0 };

template<typename Derived>

template<int CRows, int CCols>

EIGEN_DEVICE_FUNC FixedBlockXpr<CRows,CCols>::Type Eigen::DenseBase< Derived >::topLeftCorner ( ) [inline]

Returns:: an expression of a fixed-size top-left corner of *this.

The template parameters CRows and CCols are the number of rows and columns in the corner.

Example:

Output:

See also:: class Block, block(Index,Index,Index,Index)

Definition at line 192 of file DenseBase.h.

template<typename Derived>

template<int CRows, int CCols>

EIGEN_DEVICE_FUNC const ConstFixedBlockXpr<CRows,CCols>::Type Eigen::DenseBase< Derived >::topLeftCorner ( ) const [inline]

This is the const version of topLeftCorner<int, int>().

Definition at line 200 of file DenseBase.h.

template<typename Derived>

template<int CRows, int CCols>

FixedBlockXpr<CRows,CCols>::Type Eigen::DenseBase< Derived >::topLeftCorner	(	Index	cRows,
		Index	cCols
	)		`[inline]`

Returns:: an expression of a top-left corner of *this.

Template Parameters:

CRows	number of rows in corner as specified at compile-time
CCols	number of columns in corner as specified at compile-time

Parameters:

cRows	number of rows in corner as specified at run-time
cCols	number of columns in corner as specified at run-time

This function is mainly useful for corners where the number of rows is specified at compile-time and the number of columns is specified at run-time, or vice versa. The compile-time and run-time information should not contradict. In other words, cRows should equal CRows unless CRows is Dynamic, and the same for the number of columns.

Example:

Output:

See also:: class Block

Definition at line 223 of file DenseBase.h.

    {
      return IsVectorAtCompileTime ? 1
           : int(IsRowMajor) ? this->rows() : this->cols();
    }

template<typename Derived>

template<int CRows, int CCols>

const ConstFixedBlockXpr<CRows,CCols>::Type Eigen::DenseBase< Derived >::topLeftCorner	(	Index	cRows,
		Index	cCols
	)		const `[inline]`

This is the const version of topLeftCorner<int, int>(Index, Index).

Definition at line 230 of file DenseBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC BlockXpr Eigen::DenseBase< Derived >::topRightCorner	(	Index	cRows,
		Index	cCols
	)		`[inline]`

Returns:: a dynamic-size expression of a top-right corner of *this.

Parameters:

cRows	the number of rows in the corner
cCols	the number of columns in the corner

Example:

Output:

See also:: class Block, block(Index,Index,Index,Index)

Definition at line 89 of file DenseBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC const ConstBlockXpr Eigen::DenseBase< Derived >::topRightCorner	(	Index	cRows,
		Index	cCols
	)		const `[inline]`

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

Definition at line 96 of file DenseBase.h.

template<typename Derived>

template<int CRows, int CCols>

EIGEN_DEVICE_FUNC FixedBlockXpr<CRows,CCols>::Type Eigen::DenseBase< Derived >::topRightCorner ( ) [inline]

Returns:: an expression of a fixed-size top-right corner of *this.

Template Parameters:

CRows	the number of rows in the corner
CCols	the number of columns in the corner

Example:

Output:

See also:: class Block, block<int,int>(Index,Index)

Definition at line 113 of file DenseBase.h.

template<typename Derived>

template<int CRows, int CCols>

EIGEN_DEVICE_FUNC const ConstFixedBlockXpr<CRows,CCols>::Type Eigen::DenseBase< Derived >::topRightCorner ( ) const [inline]

This is the const version of topRightCorner<int, int>().

Definition at line 121 of file DenseBase.h.

template<typename Derived>

template<int CRows, int CCols>

FixedBlockXpr<CRows,CCols>::Type Eigen::DenseBase< Derived >::topRightCorner	(	Index	cRows,
		Index	cCols
	)		`[inline]`

Returns:: an expression of a top-right corner of *this.

Template Parameters:

CRows	number of rows in corner as specified at compile-time
CCols	number of columns in corner as specified at compile-time

Parameters:

cRows	number of rows in corner as specified at run-time
cCols	number of columns in corner as specified at run-time

This function is mainly useful for corners where the number of rows is specified at compile-time and the number of columns is specified at run-time, or vice versa. The compile-time and run-time information should not contradict. In other words, cRows should equal CRows unless CRows is Dynamic, and the same for the number of columns.

Example:

Output:

See also:: class Block

Definition at line 144 of file DenseBase.h.

template<typename Derived>

template<int CRows, int CCols>

const ConstFixedBlockXpr<CRows,CCols>::Type Eigen::DenseBase< Derived >::topRightCorner	(	Index	cRows,
		Index	cCols
	)		const `[inline]`

This is the const version of topRightCorner<int, int>(Index, Index).

Definition at line 151 of file DenseBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC RowsBlockXpr Eigen::DenseBase< Derived >::topRows ( Index n ) [inline]

Returns:: a block consisting of the top rows of *this.

Parameters:

n	the number of rows in the block

Example:

Output:

See also:: class Block, block(Index,Index,Index,Index)

Definition at line 405 of file DenseBase.h.

    {
      // Even though MSVC does not honor strong inlining when the return type
      // is a dynamic matrix, we desperately need strong inlining for fixed

template<typename Derived>

EIGEN_DEVICE_FUNC ConstRowsBlockXpr Eigen::DenseBase< Derived >::topRows ( Index n ) const [inline]

This is the const version of topRows(Index).

Definition at line 412 of file DenseBase.h.

template<typename Derived>

template<int N>

EIGEN_DEVICE_FUNC NRowsBlockXpr<N>::Type Eigen::DenseBase< Derived >::topRows ( Index n = N ) [inline]

Returns:: a block consisting of the top rows of *this.

Template Parameters:

N	the number of rows in the block as specified at compile-time

Parameters:

n	the number of rows in the block as specified at run-time

The compile-time and run-time information should not contradict. In other words, n should equal N unless N is Dynamic.

Example:

Output:

See also:: class Block, block(Index,Index,Index,Index)

Definition at line 432 of file DenseBase.h.

template<typename Derived>

template<int N>

EIGEN_DEVICE_FUNC ConstNRowsBlockXpr<N>::Type Eigen::DenseBase< Derived >::topRows ( Index n = N ) const [inline]

This is the const version of topRows<int>().

Definition at line 440 of file DenseBase.h.

template<typename Derived>

EIGEN_DEVICE_FUNC Scalar Eigen::DenseBase< Derived >::trace ( ) const

Reimplemented in Eigen::MatrixBase< Derived >, Eigen::MatrixBase< MatrixWrapper< ExpressionType > >, Eigen::MatrixBase< Homogeneous< MatrixType, _Direction > >, and Eigen::MatrixBase< Solve< Decomposition, RhsType > >.

template<typename Derived >

Transpose< Derived > Eigen::DenseBase< Derived >::transpose ( ) [inline]

Returns:: an expression of the transpose of *this.

Example:

Output:

Warning:

If you want to replace a matrix by its own transpose, do NOT do this:

 m = m.transpose(); // bug!!! caused by aliasing effect

Instead, use the transposeInPlace() method:

 m.transposeInPlace();

which gives Eigen good opportunities for optimization, or alternatively you can also do:

 m = m.transpose().eval();

See also:: transposeInPlace(), adjoint()

Definition at line 167 of file Transpose.h.

{
  return TransposeReturnType(derived());
}

template<typename Derived >

DenseBase< Derived >::ConstTransposeReturnType Eigen::DenseBase< Derived >::transpose ( ) const [inline]

This is the const version of transpose().

Make sure you read the warning for transpose() !

See also:: transposeInPlace(), adjoint()

Definition at line 179 of file Transpose.h.

{
  return ConstTransposeReturnType(derived());
}

template<typename Derived >

void Eigen::DenseBase< Derived >::transposeInPlace ( ) [inline]

This is the "in place" version of transpose(): it replaces *this by its own transpose. Thus, doing

 m.transposeInPlace();

has the same effect on m as doing

 m = m.transpose().eval();

and is faster and also safer because in the latter line of code, forgetting the eval() results in a bug caused by aliasing.

Notice however that this method is only useful if you want to replace a matrix by its own transpose. If you just need the transpose of a matrix, use transpose().

Note:: if the matrix is not square, then *this must be a resizable matrix. This excludes (non-square) fixed-size matrices, block-expressions and maps.

See also:: transpose(), adjoint(), adjointInPlace()

Definition at line 279 of file Transpose.h.

{
  eigen_assert((rows() == cols() || (RowsAtCompileTime == Dynamic && ColsAtCompileTime == Dynamic))
               && "transposeInPlace() called on a non-square non-resizable matrix");
  internal::inplace_transpose_selector<Derived>::run(derived());
}

template<typename Derived>

EIGEN_DEVICE_FUNC CoeffReturnType Eigen::DenseBase< Derived >::value ( ) const [inline]

Returns:: the unique coefficient of a 1x1 expression

Definition at line 474 of file DenseBase.h.

    {
      EIGEN_STATIC_ASSERT_SIZE_1x1(Derived)
      eigen_assert(this->rows() == 1 && this->cols() == 1);
      return derived().coeff(0,0);
    }

template<typename Derived >

template<typename Visitor >

EIGEN_DEVICE_FUNC void Eigen::DenseBase< Derived >::visit ( Visitor & visitor ) const

Applies the visitor visitor to the whole coefficients of the matrix or vector.

The template parameter Visitor is the type of the visitor and provides the following interface:

 struct MyVisitor {
   // called for the first coefficient
   void init(const Scalar& value, Index i, Index j);
   // called for all other coefficients
   void operator() (const Scalar& value, Index i, Index j);
 };

Note:: compared to one or two for loops, visitors offer automatic unrolling for small fixed size matrix.

See also:: minCoeff(Index*,Index*), maxCoeff(Index*,Index*), DenseBase::redux()

Definition at line 107 of file Visitor.h.

{
  typedef typename internal::visitor_evaluator<Derived> ThisEvaluator;
  ThisEvaluator thisEval(derived());
  
  enum {
    unroll =  SizeAtCompileTime != Dynamic
           && SizeAtCompileTime * ThisEvaluator::CoeffReadCost + (SizeAtCompileTime-1) * internal::functor_traits<Visitor>::Cost <= EIGEN_UNROLLING_LIMIT
  };
  return internal::visitor_impl<Visitor, ThisEvaluator, unroll ? int(SizeAtCompileTime) : Dynamic>::run(thisEval, visitor);
}

template<typename Derived >

EIGEN_STRONG_INLINE const DenseBase< Derived >::ConstantReturnType Eigen::DenseBase< Derived >::Zero	(	Index	rows,
		Index	cols
	)		`[static]`

Returns:: an expression of a zero matrix.

The parameters rows and cols are the number of rows and of columns of the returned matrix. Must be compatible with this MatrixBase type.

This variant is meant to be used for dynamic-size matrix types. For fixed-size types, it is redundant to pass rows and cols as arguments, so Zero() should be used instead.

Example:

Output:

See also:: Zero(), Zero(Index)

Definition at line 431 of file CwiseNullaryOp.h.

{
  return Constant(rows, cols, Scalar(0));
}

template<typename Derived >

EIGEN_STRONG_INLINE const DenseBase< Derived >::ConstantReturnType Eigen::DenseBase< Derived >::Zero ( Index size ) [static]

Returns:: an expression of a zero vector.

The parameter size is the size of the returned vector. Must be compatible with this MatrixBase type.

This variant is meant to be used for dynamic-size vector types. For fixed-size types, it is redundant to pass size as argument, so Zero() should be used instead.

Example:

Output:

See also:: Zero(), Zero(Index,Index)

Definition at line 454 of file CwiseNullaryOp.h.

{
  return Constant(size, Scalar(0));
}

template<typename Derived >

EIGEN_STRONG_INLINE const DenseBase< Derived >::ConstantReturnType Eigen::DenseBase< Derived >::Zero ( ) [static]

Returns:: an expression of a fixed-size zero matrix or vector.

This variant is only for fixed-size MatrixBase types. For dynamic-size types, you need to use the variants taking size arguments.

Example:

Output:

See also:: Zero(Index), Zero(Index,Index)

Definition at line 471 of file CwiseNullaryOp.h.

{
  return Constant(Scalar(0));
}

Friends And Related Function Documentation

template<typename Derived >

std::ostream & operator<<	(	std::ostream &	s,
		const DenseBase< Derived > &	m
	)		`[related]`

Outputs the matrix, to the given stream.

If you wish to print the matrix with a format different than the default, use DenseBase::format().

It is also possible to change the default format by defining EIGEN_DEFAULT_IO_FORMAT before including Eigen headers. If not defined, this will automatically be defined to Eigen::IOFormat(), that is the Eigen::IOFormat with default parameters.

See also:: DenseBase::format()

Definition at line 245 of file IO.h.

{
  return internal::print_matrix(s, m.eval(), EIGEN_DEFAULT_IO_FORMAT);
}

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Related Functions

Detailed Description

template<typename Derived> class Eigen::DenseBase< Derived >

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

template<typename Derived>
class Eigen::DenseBase< Derived >