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

#include <DenseBase.h>

Inheritance diagram for Eigen::DenseBase< Derived >:

Classes
struct	ConstFixedSegmentReturnType
struct	ConstNColsBlockXpr
struct	ConstNRowsBlockXpr
struct	FixedSegmentReturnType
class	InnerIterator
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, CoeffReadCost = internal::traits<Derived>::CoeffReadCost, InnerStrideAtCompileTime = internal::inner_stride_at_compile_time<Derived>::ret, OuterStrideAtCompileTime = internal::outer_stride_at_compile_time<Derived>::ret }
enum	{ ThisConstantIsPrivateInPlainObjectBase }
typedef DenseCoeffsBase< Derived >	Base
typedef Base::CoeffReturnType	CoeffReturnType
typedef Block< Derived, internal::traits< Derived > ::RowsAtCompileTime, Dynamic,!IsRowMajor >	ColsBlockXpr
typedef VectorwiseOp< Derived, Vertical >	ColwiseReturnType
typedef Block< Derived, internal::traits< Derived > ::RowsAtCompileTime, 1,!IsRowMajor >	ColXpr
typedef CwiseNullaryOp < internal::scalar_constant_op < Scalar >, Derived >	ConstantReturnType
typedef const Block< const Derived, internal::traits < Derived >::RowsAtCompileTime, Dynamic,!IsRowMajor >	ConstColsBlockXpr
typedef const VectorwiseOp < const Derived, Vertical >	ConstColwiseReturnType
typedef const Block< const Derived, internal::traits < Derived >::RowsAtCompileTime, 1,!IsRowMajor >	ConstColXpr
typedef const Reverse< const Derived, BothDirections >	ConstReverseReturnType
typedef const Block< const Derived, Dynamic, internal::traits< Derived > ::ColsAtCompileTime, IsRowMajor >	ConstRowsBlockXpr
typedef const VectorwiseOp < const Derived, Horizontal >	ConstRowwiseReturnType
typedef const Block< const Derived, 1, internal::traits < Derived >::ColsAtCompileTime, IsRowMajor >	ConstRowXpr
typedef const VectorBlock < const Derived >	ConstSegmentReturnType
typedef internal::add_const < Transpose< const Derived > >::type	ConstTransposeReturnType
typedef Matrix< typename NumTraits< typename internal::traits< Derived > ::Scalar >::Real, internal::traits< Derived > ::ColsAtCompileTime, 1 >	EigenvaluesReturnType
typedef internal::add_const_on_value_type < typename internal::eval < Derived >::type >::type	EvalReturnType
typedef internal::traits < Derived >::Index	Index
	The type of indices.
typedef internal::packet_traits < Scalar >::type	PacketScalar
typedef CwiseNullaryOp < internal::linspaced_op < Scalar, true >, Derived >	RandomAccessLinSpacedReturnType
typedef NumTraits< Scalar >::Real	RealScalar
typedef Reverse< Derived, BothDirections >	ReverseReturnType
typedef Block< Derived, Dynamic, internal::traits < Derived >::ColsAtCompileTime, IsRowMajor >	RowsBlockXpr
typedef VectorwiseOp< Derived, Horizontal >	RowwiseReturnType
typedef Block< Derived, 1, internal::traits< Derived > ::ColsAtCompileTime, IsRowMajor >	RowXpr
typedef internal::traits < Derived >::Scalar	Scalar
typedef VectorBlock< Derived >	SegmentReturnType
typedef CwiseNullaryOp < internal::linspaced_op < Scalar, false >, Derived >	SequentialLinSpacedReturnType
typedef internal::traits < Derived >::StorageKind	StorageKind
Public Member Functions
bool	all (void) const
bool	allFinite () const
bool	any (void) const
Block< Derived >	block (Index startRow, Index startCol, Index blockRows, Index blockCols)
const Block< const Derived >	block (Index startRow, Index startCol, Index blockRows, Index blockCols) const
template<int BlockRows, int BlockCols>
Block< Derived, BlockRows, BlockCols >	block (Index startRow, Index startCol)
template<int BlockRows, int BlockCols>
const Block< const Derived, BlockRows, BlockCols >	block (Index startRow, Index startCol) const
template<int BlockRows, int BlockCols>
Block< Derived, BlockRows, BlockCols >	block (Index startRow, Index startCol, Index blockRows, Index blockCols)
template<int BlockRows, int BlockCols>
const Block< const Derived, BlockRows, BlockCols >	block (Index startRow, Index startCol, Index blockRows, Index blockCols) const
Block< Derived >	bottomLeftCorner (Index cRows, Index cCols)
const Block< const Derived >	bottomLeftCorner (Index cRows, Index cCols) const
template<int CRows, int CCols>
Block< Derived, CRows, CCols >	bottomLeftCorner ()
template<int CRows, int CCols>
const Block< const Derived, CRows, CCols >	bottomLeftCorner () const
template<int CRows, int CCols>
Block< Derived, CRows, CCols >	bottomLeftCorner (Index cRows, Index cCols)
template<int CRows, int CCols>
const Block< const Derived, CRows, CCols >	bottomLeftCorner (Index cRows, Index cCols) const
Block< Derived >	bottomRightCorner (Index cRows, Index cCols)
const Block< const Derived >	bottomRightCorner (Index cRows, Index cCols) const
template<int CRows, int CCols>
Block< Derived, CRows, CCols >	bottomRightCorner ()
template<int CRows, int CCols>
const Block< const Derived, CRows, CCols >	bottomRightCorner () const
template<int CRows, int CCols>
Block< Derived, CRows, CCols >	bottomRightCorner (Index cRows, Index cCols)
template<int CRows, int CCols>
const Block< const Derived, CRows, CCols >	bottomRightCorner (Index cRows, Index cCols) const
RowsBlockXpr	bottomRows (Index n)
ConstRowsBlockXpr	bottomRows (Index n) const
template<int N>
NRowsBlockXpr< N >::Type	bottomRows ()
template<int N>
ConstNRowsBlockXpr< N >::Type	bottomRows () const
ColXpr	col (Index i)
ConstColXpr	col (Index i) const
ConstColwiseReturnType	colwise () const
ColwiseReturnType	colwise ()
Index	count () const
EIGEN_STRONG_INLINE EvalReturnType	eval () const
template<typename Dest >
void	evalTo (Dest &) const
void	fill (const Scalar &value)
template<unsigned int Added, unsigned int Removed>
const Flagged< Derived, Added, Removed >	flagged () const
const ForceAlignedAccess< Derived >	forceAlignedAccess () const
ForceAlignedAccess< Derived >	forceAlignedAccess ()
template<bool Enable>
const internal::conditional < Enable, ForceAlignedAccess < Derived >, Derived & >::type	forceAlignedAccessIf () const
template<bool Enable>
internal::conditional< Enable, ForceAlignedAccess< Derived > , Derived & >::type	forceAlignedAccessIf ()
const WithFormat< Derived >	format (const IOFormat &fmt) const
bool	hasNaN () const
SegmentReturnType	head (Index vecSize)
ConstSegmentReturnType	head (Index vecSize) const
template<int Size>
FixedSegmentReturnType< Size > ::Type	head ()
template<int Size>
ConstFixedSegmentReturnType < Size >::Type	head () const
Index	innerSize () const
template<typename OtherDerived >
bool	isApprox (const DenseBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
bool	isApproxToConstant (const Scalar &value, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
bool	isConstant (const Scalar &value, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
template<typename Derived >
bool	isMuchSmallerThan (const typename NumTraits< Scalar >::Real &other, const RealScalar &prec) const
bool	isMuchSmallerThan (const RealScalar &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
template<typename OtherDerived >
bool	isMuchSmallerThan (const DenseBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
bool	isOnes (const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
bool	isZero (const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
template<typename OtherDerived >
Derived &	lazyAssign (const DenseBase< OtherDerived > &other)
ColsBlockXpr	leftCols (Index n)
ConstColsBlockXpr	leftCols (Index n) const
template<int N>
NColsBlockXpr< N >::Type	leftCols ()
template<int N>
ConstNColsBlockXpr< N >::Type	leftCols () const
template<int p>
RealScalar	lpNorm () const
internal::traits< Derived >::Scalar	maxCoeff () const
template<typename IndexType >
internal::traits< Derived >::Scalar	maxCoeff (IndexType row, IndexType col) const
template<typename IndexType >
internal::traits< Derived >::Scalar	maxCoeff (IndexType *index) const
Scalar	mean () const
ColsBlockXpr	middleCols (Index startCol, Index numCols)
ConstColsBlockXpr	middleCols (Index startCol, Index numCols) const
template<int N>
NColsBlockXpr< N >::Type	middleCols (Index startCol)
template<int N>
ConstNColsBlockXpr< N >::Type	middleCols (Index startCol) const
RowsBlockXpr	middleRows (Index startRow, Index numRows)
ConstRowsBlockXpr	middleRows (Index startRow, Index numRows) const
template<int N>
NRowsBlockXpr< N >::Type	middleRows (Index startRow)
template<int N>
ConstNRowsBlockXpr< N >::Type	middleRows (Index startRow) const
internal::traits< Derived >::Scalar	minCoeff () const
template<typename IndexType >
internal::traits< Derived >::Scalar	minCoeff (IndexType row, IndexType col) const
template<typename IndexType >
internal::traits< Derived >::Scalar	minCoeff (IndexType *index) const
const NestByValue< Derived >	nestByValue () const
Index	nonZeros () const
Derived &	operator*= (const Scalar &other)
template<typename OtherDerived >
Derived &	operator+= (const EigenBase< OtherDerived > &other)
template<typename OtherDerived >
Derived &	operator-= (const EigenBase< OtherDerived > &other)
Derived &	operator/= (const Scalar &other)
CommaInitializer< Derived >	operator<< (const Scalar &s)
template<typename OtherDerived >
CommaInitializer< Derived >	operator<< (const DenseBase< OtherDerived > &other)
template<typename OtherDerived >
Derived &	operator= (const DenseBase< OtherDerived > &other)
Derived &	operator= (const DenseBase &other)
template<typename OtherDerived >
Derived &	operator= (const EigenBase< OtherDerived > &other)
	Copies the generic expression other into *this.
template<typename OtherDerived >
Derived &	operator= (const ReturnByValue< OtherDerived > &func)
Index	outerSize () const
Scalar	prod () const
template<int RowFactor, int ColFactor>
const Replicate< Derived, RowFactor, ColFactor >	replicate () const
const Replicate< Derived, Dynamic, Dynamic >	replicate (Index rowFacor, Index colFactor) const
void	resize (Index newSize)
void	resize (Index nbRows, Index nbCols)
ReverseReturnType	reverse ()
ConstReverseReturnType	reverse () const
void	reverseInPlace ()
ColsBlockXpr	rightCols (Index n)
ConstColsBlockXpr	rightCols (Index n) const
template<int N>
NColsBlockXpr< N >::Type	rightCols ()
template<int N>
ConstNColsBlockXpr< N >::Type	rightCols () const
RowXpr	row (Index i)
ConstRowXpr	row (Index i) const
ConstRowwiseReturnType	rowwise () const
RowwiseReturnType	rowwise ()
SegmentReturnType	segment (Index start, Index vecSize)
ConstSegmentReturnType	segment (Index start, Index vecSize) const
template<int Size>
FixedSegmentReturnType< Size > ::Type	segment (Index start)
template<int Size>
ConstFixedSegmentReturnType < Size >::Type	segment (Index start) const
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
Derived &	setConstant (const Scalar &value)
Derived &	setLinSpaced (Index size, const Scalar &low, const Scalar &high)
	Sets a linearly space vector.
Derived &	setLinSpaced (const Scalar &low, const Scalar &high)
	Sets a linearly space vector.
Derived &	setOnes ()
Derived &	setRandom ()
Derived &	setZero ()
Scalar	sum () const
template<typename OtherDerived >
void	swap (const DenseBase< OtherDerived > &other, int=OtherDerived::ThisConstantIsPrivateInPlainObjectBase)
template<typename OtherDerived >
void	swap (PlainObjectBase< OtherDerived > &other)
SegmentReturnType	tail (Index vecSize)
ConstSegmentReturnType	tail (Index vecSize) const
template<int Size>
FixedSegmentReturnType< Size > ::Type	tail ()
template<int Size>
ConstFixedSegmentReturnType < Size >::Type	tail () const
Block< Derived >	topLeftCorner (Index cRows, Index cCols)
const Block< const Derived >	topLeftCorner (Index cRows, Index cCols) const
template<int CRows, int CCols>
Block< Derived, CRows, CCols >	topLeftCorner ()
template<int CRows, int CCols>
const Block< const Derived, CRows, CCols >	topLeftCorner () const
template<int CRows, int CCols>
Block< Derived, CRows, CCols >	topLeftCorner (Index cRows, Index cCols)
template<int CRows, int CCols>
const Block< const Derived, CRows, CCols >	topLeftCorner (Index cRows, Index cCols) const
Block< Derived >	topRightCorner (Index cRows, Index cCols)
const Block< const Derived >	topRightCorner (Index cRows, Index cCols) const
template<int CRows, int CCols>
Block< Derived, CRows, CCols >	topRightCorner ()
template<int CRows, int CCols>
const Block< const Derived, CRows, CCols >	topRightCorner () const
template<int CRows, int CCols>
Block< Derived, CRows, CCols >	topRightCorner (Index cRows, Index cCols)
template<int CRows, int CCols>
const Block< const Derived, CRows, CCols >	topRightCorner (Index cRows, Index cCols) const
RowsBlockXpr	topRows (Index n)
ConstRowsBlockXpr	topRows (Index n) const
template<int N>
NRowsBlockXpr< N >::Type	topRows ()
template<int N>
ConstNRowsBlockXpr< N >::Type	topRows () const
Scalar	trace () const
Eigen::Transpose< Derived >	transpose ()
ConstTransposeReturnType	transpose () const
void	transposeInPlace ()
CoeffReturnType	value () const
template<typename Visitor >
void	visit (Visitor &func) const
Static Public Member Functions
static const ConstantReturnType	Constant (Index rows, Index cols, const Scalar &value)
static const ConstantReturnType	Constant (Index size, const Scalar &value)
static const ConstantReturnType	Constant (const Scalar &value)
static const SequentialLinSpacedReturnType	LinSpaced (Sequential_t, Index size, const Scalar &low, const Scalar &high)
	Sets a linearly space vector.
static const RandomAccessLinSpacedReturnType	LinSpaced (Index size, const Scalar &low, const Scalar &high)
	Sets a linearly space vector.
static const SequentialLinSpacedReturnType	LinSpaced (Sequential_t, const Scalar &low, const Scalar &high)
static const RandomAccessLinSpacedReturnType	LinSpaced (const Scalar &low, const Scalar &high)
template<typename CustomNullaryOp >
static const CwiseNullaryOp < CustomNullaryOp, Derived >	NullaryExpr (Index rows, Index cols, const CustomNullaryOp &func)
template<typename CustomNullaryOp >
static const CwiseNullaryOp < CustomNullaryOp, Derived >	NullaryExpr (Index size, const CustomNullaryOp &func)
template<typename CustomNullaryOp >
static const CwiseNullaryOp < CustomNullaryOp, Derived >	NullaryExpr (const CustomNullaryOp &func)
static const ConstantReturnType	Ones (Index rows, Index cols)
static const ConstantReturnType	Ones (Index size)
static const ConstantReturnType	Ones ()
static const CwiseNullaryOp < internal::scalar_random_op < Scalar >, Derived >	Random (Index rows, Index cols)
static const CwiseNullaryOp < internal::scalar_random_op < Scalar >, Derived >	Random (Index size)
static const CwiseNullaryOp < internal::scalar_random_op < Scalar >, Derived >	Random ()
static const ConstantReturnType	Zero (Index rows, Index cols)
static const ConstantReturnType	Zero (Index size)
static const ConstantReturnType	Zero ()
Protected Member Functions
template<typename OtherDerived >
void	checkTransposeAliasing (const OtherDerived &other) const
	DenseBase ()
Private Member Functions
	DenseBase (int)
	DenseBase (int, int)
template<typename OtherDerived >
	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 DenseCoeffsBase<Derived> Eigen::DenseBase< Derived >::Base

Definition at line 67 of file DenseBase.h.

template<typename Derived>

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

Definition at line 98 of file DenseBase.h.

template<typename Derived>

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

Definition at line 22 of file DenseBase.h.

template<typename Derived>

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

Definition at line 437 of file DenseBase.h.

template<typename Derived>

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

Definition at line 16 of file DenseBase.h.

template<typename Derived>

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

Definition at line 238 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 23 of file DenseBase.h.

template<typename Derived>

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

Definition at line 438 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 17 of file DenseBase.h.

template<typename Derived>

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

Definition at line 469 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 26 of file DenseBase.h.

template<typename Derived>

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

Definition at line 436 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 20 of file DenseBase.h.

template<typename Derived>

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

Definition at line 35 of file DenseBase.h.

template<typename Derived>

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

Definition at line 284 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

Definition at line 244 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 356 of file DenseBase.h.

template<typename Derived>

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

The type of indices.

To change this, #define the preprocessor symbol EIGEN_DEFAULT_DENSE_INDEX_TYPE.

See also:: TopicPreprocessorDirectives.

Definition at line 61 of file DenseBase.h.

template<typename Derived>

typedef internal::packet_traits<Scalar>::type Eigen::DenseBase< Derived >::PacketScalar

Definition at line 64 of file DenseBase.h.

template<typename Derived>

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

Definition at line 242 of file DenseBase.h.

template<typename Derived>

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

Definition at line 65 of file DenseBase.h.

template<typename Derived>

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

Definition at line 468 of file DenseBase.h.

template<typename Derived>

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

Definition at line 25 of file DenseBase.h.

template<typename Derived>

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

Definition at line 435 of file DenseBase.h.

template<typename Derived>

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

Definition at line 19 of file DenseBase.h.

template<typename Derived>

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

Definition at line 63 of file DenseBase.h.

template<typename Derived>

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

Definition at line 34 of file DenseBase.h.

template<typename Derived>

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

Definition at line 240 of file DenseBase.h.

template<typename Derived>

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

Definition at line 53 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
CoeffReadCost	This is a rough measure of how expensive it is to read one coefficient from this expression.
InnerStrideAtCompileTime
OuterStrideAtCompileTime

Definition at line 100 of file DenseBase.h.

template<typename Derived>

anonymous enum

Enumerator:

ThisConstantIsPrivateInPlainObjectBase

Definition at line 181 of file DenseBase.h.

Constructor & Destructor Documentation

template<typename Derived>

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

Default constructor. Do nothing.

Definition at line 501 of file DenseBase.h.

template<typename Derived>

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

template<typename Derived>

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

template<typename Derived>

template<typename OtherDerived >

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

Member Function Documentation

template<typename Derived >

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

Returns:: true if all coefficients are true

Example:

Output:

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

Definition at line 79 of file BooleanRedux.h.

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 147 of file BooleanRedux.h.

template<typename Derived >

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

Returns:: true if at least one coefficient is true

See also:: all()

Definition at line 103 of file BooleanRedux.h.

template<typename Derived>

Block<Derived> 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 57 of file DenseBase.h.

template<typename Derived>

const Block<const Derived> 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 63 of file DenseBase.h.

template<typename Derived>

template<int BlockRows, int BlockCols>

Block<Derived, BlockRows, BlockCols> Eigen::DenseBase< Derived >::block	(	Index	startRow,
		Index	startCol
	)		`[inline]`

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

The template parameters BlockRows and BlockCols 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 657 of file DenseBase.h.

template<typename Derived>

template<int BlockRows, int BlockCols>

const Block<const Derived, BlockRows, BlockCols> Eigen::DenseBase< Derived >::block	(	Index	startRow,
		Index	startCol
	)		const `[inline]`

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

Definition at line 664 of file DenseBase.h.

template<typename Derived>

template<int BlockRows, int BlockCols>

Block<Derived, BlockRows, BlockCols> Eigen::DenseBase< Derived >::block	(	Index	startRow,
		Index	startCol,
		Index	blockRows,
		Index	blockCols
	)		`[inline]`

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

Template Parameters:

BlockRows	number of rows in block as specified at compile time
BlockCols	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 BlockRows unless BlockRows is Dynamic, and the same for the number of columns.

Example:

Output:

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

Definition at line 689 of file DenseBase.h.

template<typename Derived>

template<int BlockRows, int BlockCols>

const Block<const Derived, BlockRows, BlockCols> 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 697 of file DenseBase.h.

template<typename Derived>

Block<Derived> 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 307 of file DenseBase.h.

template<typename Derived>

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

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

Definition at line 313 of file DenseBase.h.

template<typename Derived>

template<int CRows, int CCols>

Block<Derived, CRows, CCols> 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 328 of file DenseBase.h.

template<typename Derived>

template<int CRows, int CCols>

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

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

Definition at line 335 of file DenseBase.h.

template<typename Derived>

template<int CRows, int CCols>

Block<Derived, CRows, CCols> 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 358 of file DenseBase.h.

template<typename Derived>

template<int CRows, int CCols>

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

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

Definition at line 365 of file DenseBase.h.

template<typename Derived>

Block<Derived> 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 232 of file DenseBase.h.

template<typename Derived>

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

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

Definition at line 238 of file DenseBase.h.

template<typename Derived>

template<int CRows, int CCols>

Block<Derived, CRows, CCols> 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 253 of file DenseBase.h.

template<typename Derived>

template<int CRows, int CCols>

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

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

Definition at line 260 of file DenseBase.h.

template<typename Derived>

template<int CRows, int CCols>

Block<Derived, CRows, CCols> 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 283 of file DenseBase.h.

template<typename Derived>

template<int CRows, int CCols>

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

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

Definition at line 290 of file DenseBase.h.

template<typename Derived>

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 425 of file DenseBase.h.

template<typename Derived>

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

This is the const version of bottomRows(Index).

Definition at line 431 of file DenseBase.h.

template<typename Derived>

template<int N>

NRowsBlockXpr<N>::Type Eigen::DenseBase< Derived >::bottomRows ( ) [inline]

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

Template Parameters:

N	the number of rows in the block

Example:

Output:

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

Definition at line 446 of file DenseBase.h.

template<typename Derived>

template<int N>

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

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

Definition at line 453 of file DenseBase.h.

template<typename Derived >

template<typename OtherDerived >

void Eigen::DenseBase< Derived >::checkTransposeAliasing ( const OtherDerived & other ) const [protected]

Definition at line 409 of file Transpose.h.

template<typename Derived>

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 709 of file DenseBase.h.

template<typename Derived>

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

This is the const version of col().

Definition at line 715 of file DenseBase.h.

template<typename Derived >

const DenseBase< Derived >::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 598 of file VectorwiseOp.h.

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 609 of file VectorwiseOp.h.

template<typename Derived >

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

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

The parameters nbRows and nbCols 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 nbRows and nbCols 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 179 of file CwiseNullaryOp.h.

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 201 of file CwiseNullaryOp.h.

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 217 of file CwiseNullaryOp.h.

template<typename Derived >

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

Returns:: the number of coefficients which evaluate to true

See also:: all(), any()

Definition at line 127 of file BooleanRedux.h.

template<typename Derived>

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.

Definition at line 362 of file DenseBase.h.

template<typename Derived>

template<typename Dest >

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

Definition at line 494 of file DenseBase.h.

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 322 of file CwiseNullaryOp.h.

template<typename Derived >

template<unsigned int Added, unsigned int Removed>

const Flagged< Derived, Added, Removed > Eigen::DenseBase< Derived >::flagged ( ) const [inline]

Returns:: an expression of *this with added and removed flags

This is mostly for internal use.

See also:: class Flagged

Definition at line 133 of file Flagged.h.

template<typename Derived>

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

template<typename Derived>

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

template<typename Derived>

template<bool Enable>

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

template<typename Derived>

template<bool Enable>

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

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 117 of file IO.h.

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 137 of file BooleanRedux.h.

template<typename Derived>

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

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

Parameters:

vecSize the number of coefficients 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 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 782 of file DenseBase.h.

template<typename Derived>

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

This is the const version of head(Index).

Definition at line 790 of file DenseBase.h.

template<typename Derived>

template<int Size>

FixedSegmentReturnType<Size>::Type Eigen::DenseBase< Derived >::head ( ) [inline]

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

The template parameter Size is the number of coefficients in the block

Example:

Output:

See also:: class Block

Definition at line 864 of file DenseBase.h.

template<typename Derived>

template<int Size>

ConstFixedSegmentReturnType<Size>::Type Eigen::DenseBase< Derived >::head ( ) const [inline]

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

Definition at line 872 of file DenseBase.h.

template<typename Derived>

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 207 of file DenseBase.h.

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 98 of file Fuzzy.h.

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 298 of file CwiseNullaryOp.h.

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 312 of file CwiseNullaryOp.h.

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 120 of file Fuzzy.h.

template<typename Derived>

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 140 of file Fuzzy.h.

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 612 of file CwiseNullaryOp.h.

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 482 of file CwiseNullaryOp.h.

template<typename Derived >

template<typename OtherDerived >

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

Copies other into *this without evaluating other.

Returns:: a reference to *this.

Definition at line 485 of file Assign.h.

template<typename Derived>

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 515 of file DenseBase.h.

template<typename Derived>

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

This is the const version of leftCols(Index).

Definition at line 521 of file DenseBase.h.

template<typename Derived>

template<int N>

NColsBlockXpr<N>::Type Eigen::DenseBase< Derived >::leftCols ( ) [inline]

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

Template Parameters:

N	the number of columns in the block

Example:

Output:

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

Definition at line 536 of file DenseBase.h.

template<typename Derived>

template<int N>

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

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

Definition at line 543 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 space 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 242 of file CwiseNullaryOp.h.

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 space 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 276 of file CwiseNullaryOp.h.

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 space 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 254 of file CwiseNullaryOp.h.

template<typename Derived >

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

Sets a linearly space 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 288 of file CwiseNullaryOp.h.

template<typename Derived>

template<int p>

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

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 348 of file Redux.h.

template<typename Derived >

template<typename IndexType >

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::visitor(), DenseBase::maxCoeff()

Definition at line 209 of file Visitor.h.

template<typename Derived >

template<typename IndexType >

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 226 of file Visitor.h.

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 372 of file Redux.h.

template<typename Derived>

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 604 of file DenseBase.h.

template<typename Derived>

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

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

Definition at line 610 of file DenseBase.h.

template<typename Derived>

template<int N>

NColsBlockXpr<N>::Type Eigen::DenseBase< Derived >::middleCols ( Index startCol ) [inline]

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

Template Parameters:

N	the number of columns in the block

Parameters:

startCol the index of the first column in the block

Example:

Output:

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

Definition at line 626 of file DenseBase.h.

template<typename Derived>

template<int N>

ConstNColsBlockXpr<N>::Type Eigen::DenseBase< Derived >::middleCols ( Index startCol ) const [inline]

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

Definition at line 633 of file DenseBase.h.

template<typename Derived>

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

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

Parameters:

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

Example:

Output:

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

Definition at line 470 of file DenseBase.h.

template<typename Derived>

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

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

Definition at line 476 of file DenseBase.h.

template<typename Derived>

template<int N>

NRowsBlockXpr<N>::Type Eigen::DenseBase< Derived >::middleRows ( Index startRow ) [inline]

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

Template Parameters:

N	the number of rows in the block

Parameters:

startRow the index of the first row in the block

Example:

Output:

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

Definition at line 492 of file DenseBase.h.

template<typename Derived>

template<int N>

ConstNRowsBlockXpr<N>::Type Eigen::DenseBase< Derived >::middleRows ( Index startRow ) const [inline]

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

Definition at line 499 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 338 of file Redux.h.

template<typename Derived >

template<typename IndexType >

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::visitor(), DenseBase::minCoeff()

Definition at line 175 of file Visitor.h.

template<typename Derived >

template<typename IndexType >

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::visitor(), DenseBase::minCoeff()

Definition at line 192 of file Visitor.h.

template<typename Derived >

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

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

Definition at line 104 of file NestByValue.h.

template<typename Derived>

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 185 of file DenseBase.h.

template<typename Derived >

template<typename CustomNullaryOp >

EIGEN_STRONG_INLINE const CwiseNullaryOp< CustomNullaryOp, Derived > 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 117 of file CwiseNullaryOp.h.

template<typename Derived >

template<typename CustomNullaryOp >

EIGEN_STRONG_INLINE const CwiseNullaryOp< CustomNullaryOp, Derived > 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.

See also:: class CwiseNullaryOp

Definition at line 140 of file CwiseNullaryOp.h.

template<typename Derived >

template<typename CustomNullaryOp >

EIGEN_STRONG_INLINE const CwiseNullaryOp< CustomNullaryOp, Derived > 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 159 of file CwiseNullaryOp.h.

template<typename Derived >

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

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

The parameters nbRows and nbCols 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 557 of file CwiseNullaryOp.h.

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 580 of file CwiseNullaryOp.h.

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 597 of file CwiseNullaryOp.h.

template<typename Derived >

Derived & Eigen::DenseBase< Derived >::operator*= ( const Scalar & other ) [inline]

Definition at line 172 of file SelfCwiseBinaryOp.h.

template<typename Derived >

template<typename OtherDerived >

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

Definition at line 115 of file EigenBase.h.

template<typename Derived >

template<typename OtherDerived >

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

Definition at line 123 of file EigenBase.h.

template<typename Derived >

Derived & Eigen::DenseBase< Derived >::operator/= ( const Scalar & other ) [inline]

Definition at line 181 of file SelfCwiseBinaryOp.h.

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 127 of file CommaInitializer.h.

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 136 of file CommaInitializer.h.

template<typename Derived >

template<typename OtherDerived >

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

Copies other into *this.

Returns:: a reference to *this.

Definition at line 543 of file Assign.h.

template<typename Derived >

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 549 of file Assign.h.

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.

Definition at line 107 of file EigenBase.h.

template<typename Derived >

template<typename OtherDerived >

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

Definition at line 80 of file ReturnByValue.h.

template<typename Derived>

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

Returns:

true if either the number of rows or the number of columns is equal to 1. In other words, this function returns

 rows()==1 || cols()==1

See also:: rows(), cols(), IsVectorAtCompileTime.

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 196 of file DenseBase.h.

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 386 of file Redux.h.

template<typename Derived >

const CwiseNullaryOp< internal::scalar_random_op< typename internal::traits< Derived >::Scalar >, Derived > Eigen::DenseBase< Derived >::Random	(	Index	rows,
		Index	cols
	)		`[inline, static]`

Returns:: a random matrix expression

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 also:: MatrixBase::setRandom(), MatrixBase::Random(Index), MatrixBase::Random()

Definition at line 49 of file Random.h.

template<typename Derived >

const CwiseNullaryOp< internal::scalar_random_op< typename internal::traits< Derived >::Scalar >, Derived > Eigen::DenseBase< Derived >::Random ( Index size ) [inline, static]

Returns:: a random vector expression

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:: MatrixBase::setRandom(), MatrixBase::Random(Index,Index), MatrixBase::Random()

Definition at line 76 of file Random.h.

template<typename Derived >

const CwiseNullaryOp< internal::scalar_random_op< typename internal::traits< Derived >::Scalar >, Derived > Eigen::DenseBase< Derived >::Random ( ) [inline, static]

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

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:: MatrixBase::setRandom(), MatrixBase::Random(Index,Index), MatrixBase::Random(Index)

Definition at line 97 of file Random.h.

template<typename Derived >

template<int RowFactor, int ColFactor>

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

Returns:: an expression of the replication of *this

Example:

Output:

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

Definition at line 139 of file Replicate.h.

template<typename Derived >

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 154 of file Replicate.h.

template<typename Derived>

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 217 of file DenseBase.h.

template<typename Derived>

void Eigen::DenseBase< Derived >::resize	(	Index	nbRows,
		Index	nbCols
	)		`[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 227 of file DenseBase.h.

template<typename Derived >

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

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

Example:

Output:

Definition at line 191 of file Reverse.h.

template<typename Derived >

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

This is the const version of reverse().

Definition at line 199 of file Reverse.h.

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 features:

less error prone: doing the same operation with .reverse() requires special care:
```
 m = m.reverse().eval(); 
```
this API allows to avoid creating a temporary (the current implementation creates a temporary, but that could be avoided using swap)
it allows future optimizations (cache friendliness, etc.)

See also:: reverse()

Definition at line 217 of file Reverse.h.

template<typename Derived>

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 559 of file DenseBase.h.

template<typename Derived>

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

This is the const version of rightCols(Index).

Definition at line 565 of file DenseBase.h.

template<typename Derived>

template<int N>

NColsBlockXpr<N>::Type Eigen::DenseBase< Derived >::rightCols ( ) [inline]

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

Template Parameters:

N	the number of columns in the block

Example:

Output:

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

Definition at line 580 of file DenseBase.h.

template<typename Derived>

template<int N>

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

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

Definition at line 587 of file DenseBase.h.

template<typename Derived>

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 726 of file DenseBase.h.

template<typename Derived>

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

This is the const version of row().

Definition at line 732 of file DenseBase.h.

template<typename Derived >

const DenseBase< Derived >::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 623 of file VectorwiseOp.h.

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 634 of file VectorwiseOp.h.

template<typename Derived>

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

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

Parameters:

start	the first coefficient in the segment
vecSize	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 753 of file DenseBase.h.

template<typename Derived>

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

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

Definition at line 761 of file DenseBase.h.

template<typename Derived>

template<int Size>

FixedSegmentReturnType<Size>::Type Eigen::DenseBase< Derived >::segment ( Index start ) [inline]

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

The template parameter Size is the number of coefficients in the block

Parameters:

start the index of the first element of the sub-vector

Example:

Output:

See also:: class Block

Definition at line 838 of file DenseBase.h.

template<typename Derived>

template<int Size>

ConstFixedSegmentReturnType<Size>::Type Eigen::DenseBase< Derived >::segment ( Index start ) const [inline]

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

Definition at line 846 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.

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.

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.

template<typename Derived >

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

Sets all coefficients in this expression to value.

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

Definition at line 332 of file CwiseNullaryOp.h.

template<typename Derived >

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

Sets a linearly space 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 387 of file CwiseNullaryOp.h.

template<typename Derived >

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

Sets a linearly space 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 404 of file CwiseNullaryOp.h.

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 625 of file CwiseNullaryOp.h.

template<typename Derived >

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

Sets all coefficients in this expression to random values.

Example:

Output:

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

Definition at line 110 of file Random.h.

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 499 of file CwiseNullaryOp.h.

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 359 of file Redux.h.

template<typename Derived>

template<typename OtherDerived >

void Eigen::DenseBase< Derived >::swap	(	const DenseBase< OtherDerived > &	other,
		int	= `OtherDerived::ThisConstantIsPrivateInPlainObjectBase`
	)		`[inline]`

swaps *this with the expression other.

Definition at line 374 of file DenseBase.h.

template<typename Derived>

template<typename OtherDerived >

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

swaps *this with the matrix or array other.

Definition at line 384 of file DenseBase.h.

template<typename Derived>

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

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

Parameters:

vecSize the number of coefficients 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 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 811 of file DenseBase.h.

template<typename Derived>

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

This is the const version of tail(Index).

Definition at line 818 of file DenseBase.h.

template<typename Derived>

template<int Size>

FixedSegmentReturnType<Size>::Type Eigen::DenseBase< Derived >::tail ( ) [inline]

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

The template parameter Size is the number of coefficients in the block

Example:

Output:

See also:: class Block

Definition at line 890 of file DenseBase.h.

template<typename Derived>

template<int Size>

ConstFixedSegmentReturnType<Size>::Type Eigen::DenseBase< Derived >::tail ( ) const [inline]

This is the const version of tail<int>.

Definition at line 898 of file DenseBase.h.

template<typename Derived>

Block<Derived> 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 157 of file DenseBase.h.

template<typename Derived>

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

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

Definition at line 163 of file DenseBase.h.

template<typename Derived>

template<int CRows, int CCols>

Block<Derived, CRows, CCols> 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 178 of file DenseBase.h.

template<typename Derived>

template<int CRows, int CCols>

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

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

Definition at line 185 of file DenseBase.h.

template<typename Derived>

template<int CRows, int CCols>

Block<Derived, CRows, CCols> 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 208 of file DenseBase.h.

template<typename Derived>

template<int CRows, int CCols>

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

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

Definition at line 215 of file DenseBase.h.

template<typename Derived>

Block<Derived> 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 81 of file DenseBase.h.

template<typename Derived>

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

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

Definition at line 87 of file DenseBase.h.

template<typename Derived>

template<int CRows, int CCols>

Block<Derived, CRows, CCols> 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 103 of file DenseBase.h.

template<typename Derived>

template<int CRows, int CCols>

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

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

Definition at line 110 of file DenseBase.h.

template<typename Derived>

template<int CRows, int CCols>

Block<Derived, CRows, CCols> 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 133 of file DenseBase.h.

template<typename Derived>

template<int CRows, int CCols>

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

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

Definition at line 140 of file DenseBase.h.

template<typename Derived>

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 381 of file DenseBase.h.

template<typename Derived>

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

This is the const version of topRows(Index).

Definition at line 387 of file DenseBase.h.

template<typename Derived>

template<int N>

NRowsBlockXpr<N>::Type Eigen::DenseBase< Derived >::topRows ( ) [inline]

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

Template Parameters:

N	the number of rows in the block

Example:

Output:

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

Definition at line 402 of file DenseBase.h.

template<typename Derived>

template<int N>

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

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

Definition at line 409 of file DenseBase.h.

template<typename Derived>

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

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 199 of file Transpose.h.

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 211 of file Transpose.h.

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.

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

Definition at line 291 of file Transpose.h.

template<typename Derived>

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

Returns:: the unique coefficient of a 1x1 expression

Definition at line 424 of file DenseBase.h.

template<typename Derived >

template<typename Visitor >

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 77 of file Visitor.h.

template<typename Derived >

EIGEN_STRONG_INLINE const DenseBase< Derived >::ConstantReturnType Eigen::DenseBase< Derived >::Zero	(	Index	nbRows,
		Index	nbCols
	)		`[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 428 of file CwiseNullaryOp.h.

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 451 of file CwiseNullaryOp.h.

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 468 of file CwiseNullaryOp.h.

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 241 of file IO.h.

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 >