Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Functions

DenseBase< Derived > Class Template Reference

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

#include <DenseBase.h>

Inheritance diagram for DenseBase< Derived >:
internal::special_scalar_op_base< Derived, internal::traits< Derived >::Scalar, NumTraits< internal::traits< Derived >::Scalar >::Real > DenseCoeffsBase ArrayBase< Derived > MatrixBase< Derived > ProductBase< Derived, Lhs, Rhs >

List of all members.

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 internal::traits
< Derived >::StorageKind 		StorageKind
typedef internal::traits
< Derived >::Index 		Index
typedef internal::traits
< Derived >::Scalar 		Scalar
typedef
internal::packet_traits
< Scalar >::type 		PacketScalar
typedef NumTraits< Scalar >::Real RealScalar
typedef DenseCoeffsBase< Derived > Base
typedef Base::CoeffReturnType CoeffReturnType
typedef CwiseNullaryOp
< internal::scalar_constant_op
< Scalar >, Derived > 		ConstantReturnType
typedef CwiseNullaryOp
< internal::linspaced_op
< Scalar, false >, Derived > 		SequentialLinSpacedReturnType
typedef CwiseNullaryOp
< internal::linspaced_op
< Scalar, true >, Derived > 		RandomAccessLinSpacedReturnType
typedef Matrix< typename
NumTraits< typename
internal::traits< Derived >
::Scalar >::Real,
internal::traits< Derived >
::ColsAtCompileTime, 1 > 		EigenvaluesReturnType
typedef const Transpose< const
Derived > 		ConstTransposeReturnType
typedef VectorBlock< Derived > SegmentReturnType
typedef const VectorBlock
< const Derived > 		ConstSegmentReturnType
typedef VectorwiseOp< Derived,
Horizontal > 		RowwiseReturnType
typedef const VectorwiseOp
< const Derived, Horizontal > 		ConstRowwiseReturnType
typedef VectorwiseOp< Derived,
Vertical > 		ColwiseReturnType
typedef const VectorwiseOp
< const Derived, Vertical > 		ConstColwiseReturnType
typedef Reverse< Derived,
BothDirections > 		ReverseReturnType
typedef const Reverse< const
Derived, BothDirections > 		ConstReverseReturnType
typedef Block< Derived,
internal::traits< Derived >
::RowsAtCompileTime,
1,!IsRowMajor > 		ColXpr
typedef const Block< const
Derived, internal::traits
< Derived >::RowsAtCompileTime,
1,!IsRowMajor > 		ConstColXpr
typedef Block< Derived,
1, internal::traits< Derived >
::ColsAtCompileTime,
IsRowMajor > 		RowXpr
typedef const Block< const
Derived, 1, internal::traits
< Derived >::ColsAtCompileTime,
IsRowMajor > 		ConstRowXpr
typedef Block< Derived,
internal::traits< Derived >
::RowsAtCompileTime, Dynamic,!IsRowMajor > 		ColsBlockXpr
typedef const Block< const
Derived, internal::traits
< Derived >::RowsAtCompileTime,
Dynamic,!IsRowMajor > 		ConstColsBlockXpr
typedef Block< Derived,
Dynamic, internal::traits
< Derived >::ColsAtCompileTime,
IsRowMajor > 		RowsBlockXpr
typedef const Block< const
Derived, Dynamic,
internal::traits< Derived >
::ColsAtCompileTime,
IsRowMajor > 		ConstRowsBlockXpr

Public Member Functions

Index nonZeros () const
Index outerSize () const
Index innerSize () const
void resize (Index size)
void resize (Index rows, Index cols)
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 EigenBase< OtherDerived > &other)
template<typename OtherDerived >
Derived & operator-= (const EigenBase< OtherDerived > &other)
template<typename OtherDerived >
Derived & operator= (const ReturnByValue< OtherDerived > &func)
template<typename OtherDerived >
Derived & lazyAssign (const DenseBase< OtherDerived > &other)
CommaInitializer< Derived > operator<< (const Scalar &s)
template<unsigned int Added, unsigned int Removed>
const Flagged< Derived, Added,
Removed > 		flagged () const
template<typename OtherDerived >
CommaInitializer< Derived > operator<< (const DenseBase< OtherDerived > &other)
Eigen::Transpose< Derived > transpose ()
ConstTransposeReturnType transpose () const
void transposeInPlace ()
SegmentReturnType segment (Index start, Index size)
DenseBase::ConstSegmentReturnType segment (Index start, Index size) const
SegmentReturnType head (Index size)
DenseBase::ConstSegmentReturnType head (Index size) const
SegmentReturnType tail (Index size)
DenseBase::ConstSegmentReturnType tail (Index size) const
template<int Size>
FixedSegmentReturnType< Size >
::Type 		head ()
template<int Size>
ConstFixedSegmentReturnType
< Size >::Type 		head () const
template<int Size>
FixedSegmentReturnType< Size >
::Type 		tail ()
template<int Size>
ConstFixedSegmentReturnType
< Size >::Type 		tail () const
template<int Size>
FixedSegmentReturnType< Size >
::Type 		segment (Index start)
template<int Size>
ConstFixedSegmentReturnType
< Size >::Type 		segment (Index start) const
void fill (const Scalar &value)
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)
Derived & setZero ()
Derived & setOnes ()
Derived & setRandom ()
template<typename OtherDerived >
bool isApprox (const DenseBase< OtherDerived > &other, RealScalar prec=NumTraits< Scalar >::dummy_precision()) const
bool isMuchSmallerThan (const RealScalar &other, RealScalar prec=NumTraits< Scalar >::dummy_precision()) const
template<typename OtherDerived >
bool isMuchSmallerThan (const DenseBase< OtherDerived > &other, RealScalar prec=NumTraits< Scalar >::dummy_precision()) const
bool isApproxToConstant (const Scalar &value, RealScalar prec=NumTraits< Scalar >::dummy_precision()) const
bool isConstant (const Scalar &value, RealScalar prec=NumTraits< Scalar >::dummy_precision()) const
bool isZero (RealScalar prec=NumTraits< Scalar >::dummy_precision()) const
bool isOnes (RealScalar prec=NumTraits< Scalar >::dummy_precision()) const
Derived & operator*= (const Scalar &other)
Derived & operator/= (const Scalar &other)
EIGEN_STRONG_INLINE const
internal::eval< Derived >
::type 		eval () const
template<typename OtherDerived >
void swap (const DenseBase< OtherDerived > &other, int=OtherDerived::ThisConstantIsPrivateInPlainObjectBase)
template<typename OtherDerived >
void swap (PlainObjectBase< OtherDerived > &other)
const NestByValue< Derived > nestByValue () 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 ()
Scalar sum () const
Scalar mean () const
Scalar trace () const
Scalar prod () const
internal::traits< Derived >::Scalar minCoeff () const
internal::traits< Derived >::Scalar maxCoeff () const
template<typename IndexType >
internal::traits< Derived >::Scalar minCoeff (IndexType *row, IndexType *col) const
template<typename IndexType >
internal::traits< Derived >::Scalar maxCoeff (IndexType *row, IndexType *col) const
template<typename IndexType >
internal::traits< Derived >::Scalar minCoeff (IndexType *index) const
template<typename IndexType >
internal::traits< Derived >::Scalar maxCoeff (IndexType *index) const
template<typename Visitor >
void visit (Visitor &func) const
const WithFormat< Derived > format (const IOFormat &fmt) const
CoeffReturnType value () const
bool all (void) const
bool any (void) const
Index count () const
ConstRowwiseReturnType rowwise () const
RowwiseReturnType rowwise ()
ConstColwiseReturnType colwise () const
ColwiseReturnType colwise ()
template<typename ThenDerived , typename ElseDerived >
const Select< Derived,
ThenDerived, ElseDerived > 		select (const DenseBase< ThenDerived > &thenMatrix, const DenseBase< ElseDerived > &elseMatrix) const
template<typename ThenDerived >
const Select< Derived,
ThenDerived, typename
ThenDerived::ConstantReturnType > 		select (const DenseBase< ThenDerived > &thenMatrix, typename ThenDerived::Scalar elseScalar) const
template<typename ElseDerived >
const Select< Derived,
typename
ElseDerived::ConstantReturnType,
ElseDerived > 		select (typename ElseDerived::Scalar thenScalar, const DenseBase< ElseDerived > &elseMatrix) const
template<int p>
RealScalar lpNorm () const
template<int RowFactor, int ColFactor>
const Replicate< Derived,
RowFactor, ColFactor > 		replicate () const
const Replicate< Derived,
Dynamic, Dynamic > 		replicate (Index rowFacor, Index colFactor) const
ReverseReturnType reverse ()
ConstReverseReturnType reverse () const
void reverseInPlace ()
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
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
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
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
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
RowsBlockXpr topRows (Index n)
ConstRowsBlockXpr topRows (Index n) const
template<int N>
NRowsBlockXpr< N >::Type topRows ()
template<int N>
ConstNRowsBlockXpr< N >::Type topRows () 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
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
ColsBlockXpr leftCols (Index n)
ConstColsBlockXpr leftCols (Index n) const
template<int N>
NColsBlockXpr< N >::Type leftCols ()
template<int N>
ConstNColsBlockXpr< N >::Type leftCols () const
ColsBlockXpr rightCols (Index n)
ConstColsBlockXpr rightCols (Index n) const
template<int N>
NColsBlockXpr< N >::Type rightCols ()
template<int N>
ConstNColsBlockXpr< N >::Type rightCols () 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
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
ColXpr col (Index i)
ConstColXpr col (Index i) const
RowXpr row (Index i)
ConstRowXpr row (Index i) const
template<typename Dest >
void evalTo (Dest &) const
template<typename Derived >
bool isMuchSmallerThan (const typename NumTraits< Scalar >::Real &other, RealScalar prec) 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 Zero (Index rows, Index cols)
static const ConstantReturnType Zero (Index size)
static const ConstantReturnType Zero ()
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 ()

Protected Member Functions

template<typename OtherDerived >
void checkTransposeAliasing (const OtherDerived &other) const
 DenseBase ()

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

Member Typedef Documentation

template<typename Derived>
typedef DenseCoeffsBase<Derived> DenseBase< Derived >::Base

Reimplemented in ArrayBase< Derived >, ArrayWrapper< ExpressionType >, MatrixWrapper< ExpressionType >, DiagonalProduct< MatrixType, DiagonalType, ProductOrder >, Flagged< ExpressionType, Added, Removed >, MatrixBase< Derived >, ProductBase< Derived, Lhs, Rhs >, ScaledProduct< NestedProduct >, CoeffBasedProduct< LhsNested, RhsNested, NestingFlags >, Minor< MatrixType >, Homogeneous< MatrixType, _Direction >, ArrayBase< ArrayWrapper< ExpressionType > >, MatrixBase< TriangularProduct< Mode, false, Lhs, true, Rhs, false > >, MatrixBase< DenseTimeSparseSelfAdjointProduct< Lhs, Rhs, UpLo > >, MatrixBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, 0, true > >, MatrixBase< ScaledProduct< NestedProduct > >, MatrixBase< MatrixWrapper< ExpressionType > >, MatrixBase< Flagged< ExpressionType, Added, Removed > >, MatrixBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, RhsMode, false > >, MatrixBase< GeneralProduct< Lhs, Rhs, OuterProduct > >, MatrixBase< SparseSelfAdjointTimeDenseProduct< Lhs, Rhs, UpLo > >, MatrixBase< GeneralProduct< Lhs, Rhs, GemmProduct > >, MatrixBase< TriangularProduct< Mode, LhsIsTriangular, Lhs, false, Rhs, false > >, MatrixBase< SelfadjointProductMatrix< Lhs, 0, true, Rhs, RhsMode, false > >, MatrixBase< Homogeneous< MatrixType, _Direction > >, MatrixBase< SparseTimeDenseProduct< Lhs, Rhs > >, MatrixBase< DenseTimeSparseProduct< Lhs, Rhs > >, MatrixBase< CoeffBasedProduct< LhsNested, RhsNested, NestingFlags > >, MatrixBase< Minor< MatrixType > >, MatrixBase< GeneralProduct< Lhs, Rhs, GemvProduct > >, MatrixBase< DiagonalProduct< MatrixType, DiagonalType, ProductOrder > >, MatrixBase< TriangularProduct< Mode, true, Lhs, false, Rhs, true > >, ProductBase< GeneralProduct< Lhs, Rhs, GemmProduct >, Lhs, Rhs >, ProductBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, 0, true >, Lhs, Rhs >, ProductBase< TriangularProduct< Mode, true, Lhs, false, Rhs, true >, Lhs, Rhs >, ProductBase< ScaledProduct< NestedProduct >, NestedProduct::_LhsNested, NestedProduct::_RhsNested >, ProductBase< TriangularProduct< Mode, LhsIsTriangular, Lhs, false, Rhs, false >, Lhs, Rhs >, ProductBase< GeneralProduct< Lhs, Rhs, OuterProduct >, Lhs, Rhs >, ProductBase< DenseTimeSparseSelfAdjointProduct< Lhs, Rhs, UpLo >, Lhs, Rhs >, ProductBase< GeneralProduct< Lhs, Rhs, GemvProduct >, Lhs, Rhs >, ProductBase< SelfadjointProductMatrix< Lhs, 0, true, Rhs, RhsMode, false >, Lhs, Rhs >, ProductBase< TriangularProduct< Mode, false, Lhs, true, Rhs, false >, Lhs, Rhs >, ProductBase< DenseTimeSparseProduct< Lhs, Rhs >, Lhs, Rhs >, ProductBase< SparseSelfAdjointTimeDenseProduct< Lhs, Rhs, UpLo >, Lhs, Rhs >, ProductBase< SparseTimeDenseProduct< Lhs, Rhs >, Lhs, Rhs >, and ProductBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, RhsMode, false >, Lhs, Rhs >.

template<typename Derived>
typedef Base::CoeffReturnType DenseBase< Derived >::CoeffReturnType

Reimplemented in ArrayBase< Derived >, MatrixBase< Derived >, ArrayBase< ArrayWrapper< ExpressionType > >, MatrixBase< TriangularProduct< Mode, false, Lhs, true, Rhs, false > >, MatrixBase< DenseTimeSparseSelfAdjointProduct< Lhs, Rhs, UpLo > >, MatrixBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, 0, true > >, MatrixBase< ScaledProduct< NestedProduct > >, MatrixBase< MatrixWrapper< ExpressionType > >, MatrixBase< Flagged< ExpressionType, Added, Removed > >, MatrixBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, RhsMode, false > >, MatrixBase< GeneralProduct< Lhs, Rhs, OuterProduct > >, MatrixBase< SparseSelfAdjointTimeDenseProduct< Lhs, Rhs, UpLo > >, MatrixBase< GeneralProduct< Lhs, Rhs, GemmProduct > >, MatrixBase< TriangularProduct< Mode, LhsIsTriangular, Lhs, false, Rhs, false > >, MatrixBase< SelfadjointProductMatrix< Lhs, 0, true, Rhs, RhsMode, false > >, MatrixBase< Homogeneous< MatrixType, _Direction > >, MatrixBase< SparseTimeDenseProduct< Lhs, Rhs > >, MatrixBase< DenseTimeSparseProduct< Lhs, Rhs > >, MatrixBase< CoeffBasedProduct< LhsNested, RhsNested, NestingFlags > >, MatrixBase< Minor< MatrixType > >, MatrixBase< GeneralProduct< Lhs, Rhs, GemvProduct > >, MatrixBase< DiagonalProduct< MatrixType, DiagonalType, ProductOrder > >, and MatrixBase< TriangularProduct< Mode, true, Lhs, false, Rhs, true > >.

template<typename Derived>
typedef Block<Derived, internal::traits<Derived>::RowsAtCompileTime, Dynamic, !IsRowMajor> DenseBase< Derived >::ColsBlockXpr
template<typename Derived>
typedef VectorwiseOp<Derived, Vertical> DenseBase< Derived >::ColwiseReturnType
template<typename Derived>
typedef Block<Derived, internal::traits<Derived>::RowsAtCompileTime, 1, !IsRowMajor> DenseBase< Derived >::ColXpr

Reimplemented in MatrixBase< Derived >, MatrixBase< TriangularProduct< Mode, false, Lhs, true, Rhs, false > >, MatrixBase< DenseTimeSparseSelfAdjointProduct< Lhs, Rhs, UpLo > >, MatrixBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, 0, true > >, MatrixBase< ScaledProduct< NestedProduct > >, MatrixBase< MatrixWrapper< ExpressionType > >, MatrixBase< Flagged< ExpressionType, Added, Removed > >, MatrixBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, RhsMode, false > >, MatrixBase< GeneralProduct< Lhs, Rhs, OuterProduct > >, MatrixBase< SparseSelfAdjointTimeDenseProduct< Lhs, Rhs, UpLo > >, MatrixBase< GeneralProduct< Lhs, Rhs, GemmProduct > >, MatrixBase< TriangularProduct< Mode, LhsIsTriangular, Lhs, false, Rhs, false > >, MatrixBase< SelfadjointProductMatrix< Lhs, 0, true, Rhs, RhsMode, false > >, MatrixBase< Homogeneous< MatrixType, _Direction > >, MatrixBase< SparseTimeDenseProduct< Lhs, Rhs > >, MatrixBase< DenseTimeSparseProduct< Lhs, Rhs > >, MatrixBase< CoeffBasedProduct< LhsNested, RhsNested, NestingFlags > >, MatrixBase< Minor< MatrixType > >, MatrixBase< GeneralProduct< Lhs, Rhs, GemvProduct > >, MatrixBase< DiagonalProduct< MatrixType, DiagonalType, ProductOrder > >, and MatrixBase< TriangularProduct< Mode, true, Lhs, false, Rhs, true > >.

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

Reimplemented in ArrayBase< Derived >, MatrixBase< Derived >, ArrayBase< ArrayWrapper< ExpressionType > >, MatrixBase< TriangularProduct< Mode, false, Lhs, true, Rhs, false > >, MatrixBase< DenseTimeSparseSelfAdjointProduct< Lhs, Rhs, UpLo > >, MatrixBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, 0, true > >, MatrixBase< ScaledProduct< NestedProduct > >, MatrixBase< MatrixWrapper< ExpressionType > >, MatrixBase< Flagged< ExpressionType, Added, Removed > >, MatrixBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, RhsMode, false > >, MatrixBase< GeneralProduct< Lhs, Rhs, OuterProduct > >, MatrixBase< SparseSelfAdjointTimeDenseProduct< Lhs, Rhs, UpLo > >, MatrixBase< GeneralProduct< Lhs, Rhs, GemmProduct > >, MatrixBase< TriangularProduct< Mode, LhsIsTriangular, Lhs, false, Rhs, false > >, MatrixBase< SelfadjointProductMatrix< Lhs, 0, true, Rhs, RhsMode, false > >, MatrixBase< Homogeneous< MatrixType, _Direction > >, MatrixBase< SparseTimeDenseProduct< Lhs, Rhs > >, MatrixBase< DenseTimeSparseProduct< Lhs, Rhs > >, MatrixBase< CoeffBasedProduct< LhsNested, RhsNested, NestingFlags > >, MatrixBase< Minor< MatrixType > >, MatrixBase< GeneralProduct< Lhs, Rhs, GemvProduct > >, MatrixBase< DiagonalProduct< MatrixType, DiagonalType, ProductOrder > >, and MatrixBase< TriangularProduct< Mode, true, Lhs, false, Rhs, true > >.

template<typename Derived>
typedef const Block<const Derived, internal::traits<Derived>::RowsAtCompileTime, Dynamic, !IsRowMajor> DenseBase< Derived >::ConstColsBlockXpr
template<typename Derived>
typedef const VectorwiseOp<const Derived, Vertical> DenseBase< Derived >::ConstColwiseReturnType
template<typename Derived>
typedef const Block<const Derived, internal::traits<Derived>::RowsAtCompileTime, 1, !IsRowMajor> DenseBase< Derived >::ConstColXpr
template<typename Derived>
typedef const Reverse<const Derived, BothDirections> DenseBase< Derived >::ConstReverseReturnType
template<typename Derived>
typedef const Block<const Derived, Dynamic, internal::traits<Derived>::ColsAtCompileTime, IsRowMajor> DenseBase< Derived >::ConstRowsBlockXpr
template<typename Derived>
typedef const VectorwiseOp<const Derived, Horizontal> DenseBase< Derived >::ConstRowwiseReturnType
template<typename Derived>
typedef const Block<const Derived, 1, internal::traits<Derived>::ColsAtCompileTime, IsRowMajor> DenseBase< Derived >::ConstRowXpr
template<typename Derived>
typedef const VectorBlock<const Derived> DenseBase< Derived >::ConstSegmentReturnType
template<typename Derived>
typedef const Transpose<const Derived> DenseBase< Derived >::ConstTransposeReturnType

Reimplemented in MatrixBase< Derived >, MatrixBase< TriangularProduct< Mode, false, Lhs, true, Rhs, false > >, MatrixBase< DenseTimeSparseSelfAdjointProduct< Lhs, Rhs, UpLo > >, MatrixBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, 0, true > >, MatrixBase< ScaledProduct< NestedProduct > >, MatrixBase< MatrixWrapper< ExpressionType > >, MatrixBase< Flagged< ExpressionType, Added, Removed > >, MatrixBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, RhsMode, false > >, MatrixBase< GeneralProduct< Lhs, Rhs, OuterProduct > >, MatrixBase< SparseSelfAdjointTimeDenseProduct< Lhs, Rhs, UpLo > >, MatrixBase< GeneralProduct< Lhs, Rhs, GemmProduct > >, MatrixBase< TriangularProduct< Mode, LhsIsTriangular, Lhs, false, Rhs, false > >, MatrixBase< SelfadjointProductMatrix< Lhs, 0, true, Rhs, RhsMode, false > >, MatrixBase< Homogeneous< MatrixType, _Direction > >, MatrixBase< SparseTimeDenseProduct< Lhs, Rhs > >, MatrixBase< DenseTimeSparseProduct< Lhs, Rhs > >, MatrixBase< CoeffBasedProduct< LhsNested, RhsNested, NestingFlags > >, MatrixBase< Minor< MatrixType > >, MatrixBase< GeneralProduct< Lhs, Rhs, GemvProduct > >, MatrixBase< DiagonalProduct< MatrixType, DiagonalType, ProductOrder > >, and MatrixBase< TriangularProduct< Mode, true, Lhs, false, Rhs, true > >.

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

Reimplemented in MatrixBase< Derived >, MatrixBase< TriangularProduct< Mode, false, Lhs, true, Rhs, false > >, MatrixBase< DenseTimeSparseSelfAdjointProduct< Lhs, Rhs, UpLo > >, MatrixBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, 0, true > >, MatrixBase< ScaledProduct< NestedProduct > >, MatrixBase< MatrixWrapper< ExpressionType > >, MatrixBase< Flagged< ExpressionType, Added, Removed > >, MatrixBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, RhsMode, false > >, MatrixBase< GeneralProduct< Lhs, Rhs, OuterProduct > >, MatrixBase< SparseSelfAdjointTimeDenseProduct< Lhs, Rhs, UpLo > >, MatrixBase< GeneralProduct< Lhs, Rhs, GemmProduct > >, MatrixBase< TriangularProduct< Mode, LhsIsTriangular, Lhs, false, Rhs, false > >, MatrixBase< SelfadjointProductMatrix< Lhs, 0, true, Rhs, RhsMode, false > >, MatrixBase< Homogeneous< MatrixType, _Direction > >, MatrixBase< SparseTimeDenseProduct< Lhs, Rhs > >, MatrixBase< DenseTimeSparseProduct< Lhs, Rhs > >, MatrixBase< CoeffBasedProduct< LhsNested, RhsNested, NestingFlags > >, MatrixBase< Minor< MatrixType > >, MatrixBase< GeneralProduct< Lhs, Rhs, GemvProduct > >, MatrixBase< DiagonalProduct< MatrixType, DiagonalType, ProductOrder > >, and MatrixBase< TriangularProduct< Mode, true, Lhs, false, Rhs, true > >.

template<typename Derived>
typedef internal::traits<Derived>::Index DenseBase< Derived >::Index

The type of indices

Reimplemented in ArrayBase< Derived >, MatrixBase< Derived >, ArrayBase< ArrayWrapper< ExpressionType > >, MatrixBase< TriangularProduct< Mode, false, Lhs, true, Rhs, false > >, MatrixBase< DenseTimeSparseSelfAdjointProduct< Lhs, Rhs, UpLo > >, MatrixBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, 0, true > >, MatrixBase< ScaledProduct< NestedProduct > >, MatrixBase< MatrixWrapper< ExpressionType > >, MatrixBase< Flagged< ExpressionType, Added, Removed > >, MatrixBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, RhsMode, false > >, MatrixBase< GeneralProduct< Lhs, Rhs, OuterProduct > >, MatrixBase< SparseSelfAdjointTimeDenseProduct< Lhs, Rhs, UpLo > >, MatrixBase< GeneralProduct< Lhs, Rhs, GemmProduct > >, MatrixBase< TriangularProduct< Mode, LhsIsTriangular, Lhs, false, Rhs, false > >, MatrixBase< SelfadjointProductMatrix< Lhs, 0, true, Rhs, RhsMode, false > >, MatrixBase< Homogeneous< MatrixType, _Direction > >, MatrixBase< SparseTimeDenseProduct< Lhs, Rhs > >, MatrixBase< DenseTimeSparseProduct< Lhs, Rhs > >, MatrixBase< CoeffBasedProduct< LhsNested, RhsNested, NestingFlags > >, MatrixBase< Minor< MatrixType > >, MatrixBase< GeneralProduct< Lhs, Rhs, GemvProduct > >, MatrixBase< DiagonalProduct< MatrixType, DiagonalType, ProductOrder > >, and MatrixBase< TriangularProduct< Mode, true, Lhs, false, Rhs, true > >.

template<typename Derived>
typedef internal::packet_traits<Scalar>::type DenseBase< Derived >::PacketScalar

Reimplemented in ArrayBase< Derived >, MatrixBase< Derived >, ArrayBase< ArrayWrapper< ExpressionType > >, MatrixBase< TriangularProduct< Mode, false, Lhs, true, Rhs, false > >, MatrixBase< DenseTimeSparseSelfAdjointProduct< Lhs, Rhs, UpLo > >, MatrixBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, 0, true > >, MatrixBase< ScaledProduct< NestedProduct > >, MatrixBase< MatrixWrapper< ExpressionType > >, MatrixBase< Flagged< ExpressionType, Added, Removed > >, MatrixBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, RhsMode, false > >, MatrixBase< GeneralProduct< Lhs, Rhs, OuterProduct > >, MatrixBase< SparseSelfAdjointTimeDenseProduct< Lhs, Rhs, UpLo > >, MatrixBase< GeneralProduct< Lhs, Rhs, GemmProduct > >, MatrixBase< TriangularProduct< Mode, LhsIsTriangular, Lhs, false, Rhs, false > >, MatrixBase< SelfadjointProductMatrix< Lhs, 0, true, Rhs, RhsMode, false > >, MatrixBase< Homogeneous< MatrixType, _Direction > >, MatrixBase< SparseTimeDenseProduct< Lhs, Rhs > >, MatrixBase< DenseTimeSparseProduct< Lhs, Rhs > >, MatrixBase< CoeffBasedProduct< LhsNested, RhsNested, NestingFlags > >, MatrixBase< Minor< MatrixType > >, MatrixBase< GeneralProduct< Lhs, Rhs, GemvProduct > >, MatrixBase< DiagonalProduct< MatrixType, DiagonalType, ProductOrder > >, and MatrixBase< TriangularProduct< Mode, true, Lhs, false, Rhs, true > >.

template<typename Derived>
typedef CwiseNullaryOp<internal::linspaced_op<Scalar,true>,Derived> DenseBase< Derived >::RandomAccessLinSpacedReturnType
template<typename Derived>
typedef NumTraits<Scalar>::Real DenseBase< Derived >::RealScalar

Reimplemented in ArrayBase< Derived >, MatrixBase< Derived >, ArrayBase< ArrayWrapper< ExpressionType > >, MatrixBase< TriangularProduct< Mode, false, Lhs, true, Rhs, false > >, MatrixBase< DenseTimeSparseSelfAdjointProduct< Lhs, Rhs, UpLo > >, MatrixBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, 0, true > >, MatrixBase< ScaledProduct< NestedProduct > >, MatrixBase< MatrixWrapper< ExpressionType > >, MatrixBase< Flagged< ExpressionType, Added, Removed > >, MatrixBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, RhsMode, false > >, MatrixBase< GeneralProduct< Lhs, Rhs, OuterProduct > >, MatrixBase< SparseSelfAdjointTimeDenseProduct< Lhs, Rhs, UpLo > >, MatrixBase< GeneralProduct< Lhs, Rhs, GemmProduct > >, MatrixBase< TriangularProduct< Mode, LhsIsTriangular, Lhs, false, Rhs, false > >, MatrixBase< SelfadjointProductMatrix< Lhs, 0, true, Rhs, RhsMode, false > >, MatrixBase< Homogeneous< MatrixType, _Direction > >, MatrixBase< SparseTimeDenseProduct< Lhs, Rhs > >, MatrixBase< DenseTimeSparseProduct< Lhs, Rhs > >, MatrixBase< CoeffBasedProduct< LhsNested, RhsNested, NestingFlags > >, MatrixBase< Minor< MatrixType > >, MatrixBase< GeneralProduct< Lhs, Rhs, GemvProduct > >, MatrixBase< DiagonalProduct< MatrixType, DiagonalType, ProductOrder > >, and MatrixBase< TriangularProduct< Mode, true, Lhs, false, Rhs, true > >.

template<typename Derived>
typedef Reverse<Derived, BothDirections> DenseBase< Derived >::ReverseReturnType
template<typename Derived>
typedef Block<Derived, Dynamic, internal::traits<Derived>::ColsAtCompileTime, IsRowMajor> DenseBase< Derived >::RowsBlockXpr
template<typename Derived>
typedef VectorwiseOp<Derived, Horizontal> DenseBase< Derived >::RowwiseReturnType
template<typename Derived>
typedef Block<Derived, 1, internal::traits<Derived>::ColsAtCompileTime, IsRowMajor> DenseBase< Derived >::RowXpr

Reimplemented in MatrixBase< Derived >, MatrixBase< TriangularProduct< Mode, false, Lhs, true, Rhs, false > >, MatrixBase< DenseTimeSparseSelfAdjointProduct< Lhs, Rhs, UpLo > >, MatrixBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, 0, true > >, MatrixBase< ScaledProduct< NestedProduct > >, MatrixBase< MatrixWrapper< ExpressionType > >, MatrixBase< Flagged< ExpressionType, Added, Removed > >, MatrixBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, RhsMode, false > >, MatrixBase< GeneralProduct< Lhs, Rhs, OuterProduct > >, MatrixBase< SparseSelfAdjointTimeDenseProduct< Lhs, Rhs, UpLo > >, MatrixBase< GeneralProduct< Lhs, Rhs, GemmProduct > >, MatrixBase< TriangularProduct< Mode, LhsIsTriangular, Lhs, false, Rhs, false > >, MatrixBase< SelfadjointProductMatrix< Lhs, 0, true, Rhs, RhsMode, false > >, MatrixBase< Homogeneous< MatrixType, _Direction > >, MatrixBase< SparseTimeDenseProduct< Lhs, Rhs > >, MatrixBase< DenseTimeSparseProduct< Lhs, Rhs > >, MatrixBase< CoeffBasedProduct< LhsNested, RhsNested, NestingFlags > >, MatrixBase< Minor< MatrixType > >, MatrixBase< GeneralProduct< Lhs, Rhs, GemvProduct > >, MatrixBase< DiagonalProduct< MatrixType, DiagonalType, ProductOrder > >, and MatrixBase< TriangularProduct< Mode, true, Lhs, false, Rhs, true > >.

template<typename Derived>
typedef internal::traits<Derived>::Scalar DenseBase< Derived >::Scalar

Reimplemented in ArrayBase< Derived >, MatrixBase< Derived >, ScaledProduct< NestedProduct >, ArrayBase< ArrayWrapper< ExpressionType > >, MatrixBase< TriangularProduct< Mode, false, Lhs, true, Rhs, false > >, MatrixBase< DenseTimeSparseSelfAdjointProduct< Lhs, Rhs, UpLo > >, MatrixBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, 0, true > >, MatrixBase< ScaledProduct< NestedProduct > >, MatrixBase< MatrixWrapper< ExpressionType > >, MatrixBase< Flagged< ExpressionType, Added, Removed > >, MatrixBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, RhsMode, false > >, MatrixBase< GeneralProduct< Lhs, Rhs, OuterProduct > >, MatrixBase< SparseSelfAdjointTimeDenseProduct< Lhs, Rhs, UpLo > >, MatrixBase< GeneralProduct< Lhs, Rhs, GemmProduct > >, MatrixBase< TriangularProduct< Mode, LhsIsTriangular, Lhs, false, Rhs, false > >, MatrixBase< SelfadjointProductMatrix< Lhs, 0, true, Rhs, RhsMode, false > >, MatrixBase< Homogeneous< MatrixType, _Direction > >, MatrixBase< SparseTimeDenseProduct< Lhs, Rhs > >, MatrixBase< DenseTimeSparseProduct< Lhs, Rhs > >, MatrixBase< CoeffBasedProduct< LhsNested, RhsNested, NestingFlags > >, MatrixBase< Minor< MatrixType > >, MatrixBase< GeneralProduct< Lhs, Rhs, GemvProduct > >, MatrixBase< DiagonalProduct< MatrixType, DiagonalType, ProductOrder > >, and MatrixBase< TriangularProduct< Mode, true, Lhs, false, Rhs, true > >.

template<typename Derived>
typedef VectorBlock<Derived> DenseBase< Derived >::SegmentReturnType
template<typename Derived>
typedef CwiseNullaryOp<internal::linspaced_op<Scalar,false>,Derived> DenseBase< Derived >::SequentialLinSpacedReturnType
template<typename Derived>
typedef internal::traits<Derived>::StorageKind DenseBase< Derived >::StorageKind

Reimplemented in ArrayBase< Derived >, MatrixBase< Derived >, ArrayBase< ArrayWrapper< ExpressionType > >, MatrixBase< TriangularProduct< Mode, false, Lhs, true, Rhs, false > >, MatrixBase< DenseTimeSparseSelfAdjointProduct< Lhs, Rhs, UpLo > >, MatrixBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, 0, true > >, MatrixBase< ScaledProduct< NestedProduct > >, MatrixBase< MatrixWrapper< ExpressionType > >, MatrixBase< Flagged< ExpressionType, Added, Removed > >, MatrixBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, RhsMode, false > >, MatrixBase< GeneralProduct< Lhs, Rhs, OuterProduct > >, MatrixBase< SparseSelfAdjointTimeDenseProduct< Lhs, Rhs, UpLo > >, MatrixBase< GeneralProduct< Lhs, Rhs, GemmProduct > >, MatrixBase< TriangularProduct< Mode, LhsIsTriangular, Lhs, false, Rhs, false > >, MatrixBase< SelfadjointProductMatrix< Lhs, 0, true, Rhs, RhsMode, false > >, MatrixBase< Homogeneous< MatrixType, _Direction > >, MatrixBase< SparseTimeDenseProduct< Lhs, Rhs > >, MatrixBase< DenseTimeSparseProduct< Lhs, Rhs > >, MatrixBase< CoeffBasedProduct< LhsNested, RhsNested, NestingFlags > >, MatrixBase< Minor< MatrixType > >, MatrixBase< GeneralProduct< Lhs, Rhs, GemvProduct > >, MatrixBase< DiagonalProduct< MatrixType, DiagonalType, ProductOrder > >, and MatrixBase< TriangularProduct< Mode, true, Lhs, false, Rhs, true > >.

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 
template<typename Derived>
anonymous enum
Enumerator:
ThisConstantIsPrivateInPlainObjectBase 

Constructor & Destructor Documentation

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

Default constructor. Do nothing.

Member Function Documentation

template<typename Derived >
bool DenseBase< Derived >::all ( void   )  const [inline]
Returns:
true if all coefficients are true

Example: 

 Output: 


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













template<typename Derived > 

      

        

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

      






Returns:
true if at least one coefficient is true


See also:
all() 













template<typename Derived> 



template<int BlockRows, int BlockCols> 

      

        

          Block<Derived, BlockRows, BlockCols> 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) 













template<typename Derived> 



template<int BlockRows, int BlockCols> 

      

        

          const Block<const Derived, BlockRows, BlockCols> DenseBase< Derived >::block 
          (
          Index 
           startRow, 
        

        

          
          
          Index 
           startCol 
        

        

          
          )
           const [inline]
        

      






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













template<typename Derived> 

      

        

          Block<Derived> 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) 













template<typename Derived> 

      

        

          const Block<const Derived> DenseBase< Derived >::block 
          (
          Index 
           startRow, 
        

        

          
          
          Index 
           startCol, 
        

        

          
          
          Index 
           blockRows, 
        

        

          
          
          Index 
           blockCols 
        

        

          
          )
           const [inline]
        

      






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













template<typename Derived> 

      

        

          Block<Derived> 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) 













template<typename Derived> 

      

        

          const Block<const Derived> DenseBase< Derived >::bottomLeftCorner 
          (
          Index 
           cRows, 
        

        

          
          
          Index 
           cCols 
        

        

          
          )
           const [inline]
        

      






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













template<typename Derived> 



template<int CRows, int CCols> 

      

        

          Block<Derived, CRows, CCols> 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) 













template<typename Derived> 



template<int CRows, int CCols> 

      

        

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

      






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













template<typename Derived> 

      

        

          Block<Derived> 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) 













template<typename Derived> 



template<int CRows, int CCols> 

      

        

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

      






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













template<typename Derived> 

      

        

          const Block<const Derived> DenseBase< Derived >::bottomRightCorner 
          (
          Index 
           cRows, 
        

        

          
          
          Index 
           cCols 
        

        

          
          )
           const [inline]
        

      






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













template<typename Derived> 



template<int CRows, int CCols> 

      

        

          Block<Derived, CRows, CCols> 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) 













template<typename Derived> 



template<int N> 

      

        

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

      






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













template<typename Derived> 



template<int N> 

      

        

          NRowsBlockXpr<N>::Type 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) 













template<typename Derived> 

      

        

          RowsBlockXpr 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) 













template<typename Derived> 

      

        

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

      






This is the const version of bottomRows(Index). 













template<typename Derived > 



template<typename OtherDerived > 

      

        

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

      

















template<typename Derived> 

      

        

          ColXpr 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 













template<typename Derived> 

      

        

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

      






This is the const version of col(). 













template<typename Derived > 

      

        

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

      






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


Example: 


 Output: 


See also:
rowwise(), class VectorwiseOp 













template<typename Derived > 

      

        

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

      






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


See also:
rowwise(), class VectorwiseOp 













template<typename Derived > 

      

        

          EIGEN_STRONG_INLINE const DenseBase< Derived >::ConstantReturnType 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 













template<typename Derived > 

      

        

          EIGEN_STRONG_INLINE const DenseBase< Derived >::ConstantReturnType 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 













template<typename Derived > 

      

        

          EIGEN_STRONG_INLINE const DenseBase< Derived >::ConstantReturnType DenseBase< Derived >::Constant 
          (
          Index 
           rows, 
        

        

          
          
          Index 
           cols, 
        

        

          
          
          const Scalar & 
           value 
        

        

          
          )
           [static]
        

      






Returns:
an expression of a constant matrix of value value 


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


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


The template parameter CustomNullaryOp is the type of the functor.


See also:
class CwiseNullaryOp 













template<typename Derived > 

      

        

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

      






Returns:
the number of coefficients which evaluate to true


See also:
all(), any() 













template<typename Derived> 

      

        

          EIGEN_STRONG_INLINE const internal::eval<Derived>::type 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. 













template<typename Derived> 



template<typename Dest > 

      

        

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

      







Reimplemented in ArrayWrapper< ExpressionType >, ProductBase< Derived, Lhs, Rhs >, ScaledProduct< NestedProduct >, ProductBase< GeneralProduct< Lhs, Rhs, GemmProduct >, Lhs, Rhs >, ProductBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, 0, true >, Lhs, Rhs >, ProductBase< TriangularProduct< Mode, true, Lhs, false, Rhs, true >, Lhs, Rhs >, ProductBase< ScaledProduct< NestedProduct >, NestedProduct::_LhsNested, NestedProduct::_RhsNested >, ProductBase< TriangularProduct< Mode, LhsIsTriangular, Lhs, false, Rhs, false >, Lhs, Rhs >, ProductBase< GeneralProduct< Lhs, Rhs, OuterProduct >, Lhs, Rhs >, ProductBase< DenseTimeSparseSelfAdjointProduct< Lhs, Rhs, UpLo >, Lhs, Rhs >, ProductBase< GeneralProduct< Lhs, Rhs, GemvProduct >, Lhs, Rhs >, ProductBase< SelfadjointProductMatrix< Lhs, 0, true, Rhs, RhsMode, false >, Lhs, Rhs >, ProductBase< TriangularProduct< Mode, false, Lhs, true, Rhs, false >, Lhs, Rhs >, ProductBase< DenseTimeSparseProduct< Lhs, Rhs >, Lhs, Rhs >, ProductBase< SparseSelfAdjointTimeDenseProduct< Lhs, Rhs, UpLo >, Lhs, Rhs >, ProductBase< SparseTimeDenseProduct< Lhs, Rhs >, Lhs, Rhs >, and ProductBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, RhsMode, false >, Lhs, Rhs >.













template<typename Derived > 

      

        

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

      






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


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













template<typename Derived > 



template<unsigned int Added, unsigned int Removed> 

      

        

          const Flagged< Derived, Added, Removed > 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 













template<typename Derived> 

      

        

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

      







Reimplemented in MatrixBase< Derived >, MatrixBase< TriangularProduct< Mode, false, Lhs, true, Rhs, false > >, MatrixBase< DenseTimeSparseSelfAdjointProduct< Lhs, Rhs, UpLo > >, MatrixBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, 0, true > >, MatrixBase< ScaledProduct< NestedProduct > >, MatrixBase< MatrixWrapper< ExpressionType > >, MatrixBase< Flagged< ExpressionType, Added, Removed > >, MatrixBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, RhsMode, false > >, MatrixBase< GeneralProduct< Lhs, Rhs, OuterProduct > >, MatrixBase< SparseSelfAdjointTimeDenseProduct< Lhs, Rhs, UpLo > >, MatrixBase< GeneralProduct< Lhs, Rhs, GemmProduct > >, MatrixBase< TriangularProduct< Mode, LhsIsTriangular, Lhs, false, Rhs, false > >, MatrixBase< SelfadjointProductMatrix< Lhs, 0, true, Rhs, RhsMode, false > >, MatrixBase< Homogeneous< MatrixType, _Direction > >, MatrixBase< SparseTimeDenseProduct< Lhs, Rhs > >, MatrixBase< DenseTimeSparseProduct< Lhs, Rhs > >, MatrixBase< CoeffBasedProduct< LhsNested, RhsNested, NestingFlags > >, MatrixBase< Minor< MatrixType > >, MatrixBase< GeneralProduct< Lhs, Rhs, GemvProduct > >, MatrixBase< DiagonalProduct< MatrixType, DiagonalType, ProductOrder > >, and MatrixBase< TriangularProduct< Mode, true, Lhs, false, Rhs, true > >.













template<typename Derived> 

      

        

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

      







Reimplemented in MatrixBase< Derived >, MatrixBase< TriangularProduct< Mode, false, Lhs, true, Rhs, false > >, MatrixBase< DenseTimeSparseSelfAdjointProduct< Lhs, Rhs, UpLo > >, MatrixBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, 0, true > >, MatrixBase< ScaledProduct< NestedProduct > >, MatrixBase< MatrixWrapper< ExpressionType > >, MatrixBase< Flagged< ExpressionType, Added, Removed > >, MatrixBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, RhsMode, false > >, MatrixBase< GeneralProduct< Lhs, Rhs, OuterProduct > >, MatrixBase< SparseSelfAdjointTimeDenseProduct< Lhs, Rhs, UpLo > >, MatrixBase< GeneralProduct< Lhs, Rhs, GemmProduct > >, MatrixBase< TriangularProduct< Mode, LhsIsTriangular, Lhs, false, Rhs, false > >, MatrixBase< SelfadjointProductMatrix< Lhs, 0, true, Rhs, RhsMode, false > >, MatrixBase< Homogeneous< MatrixType, _Direction > >, MatrixBase< SparseTimeDenseProduct< Lhs, Rhs > >, MatrixBase< DenseTimeSparseProduct< Lhs, Rhs > >, MatrixBase< CoeffBasedProduct< LhsNested, RhsNested, NestingFlags > >, MatrixBase< Minor< MatrixType > >, MatrixBase< GeneralProduct< Lhs, Rhs, GemvProduct > >, MatrixBase< DiagonalProduct< MatrixType, DiagonalType, ProductOrder > >, and MatrixBase< TriangularProduct< Mode, true, Lhs, false, Rhs, true > >.













template<typename Derived> 



template<bool Enable> 

      

        

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

      







Reimplemented in MatrixBase< Derived >, MatrixBase< TriangularProduct< Mode, false, Lhs, true, Rhs, false > >, MatrixBase< DenseTimeSparseSelfAdjointProduct< Lhs, Rhs, UpLo > >, MatrixBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, 0, true > >, MatrixBase< ScaledProduct< NestedProduct > >, MatrixBase< MatrixWrapper< ExpressionType > >, MatrixBase< Flagged< ExpressionType, Added, Removed > >, MatrixBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, RhsMode, false > >, MatrixBase< GeneralProduct< Lhs, Rhs, OuterProduct > >, MatrixBase< SparseSelfAdjointTimeDenseProduct< Lhs, Rhs, UpLo > >, MatrixBase< GeneralProduct< Lhs, Rhs, GemmProduct > >, MatrixBase< TriangularProduct< Mode, LhsIsTriangular, Lhs, false, Rhs, false > >, MatrixBase< SelfadjointProductMatrix< Lhs, 0, true, Rhs, RhsMode, false > >, MatrixBase< Homogeneous< MatrixType, _Direction > >, MatrixBase< SparseTimeDenseProduct< Lhs, Rhs > >, MatrixBase< DenseTimeSparseProduct< Lhs, Rhs > >, MatrixBase< CoeffBasedProduct< LhsNested, RhsNested, NestingFlags > >, MatrixBase< Minor< MatrixType > >, MatrixBase< GeneralProduct< Lhs, Rhs, GemvProduct > >, MatrixBase< DiagonalProduct< MatrixType, DiagonalType, ProductOrder > >, and MatrixBase< TriangularProduct< Mode, true, Lhs, false, Rhs, true > >.













template<typename Derived> 



template<bool Enable> 

      

        

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

      







Reimplemented in MatrixBase< Derived >, MatrixBase< TriangularProduct< Mode, false, Lhs, true, Rhs, false > >, MatrixBase< DenseTimeSparseSelfAdjointProduct< Lhs, Rhs, UpLo > >, MatrixBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, 0, true > >, MatrixBase< ScaledProduct< NestedProduct > >, MatrixBase< MatrixWrapper< ExpressionType > >, MatrixBase< Flagged< ExpressionType, Added, Removed > >, MatrixBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, RhsMode, false > >, MatrixBase< GeneralProduct< Lhs, Rhs, OuterProduct > >, MatrixBase< SparseSelfAdjointTimeDenseProduct< Lhs, Rhs, UpLo > >, MatrixBase< GeneralProduct< Lhs, Rhs, GemmProduct > >, MatrixBase< TriangularProduct< Mode, LhsIsTriangular, Lhs, false, Rhs, false > >, MatrixBase< SelfadjointProductMatrix< Lhs, 0, true, Rhs, RhsMode, false > >, MatrixBase< Homogeneous< MatrixType, _Direction > >, MatrixBase< SparseTimeDenseProduct< Lhs, Rhs > >, MatrixBase< DenseTimeSparseProduct< Lhs, Rhs > >, MatrixBase< CoeffBasedProduct< LhsNested, RhsNested, NestingFlags > >, MatrixBase< Minor< MatrixType > >, MatrixBase< GeneralProduct< Lhs, Rhs, GemvProduct > >, MatrixBase< DiagonalProduct< MatrixType, DiagonalType, ProductOrder > >, and MatrixBase< TriangularProduct< Mode, true, Lhs, false, Rhs, true > >.













template<typename Derived > 

      

        

          const WithFormat< Derived > 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 













template<typename Derived > 

      

        

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

      






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


Parameters:

  

    
size 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) 













template<typename Derived > 

      

        

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

      






This is the const version of head(Index). 













template<typename Derived > 



template<int Size> 

      

        

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

      






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













template<typename Derived > 



template<int Size> 

      

        

          DenseBase< Derived >::template FixedSegmentReturnType< Size >::Type 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 













template<typename Derived> 

      

        

          Index 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. 













template<typename Derived > 



template<typename OtherDerived > 

      

        

          bool DenseBase< Derived >::isApprox 
          (
          const DenseBase< OtherDerived > & 
           other, 
        

        

          
          
          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 $ v $ and $ w $ are considered to be approximately equal within precision $ p $ 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 













template<typename Derived > 

      

        

          bool DenseBase< Derived >::isApproxToConstant 
          (
          const Scalar & 
           value, 
        

        

          
          
          RealScalar 
           prec = NumTraits<Scalar>::dummy_precision() 
        

        

          
          )
           const
        

      






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













template<typename Derived > 

      

        

          bool DenseBase< Derived >::isConstant 
          (
          const Scalar & 
           value, 
        

        

          
          
          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 













template<typename Derived> 



template<typename Derived > 

      

        

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

        

          
          
          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 $ v $ is considered to be much smaller than $ x $ within precision $ p $ 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 













template<typename Derived> 

      

        

          bool DenseBase< Derived >::isMuchSmallerThan 
          (
          const RealScalar & 
           other, 
        

        

          
          
          RealScalar 
           prec = NumTraits< Scalar >::dummy_precision() 
        

        

          
          )
           const
        

      

















template<typename Derived > 



template<typename OtherDerived > 

      

        

          bool DenseBase< Derived >::isMuchSmallerThan 
          (
          const DenseBase< OtherDerived > & 
           other, 
        

        

          
          
          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 $ v $ is considered to be much smaller than a vector $ w $ within precision $ p $ 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 













template<typename Derived > 

      

        

          bool DenseBase< Derived >::isOnes 
          (
          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() 













template<typename Derived > 

      

        

          bool DenseBase< Derived >::isZero 
          (
          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() 













template<typename Derived > 



template<typename OtherDerived > 

      

        

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

      






Copies other into *this without evaluating other. 


Returns:
a reference to *this. 













template<typename Derived> 

      

        

          ColsBlockXpr 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) 













template<typename Derived> 

      

        

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

      






This is the const version of leftCols(Index). 













template<typename Derived> 



template<int N> 

      

        

          NColsBlockXpr<N>::Type 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) 













template<typename Derived> 



template<int N> 

      

        

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

      






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













template<typename Derived > 

      

        

          EIGEN_STRONG_INLINE const DenseBase< Derived >::SequentialLinSpacedReturnType 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.


Example: 


 Output: 


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













template<typename Derived > 

      

        

          EIGEN_STRONG_INLINE const DenseBase< Derived >::RandomAccessLinSpacedReturnType 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].


Example: 


 Output: 


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













template<typename Derived > 

      

        

          EIGEN_STRONG_INLINE const DenseBase< Derived >::SequentialLinSpacedReturnType 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.


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. 













template<typename Derived > 

      

        

          EIGEN_STRONG_INLINE const DenseBase< Derived >::RandomAccessLinSpacedReturnType 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].


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. 













template<typename Derived> 



template<int p> 

      

        

          RealScalar DenseBase< Derived >::lpNorm 
          (
          
           ) 
           const
        

      







Reimplemented in MatrixBase< Derived >, MatrixBase< TriangularProduct< Mode, false, Lhs, true, Rhs, false > >, MatrixBase< DenseTimeSparseSelfAdjointProduct< Lhs, Rhs, UpLo > >, MatrixBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, 0, true > >, MatrixBase< ScaledProduct< NestedProduct > >, MatrixBase< MatrixWrapper< ExpressionType > >, MatrixBase< Flagged< ExpressionType, Added, Removed > >, MatrixBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, RhsMode, false > >, MatrixBase< GeneralProduct< Lhs, Rhs, OuterProduct > >, MatrixBase< SparseSelfAdjointTimeDenseProduct< Lhs, Rhs, UpLo > >, MatrixBase< GeneralProduct< Lhs, Rhs, GemmProduct > >, MatrixBase< TriangularProduct< Mode, LhsIsTriangular, Lhs, false, Rhs, false > >, MatrixBase< SelfadjointProductMatrix< Lhs, 0, true, Rhs, RhsMode, false > >, MatrixBase< Homogeneous< MatrixType, _Direction > >, MatrixBase< SparseTimeDenseProduct< Lhs, Rhs > >, MatrixBase< DenseTimeSparseProduct< Lhs, Rhs > >, MatrixBase< CoeffBasedProduct< LhsNested, RhsNested, NestingFlags > >, MatrixBase< Minor< MatrixType > >, MatrixBase< GeneralProduct< Lhs, Rhs, GemvProduct > >, MatrixBase< DiagonalProduct< MatrixType, DiagonalType, ProductOrder > >, and MatrixBase< TriangularProduct< Mode, true, Lhs, false, Rhs, true > >.













template<typename Derived > 

      

        

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

      






Returns:
the maximum of all coefficients of *this 













template<typename Derived > 



template<typename IndexType > 

      

        

          internal::traits< Derived >::Scalar DenseBase< Derived >::maxCoeff 
          (
          IndexType * 
           row, 
        

        

          
          
          IndexType * 
           col 
        

        

          
          )
           const
        

      






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


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













template<typename Derived > 



template<typename IndexType > 

      

        

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

      






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


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













template<typename Derived > 

      

        

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

      






Returns:
the mean of all coefficients of *this


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













template<typename Derived> 



template<int N> 

      

        

          NColsBlockXpr<N>::Type 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) 













template<typename Derived> 



template<int N> 

      

        

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

      






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













template<typename Derived> 

      

        

          ConstColsBlockXpr DenseBase< Derived >::middleCols 
          (
          Index 
           startCol, 
        

        

          
          
          Index 
           numCols 
        

        

          
          )
           const [inline]
        

      






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













template<typename Derived> 

      

        

          ColsBlockXpr 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) 













template<typename Derived> 



template<int N> 

      

        

          NRowsBlockXpr<N>::Type 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) 













template<typename Derived> 

      

        

          RowsBlockXpr 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) 













template<typename Derived> 



template<int N> 

      

        

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

      






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













template<typename Derived> 

      

        

          ConstRowsBlockXpr DenseBase< Derived >::middleRows 
          (
          Index 
           startRow, 
        

        

          
          
          Index 
           numRows 
        

        

          
          )
           const [inline]
        

      






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













template<typename Derived > 

      

        

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

      






Returns:
the minimum of all coefficients of *this 













template<typename Derived > 



template<typename IndexType > 

      

        

          internal::traits< Derived >::Scalar DenseBase< Derived >::minCoeff 
          (
          IndexType * 
           row, 
        

        

          
          
          IndexType * 
           col 
        

        

          
          )
           const
        

      






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


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













template<typename Derived > 



template<typename IndexType > 

      

        

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

      






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


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













template<typename Derived > 

      

        

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

      






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













template<typename Derived> 

      

        

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

      






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













template<typename Derived > 



template<typename CustomNullaryOp > 

      

        

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













template<typename Derived > 



template<typename CustomNullaryOp > 

      

        

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













template<typename Derived > 



template<typename CustomNullaryOp > 

      

        

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













template<typename Derived > 

      

        

          EIGEN_STRONG_INLINE const DenseBase< Derived >::ConstantReturnType DenseBase< Derived >::Ones 
          (
          Index 
           rows, 
        

        

          
          
          Index 
           cols 
        

        

          
          )
           [static]
        

      






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


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


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


Example: 


 Output: 


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













template<typename Derived > 

      

        

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

      






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


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 Ones() should be used instead.


Example: 


 Output: 


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













template<typename Derived > 

      

        

          EIGEN_STRONG_INLINE const DenseBase< Derived >::ConstantReturnType 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 













template<typename Derived > 

      

        

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

      

















template<typename Derived > 



template<typename OtherDerived > 

      

        

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

      

















template<typename Derived > 



template<typename OtherDerived > 

      

        

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

      

















template<typename Derived > 

      

        

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

      

















template<typename Derived > 

      

        

          CommaInitializer< Derived > 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: 


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













template<typename Derived > 



template<typename OtherDerived > 

      

        

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

      






See also:
operator<<(const Scalar&) 













template<typename Derived > 



template<typename OtherDerived > 

      

        

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

      







Copies the generic expression other into *this. 


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


Returns:
a reference to *this. 



Reimplemented in MatrixBase< Derived >, MatrixBase< TriangularProduct< Mode, false, Lhs, true, Rhs, false > >, MatrixBase< DenseTimeSparseSelfAdjointProduct< Lhs, Rhs, UpLo > >, MatrixBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, 0, true > >, MatrixBase< ScaledProduct< NestedProduct > >, MatrixBase< MatrixWrapper< ExpressionType > >, MatrixBase< Flagged< ExpressionType, Added, Removed > >, MatrixBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, RhsMode, false > >, MatrixBase< GeneralProduct< Lhs, Rhs, OuterProduct > >, MatrixBase< SparseSelfAdjointTimeDenseProduct< Lhs, Rhs, UpLo > >, MatrixBase< GeneralProduct< Lhs, Rhs, GemmProduct > >, MatrixBase< TriangularProduct< Mode, LhsIsTriangular, Lhs, false, Rhs, false > >, MatrixBase< SelfadjointProductMatrix< Lhs, 0, true, Rhs, RhsMode, false > >, MatrixBase< Homogeneous< MatrixType, _Direction > >, MatrixBase< SparseTimeDenseProduct< Lhs, Rhs > >, MatrixBase< DenseTimeSparseProduct< Lhs, Rhs > >, MatrixBase< CoeffBasedProduct< LhsNested, RhsNested, NestingFlags > >, MatrixBase< Minor< MatrixType > >, MatrixBase< GeneralProduct< Lhs, Rhs, GemvProduct > >, MatrixBase< DiagonalProduct< MatrixType, DiagonalType, ProductOrder > >, and MatrixBase< TriangularProduct< Mode, true, Lhs, false, Rhs, true > >.













template<typename Derived > 



template<typename OtherDerived > 

      

        

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

      







Reimplemented in MatrixBase< Derived >, MatrixBase< TriangularProduct< Mode, false, Lhs, true, Rhs, false > >, MatrixBase< DenseTimeSparseSelfAdjointProduct< Lhs, Rhs, UpLo > >, MatrixBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, 0, true > >, MatrixBase< ScaledProduct< NestedProduct > >, MatrixBase< MatrixWrapper< ExpressionType > >, MatrixBase< Flagged< ExpressionType, Added, Removed > >, MatrixBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, RhsMode, false > >, MatrixBase< GeneralProduct< Lhs, Rhs, OuterProduct > >, MatrixBase< SparseSelfAdjointTimeDenseProduct< Lhs, Rhs, UpLo > >, MatrixBase< GeneralProduct< Lhs, Rhs, GemmProduct > >, MatrixBase< TriangularProduct< Mode, LhsIsTriangular, Lhs, false, Rhs, false > >, MatrixBase< SelfadjointProductMatrix< Lhs, 0, true, Rhs, RhsMode, false > >, MatrixBase< Homogeneous< MatrixType, _Direction > >, MatrixBase< SparseTimeDenseProduct< Lhs, Rhs > >, MatrixBase< DenseTimeSparseProduct< Lhs, Rhs > >, MatrixBase< CoeffBasedProduct< LhsNested, RhsNested, NestingFlags > >, MatrixBase< Minor< MatrixType > >, MatrixBase< GeneralProduct< Lhs, Rhs, GemvProduct > >, MatrixBase< DiagonalProduct< MatrixType, DiagonalType, ProductOrder > >, and MatrixBase< TriangularProduct< Mode, true, Lhs, false, Rhs, true > >.













template<typename Derived > 

      

        

          EIGEN_STRONG_INLINE Derived & 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) 













template<typename Derived > 



template<typename OtherDerived > 

      

        

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

      






Copies other into *this. 


Returns:
a reference to *this. 



Reimplemented in MatrixBase< Derived >, MatrixBase< TriangularProduct< Mode, false, Lhs, true, Rhs, false > >, MatrixBase< DenseTimeSparseSelfAdjointProduct< Lhs, Rhs, UpLo > >, MatrixBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, 0, true > >, MatrixBase< ScaledProduct< NestedProduct > >, MatrixBase< MatrixWrapper< ExpressionType > >, MatrixBase< Flagged< ExpressionType, Added, Removed > >, MatrixBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, RhsMode, false > >, MatrixBase< GeneralProduct< Lhs, Rhs, OuterProduct > >, MatrixBase< SparseSelfAdjointTimeDenseProduct< Lhs, Rhs, UpLo > >, MatrixBase< GeneralProduct< Lhs, Rhs, GemmProduct > >, MatrixBase< TriangularProduct< Mode, LhsIsTriangular, Lhs, false, Rhs, false > >, MatrixBase< SelfadjointProductMatrix< Lhs, 0, true, Rhs, RhsMode, false > >, MatrixBase< Homogeneous< MatrixType, _Direction > >, MatrixBase< SparseTimeDenseProduct< Lhs, Rhs > >, MatrixBase< DenseTimeSparseProduct< Lhs, Rhs > >, MatrixBase< CoeffBasedProduct< LhsNested, RhsNested, NestingFlags > >, MatrixBase< Minor< MatrixType > >, MatrixBase< GeneralProduct< Lhs, Rhs, GemvProduct > >, MatrixBase< DiagonalProduct< MatrixType, DiagonalType, ProductOrder > >, and MatrixBase< TriangularProduct< Mode, true, Lhs, false, Rhs, true > >.













template<typename Derived> 

      

        

          Index 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. 













template<typename Derived > 

      

        

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

      






Returns:
the product of all coefficients of *this


Example: 


 Output: 


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













template<typename Derived > 

      

        

          const CwiseNullaryOp< internal::scalar_random_op< typename internal::traits< Derived >::Scalar >, Derived > 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() 













template<typename Derived > 

      

        

          const CwiseNullaryOp< internal::scalar_random_op< typename internal::traits< Derived >::Scalar >, Derived > 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) 













template<typename Derived > 

      

        

          const CwiseNullaryOp< internal::scalar_random_op< typename internal::traits< Derived >::Scalar >, Derived > 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() 













template<typename Derived > 



template<int RowFactor, int ColFactor> 

      

        

          const Replicate< Derived, RowFactor, ColFactor > 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 













template<typename Derived > 

      

        

          const Replicate< Derived, Dynamic, Dynamic > 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 













template<typename Derived> 

      

        

          void DenseBase< Derived >::resize 
          (
          Index 
           rows, 
        

        

          
          
          Index 
           cols 
        

        

          
          )
           [inline]
        

      






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













template<typename Derived> 

      

        

          void DenseBase< Derived >::resize 
          (
          Index 
           size
           ) 
           [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. 













template<typename Derived > 

      

        

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

      






Returns:
an expression of the reverse of *this.


Example: 


 Output: 


 











template<typename Derived > 

      

        

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

      






This is the const version of reverse(). 













template<typename Derived > 

      

        

          void 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() 













template<typename Derived> 



template<int N> 

      

        

          NColsBlockXpr<N>::Type 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) 













template<typename Derived> 

      

        

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

      






This is the const version of rightCols(Index). 













template<typename Derived> 

      

        

          ColsBlockXpr 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) 













template<typename Derived> 



template<int N> 

      

        

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

      






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













template<typename Derived> 

      

        

          RowXpr 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 













template<typename Derived> 

      

        

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

      






This is the const version of row(). 













template<typename Derived > 

      

        

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

      






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


Example: 


 Output: 


See also:
colwise(), class VectorwiseOp 













template<typename Derived > 

      

        

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

      






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


See also:
colwise(), class VectorwiseOp 













template<typename Derived > 



template<int Size> 

      

        

          DenseBase< Derived >::template FixedSegmentReturnType< Size >::Type 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 













template<typename Derived > 

      

        

          DenseBase< Derived >::SegmentReturnType DenseBase< Derived >::segment 
          (
          Index 
           start, 
        

        

          
          
          Index 
           size 
        

        

          
          )
           [inline]
        

      






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


Parameters:

  

    
start the first coefficient in the segment 

    
size 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) 













template<typename Derived > 

      

        

          DenseBase< Derived >::ConstSegmentReturnType DenseBase< Derived >::segment 
          (
          Index 
           start, 
        

        

          
          
          Index 
           size 
        

        

          
          )
           const [inline]
        

      






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













template<typename Derived > 



template<int Size> 

      

        

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

      






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













template<typename Derived > 



template<typename ThenDerived , typename ElseDerived > 

      

        

          const Select< Derived, ThenDerived, ElseDerived > 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 













template<typename Derived > 



template<typename ElseDerived > 

      

        

          const Select< Derived, typename ElseDerived::ConstantReturnType, ElseDerived > DenseBase< Derived >::select 
          (
          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 













template<typename Derived > 



template<typename ThenDerived > 

      

        

          const Select< Derived, ThenDerived, typename ThenDerived::ConstantReturnType > DenseBase< Derived >::select 
          (
          const DenseBase< ThenDerived > & 
           thenMatrix, 
        

        

          
          
          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 













template<typename Derived > 

      

        

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

      






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() 













template<typename Derived> 

      

        

          Derived& DenseBase< Derived >::setLinSpaced 
          (
          const Scalar & 
           low, 
        

        

          
          
          const Scalar & 
           high 
        

        

          
          )
          
        

      

















template<typename Derived > 

      

        

          EIGEN_STRONG_INLINE Derived & DenseBase< Derived >::setLinSpaced 
          (
          Index 
           size, 
        

        

          
          
          const Scalar & 
           low, 
        

        

          
          
          const Scalar & 
           high 
        

        

          
          )
          
        

      







Sets a linearly space vector. 


The function generates 'size' equally spaced values in the closed interval [low,high].


Example: 


 Output: 


See also:
CwiseNullaryOp 













template<typename Derived > 

      

        

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

      






Sets all coefficients in this expression to one.


Example: 


 Output: 


See also:
class CwiseNullaryOp, Ones() 













template<typename Derived > 

      

        

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

      






Sets all coefficients in this expression to random values.


Example: 


 Output: 


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













template<typename Derived > 

      

        

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

      






Sets all coefficients in this expression to zero.


Example: 


 Output: 


See also:
class CwiseNullaryOp, Zero() 













template<typename Derived > 

      

        

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

      






Returns:
the sum of all coefficients of *this


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













template<typename Derived> 



template<typename OtherDerived > 

      

        

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

      






swaps *this with the matrix or array other. 













template<typename Derived> 



template<typename OtherDerived > 

      

        

          void DenseBase< Derived >::swap 
          (
          const DenseBase< OtherDerived > & 
           other, 
        

        

          
          
          int 
           = OtherDerived::ThisConstantIsPrivateInPlainObjectBase 
        

        

          
          )
           [inline]
        

      






swaps *this with the expression other. 













template<typename Derived > 

      

        

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

      






This is the const version of tail(Index). 













template<typename Derived > 



template<int Size> 

      

        

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

      






This is the const version of tail<int>. 













template<typename Derived > 



template<int Size> 

      

        

          DenseBase< Derived >::template FixedSegmentReturnType< Size >::Type 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 













template<typename Derived > 

      

        

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

      






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


Parameters:

  

    
size 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) 













template<typename Derived> 



template<int CRows, int CCols> 

      

        

          Block<Derived, CRows, CCols> 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) 













template<typename Derived> 

      

        

          Block<Derived> 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) 













template<typename Derived> 

      

        

          const Block<const Derived> DenseBase< Derived >::topLeftCorner 
          (
          Index 
           cRows, 
        

        

          
          
          Index 
           cCols 
        

        

          
          )
           const [inline]
        

      






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













template<typename Derived> 



template<int CRows, int CCols> 

      

        

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

      






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













template<typename Derived> 



template<int CRows, int CCols> 

      

        

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

      






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













template<typename Derived> 



template<int CRows, int CCols> 

      

        

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

      






Returns:
an expression of a fixed-size top-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) 













template<typename Derived> 

      

        

          Block<Derived> 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) 













template<typename Derived> 

      

        

          const Block<const Derived> DenseBase< Derived >::topRightCorner 
          (
          Index 
           cRows, 
        

        

          
          
          Index 
           cCols 
        

        

          
          )
           const [inline]
        

      






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













template<typename Derived> 



template<int N> 

      

        

          NRowsBlockXpr<N>::Type 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) 













template<typename Derived> 

      

        

          RowsBlockXpr 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) 













template<typename Derived> 



template<int N> 

      

        

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

      






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













template<typename Derived> 

      

        

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

      






This is the const version of topRows(Index). 













template<typename Derived> 

      

        

          Scalar DenseBase< Derived >::trace 
          (
          
           ) 
           const
        

      







Reimplemented in MatrixBase< Derived >, MatrixBase< TriangularProduct< Mode, false, Lhs, true, Rhs, false > >, MatrixBase< DenseTimeSparseSelfAdjointProduct< Lhs, Rhs, UpLo > >, MatrixBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, 0, true > >, MatrixBase< ScaledProduct< NestedProduct > >, MatrixBase< MatrixWrapper< ExpressionType > >, MatrixBase< Flagged< ExpressionType, Added, Removed > >, MatrixBase< SelfadjointProductMatrix< Lhs, LhsMode, false, Rhs, RhsMode, false > >, MatrixBase< GeneralProduct< Lhs, Rhs, OuterProduct > >, MatrixBase< SparseSelfAdjointTimeDenseProduct< Lhs, Rhs, UpLo > >, MatrixBase< GeneralProduct< Lhs, Rhs, GemmProduct > >, MatrixBase< TriangularProduct< Mode, LhsIsTriangular, Lhs, false, Rhs, false > >, MatrixBase< SelfadjointProductMatrix< Lhs, 0, true, Rhs, RhsMode, false > >, MatrixBase< Homogeneous< MatrixType, _Direction > >, MatrixBase< SparseTimeDenseProduct< Lhs, Rhs > >, MatrixBase< DenseTimeSparseProduct< Lhs, Rhs > >, MatrixBase< CoeffBasedProduct< LhsNested, RhsNested, NestingFlags > >, MatrixBase< Minor< MatrixType > >, MatrixBase< GeneralProduct< Lhs, Rhs, GemvProduct > >, MatrixBase< DiagonalProduct< MatrixType, DiagonalType, ProductOrder > >, and MatrixBase< TriangularProduct< Mode, true, Lhs, false, Rhs, true > >.













template<typename Derived > 

      

        

          Transpose< Derived > 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() 













template<typename Derived > 

      

        

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

      






This is the const version of transpose().


Make sure you read the warning for transpose() !


See also:
transposeInPlace(), adjoint() 













template<typename Derived > 

      

        

          void 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() 













template<typename Derived> 

      

        

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

      






Returns:
the unique coefficient of a 1x1 expression 













template<typename Derived > 



template<typename Visitor > 

      

        

          void 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() 













template<typename Derived > 

      

        

          EIGEN_STRONG_INLINE const DenseBase< Derived >::ConstantReturnType 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) 













template<typename Derived > 

      

        

          EIGEN_STRONG_INLINE const DenseBase< Derived >::ConstantReturnType 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) 













template<typename Derived > 

      

        

          EIGEN_STRONG_INLINE const DenseBase< Derived >::ConstantReturnType DenseBase< Derived >::Zero 
          (
          Index 
           rows, 
        

        

          
          
          Index 
           cols 
        

        

          
          )
           [static]
        

      






Returns:
an expression of a zero matrix.


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


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


Example: 


 Output: 


See also:
Zero(), Zero(Index) 







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() 







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



Generated on Thu Dec 1 2011 12:54:16 for HUMIM Tracker by 

doxygen 1.7.1