Eigen::DenseBase< Derived > Class Template Reference

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

#include <DenseBase.h>

Inheritance diagram for Eigen::DenseBase< Derived >:

Classes
struct	CastXpr
struct	ConstFixedBlockXpr
struct	ConstFixedSegmentReturnType
struct	ConstNColsBlockXpr
struct	ConstNRowsBlockXpr
struct	EIGEN_INDEXED_VIEW_METHOD_TYPE
struct	FixedBlockXpr
struct	FixedSegmentReturnType
struct	IvcColType
struct	IvcRowType
struct	IvcType
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, NumDimensions = int(MaxSizeAtCompileTime) == 1 ? 0 : bool(IsVectorAtCompileTime) ? 1 : 2,   Flags = internal::traits<Derived>::Flags, IsRowMajor = int(Flags) & RowMajorBit, InnerSizeAtCompileTime, InnerStrideAtCompileTime = internal::inner_stride_at_compile_time<Derived>::ret,   OuterStrideAtCompileTime = internal::outer_stride_at_compile_time<Derived>::ret }
enum	{ IsPlainObjectBase = 0 }
typedef DenseCoeffsBase< Derived, internal::accessors_level< Derived >::value >	Base
typedef Block< Derived >	BlockXpr
typedef Base::CoeffReturnType	CoeffReturnType
typedef Block< Derived, internal::traits< Derived >::RowsAtCompileTime, Dynamic, !IsRowMajor >	ColsBlockXpr
typedef VectorwiseOp< Derived, Vertical >	ColwiseReturnType
typedef Block< Derived, internal::traits< Derived >::RowsAtCompileTime, 1, !IsRowMajor >	ColXpr
typedef internal::conditional< NumTraits< Scalar >::IsComplex, const CwiseUnaryOp< internal::scalar_conjugate_op< Scalar >, const Derived >, const Derived &>::type	ConjugateReturnType
typedef internal::conditional< IsVectorAtCompileTime, const_iterator_type, void >::type	const_iterator
typedef internal::conditional<(Flags &DirectAccessBit)==DirectAccessBit, internal::pointer_based_stl_iterator< const Derived >, internal::generic_randaccess_stl_iterator< const Derived > >::type	const_iterator_type
typedef CwiseNullaryOp< internal::scalar_constant_op< Scalar >, PlainObject >	ConstantReturnType
typedef const Block< const Derived >	ConstBlockXpr
typedef const Block< const Derived, internal::traits< Derived >::RowsAtCompileTime, Dynamic, !IsRowMajor >	ConstColsBlockXpr
typedef const VectorwiseOp< const Derived, Vertical >	ConstColwiseReturnType
typedef const Block< const Derived, internal::traits< Derived >::RowsAtCompileTime, 1, !IsRowMajor >	ConstColXpr
typedef Block< const Derived, IsRowMajor?1:Dynamic, IsRowMajor?Dynamic:1, true >	ConstInnerVectorReturnType
typedef Block< const Derived, Dynamic, Dynamic, true >	ConstInnerVectorsReturnType
typedef const Reverse< const Derived, BothDirections >	ConstReverseReturnType
typedef const Block< const Derived, Dynamic, internal::traits< Derived >::ColsAtCompileTime, IsRowMajor >	ConstRowsBlockXpr
typedef const VectorwiseOp< const Derived, Horizontal >	ConstRowwiseReturnType
typedef const Block< const Derived, 1, internal::traits< Derived >::ColsAtCompileTime, IsRowMajor >	ConstRowXpr
typedef const VectorBlock< const Derived >	ConstSegmentReturnType
typedef internal::add_const< Transpose< const Derived > >::type	ConstTransposeReturnType
typedef Matrix< typename NumTraits< typename internal::traits< Derived >::Scalar >::Real, internal::traits< Derived >::ColsAtCompileTime, 1 >	EigenvaluesReturnType
typedef internal::add_const_on_value_type< typename internal::eval< Derived >::type >::type	EvalReturnType
typedef CwiseUnaryOp< internal::scalar_imag_op< Scalar >, const Derived >	ImagReturnType
typedef Eigen::InnerIterator< Derived >	InnerIterator
typedef Block< Derived, IsRowMajor?1:Dynamic, IsRowMajor?Dynamic:1, true >	InnerVectorReturnType
typedef Block< Derived, Dynamic, Dynamic, true >	InnerVectorsReturnType
typedef internal::conditional< IsVectorAtCompileTime, iterator_type, void >::type	iterator
typedef internal::conditional<(Flags &DirectAccessBit)==DirectAccessBit, internal::pointer_based_stl_iterator< Derived >, internal::generic_randaccess_stl_iterator< Derived > >::type	iterator_type
typedef CwiseUnaryOp< internal::scalar_opposite_op< Scalar >, const Derived >	NegativeReturnType
typedef CwiseUnaryView< internal::scalar_imag_ref_op< Scalar >, Derived >	NonConstImagReturnType
typedef internal::conditional< NumTraits< Scalar >::IsComplex, CwiseUnaryView< internal::scalar_real_ref_op< Scalar >, Derived >, Derived &>::type	NonConstRealReturnType
typedef internal::find_best_packet< Scalar, SizeAtCompileTime >::type	PacketScalar
typedef Array< typename internal::traits< Derived >::Scalar, internal::traits< Derived >::RowsAtCompileTime, internal::traits< Derived >::ColsAtCompileTime, AutoAlign|(internal::traits< Derived >::Flags &RowMajorBit ? RowMajor :ColMajor), internal::traits< Derived >::MaxRowsAtCompileTime, internal::traits< Derived >::MaxColsAtCompileTime >	PlainArray
typedef Matrix< typename internal::traits< Derived >::Scalar, internal::traits< Derived >::RowsAtCompileTime, internal::traits< Derived >::ColsAtCompileTime, AutoAlign|(internal::traits< Derived >::Flags &RowMajorBit ? RowMajor :ColMajor), internal::traits< Derived >::MaxRowsAtCompileTime, internal::traits< Derived >::MaxColsAtCompileTime >	PlainMatrix
typedef internal::conditional< internal::is_same< typename internal::traits< Derived >::XprKind, MatrixXpr >::value, PlainMatrix, PlainArray >::type	PlainObject
	The plain matrix or array type corresponding to this expression. More...
typedef CwiseNullaryOp< internal::linspaced_op< Scalar >, PlainObject >	RandomAccessLinSpacedReturnType
typedef CwiseNullaryOp< internal::scalar_random_op< Scalar >, PlainObject >	RandomReturnType
typedef internal::conditional< NumTraits< Scalar >::IsComplex, const CwiseUnaryOp< internal::scalar_real_op< Scalar >, const Derived >, const Derived &>::type	RealReturnType
typedef NumTraits< Scalar >::Real	RealScalar
typedef Reverse< Derived, BothDirections >	ReverseReturnType
typedef Block< Derived, Dynamic, internal::traits< Derived >::ColsAtCompileTime, IsRowMajor >	RowsBlockXpr
typedef VectorwiseOp< Derived, Horizontal >	RowwiseReturnType
typedef Block< Derived, 1, internal::traits< Derived >::ColsAtCompileTime, IsRowMajor >	RowXpr
typedef internal::traits< Derived >::Scalar	Scalar
typedef VectorBlock< Derived >	SegmentReturnType
typedef internal::traits< Derived >::StorageIndex	StorageIndex
	The type used to store indices. More...
typedef internal::traits< Derived >::StorageKind	StorageKind
typedef Transpose< Derived >	TransposeReturnType
typedef Scalar	value_type

Public Member Functions
EIGEN_DEVICE_FUNC bool	all () const
bool	allFinite () const
EIGEN_DEVICE_FUNC bool	any () const
iterator	begin ()
const_iterator	begin () const
template<typename NRowsType , typename NColsType >
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedBlockXpr< internal::get_fixed_value< NRowsType >::value, internal::get_fixed_value< NColsType >::value >::Type	block (Index startRow, Index startCol, NRowsType blockRows, NColsType blockCols)
template<typename NRowsType , typename NColsType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedBlockXpr< internal::get_fixed_value< NRowsType >::value, internal::get_fixed_value< NColsType >::value >::Type	block (Index startRow, Index startCol, NRowsType blockRows, NColsType blockCols) const
	This is the const version of block(Index,Index,NRowsType,NColsType) More...
template<int NRows, int NCols>
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedBlockXpr< NRows, NCols >::Type	block (Index startRow, Index startCol)
template<int NRows, int NCols>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedBlockXpr< NRows, NCols >::Type	block (Index startRow, Index startCol) const
	This is the const version of block<>(Index, Index). */. More...
template<int NRows, int NCols>
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedBlockXpr< NRows, NCols >::Type	block (Index startRow, Index startCol, Index blockRows, Index blockCols)
template<int NRows, int NCols>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedBlockXpr< NRows, NCols >::Type	block (Index startRow, Index startCol, Index blockRows, Index blockCols) const
	This is the const version of block<>(Index, Index, Index, Index). More...
template<typename NRowsType , typename NColsType >
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedBlockXpr< internal::get_fixed_value< NRowsType >::value, internal::get_fixed_value< NColsType >::value >::Type	bottomLeftCorner (NRowsType cRows, NColsType cCols)
template<typename NRowsType , typename NColsType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE ConstFixedBlockXpr< internal::get_fixed_value< NRowsType >::value, internal::get_fixed_value< NColsType >::value >::Type	bottomLeftCorner (NRowsType cRows, NColsType cCols) const
	This is the const version of bottomLeftCorner(NRowsType, NColsType). More...
template<int CRows, int CCols>
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedBlockXpr< CRows, CCols >::Type	bottomLeftCorner ()
template<int CRows, int CCols>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedBlockXpr< CRows, CCols >::Type	bottomLeftCorner () const
	This is the const version of bottomLeftCorner<int, int>(). More...
template<int CRows, int CCols>
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_STRONG_INLINE FixedBlockXpr< CRows, CCols >::Type	bottomLeftCorner (Index cRows, Index cCols)
template<int CRows, int CCols>
EIGEN_STRONG_INLINE const ConstFixedBlockXpr< CRows, CCols >::Type	bottomLeftCorner (Index cRows, Index cCols) const
	This is the const version of bottomLeftCorner<int, int>(Index, Index). More...
template<typename NRowsType , typename NColsType >
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedBlockXpr< internal::get_fixed_value< NRowsType >::value, internal::get_fixed_value< NColsType >::value >::Type	bottomRightCorner (NRowsType cRows, NColsType cCols)
template<typename NRowsType , typename NColsType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedBlockXpr< internal::get_fixed_value< NRowsType >::value, internal::get_fixed_value< NColsType >::value >::Type	bottomRightCorner (NRowsType cRows, NColsType cCols) const
	This is the const version of bottomRightCorner(NRowsType, NColsType). More...
template<int CRows, int CCols>
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedBlockXpr< CRows, CCols >::Type	bottomRightCorner ()
template<int CRows, int CCols>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedBlockXpr< CRows, CCols >::Type	bottomRightCorner () const
	This is the const version of bottomRightCorner<int, int>(). More...
template<int CRows, int CCols>
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedBlockXpr< CRows, CCols >::Type	bottomRightCorner (Index cRows, Index cCols)
template<int CRows, int CCols>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedBlockXpr< CRows, CCols >::Type	bottomRightCorner (Index cRows, Index cCols) const
	This is the const version of bottomRightCorner<int, int>(Index, Index). More...
template<typename NRowsType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE NRowsBlockXpr< internal::get_fixed_value< NRowsType >::value >::Type	bottomRows (NRowsType n)
template<typename NRowsType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstNRowsBlockXpr< internal::get_fixed_value< NRowsType >::value >::Type	bottomRows (NRowsType n) const
	This is the const version of bottomRows(NRowsType). More...
template<int N>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE NRowsBlockXpr< N >::Type	bottomRows (Index n=N)
template<int N>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE ConstNRowsBlockXpr< N >::Type	bottomRows (Index n=N) const
	This is the const version of bottomRows<int>(). More...
template<typename NewType >
EIGEN_DEVICE_FUNC CastXpr< NewType >::Type	cast () const
const_iterator	cbegin () const
const_iterator	cend () const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE ColXpr	col (Index i)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE ConstColXpr	col (Index i) const
	This is the const version of col(). More...
EIGEN_DEVICE_FUNC ConstColwiseReturnType	colwise () const
EIGEN_DEVICE_FUNC ColwiseReturnType	colwise ()
EIGEN_DEVICE_FUNC ConjugateReturnType	conjugate () const
template<bool Cond>
EIGEN_DEVICE_FUNC internal::conditional< Cond, ConjugateReturnType, const Derived & >::type	conjugateIf () const
EIGEN_DEVICE_FUNC Index	count () const
iterator	end ()
const_iterator	end () const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EvalReturnType	eval () const
template<typename Dest >
EIGEN_DEVICE_FUNC void	evalTo (Dest &) const
EIGEN_DEVICE_FUNC void	fill (const Scalar &value)
template<unsigned int Added, unsigned int Removed>
EIGEN_DEPRECATED const Derived &	flagged () const
EIGEN_DEVICE_FUNC const ForceAlignedAccess< Derived >	forceAlignedAccess () const
EIGEN_DEVICE_FUNC ForceAlignedAccess< Derived >	forceAlignedAccess ()
template<bool Enable>
EIGEN_DEVICE_FUNC const internal::conditional< Enable, ForceAlignedAccess< Derived >, Derived & >::type	forceAlignedAccessIf () const
template<bool Enable>
EIGEN_DEVICE_FUNC internal::conditional< Enable, ForceAlignedAccess< Derived >, Derived & >::type	forceAlignedAccessIf ()
const WithFormat< Derived >	format (const IOFormat &fmt) const
bool	hasNaN () const
template<typename NType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedSegmentReturnType< internal::get_fixed_value< NType >::value >::Type	head (NType n)
template<typename NType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedSegmentReturnType< internal::get_fixed_value< NType >::value >::Type	head (NType n) const
	This is the const version of head(NType). More...
template<int N>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedSegmentReturnType< N >::Type	head (Index n=N)
template<int N>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE ConstFixedSegmentReturnType< N >::Type	head (Index n=N) const
	This is the const version of head<int>(). More...
EIGEN_DEVICE_FUNC const ImagReturnType	imag () const
EIGEN_DEVICE_FUNC NonConstImagReturnType	imag ()
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	innerSize () const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE InnerVectorReturnType	innerVector (Index outer)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstInnerVectorReturnType	innerVector (Index outer) const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE InnerVectorsReturnType	innerVectors (Index outerStart, Index outerSize)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstInnerVectorsReturnType	innerVectors (Index outerStart, Index outerSize) const
template<typename OtherDerived >
EIGEN_DEVICE_FUNC bool	isApprox (const DenseBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
EIGEN_DEVICE_FUNC bool	isApproxToConstant (const Scalar &value, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
EIGEN_DEVICE_FUNC bool	isConstant (const Scalar &value, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
template<typename Derived >
EIGEN_DEVICE_FUNC bool	isMuchSmallerThan (const typename NumTraits< Scalar >::Real &other, const RealScalar &prec) const
EIGEN_DEVICE_FUNC bool	isMuchSmallerThan (const RealScalar &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
template<typename OtherDerived >
EIGEN_DEVICE_FUNC bool	isMuchSmallerThan (const DenseBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
EIGEN_DEVICE_FUNC bool	isOnes (const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
EIGEN_DEVICE_FUNC bool	isZero (const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived &	lazyAssign (const DenseBase< OtherDerived > &other)
template<typename OtherDerived >
EIGEN_DEPRECATED EIGEN_DEVICE_FUNC Derived &	lazyAssign (const DenseBase< OtherDerived > &other)
template<typename NColsType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE NColsBlockXpr< internal::get_fixed_value< NColsType >::value >::Type	leftCols (NColsType n)
template<typename NColsType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstNColsBlockXpr< internal::get_fixed_value< NColsType >::value >::Type	leftCols (NColsType n) const
	This is the const version of leftCols(NColsType). More...
template<int N>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE NColsBlockXpr< N >::Type	leftCols (Index n=N)
template<int N>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE ConstNColsBlockXpr< N >::Type	leftCols (Index n=N) const
	This is the const version of leftCols<int>(). More...
template<int p>
RealScalar	lpNorm () const
template<int NaNPropagation>
EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar	maxCoeff () const
EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar	maxCoeff () const
template<int NaNPropagation, typename IndexType >
EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar	maxCoeff (IndexType *row, IndexType *col) const
template<int NaNPropagation, typename IndexType >
EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar	maxCoeff (IndexType *index) const
template<typename IndexType >
EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar	maxCoeff (IndexType *row, IndexType *col) const
template<typename IndexType >
EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar	maxCoeff (IndexType *index) const
EIGEN_DEVICE_FUNC Scalar	mean () const
template<typename NColsType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE NColsBlockXpr< internal::get_fixed_value< NColsType >::value >::Type	middleCols (Index startCol, NColsType numCols)
template<typename NColsType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstNColsBlockXpr< internal::get_fixed_value< NColsType >::value >::Type	middleCols (Index startCol, NColsType numCols) const
	This is the const version of middleCols(Index,NColsType). More...
template<int N>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE NColsBlockXpr< N >::Type	middleCols (Index startCol, Index n=N)
template<int N>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE ConstNColsBlockXpr< N >::Type	middleCols (Index startCol, Index n=N) const
	This is the const version of middleCols<int>(). More...
template<typename NRowsType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE NRowsBlockXpr< internal::get_fixed_value< NRowsType >::value >::Type	middleRows (Index startRow, NRowsType n)
template<typename NRowsType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstNRowsBlockXpr< internal::get_fixed_value< NRowsType >::value >::Type	middleRows (Index startRow, NRowsType n) const
	This is the const version of middleRows(Index,NRowsType). More...
template<int N>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE NRowsBlockXpr< N >::Type	middleRows (Index startRow, Index n=N)
template<int N>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE ConstNRowsBlockXpr< N >::Type	middleRows (Index startRow, Index n=N) const
	This is the const version of middleRows<int>(). More...
template<int NaNPropagation>
EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar	minCoeff () const
EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar	minCoeff () const
template<int NaNPropagation, typename IndexType >
EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar	minCoeff (IndexType *row, IndexType *col) const
template<int NaNPropagation, typename IndexType >
EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar	minCoeff (IndexType *index) const
template<typename IndexType >
EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar	minCoeff (IndexType *row, IndexType *col) const
template<typename IndexType >
EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar	minCoeff (IndexType *index) const
EIGEN_DEVICE_FUNC const NestByValue< Derived >	nestByValue () const
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	nonZeros () const
template<typename CustomNullaryOp >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseNullaryOp< CustomNullaryOp, typename DenseBase< Derived >::PlainObject >	NullaryExpr (Index rows, Index cols, const CustomNullaryOp &func)
template<typename CustomNullaryOp >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseNullaryOp< CustomNullaryOp, typename DenseBase< Derived >::PlainObject >	NullaryExpr (Index size, const CustomNullaryOp &func)
template<typename CustomNullaryOp >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseNullaryOp< CustomNullaryOp, typename DenseBase< Derived >::PlainObject >	NullaryExpr (const CustomNullaryOp &func)
template<typename RowIndices , typename ColIndices >
internal::enable_if< internal::valid_indexed_view_overload< RowIndices, ColIndices >::value &&internal::traits< typename EIGEN_INDEXED_VIEW_METHOD_TYPE< RowIndices, ColIndices >::type >::ReturnAsIndexedView, typename EIGEN_INDEXED_VIEW_METHOD_TYPE< RowIndices, ColIndices >::type >::type	operator() (const RowIndices &rowIndices, const ColIndices &colIndices) EIGEN_INDEXED_VIEW_METHOD_CONST
template<typename RowIndices , typename ColIndices >
internal::enable_if< internal::valid_indexed_view_overload< RowIndices, ColIndices >::value &&internal::traits< typename EIGEN_INDEXED_VIEW_METHOD_TYPE< RowIndices, ColIndices >::type >::ReturnAsIndexedView, typename EIGEN_INDEXED_VIEW_METHOD_TYPE< RowIndices, ColIndices >::type >::type	operator() (const RowIndices &rowIndices, const ColIndices &colIndices) EIGEN_INDEXED_VIEW_METHOD_CONST
template<typename RowIndices , typename ColIndices >
internal::enable_if< internal::valid_indexed_view_overload< RowIndices, ColIndices >::value &&internal::traits< typename EIGEN_INDEXED_VIEW_METHOD_TYPE< RowIndices, ColIndices >::type >::ReturnAsBlock, typename internal::traits< typename EIGEN_INDEXED_VIEW_METHOD_TYPE< RowIndices, ColIndices >::type >::BlockType >::type	operator() (const RowIndices &rowIndices, const ColIndices &colIndices) EIGEN_INDEXED_VIEW_METHOD_CONST
template<typename RowIndices , typename ColIndices >
internal::enable_if< internal::valid_indexed_view_overload< RowIndices, ColIndices >::value &&internal::traits< typename EIGEN_INDEXED_VIEW_METHOD_TYPE< RowIndices, ColIndices >::type >::ReturnAsBlock, typename internal::traits< typename EIGEN_INDEXED_VIEW_METHOD_TYPE< RowIndices, ColIndices >::type >::BlockType >::type	operator() (const RowIndices &rowIndices, const ColIndices &colIndices) EIGEN_INDEXED_VIEW_METHOD_CONST
template<typename RowIndices , typename ColIndices >
internal::enable_if< internal::valid_indexed_view_overload< RowIndices, ColIndices >::value &&internal::traits< typename EIGEN_INDEXED_VIEW_METHOD_TYPE< RowIndices, ColIndices >::type >::ReturnAsScalar, CoeffReturnType >::type	operator() (const RowIndices &rowIndices, const ColIndices &colIndices) EIGEN_INDEXED_VIEW_METHOD_CONST
template<typename RowIndices , typename ColIndices >
internal::enable_if< internal::valid_indexed_view_overload< RowIndices, ColIndices >::value &&internal::traits< typename EIGEN_INDEXED_VIEW_METHOD_TYPE< RowIndices, ColIndices >::type >::ReturnAsScalar, CoeffReturnType >::type	operator() (const RowIndices &rowIndices, const ColIndices &colIndices) EIGEN_INDEXED_VIEW_METHOD_CONST
template<typename Indices >
internal::enable_if< IsRowMajor &&(!(internal::get_compile_time_incr< typename IvcType< Indices >::type >::value==1||internal::is_valid_index_type< Indices >::value)), IndexedView< EIGEN_INDEXED_VIEW_METHOD_CONST Derived, IvcIndex, typename IvcType< Indices >::type > >::type	operator() (const Indices &indices) EIGEN_INDEXED_VIEW_METHOD_CONST
template<typename Indices >
internal::enable_if< IsRowMajor &&(!(internal::get_compile_time_incr< typename IvcType< Indices >::type >::value==1||internal::is_valid_index_type< Indices >::value)), IndexedView< EIGEN_INDEXED_VIEW_METHOD_CONST Derived, IvcIndex, typename IvcType< Indices >::type > >::type	operator() (const Indices &indices) EIGEN_INDEXED_VIEW_METHOD_CONST
template<typename Indices >
internal::enable_if<(!IsRowMajor) &&(!(internal::get_compile_time_incr< typename IvcType< Indices >::type >::value==1||internal::is_valid_index_type< Indices >::value)), IndexedView< EIGEN_INDEXED_VIEW_METHOD_CONST Derived, typename IvcType< Indices >::type, IvcIndex > >::type	operator() (const Indices &indices) EIGEN_INDEXED_VIEW_METHOD_CONST
template<typename Indices >
internal::enable_if<(!IsRowMajor) &&(!(internal::get_compile_time_incr< typename IvcType< Indices >::type >::value==1||internal::is_valid_index_type< Indices >::value)), IndexedView< EIGEN_INDEXED_VIEW_METHOD_CONST Derived, typename IvcType< Indices >::type, IvcIndex > >::type	operator() (const Indices &indices) EIGEN_INDEXED_VIEW_METHOD_CONST
template<typename Indices >
internal::enable_if<(internal::get_compile_time_incr< typename IvcType< Indices >::type >::value==1) &&(!internal::is_valid_index_type< Indices >::value) &&(!symbolic::is_symbolic< Indices >::value), VectorBlock< EIGEN_INDEXED_VIEW_METHOD_CONST Derived, internal::array_size< Indices >::value > >::type	operator() (const Indices &indices) EIGEN_INDEXED_VIEW_METHOD_CONST
template<typename Indices >
internal::enable_if<(internal::get_compile_time_incr< typename IvcType< Indices >::type >::value==1) &&(!internal::is_valid_index_type< Indices >::value) &&(!symbolic::is_symbolic< Indices >::value), VectorBlock< EIGEN_INDEXED_VIEW_METHOD_CONST Derived, internal::array_size< Indices >::value > >::type	operator() (const Indices &indices) EIGEN_INDEXED_VIEW_METHOD_CONST
template<typename IndexType >
internal::enable_if< symbolic::is_symbolic< IndexType >::value, CoeffReturnType >::type	operator() (const IndexType &id) EIGEN_INDEXED_VIEW_METHOD_CONST
template<typename IndexType >
internal::enable_if< symbolic::is_symbolic< IndexType >::value, CoeffReturnType >::type	operator() (const IndexType &id) EIGEN_INDEXED_VIEW_METHOD_CONST
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived &	operator*= (const Scalar &other)
template<typename OtherDerived >
EIGEN_DEVICE_FUNC Derived &	operator+= (const EigenBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC const NegativeReturnType	operator- () const
template<typename OtherDerived >
EIGEN_DEVICE_FUNC Derived &	operator-= (const EigenBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived &	operator/= (const Scalar &other)
EIGEN_DEVICE_FUNC CommaInitializer< Derived >	operator<< (const Scalar &s)
template<typename OtherDerived >
EIGEN_DEVICE_FUNC CommaInitializer< Derived >	operator<< (const DenseBase< OtherDerived > &other)
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived &	operator= (const DenseBase< OtherDerived > &other)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived &	operator= (const DenseBase &other)
template<typename OtherDerived >
EIGEN_DEVICE_FUNC Derived &	operator= (const EigenBase< OtherDerived > &other)
	Copies the generic expression other into *this. More...
template<typename OtherDerived >
EIGEN_DEVICE_FUNC Derived &	operator= (const ReturnByValue< OtherDerived > &func)
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	outerSize () const
EIGEN_DEVICE_FUNC Scalar	prod () const
EIGEN_DEVICE_FUNC RealReturnType	real () const
EIGEN_DEVICE_FUNC NonConstRealReturnType	real ()
template<typename Func >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE internal::traits< Derived >::Scalar	redux (const Func &func) const
template<typename BinaryOp >
EIGEN_DEVICE_FUNC Scalar	redux (const BinaryOp &func) const
template<int RowFactor, int ColFactor>
EIGEN_DEVICE_FUNC const Replicate< Derived, RowFactor, ColFactor >	replicate () const
EIGEN_DEVICE_FUNC const Replicate< Derived, Dynamic, Dynamic >	replicate (Index rowFactor, Index colFactor) const
template<typename NRowsType , typename NColsType >
EIGEN_DEVICE_FUNC Reshaped< EIGEN_RESHAPED_METHOD_CONST Derived, internal::get_compiletime_reshape_size< NRowsType, NColsType, SizeAtCompileTime >::value, internal::get_compiletime_reshape_size< NColsType, NRowsType, SizeAtCompileTime >::value >	reshaped (NRowsType nRows, NColsType nCols) EIGEN_RESHAPED_METHOD_CONST
template<typename NRowsType , typename NColsType >
EIGEN_DEVICE_FUNC Reshaped< EIGEN_RESHAPED_METHOD_CONST Derived, internal::get_compiletime_reshape_size< NRowsType, NColsType, SizeAtCompileTime >::value, internal::get_compiletime_reshape_size< NColsType, NRowsType, SizeAtCompileTime >::value >	reshaped (NRowsType nRows, NColsType nCols) EIGEN_RESHAPED_METHOD_CONST
template<int Order, typename NRowsType , typename NColsType >
EIGEN_DEVICE_FUNC Reshaped< EIGEN_RESHAPED_METHOD_CONST Derived, internal::get_compiletime_reshape_size< NRowsType, NColsType, SizeAtCompileTime >::value, internal::get_compiletime_reshape_size< NColsType, NRowsType, SizeAtCompileTime >::value, internal::get_compiletime_reshape_order< Flags, Order >::value >	reshaped (NRowsType nRows, NColsType nCols) EIGEN_RESHAPED_METHOD_CONST
template<int Order, typename NRowsType , typename NColsType >
EIGEN_DEVICE_FUNC Reshaped< EIGEN_RESHAPED_METHOD_CONST Derived, internal::get_compiletime_reshape_size< NRowsType, NColsType, SizeAtCompileTime >::value, internal::get_compiletime_reshape_size< NColsType, NRowsType, SizeAtCompileTime >::value, internal::get_compiletime_reshape_order< Flags, Order >::value >	reshaped (NRowsType nRows, NColsType nCols) EIGEN_RESHAPED_METHOD_CONST
EIGEN_DEVICE_FUNC Reshaped< EIGEN_RESHAPED_METHOD_CONST Derived, SizeAtCompileTime, 1 >	reshaped () EIGEN_RESHAPED_METHOD_CONST
EIGEN_DEVICE_FUNC Reshaped< EIGEN_RESHAPED_METHOD_CONST Derived, SizeAtCompileTime, 1 >	reshaped () EIGEN_RESHAPED_METHOD_CONST
template<int Order>
EIGEN_DEVICE_FUNC Reshaped< EIGEN_RESHAPED_METHOD_CONST Derived, SizeAtCompileTime, 1, internal::get_compiletime_reshape_order< Flags, Order >::value >	reshaped () EIGEN_RESHAPED_METHOD_CONST
template<int Order>
EIGEN_DEVICE_FUNC Reshaped< EIGEN_RESHAPED_METHOD_CONST Derived, SizeAtCompileTime, 1, internal::get_compiletime_reshape_order< Flags, Order >::value >	reshaped () EIGEN_RESHAPED_METHOD_CONST
EIGEN_DEVICE_FUNC void	resize (Index newSize)
EIGEN_DEVICE_FUNC void	resize (Index rows, Index cols)
EIGEN_DEVICE_FUNC ReverseReturnType	reverse ()
EIGEN_DEVICE_FUNC ConstReverseReturnType	reverse () const
EIGEN_DEVICE_FUNC void	reverseInPlace ()
template<typename NColsType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE NColsBlockXpr< internal::get_fixed_value< NColsType >::value >::Type	rightCols (NColsType n)
template<typename NColsType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstNColsBlockXpr< internal::get_fixed_value< NColsType >::value >::Type	rightCols (NColsType n) const
	This is the const version of rightCols(NColsType). More...
template<int N>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE NColsBlockXpr< N >::Type	rightCols (Index n=N)
template<int N>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE ConstNColsBlockXpr< N >::Type	rightCols (Index n=N) const
	This is the const version of rightCols<int>(). More...
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE RowXpr	row (Index i)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE ConstRowXpr	row (Index i) const
	This is the const version of row(). */. More...
EIGEN_DEVICE_FUNC ConstRowwiseReturnType	rowwise () const
EIGEN_DEVICE_FUNC RowwiseReturnType	rowwise ()
template<typename NType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedSegmentReturnType< internal::get_fixed_value< NType >::value >::Type	segment (Index start, NType n)
template<typename NType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedSegmentReturnType< internal::get_fixed_value< NType >::value >::Type	segment (Index start, NType n) const
	This is the const version of segment(Index,NType). More...
template<int N>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedSegmentReturnType< N >::Type	segment (Index start, Index n=N)
template<int N>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE ConstFixedSegmentReturnType< N >::Type	segment (Index start, Index n=N) const
	This is the const version of segment<int>(Index). More...
template<typename ThenDerived , typename ElseDerived >
EIGEN_DEVICE_FUNC const Select< Derived, ThenDerived, ElseDerived >	select (const DenseBase< ThenDerived > &thenMatrix, const DenseBase< ElseDerived > &elseMatrix) const
template<typename ThenDerived >
EIGEN_DEVICE_FUNC const Select< Derived, ThenDerived, typename ThenDerived::ConstantReturnType >	select (const DenseBase< ThenDerived > &thenMatrix, const typename ThenDerived::Scalar &elseScalar) const
template<typename ElseDerived >
EIGEN_DEVICE_FUNC const Select< Derived, typename ElseDerived::ConstantReturnType, ElseDerived >	select (const typename ElseDerived::Scalar &thenScalar, const DenseBase< ElseDerived > &elseMatrix) const
EIGEN_DEVICE_FUNC Derived &	setConstant (const Scalar &value)
EIGEN_DEVICE_FUNC Derived &	setLinSpaced (Index size, const Scalar &low, const Scalar &high)
	Sets a linearly spaced vector. More...
EIGEN_DEVICE_FUNC Derived &	setLinSpaced (const Scalar &low, const Scalar &high)
	Sets a linearly spaced vector. More...
EIGEN_DEVICE_FUNC Derived &	setOnes ()
EIGEN_DEVICE_FUNC Derived &	setRandom ()
EIGEN_DEVICE_FUNC Derived &	setZero ()
template<DirectionType Direction>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE internal::conditional< Direction==Vertical, ColXpr, RowXpr >::type	subVector (Index i)
template<DirectionType Direction>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE internal::conditional< Direction==Vertical, ConstColXpr, ConstRowXpr >::type	subVector (Index i) const
template<DirectionType Direction>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR Index	subVectors () const
EIGEN_DEVICE_FUNC Scalar	sum () const
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	swap (const DenseBase< OtherDerived > &other)
template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void	swap (PlainObjectBase< OtherDerived > &other)
template<typename NType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedSegmentReturnType< internal::get_fixed_value< NType >::value >::Type	tail (NType n)
template<typename NType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedSegmentReturnType< internal::get_fixed_value< NType >::value >::Type	tail (NType n) const
	This is the const version of tail(Index). More...
template<int N>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedSegmentReturnType< N >::Type	tail (Index n=N)
template<int N>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE ConstFixedSegmentReturnType< N >::Type	tail (Index n=N) const
	This is the const version of tail<int>. More...
template<typename NRowsType , typename NColsType >
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedBlockXpr< internal::get_fixed_value< NRowsType >::value, internal::get_fixed_value< NColsType >::value >::Type	topLeftCorner (NRowsType cRows, NColsType cCols)
template<typename NRowsType , typename NColsType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedBlockXpr< internal::get_fixed_value< NRowsType >::value, internal::get_fixed_value< NColsType >::value >::Type	topLeftCorner (NRowsType cRows, NColsType cCols) const
	This is the const version of topLeftCorner(Index, Index). More...
template<int CRows, int CCols>
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedBlockXpr< CRows, CCols >::Type	topLeftCorner ()
template<int CRows, int CCols>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedBlockXpr< CRows, CCols >::Type	topLeftCorner () const
	This is the const version of topLeftCorner<int, int>(). More...
template<int CRows, int CCols>
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedBlockXpr< CRows, CCols >::Type	topLeftCorner (Index cRows, Index cCols)
template<int CRows, int CCols>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedBlockXpr< CRows, CCols >::Type	topLeftCorner (Index cRows, Index cCols) const
	This is the const version of topLeftCorner<int, int>(Index, Index). More...
template<typename NRowsType , typename NColsType >
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedBlockXpr< internal::get_fixed_value< NRowsType >::value, internal::get_fixed_value< NColsType >::value >::Type	topRightCorner (NRowsType cRows, NColsType cCols)
template<typename NRowsType , typename NColsType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedBlockXpr< internal::get_fixed_value< NRowsType >::value, internal::get_fixed_value< NColsType >::value >::Type	topRightCorner (NRowsType cRows, NColsType cCols) const
	This is the const version of topRightCorner(NRowsType, NColsType). More...
template<int CRows, int CCols>
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedBlockXpr< CRows, CCols >::Type	topRightCorner ()
template<int CRows, int CCols>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedBlockXpr< CRows, CCols >::Type	topRightCorner () const
	This is the const version of topRightCorner<int, int>(). More...
template<int CRows, int CCols>
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedBlockXpr< CRows, CCols >::Type	topRightCorner (Index cRows, Index cCols)
template<int CRows, int CCols>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedBlockXpr< CRows, CCols >::Type	topRightCorner (Index cRows, Index cCols) const
	This is the const version of topRightCorner<int, int>(Index, Index). More...
template<typename NRowsType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE NRowsBlockXpr< internal::get_fixed_value< NRowsType >::value >::Type	topRows (NRowsType n)
template<typename NRowsType >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstNRowsBlockXpr< internal::get_fixed_value< NRowsType >::value >::Type	topRows (NRowsType n) const
	This is the const version of topRows(NRowsType). More...
template<int N>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE NRowsBlockXpr< N >::Type	topRows (Index n=N)
template<int N>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE ConstNRowsBlockXpr< N >::Type	topRows (Index n=N) const
	This is the const version of topRows<int>(). More...
EIGEN_DEVICE_FUNC Scalar	trace () const
EIGEN_DEVICE_FUNC TransposeReturnType	transpose ()
EIGEN_DEVICE_FUNC ConstTransposeReturnType	transpose () const
EIGEN_DEVICE_FUNC void	transposeInPlace ()
template<typename CustomUnaryOp >
EIGEN_DEVICE_FUNC const CwiseUnaryOp< CustomUnaryOp, const Derived >	unaryExpr (const CustomUnaryOp &func=CustomUnaryOp()) const
	Apply a unary operator coefficient-wise. More...
template<typename CustomViewOp >
EIGEN_DEVICE_FUNC const CwiseUnaryView< CustomViewOp, const Derived >	unaryViewExpr (const CustomViewOp &func=CustomViewOp()) const
EIGEN_DEVICE_FUNC CoeffReturnType	value () const
template<typename Visitor >
EIGEN_DEVICE_FUNC void	visit (Visitor &func) const

Static Public Member Functions
static EIGEN_DEVICE_FUNC const ConstantReturnType	Constant (Index rows, Index cols, const Scalar &value)
static EIGEN_DEVICE_FUNC const ConstantReturnType	Constant (Index size, const Scalar &value)
static EIGEN_DEVICE_FUNC const ConstantReturnType	Constant (const Scalar &value)
EIGEN_DEPRECATED static EIGEN_DEVICE_FUNC const RandomAccessLinSpacedReturnType	LinSpaced (Sequential_t, Index size, const Scalar &low, const Scalar &high)
EIGEN_DEPRECATED static EIGEN_DEVICE_FUNC const RandomAccessLinSpacedReturnType	LinSpaced (Sequential_t, const Scalar &low, const Scalar &high)
static EIGEN_DEVICE_FUNC const RandomAccessLinSpacedReturnType	LinSpaced (Index size, const Scalar &low, const Scalar &high)
	Sets a linearly spaced vector. More...
static EIGEN_DEVICE_FUNC const RandomAccessLinSpacedReturnType	LinSpaced (const Scalar &low, const Scalar &high)
	Sets a linearly spaced vector. More...
template<typename CustomNullaryOp >
static EIGEN_DEVICE_FUNC const CwiseNullaryOp< CustomNullaryOp, PlainObject >	NullaryExpr (Index rows, Index cols, const CustomNullaryOp &func)
template<typename CustomNullaryOp >
static EIGEN_DEVICE_FUNC const CwiseNullaryOp< CustomNullaryOp, PlainObject >	NullaryExpr (Index size, const CustomNullaryOp &func)
template<typename CustomNullaryOp >
static EIGEN_DEVICE_FUNC const CwiseNullaryOp< CustomNullaryOp, PlainObject >	NullaryExpr (const CustomNullaryOp &func)
static EIGEN_DEVICE_FUNC const ConstantReturnType	Ones (Index rows, Index cols)
static EIGEN_DEVICE_FUNC const ConstantReturnType	Ones (Index size)
static EIGEN_DEVICE_FUNC const ConstantReturnType	Ones ()
static const RandomReturnType	Random (Index rows, Index cols)
static const RandomReturnType	Random (Index size)
static const RandomReturnType	Random ()
static EIGEN_DEVICE_FUNC const ConstantReturnType	Zero (Index rows, Index cols)
static EIGEN_DEVICE_FUNC const ConstantReturnType	Zero (Index size)
static EIGEN_DEVICE_FUNC const ConstantReturnType	Zero ()

Public Attributes
EIGEN_DEPRECATED typedef CwiseNullaryOp< internal::linspaced_op< Scalar >, PlainObject >	SequentialLinSpacedReturnType

Protected Types
typedef internal::IndexedViewCompatibleType< Index, 1 >::type	IvcIndex

Protected Member Functions
EIGEN_DEVICE_FUNC	DenseBase ()
template<typename Indices >
IvcColType< Indices >::type	ivcCol (const Indices &indices) const
template<typename Indices >
IvcRowType< Indices >::type	ivcRow (const Indices &indices) const
template<typename Indices >
IvcColType< Indices >::type	ivcSize (const Indices &indices) const

Private Member Functions
EIGEN_DEVICE_FUNC	DenseBase (int)
EIGEN_DEVICE_FUNC	DenseBase (int, int)
template<typename OtherDerived >
EIGEN_DEVICE_FUNC	DenseBase (const DenseBase< OtherDerived > &)

Related Functions
(Note that these are not member functions.)
template<typename Derived >
std::ostream &	operator<< (std::ostream &s, const DenseBase< Derived > &m)

Detailed Description

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

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

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

Template Parameters

Derived

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

This class can be extended with the help of the plugin mechanism described on the page Extending MatrixBase (and other classes) by defining the preprocessor symbol EIGEN_DENSEBASE_PLUGIN.

See also

The class hierarchy

Definition at line 41 of file DenseBase.h.

Member Typedef Documentation

Base

template<typename Derived>

typedef DenseCoeffsBase<Derived, internal::accessors_level<Derived>::value> Eigen::DenseBase< Derived >::Base

Definition at line 74 of file DenseBase.h.

BlockXpr

template<typename Derived>

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

Definition at line 33 of file DenseBase.h.

CoeffReturnType

template<typename Derived>

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

Definition at line 96 of file DenseBase.h.

ColsBlockXpr

template<typename Derived>

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

Definition at line 21 of file DenseBase.h.

ColwiseReturnType

template<typename Derived>

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

Definition at line 539 of file DenseBase.h.

ColXpr

template<typename Derived>

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

Definition at line 15 of file DenseBase.h.

ConjugateReturnType

template<typename Derived>

typedef internal::conditional<NumTraits<Scalar>::IsComplex, const CwiseUnaryOp<internal::scalar_conjugate_op<Scalar>, const Derived>, const Derived& >::type Eigen::DenseBase< Derived >::ConjugateReturnType

Definition at line 20 of file DenseBase.h.

const_iterator

template<typename Derived>

typedef internal::conditional< IsVectorAtCompileTime, const_iterator_type, void >::type Eigen::DenseBase< Derived >::const_iterator

Definition at line 644 of file DenseBase.h.

const_iterator_type

template<typename Derived>

typedef internal::conditional< (Flags&DirectAccessBit)==DirectAccessBit, internal::pointer_based_stl_iterator<const Derived>, internal::generic_randaccess_stl_iterator<const Derived> >::type Eigen::DenseBase< Derived >::const_iterator_type

Definition at line 632 of file DenseBase.h.

ConstantReturnType

template<typename Derived>

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

Definition at line 267 of file DenseBase.h.

ConstBlockXpr

template<typename Derived>

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

Definition at line 34 of file DenseBase.h.

ConstColsBlockXpr

template<typename Derived>

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

Definition at line 22 of file DenseBase.h.

ConstColwiseReturnType

template<typename Derived>

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

Definition at line 540 of file DenseBase.h.

ConstColXpr

template<typename Derived>

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

Definition at line 16 of file DenseBase.h.

ConstInnerVectorReturnType

template<typename Derived>

typedef Block<const Derived,IsRowMajor?1:Dynamic,IsRowMajor?Dynamic:1,true> Eigen::DenseBase< Derived >::ConstInnerVectorReturnType

Definition at line 46 of file DenseBase.h.

ConstInnerVectorsReturnType

template<typename Derived>

typedef Block<const Derived,Dynamic,Dynamic,true> Eigen::DenseBase< Derived >::ConstInnerVectorsReturnType

Definition at line 50 of file DenseBase.h.

ConstReverseReturnType

template<typename Derived>

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

Definition at line 606 of file DenseBase.h.

ConstRowsBlockXpr

template<typename Derived>

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

Definition at line 25 of file DenseBase.h.

ConstRowwiseReturnType

template<typename Derived>

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

Definition at line 538 of file DenseBase.h.

ConstRowXpr

template<typename Derived>

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

Definition at line 19 of file DenseBase.h.

ConstSegmentReturnType

template<typename Derived>

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

Definition at line 40 of file DenseBase.h.

ConstTransposeReturnType

template<typename Derived>

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

Definition at line 327 of file DenseBase.h.

EigenvaluesReturnType

template<typename Derived>

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

Definition at line 273 of file DenseBase.h.

EvalReturnType

template<typename Derived>

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

Definition at line 398 of file DenseBase.h.

ImagReturnType

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_imag_op<Scalar>, const Derived> Eigen::DenseBase< Derived >::ImagReturnType

Definition at line 32 of file DenseBase.h.

InnerIterator

template<typename Derived>

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

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

See also

class InnerIterator

Definition at line 53 of file DenseBase.h.

InnerVectorReturnType

template<typename Derived>

typedef Block<Derived,IsRowMajor?1:Dynamic,IsRowMajor?Dynamic:1,true> Eigen::DenseBase< Derived >::InnerVectorReturnType

Definition at line 45 of file DenseBase.h.

InnerVectorsReturnType

template<typename Derived>

typedef Block<Derived,Dynamic,Dynamic,true> Eigen::DenseBase< Derived >::InnerVectorsReturnType

Definition at line 49 of file DenseBase.h.

iterator

template<typename Derived>

typedef internal::conditional< IsVectorAtCompileTime, iterator_type, void >::type Eigen::DenseBase< Derived >::iterator

Definition at line 639 of file DenseBase.h.

iterator_type

template<typename Derived>

typedef internal::conditional< (Flags&DirectAccessBit)==DirectAccessBit, internal::pointer_based_stl_iterator<Derived>, internal::generic_randaccess_stl_iterator<Derived> >::type Eigen::DenseBase< Derived >::iterator_type

Definition at line 627 of file DenseBase.h.

IvcIndex

template<typename Derived>

typedef internal::IndexedViewCompatibleType<Index,1>::type Eigen::DenseBase< Derived >::IvcIndex

protected

Definition at line 37 of file DenseBase.h.

NegativeReturnType

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_opposite_op<Scalar>, const Derived> Eigen::DenseBase< Derived >::NegativeReturnType

Definition at line 36 of file DenseBase.h.

NonConstImagReturnType

template<typename Derived>

typedef CwiseUnaryView<internal::scalar_imag_ref_op<Scalar>, Derived> Eigen::DenseBase< Derived >::NonConstImagReturnType

Definition at line 34 of file DenseBase.h.

NonConstRealReturnType

template<typename Derived>

typedef internal::conditional<NumTraits<Scalar>::IsComplex, CwiseUnaryView<internal::scalar_real_ref_op<Scalar>, Derived>, Derived& >::type Eigen::DenseBase< Derived >::NonConstRealReturnType

Definition at line 30 of file DenseBase.h.

PacketScalar

template<typename Derived>

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

Definition at line 179 of file DenseBase.h.

PlainArray

template<typename Derived>

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

The plain array type corresponding to this expression.

See also

PlainObject

Definition at line 201 of file DenseBase.h.

PlainMatrix

template<typename Derived>

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

The plain matrix type corresponding to this expression.

See also

PlainObject

Definition at line 191 of file DenseBase.h.

PlainObject

template<typename Derived>

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

The plain matrix or array type corresponding to this expression.

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

Definition at line 210 of file DenseBase.h.

RandomAccessLinSpacedReturnType

template<typename Derived>

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

Definition at line 271 of file DenseBase.h.

RandomReturnType

template<typename Derived>

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

Definition at line 567 of file DenseBase.h.

RealReturnType

template<typename Derived>

typedef internal::conditional<NumTraits<Scalar>::IsComplex, const CwiseUnaryOp<internal::scalar_real_op<Scalar>, const Derived>, const Derived& >::type Eigen::DenseBase< Derived >::RealReturnType

Definition at line 25 of file DenseBase.h.

RealScalar

template<typename Derived>

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

Definition at line 73 of file DenseBase.h.

ReverseReturnType

template<typename Derived>

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

Definition at line 605 of file DenseBase.h.

RowsBlockXpr

template<typename Derived>

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

Definition at line 24 of file DenseBase.h.

RowwiseReturnType

template<typename Derived>

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

Definition at line 537 of file DenseBase.h.

RowXpr

template<typename Derived>

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

Definition at line 18 of file DenseBase.h.

Scalar

template<typename Derived>

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

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

Definition at line 66 of file DenseBase.h.

SegmentReturnType

template<typename Derived>

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

Definition at line 39 of file DenseBase.h.

StorageIndex

template<typename Derived>

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

The type used to store indices.

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

See also

Preprocessor directives, Eigen::Index, SparseMatrixBase.

Definition at line 63 of file DenseBase.h.

StorageKind

template<typename Derived>

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

Definition at line 55 of file DenseBase.h.

TransposeReturnType

template<typename Derived>

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

Definition at line 324 of file DenseBase.h.

value_type

template<typename Derived>

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

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

It is an alias for the Scalar type

Definition at line 71 of file DenseBase.h.

Member Enumeration Documentation

anonymous enum

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).
NumDimensions	This value is equal to Tensor::NumDimensions, i.e. 0 for scalars, 1 for vectors, and 2 for matrices.
Flags	This stores expression Flags flags which may or may not be inherited by new expressions constructed from this one. See the list of flags.
IsRowMajor	True if this expression has row-major storage order.
InnerSizeAtCompileTime
InnerStrideAtCompileTime
OuterStrideAtCompileTime

Definition at line 98 of file DenseBase.h.

anonymous enum

template<typename Derived>

anonymous enum

Enumerator
IsPlainObjectBase

Definition at line 181 of file DenseBase.h.

Constructor & Destructor Documentation

DenseBase() [1/4]

template<typename Derived>

EIGEN_DEVICE_FUNC Eigen::DenseBase< Derived >::DenseBase ( )

inlineprotected

Default constructor. Do nothing.

Definition at line 681 of file DenseBase.h.

DenseBase() [2/4]

template<typename Derived>

EIGEN_DEVICE_FUNC Eigen::DenseBase< Derived >::DenseBase ( int  )

explicitprivate

DenseBase() [3/4]

template<typename Derived>

EIGEN_DEVICE_FUNC Eigen::DenseBase< Derived >::DenseBase ( int  , int    )

private

DenseBase() [4/4]

template<typename Derived>

template<typename OtherDerived >

EIGEN_DEVICE_FUNC Eigen::DenseBase< Derived >::DenseBase ( const DenseBase< OtherDerived > &  )

explicitprivate

Member Function Documentation

all()

template<typename Derived >

EIGEN_DEVICE_FUNC bool Eigen::DenseBase< Derived >::all ( ) const

inline

Returns

true if all coefficients are true

Example:

Vector3f boxMin(Vector3f::Zero()), boxMax(Vector3f::Ones());
Vector3f p0 = Vector3f::Random(), p1 = Vector3f::Random().cwiseAbs();
// let's check if p0 and p1 are inside the axis aligned box defined by the corners boxMin,boxMax:
cout << "Is (" << p0.transpose() << ") inside the box: "
     << ((boxMin.array()<p0.array()).all() && (boxMax.array()>p0.array()).all()) << endl;
cout << "Is (" << p1.transpose() << ") inside the box: "
     << ((boxMin.array()<p1.array()).all() && (boxMax.array()>p1.array()).all()) << endl;

Output:

See also

any(), Cwise::operator<()

Definition at line 79 of file BooleanRedux.h.

allFinite()

template<typename Derived >

bool Eigen::DenseBase< Derived >::allFinite ( ) const

inline

Returns

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

See also

hasNaN()

Definition at line 151 of file BooleanRedux.h.

any()

template<typename Derived >

EIGEN_DEVICE_FUNC bool Eigen::DenseBase< Derived >::any ( ) const

inline

Returns

true if at least one coefficient is true

See also

all()

Definition at line 103 of file BooleanRedux.h.

begin() [1/2]

template<typename Derived >

DenseBase< Derived >::iterator Eigen::DenseBase< Derived >::begin ( )

inline

returns an iterator to the first element of the 1D vector or array

See also

end(), cbegin()

Definition at line 408 of file StlIterators.h.

begin() [2/2]

template<typename Derived >

DenseBase< Derived >::const_iterator Eigen::DenseBase< Derived >::begin ( ) const

inline

const version of begin()

Definition at line 416 of file StlIterators.h.

block() [1/6]

template<typename Derived>

template<typename NRowsType , typename NColsType >

EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedBlockXpr<internal::get_fixed_value<NRowsType>::value,internal::get_fixed_value<NColsType>::value>::Type Eigen::DenseBase< Derived >::block ( Index  startRow, Index  startCol, NRowsType  blockRows, NColsType  blockCols  )

inline

Returns

an expression of a block in *this with either dynamic or fixed sizes.

Parameters

startRow	the first row in the block
startCol	the first column in the block
blockRows	number of rows in the block, specified at either run-time or compile-time
blockCols	number of columns in the block, specified at either run-time or compile-time

Template Parameters

NRowsType	the type of the value handling the number of rows in the block, typically Index.
NColsType	the type of the value handling the number of columns in the block, typically Index.

Example using runtime (aka dynamic) sizes:

Matrix4i m = Matrix4i::Random();
cout << "Here is the matrix m:" << endl << m << endl;
cout << "Here is m.block(1, 1, 2, 2):" << endl << m.block(1, 1, 2, 2) << endl;
m.block(1, 1, 2, 2).setZero();
cout << "Now the matrix m is:" << endl << m << endl;

Output:

{3.4}:

The number of rows blockRows and columns blockCols can also be specified at compile-time by passing Eigen::fix<N>, or Eigen::fix<N>(n) as arguments. In the later case, n plays the role of a runtime fallback value in case N equals Eigen::Dynamic. Here is an example with a fixed number of rows NRows and dynamic number of columns cols:

mat.block(i,j,fix<NRows>,cols)

This function thus fully covers the features offered by the following overloads block<NRows,NCols>(Index, Index), and block<NRows,NCols>(Index, Index, Index, Index) that are thus obsolete. Indeed, this generic version avoids redundancy, it preserves the argument order, and prevents the need to rely on the template keyword in templated code.

but with less redundancy and more consistency as it does not modify the argument order and seamlessly enable hybrid fixed/dynamic sizes.

Note

Even in the case that 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, fix, fix<N>(int)

Definition at line 97 of file DenseBase.h.

block() [2/6]

template<typename Derived>

template<typename NRowsType , typename NColsType >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedBlockXpr<internal::get_fixed_value<NRowsType>::value,internal::get_fixed_value<NColsType>::value>::Type Eigen::DenseBase< Derived >::block ( Index  startRow, Index  startCol, NRowsType  blockRows, NColsType  blockCols  ) const

inline

This is the const version of block(Index,Index,NRowsType,NColsType)

Definition at line 111 of file DenseBase.h.

block() [3/6]

template<typename Derived>

template<int NRows, int NCols>

EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedBlockXpr<NRows,NCols>::Type Eigen::DenseBase< Derived >::block ( Index  startRow, Index  startCol  )

inline

Returns

a fixed-size expression of a block of *this.

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

Parameters

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

Example:

Matrix4i m = Matrix4i::Random();
cout << "Here is the matrix m:" << endl << m << endl;
cout << "Here is m.block<2,2>(1,1):" << endl << m.block<2,2>(1,1) << endl;
m.block<2,2>(1,1).setZero();
cout << "Now the matrix m is:" << endl << m << endl;

Output:

Note

The usage of of this overload is discouraged from Eigen 3.4, better used the generic block(Index,Index,NRowsType,NColsType), here is the one-to-one equivalence:

mat.template block<NRows,NCols>(i,j)  <-->  mat.block(i,j,fix<NRows>,fix<NCols>)

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

block(Index,Index,NRowsType,NColsType), class Block

Definition at line 1028 of file DenseBase.h.

block() [4/6]

template<typename Derived>

template<int NRows, int NCols>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedBlockXpr<NRows,NCols>::Type Eigen::DenseBase< Derived >::block ( Index  startRow, Index  startCol  ) const

inline

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

Definition at line 1036 of file DenseBase.h.

block() [5/6]

template<typename Derived>

template<int NRows, int NCols>

EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedBlockXpr<NRows,NCols>::Type Eigen::DenseBase< Derived >::block ( Index  startRow, Index  startCol, Index  blockRows, Index  blockCols  )

inline

Returns

an expression of a block of *this.

Template Parameters

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

Parameters

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

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

Example:

Matrix4i m = Matrix4i::Random();
cout << "Here is the matrix m:" << endl << m << endl;
cout << "Here is the block:" << endl << m.block<2, Dynamic>(1, 1, 2, 3) << endl;
m.block<2, Dynamic>(1, 1, 2, 3).setZero();
cout << "Now the matrix m is:" << endl << m << endl;

Output:

Note

The usage of of this overload is discouraged from Eigen 3.4, better used the generic block(Index,Index,NRowsType,NColsType), here is the one-to-one complete equivalence:

mat.template block<NRows,NCols>(i,j,rows,cols)     <-->  mat.block(i,j,fix<NRows>(rows),fix<NCols>(cols))

If we known that, e.g., NRows==Dynamic and NCols!=Dynamic, then the equivalence becomes:

mat.template block<Dynamic,NCols>(i,j,rows,NCols)  <-->  mat.block(i,j,rows,fix<NCols>)

See also

block(Index,Index,NRowsType,NColsType), class Block

Definition at line 1074 of file DenseBase.h.

block() [6/6]

template<typename Derived>

template<int NRows, int NCols>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedBlockXpr<NRows,NCols>::Type Eigen::DenseBase< Derived >::block ( Index  startRow, Index  startCol, Index  blockRows, Index  blockCols  ) const

inline

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

Definition at line 1083 of file DenseBase.h.

bottomLeftCorner() [1/6]

template<typename Derived>

template<typename NRowsType , typename NColsType >

EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedBlockXpr<internal::get_fixed_value<NRowsType>::value,internal::get_fixed_value<NColsType>::value>::Type Eigen::DenseBase< Derived >::bottomLeftCorner ( NRowsType  cRows, NColsType  cCols  )

inline

Returns

an expression of a bottom-left corner of *this with either dynamic or fixed sizes.

Parameters

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

Template Parameters

NRowsType	the type of the value handling the number of rows in the block, typically Index.
NColsType	the type of the value handling the number of columns in the block, typically Index.

Example:

Matrix4i m = Matrix4i::Random();
cout << "Here is the matrix m:" << endl << m << endl;
cout << "Here is m.bottomLeftCorner(2, 2):" << endl;
cout << m.bottomLeftCorner(2, 2) << endl;
m.bottomLeftCorner(2, 2).setZero();
cout << "Now the matrix m is:" << endl << m << endl;

Output:

The number of rows blockRows and columns blockCols can also be specified at compile-time by passing Eigen::fix<N>, or Eigen::fix<N>(n) as arguments. See block() for the details.

See also

block(Index,Index,NRowsType,NColsType), class Block

Definition at line 464 of file DenseBase.h.

bottomLeftCorner() [2/6]

template<typename Derived>

template<typename NRowsType , typename NColsType >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE ConstFixedBlockXpr<internal::get_fixed_value<NRowsType>::value,internal::get_fixed_value<NColsType>::value>::Type Eigen::DenseBase< Derived >::bottomLeftCorner ( NRowsType  cRows, NColsType  cCols  ) const

inline

This is the const version of bottomLeftCorner(NRowsType, NColsType).

Definition at line 479 of file DenseBase.h.

bottomLeftCorner() [3/6]

template<typename Derived>

template<int CRows, int CCols>

EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedBlockXpr<CRows,CCols>::Type Eigen::DenseBase< Derived >::bottomLeftCorner ( )

inline

Returns

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

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

Example:

Matrix4i m = Matrix4i::Random();
cout << "Here is the matrix m:" << endl << m << endl;
cout << "Here is m.bottomLeftCorner<2,2>():" << endl;
cout << m.bottomLeftCorner<2,2>() << endl;
m.bottomLeftCorner<2,2>().setZero();
cout << "Now the matrix m is:" << endl << m << endl;

Output:

See also

block(Index,Index,NRowsType,NColsType), class Block

Definition at line 499 of file DenseBase.h.

bottomLeftCorner() [4/6]

template<typename Derived>

template<int CRows, int CCols>

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

inline

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

Definition at line 507 of file DenseBase.h.

bottomLeftCorner() [5/6]

template<typename Derived>

template<int CRows, int CCols>

EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_STRONG_INLINE FixedBlockXpr<CRows,CCols>::Type Eigen::DenseBase< Derived >::bottomLeftCorner ( Index  cRows, Index  cCols  )

inline

Returns

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

Template Parameters

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

Parameters

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

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

Example:

Matrix4i m = Matrix4i::Random();
cout << "Here is the matrix m:" << endl << m << endl;
cout << "Here is m.bottomLeftCorner<2,Dynamic>(2,2):" << endl;
cout << m.bottomLeftCorner<2,Dynamic>(2,2) << endl;
m.bottomLeftCorner<2,Dynamic>(2,2).setZero();
cout << "Now the matrix m is:" << endl << m << endl;

Output:

See also

class Block

Definition at line 533 of file DenseBase.h.

bottomLeftCorner() [6/6]

template<typename Derived>

template<int CRows, int CCols>

EIGEN_STRONG_INLINE const ConstFixedBlockXpr<CRows,CCols>::Type Eigen::DenseBase< Derived >::bottomLeftCorner ( Index  cRows, Index  cCols  ) const

inline

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

Definition at line 541 of file DenseBase.h.

bottomRightCorner() [1/6]

template<typename Derived>

template<typename NRowsType , typename NColsType >

EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedBlockXpr<internal::get_fixed_value<NRowsType>::value,internal::get_fixed_value<NColsType>::value>::Type Eigen::DenseBase< Derived >::bottomRightCorner ( NRowsType  cRows, NColsType  cCols  )

inline

Returns

an expression of a bottom-right corner of *this with either dynamic or fixed sizes.

Parameters

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

Template Parameters

NRowsType	the type of the value handling the number of rows in the block, typically Index.
NColsType	the type of the value handling the number of columns in the block, typically Index.

Example:

Matrix4i m = Matrix4i::Random();
cout << "Here is the matrix m:" << endl << m << endl;
cout << "Here is m.bottomRightCorner(2, 2):" << endl;
cout << m.bottomRightCorner(2, 2) << endl;
m.bottomRightCorner(2, 2).setZero();
cout << "Now the matrix m is:" << endl << m << endl;

Output:

The number of rows blockRows and columns blockCols can also be specified at compile-time by passing Eigen::fix<N>, or Eigen::fix<N>(n) as arguments. See block() for the details.

See also

block(Index,Index,NRowsType,NColsType), class Block

Definition at line 356 of file DenseBase.h.

bottomRightCorner() [2/6]

template<typename Derived>

template<typename NRowsType , typename NColsType >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedBlockXpr<internal::get_fixed_value<NRowsType>::value,internal::get_fixed_value<NColsType>::value>::Type Eigen::DenseBase< Derived >::bottomRightCorner ( NRowsType  cRows, NColsType  cCols  ) const

inline

This is the const version of bottomRightCorner(NRowsType, NColsType).

Definition at line 371 of file DenseBase.h.

bottomRightCorner() [3/6]

template<typename Derived>

template<int CRows, int CCols>

EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedBlockXpr<CRows,CCols>::Type Eigen::DenseBase< Derived >::bottomRightCorner ( )

inline

Returns

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

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

Example:

Matrix4i m = Matrix4i::Random();
cout << "Here is the matrix m:" << endl << m << endl;
cout << "Here is m.bottomRightCorner<2,2>():" << endl;
cout << m.bottomRightCorner<2,2>() << endl;
m.bottomRightCorner<2,2>().setZero();
cout << "Now the matrix m is:" << endl << m << endl;

Output:

See also

block(Index,Index,NRowsType,NColsType), class Block

Definition at line 391 of file DenseBase.h.

bottomRightCorner() [4/6]

template<typename Derived>

template<int CRows, int CCols>

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

inline

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

Definition at line 399 of file DenseBase.h.

bottomRightCorner() [5/6]

template<typename Derived>

template<int CRows, int CCols>

EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedBlockXpr<CRows,CCols>::Type Eigen::DenseBase< Derived >::bottomRightCorner ( Index  cRows, Index  cCols  )

inline

Returns

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

Template Parameters

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

Parameters

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

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

Example:

Matrix4i m = Matrix4i::Random();
cout << "Here is the matrix m:" << endl << m << endl;
cout << "Here is m.bottomRightCorner<2,Dynamic>(2,2):" << endl;
cout << m.bottomRightCorner<2,Dynamic>(2,2) << endl;
m.bottomRightCorner<2,Dynamic>(2,2).setZero();
cout << "Now the matrix m is:" << endl << m << endl;

Output:

See also

class Block

Definition at line 425 of file DenseBase.h.

bottomRightCorner() [6/6]

template<typename Derived>

template<int CRows, int CCols>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedBlockXpr<CRows,CCols>::Type Eigen::DenseBase< Derived >::bottomRightCorner ( Index  cRows, Index  cCols  ) const

inline

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

Definition at line 433 of file DenseBase.h.

bottomRows() [1/4]

template<typename Derived>

template<typename NRowsType >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE NRowsBlockXpr<internal::get_fixed_value<NRowsType>::value>::Type Eigen::DenseBase< Derived >::bottomRows ( NRowsType  n )

inline

Returns

a block consisting of the bottom rows of *this.

Parameters

n	the number of rows in the block

Template Parameters

NRowsType

the type of the value handling the number of rows in the block, typically Index.

Example:

Array44i a = Array44i::Random();
cout << "Here is the array a:" << endl << a << endl;
cout << "Here is a.bottomRows(2):" << endl;
cout << a.bottomRows(2) << endl;
a.bottomRows(2).setZero();
cout << "Now the array a is:" << endl << a << endl;

Output:

The number of rows n can also be specified at compile-time by passing Eigen::fix<N>, or Eigen::fix<N>(n) as arguments. See block() for the details.

See also

block(Index,Index,NRowsType,NColsType), class Block

Definition at line 646 of file DenseBase.h.

bottomRows() [2/4]

template<typename Derived>

template<typename NRowsType >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstNRowsBlockXpr<internal::get_fixed_value<NRowsType>::value>::Type Eigen::DenseBase< Derived >::bottomRows ( NRowsType  n ) const

inline

This is the const version of bottomRows(NRowsType).

Definition at line 660 of file DenseBase.h.

bottomRows() [3/4]

template<typename Derived>

template<int N>

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

inline

Returns

a block consisting of the bottom rows of *this.

Template Parameters

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

Parameters

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

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

Example:

Array44i a = Array44i::Random();
cout << "Here is the array a:" << endl << a << endl;
cout << "Here is a.bottomRows<2>():" << endl;
cout << a.bottomRows<2>() << endl;
a.bottomRows<2>().setZero();
cout << "Now the array a is:" << endl << a << endl;

Output:

See also

block(Index,Index,NRowsType,NColsType), class Block

Definition at line 683 of file DenseBase.h.

bottomRows() [4/4]

template<typename Derived>

template<int N>

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

inline

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

Definition at line 691 of file DenseBase.h.

cast()

template<typename Derived>

template<typename NewType >

EIGEN_DEVICE_FUNC CastXpr<NewType>::Type Eigen::DenseBase< Derived >::cast ( ) const

inline

Returns

an expression of *this with the Scalar type casted to NewScalar.

The template parameter NewScalar is the type we are casting the scalars to.

See also

class CwiseUnaryOp

Definition at line 63 of file DenseBase.h.

cbegin()

template<typename Derived >

DenseBase< Derived >::const_iterator Eigen::DenseBase< Derived >::cbegin ( ) const

inline

returns a read-only const_iterator to the first element of the 1D vector or array

See also

cend(), begin()

Definition at line 426 of file StlIterators.h.

cend()

template<typename Derived >

DenseBase< Derived >::const_iterator Eigen::DenseBase< Derived >::cend ( ) const

inline

returns a read-only const_iterator to the element following the last element of the 1D vector or array

See also

begin(), cend()

Definition at line 455 of file StlIterators.h.

col() [1/2]

template<typename Derived>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE ColXpr Eigen::DenseBase< Derived >::col ( Index  i )

inline

Returns

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

Example:

Matrix3d m = Matrix3d::Identity();
m.col(1) = Vector3d(4,5,6);
cout << m << endl;

Output:

See also

row(), class Block

Definition at line 1098 of file DenseBase.h.

col() [2/2]

template<typename Derived>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE ConstColXpr Eigen::DenseBase< Derived >::col ( Index  i ) const

inline

This is the const version of col().

Definition at line 1105 of file DenseBase.h.

colwise() [1/2]

template<typename Derived>

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

inline

Returns

a VectorwiseOp wrapper of *this broadcasting and partial reductions

Example:

Matrix3d m = Matrix3d::Random();
cout << "Here is the matrix m:" << endl << m << endl;
cout << "Here is the sum of each column:" << endl << m.colwise().sum() << endl;
cout << "Here is the maximum absolute value of each column:"
     << endl << m.cwiseAbs().colwise().maxCoeff() << endl;

Output:

See also

rowwise(), class VectorwiseOp, TutorialReductionsVisitorsBroadcasting

Definition at line 562 of file DenseBase.h.

colwise() [2/2]

template<typename Derived >

EIGEN_DEVICE_FUNC DenseBase< Derived >::ColwiseReturnType Eigen::DenseBase< Derived >::colwise ( )

inline

Returns

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

See also

rowwise(), class VectorwiseOp, TutorialReductionsVisitorsBroadcasting

Definition at line 763 of file VectorwiseOp.h.

conjugate()

template<typename Derived>

EIGEN_DEVICE_FUNC ConjugateReturnType Eigen::DenseBase< Derived >::conjugate ( void  ) const

inline

Returns

an expression of the complex conjugate of *this.

See also

Math functions, MatrixBase::adjoint()

Definition at line 75 of file DenseBase.h.

conjugateIf()

template<typename Derived>

template<bool Cond>

EIGEN_DEVICE_FUNC internal::conditional<Cond,ConjugateReturnType,const Derived&>::type Eigen::DenseBase< Derived >::conjugateIf ( ) const

inline

Returns

an expression of the complex conjugate of *this if Cond==true, returns derived() otherwise.

See also

conjugate()

Definition at line 88 of file DenseBase.h.

Constant() [1/3]

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const DenseBase< Derived >::ConstantReturnType Eigen::DenseBase< Derived >::Constant ( Index  rows, Index  cols, const Scalar &  value  )

static

Returns

an expression of a constant matrix of value value

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

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

The template parameter CustomNullaryOp is the type of the functor.

See also

class CwiseNullaryOp

Definition at line 189 of file CwiseNullaryOp.h.

Constant() [2/3]

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const DenseBase< Derived >::ConstantReturnType Eigen::DenseBase< Derived >::Constant ( Index  size, const Scalar &  value  )

static

Returns

an expression of a constant matrix of value value

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

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

The template parameter CustomNullaryOp is the type of the functor.

See also

class CwiseNullaryOp

Definition at line 211 of file CwiseNullaryOp.h.

Constant() [3/3]

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const DenseBase< Derived >::ConstantReturnType Eigen::DenseBase< Derived >::Constant ( const Scalar &  value )

static

Returns

an expression of a constant matrix of value value

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

The template parameter CustomNullaryOp is the type of the functor.

See also

class CwiseNullaryOp

Definition at line 227 of file CwiseNullaryOp.h.

count()

template<typename Derived >

EIGEN_DEVICE_FUNC Eigen::Index Eigen::DenseBase< Derived >::count ( ) const

inline

Returns

the number of coefficients which evaluate to true

See also

all(), any()

Definition at line 127 of file BooleanRedux.h.

end() [1/2]

template<typename Derived >

DenseBase< Derived >::iterator Eigen::DenseBase< Derived >::end ( )

inline

returns an iterator to the element following the last element of the 1D vector or array

See also

begin(), cend()

Definition at line 437 of file StlIterators.h.

end() [2/2]

template<typename Derived >

DenseBase< Derived >::const_iterator Eigen::DenseBase< Derived >::end ( ) const

inline

const version of end()

Definition at line 445 of file StlIterators.h.

eval()

template<typename Derived>

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

inline

Returns

the matrix or vector obtained by evaluating this expression.

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

Warning

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

Definition at line 407 of file DenseBase.h.

evalTo()

template<typename Derived>

template<typename Dest >

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

inline

Definition at line 673 of file DenseBase.h.

fill()

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void Eigen::DenseBase< Derived >::fill

(

const Scalar &

val

)

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

See also

setConstant(), Constant(), class CwiseNullaryOp

Definition at line 335 of file CwiseNullaryOp.h.

flagged()

template<typename Derived>

template<unsigned int Added, unsigned int Removed>

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

inline

Deprecated:

it now returns *this

Definition at line 317 of file DenseBase.h.

forceAlignedAccess() [1/2]

template<typename Derived>

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

inline

forceAlignedAccess() [2/2]

template<typename Derived>

EIGEN_DEVICE_FUNC ForceAlignedAccess<Derived> Eigen::DenseBase< Derived >::forceAlignedAccess ( )

inline

forceAlignedAccessIf() [1/2]

template<typename Derived>

template<bool Enable>

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

inline

forceAlignedAccessIf() [2/2]

template<typename Derived>

template<bool Enable>

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

inline

format()

template<typename Derived>

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

inline

Returns

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

See class IOFormat for some examples.

See also

class IOFormat, class WithFormat

Definition at line 519 of file DenseBase.h.

hasNaN()

template<typename Derived >

bool Eigen::DenseBase< Derived >::hasNaN ( ) const

inline

Returns

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

See also

allFinite()

Definition at line 137 of file BooleanRedux.h.

head() [1/4]

template<typename Derived>

template<typename NType >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedSegmentReturnType<internal::get_fixed_value<NType>::value>::Type Eigen::DenseBase< Derived >::head ( NType  n )

inline

Returns

an expression of the first coefficients of *this with either dynamic or fixed sizes.

Parameters

n	the number of coefficients in the segment

Template Parameters

NType

the type of the value handling the number of coefficients in the segment, typically Index.

Example:

RowVector4i v = RowVector4i::Random();
cout << "Here is the vector v:" << endl << v << endl;
cout << "Here is v.head(2):" << endl << v.head(2) << endl;
v.head(2).setZero();
cout << "Now the vector v is:" << endl << v << endl;

Output:

The number of coefficients n can also be specified at compile-time by passing Eigen::fix<N>, or Eigen::fix<N>(n) as arguments. See block() for the details.

Note

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

See also

class Block, block(Index,Index)

Definition at line 1209 of file DenseBase.h.

head() [2/4]

template<typename Derived>

template<typename NType >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedSegmentReturnType<internal::get_fixed_value<NType>::value>::Type Eigen::DenseBase< Derived >::head ( NType  n ) const

inline

This is the const version of head(NType).

Definition at line 1224 of file DenseBase.h.

head() [3/4]

template<typename Derived>

template<int N>

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

inline

Returns

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

Template Parameters

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

Parameters

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

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

Example:

RowVector4i v = RowVector4i::Random();
cout << "Here is the vector v:" << endl << v << endl;
cout << "Here is v.head(2):" << endl << v.head<2>() << endl;
v.head<2>().setZero();
cout << "Now the vector v is:" << endl << v << endl;

Output:

See also

head(NType), class Block

Definition at line 1330 of file DenseBase.h.

head() [4/4]

template<typename Derived>

template<int N>

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

inline

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

Definition at line 1339 of file DenseBase.h.

imag() [1/2]

template<typename Derived>

EIGEN_DEVICE_FUNC const ImagReturnType Eigen::DenseBase< Derived >::imag ( ) const

inline

Returns

an read-only expression of the imaginary part of *this.

See also

real()

Definition at line 110 of file DenseBase.h.

imag() [2/2]

template<typename Derived>

EIGEN_DEVICE_FUNC NonConstImagReturnType Eigen::DenseBase< Derived >::imag ( )

inline

Returns

a non const expression of the imaginary part of *this.

See also

real()

Definition at line 178 of file DenseBase.h.

innerSize()

template<typename Derived>

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::DenseBase< Derived >::innerSize ( ) const

inline

Returns

the inner size.

Note

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

Definition at line 235 of file DenseBase.h.

innerVector() [1/2]

template<typename Derived>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE InnerVectorReturnType Eigen::DenseBase< Derived >::innerVector ( Index  outer )

inline

Returns

the outer -th column (resp. row) of the matrix *this if *this is col-major (resp. row-major).

Definition at line 1381 of file DenseBase.h.

innerVector() [2/2]

template<typename Derived>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstInnerVectorReturnType Eigen::DenseBase< Derived >::innerVector ( Index  outer ) const

inline

Returns

the outer -th column (resp. row) of the matrix *this if *this is col-major (resp. row-major). Read-only.

Definition at line 1388 of file DenseBase.h.

innerVectors() [1/2]

template<typename Derived>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE InnerVectorsReturnType Eigen::DenseBase< Derived >::innerVectors ( Index  outerStart, Index  outerSize  )

inline

Returns

the outer -th column (resp. row) of the matrix *this if *this is col-major (resp. row-major).

Definition at line 1396 of file DenseBase.h.

innerVectors() [2/2]

template<typename Derived>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstInnerVectorsReturnType Eigen::DenseBase< Derived >::innerVectors ( Index  outerStart, Index  outerSize  ) const

inline

Returns

the outer -th column (resp. row) of the matrix *this if *this is col-major (resp. row-major). Read-only.

Definition at line 1409 of file DenseBase.h.

isApprox()

template<typename Derived >

template<typename OtherDerived >

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

Returns

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

Note

The fuzzy compares are done multiplicatively. Two vectors and are considered to be approximately equal within precision if

For matrices, the comparison is done using the Hilbert-Schmidt norm (aka Frobenius norm L2 norm).

Because of the multiplicativeness of this comparison, one can't use this function to check whether *this is approximately equal to the zero matrix or vector. Indeed, isApprox(zero) returns false unless *this itself is exactly the zero matrix or vector. If you want to test whether *this is zero, use internal::isMuchSmallerThan(const RealScalar&, RealScalar) instead.

See also

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

Definition at line 103 of file Fuzzy.h.

isApproxToConstant()

template<typename Derived >

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

Returns

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

Definition at line 310 of file CwiseNullaryOp.h.

isConstant()

template<typename Derived >

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

This is just an alias for isApproxToConstant().

Returns

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

Definition at line 325 of file CwiseNullaryOp.h.

isMuchSmallerThan() [1/3]

template<typename Derived>

template<typename Derived >

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

Returns

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

Note

The fuzzy compares are done multiplicatively. A vector is considered to be much smaller than within precision if

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

See also

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

Definition at line 125 of file Fuzzy.h.

isMuchSmallerThan() [2/3]

template<typename Derived>

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

isMuchSmallerThan() [3/3]

template<typename Derived >

template<typename OtherDerived >

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

Returns

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

Note

The fuzzy compares are done multiplicatively. A vector is considered to be much smaller than a vector within precision if

For matrices, the comparison is done using the Hilbert-Schmidt norm.

See also

isApprox(), isMuchSmallerThan(const RealScalar&, RealScalar) const

Definition at line 145 of file Fuzzy.h.

isOnes()

template<typename Derived >

EIGEN_DEVICE_FUNC bool Eigen::DenseBase< Derived >::isOnes

(

const RealScalar &

prec = NumTraits<Scalar>::dummy_precision()

)

const

Returns

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

Example:

Matrix3d m = Matrix3d::Ones();
m(0,2) += 1e-4;
cout << "Here's the matrix m:" << endl << m << endl;
cout << "m.isOnes() returns: " << m.isOnes() << endl;
cout << "m.isOnes(1e-3) returns: " << m.isOnes(1e-3) << endl;

Output:

See also

class CwiseNullaryOp, Ones()

Definition at line 685 of file CwiseNullaryOp.h.

isZero()

template<typename Derived >

EIGEN_DEVICE_FUNC bool Eigen::DenseBase< Derived >::isZero

(

const RealScalar &

prec = NumTraits<Scalar>::dummy_precision()

)

const

Returns

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

Example:

Matrix3d m = Matrix3d::Zero();
m(0,2) = 1e-4;
cout << "Here's the matrix m:" << endl << m << endl;
cout << "m.isZero() returns: " << m.isZero() << endl;
cout << "m.isZero(1e-3) returns: " << m.isZero(1e-3) << endl;

Output:

See also

class CwiseNullaryOp, Zero()

Definition at line 528 of file CwiseNullaryOp.h.

ivcCol()

template<typename Derived>

template<typename Indices >

IvcColType<Indices>::type Eigen::DenseBase< Derived >::ivcCol ( const Indices &  indices ) const

inlineprotected

Definition at line 47 of file DenseBase.h.

ivcRow()

template<typename Derived>

template<typename Indices >

IvcRowType<Indices>::type Eigen::DenseBase< Derived >::ivcRow ( const Indices &  indices ) const

inlineprotected

Definition at line 41 of file DenseBase.h.

ivcSize()

template<typename Derived>

template<typename Indices >

IvcColType<Indices>::type Eigen::DenseBase< Derived >::ivcSize ( const Indices &  indices ) const

inlineprotected

Definition at line 53 of file DenseBase.h.

lazyAssign() [1/2]

template<typename Derived>

template<typename OtherDerived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived& Eigen::DenseBase< Derived >::lazyAssign

(

const DenseBase< OtherDerived > &

other

)

Definition at line 20 of file Assign.h.

lazyAssign() [2/2]

template<typename Derived>

template<typename OtherDerived >

EIGEN_DEPRECATED EIGEN_DEVICE_FUNC Derived& Eigen::DenseBase< Derived >::lazyAssign

(

const DenseBase< OtherDerived > &

other

)

Deprecated:

leftCols() [1/4]

template<typename Derived>

template<typename NColsType >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE NColsBlockXpr<internal::get_fixed_value<NColsType>::value>::Type Eigen::DenseBase< Derived >::leftCols ( NColsType  n )

inline

Returns

a block consisting of the left columns of *this.

Parameters

n	the number of columns in the block

Template Parameters

NColsType

the type of the value handling the number of columns in the block, typically Index.

Example:

Array44i a = Array44i::Random();
cout << "Here is the array a:" << endl << a << endl;
cout << "Here is a.leftCols(2):" << endl;
cout << a.leftCols(2) << endl;
a.leftCols(2).setZero();
cout << "Now the array a is:" << endl << a << endl;

Output:

The number of columns n can also be specified at compile-time by passing Eigen::fix<N>, or Eigen::fix<N>(n) as arguments. See block() for the details.

See also

block(Index,Index,NRowsType,NColsType), class Block

Definition at line 798 of file DenseBase.h.

leftCols() [2/4]

template<typename Derived>

template<typename NColsType >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstNColsBlockXpr<internal::get_fixed_value<NColsType>::value>::Type Eigen::DenseBase< Derived >::leftCols ( NColsType  n ) const

inline

This is the const version of leftCols(NColsType).

Definition at line 812 of file DenseBase.h.

leftCols() [3/4]

template<typename Derived>

template<int N>

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

inline

Returns

a block consisting of the left columns of *this.

Template Parameters

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

Parameters

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

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

Example:

Array44i a = Array44i::Random();
cout << "Here is the array a:" << endl << a << endl;
cout << "Here is a.leftCols<2>():" << endl;
cout << a.leftCols<2>() << endl;
a.leftCols<2>().setZero();
cout << "Now the array a is:" << endl << a << endl;

Output:

See also

block(Index,Index,NRowsType,NColsType), class Block

Definition at line 835 of file DenseBase.h.

leftCols() [4/4]

template<typename Derived>

template<int N>

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

inline

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

Definition at line 843 of file DenseBase.h.

LinSpaced() [1/4]

template<typename Derived >

EIGEN_DEPRECATED EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const DenseBase< Derived >::RandomAccessLinSpacedReturnType Eigen::DenseBase< Derived >::LinSpaced ( Sequential_t  , Index  size, const Scalar &  low, const Scalar &  high  )

static

Deprecated:

because of accuracy loss. In Eigen 3.3, it is an alias for LinSpaced(Index,const Scalar&,const Scalar&)

Example:

cout << VectorXi::LinSpaced(Sequential,4,7,10).transpose() << endl;
cout << VectorXd::LinSpaced(Sequential,5,0.0,1.0).transpose() << endl;

Output:

See also

LinSpaced(Index,const Scalar&, const Scalar&), setLinSpaced(Index,const Scalar&,const Scalar&)

Definition at line 244 of file CwiseNullaryOp.h.

LinSpaced() [2/4]

template<typename Derived >

EIGEN_DEPRECATED EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const DenseBase< Derived >::RandomAccessLinSpacedReturnType Eigen::DenseBase< Derived >::LinSpaced ( Sequential_t  , const Scalar &  low, const Scalar &  high  )

static

Deprecated:

because of accuracy loss. In Eigen 3.3, it is an alias for LinSpaced(const Scalar&,const Scalar&)

See also

LinSpaced(const Scalar&, const Scalar&)

Definition at line 256 of file CwiseNullaryOp.h.

LinSpaced() [3/4]

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const DenseBase< Derived >::RandomAccessLinSpacedReturnType Eigen::DenseBase< Derived >::LinSpaced ( Index  size, const Scalar &  low, const Scalar &  high  )

static

Sets a linearly spaced vector.

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

Example:

cout << VectorXi::LinSpaced(4,7,10).transpose() << endl;
cout << VectorXd::LinSpaced(5,0.0,1.0).transpose() << endl;

Output:

For integer scalar types, an even spacing is possible if and only if the length of the range, i.e., high-low is a scalar multiple of size-1, or if size is a scalar multiple of the number of values high-low+1 (meaning each value can be repeated the same number of time). If one of these two considions is not satisfied, then high is lowered to the largest value satisfying one of this constraint. Here are some examples:

Example:

cout << "Even spacing inputs:" << endl;
cout << VectorXi::LinSpaced(8,1,4).transpose() << endl;
cout << VectorXi::LinSpaced(8,1,8).transpose() << endl;
cout << VectorXi::LinSpaced(8,1,15).transpose() << endl;
cout << "Uneven spacing inputs:" << endl;
cout << VectorXi::LinSpaced(8,1,7).transpose() << endl;
cout << VectorXi::LinSpaced(8,1,9).transpose() << endl;
cout << VectorXi::LinSpaced(8,1,16).transpose() << endl;

Output:

See also

setLinSpaced(Index,const Scalar&,const Scalar&), CwiseNullaryOp

Definition at line 288 of file CwiseNullaryOp.h.

LinSpaced() [4/4]

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const DenseBase< Derived >::RandomAccessLinSpacedReturnType Eigen::DenseBase< Derived >::LinSpaced ( const Scalar &  low, const Scalar &  high  )

static

Sets a linearly spaced vector.

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

Example:

cout << VectorXi::LinSpaced(4,7,10).transpose() << endl;
cout << VectorXd::LinSpaced(5,0.0,1.0).transpose() << endl;

Output:

For integer scalar types, an even spacing is possible if and only if the length of the range, i.e., high-low is a scalar multiple of size-1, or if size is a scalar multiple of the number of values high-low+1 (meaning each value can be repeated the same number of time). If one of these two considions is not satisfied, then high is lowered to the largest value satisfying one of this constraint. Here are some examples:

Example:

cout << "Even spacing inputs:" << endl;
cout << VectorXi::LinSpaced(8,1,4).transpose() << endl;
cout << VectorXi::LinSpaced(8,1,8).transpose() << endl;
cout << VectorXi::LinSpaced(8,1,15).transpose() << endl;
cout << "Uneven spacing inputs:" << endl;
cout << VectorXi::LinSpaced(8,1,7).transpose() << endl;
cout << VectorXi::LinSpaced(8,1,9).transpose() << endl;
cout << VectorXi::LinSpaced(8,1,16).transpose() << endl;

Output:

See also

setLinSpaced(Index,const Scalar&,const Scalar&), CwiseNullaryOp Special version for fixed size types which does not require the size parameter.

Definition at line 300 of file CwiseNullaryOp.h.

lpNorm()

template<typename Derived>

template<int p>

RealScalar Eigen::DenseBase< Derived >::lpNorm

(

)

const

maxCoeff() [1/6]

template<typename Derived>

template<int NaNPropagation>

EIGEN_DEVICE_FUNC internal::traits<Derived>::Scalar Eigen::DenseBase< Derived >::maxCoeff

(

)

const

maxCoeff() [2/6]

template<typename Derived>

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

inline

Returns

the maximum of all coefficients of *this. In case *this contains NaN, NaNPropagation determines the behavior: NaNPropagation == PropagateFast : undefined NaNPropagation == PropagateNaN : result is NaN NaNPropagation == PropagateNumbers : result is maximum of elements that are not NaN

Warning

the matrix must be not empty, otherwise an assertion is triggered.

Definition at line 465 of file DenseBase.h.

maxCoeff() [3/6]

template<typename Derived >

template<int NaNPropagation, typename IndexType >

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

Returns

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

In case *this contains NaN, NaNPropagation determines the behavior: NaNPropagation == PropagateFast : undefined NaNPropagation == PropagateNaN : result is NaN NaNPropagation == PropagateNumbers : result is maximum of elements that are not NaN

Warning

the matrix must be not empty, otherwise an assertion is triggered.

See also

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

Definition at line 343 of file Visitor.h.

maxCoeff() [4/6]

template<typename Derived >

template<int NaNPropagation, typename IndexType >

EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar Eigen::DenseBase< Derived >::maxCoeff

(

IndexType *

index

)

const

Returns

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

In case *this contains NaN, NaNPropagation determines the behavior: NaNPropagation == PropagateFast : undefined NaNPropagation == PropagateNaN : result is NaN NaNPropagation == PropagateNumbers : result is maximum of elements that are not NaN

Warning

the matrix must be not empty, otherwise an assertion is triggered.

See also

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

Definition at line 368 of file Visitor.h.

maxCoeff() [5/6]

template<typename Derived>

template<typename IndexType >

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

inline

Definition at line 490 of file DenseBase.h.

maxCoeff() [6/6]

template<typename Derived>

template<typename IndexType >

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

inline

Definition at line 500 of file DenseBase.h.

mean()

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE internal::traits< Derived >::Scalar Eigen::DenseBase< Derived >::mean

(

)

const

Returns

the mean of all coefficients of *this

See also

trace(), prod(), sum()

Definition at line 472 of file Redux.h.

middleCols() [1/4]

template<typename Derived>

template<typename NColsType >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE NColsBlockXpr<internal::get_fixed_value<NColsType>::value>::Type Eigen::DenseBase< Derived >::middleCols ( Index  startCol, NColsType  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

Template Parameters

NColsType

the type of the value handling the number of columns in the block, typically Index.

Example:

#include <Eigen/Core>
#include <iostream>

using namespace Eigen;
using namespace std;

int main(void)
{
    int const N = 5;
    MatrixXi A(N,N);
    A.setRandom();
    cout << "A =\n" << A << '\n' << endl;
    cout << "A(1..3,:) =\n" << A.middleCols(1,3) << endl;
    return 0;
}

Output:

The number of columns n can also be specified at compile-time by passing Eigen::fix<N>, or Eigen::fix<N>(n) as arguments. See block() for the details.

See also

block(Index,Index,NRowsType,NColsType), class Block

Definition at line 949 of file DenseBase.h.

middleCols() [2/4]

template<typename Derived>

template<typename NColsType >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstNColsBlockXpr<internal::get_fixed_value<NColsType>::value>::Type Eigen::DenseBase< Derived >::middleCols ( Index  startCol, NColsType  numCols  ) const

inline

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

Definition at line 963 of file DenseBase.h.

middleCols() [3/4]

template<typename Derived>

template<int N>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE NColsBlockXpr<N>::Type Eigen::DenseBase< Derived >::middleCols ( Index  startCol, Index  n = N  )

inline

Returns

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

Template Parameters

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

Parameters

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

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

Example:

#include <Eigen/Core>
#include <iostream>

using namespace Eigen;
using namespace std;

int main(void)
{
    int const N = 5;
    MatrixXi A(N,N);
    A.setRandom();
    cout << "A =\n" << A << '\n' << endl;
    cout << "A(:,1..3) =\n" << A.middleCols<3>(1) << endl;
    return 0;
}

Output:

See also

block(Index,Index,NRowsType,NColsType), class Block

Definition at line 987 of file DenseBase.h.

middleCols() [4/4]

template<typename Derived>

template<int N>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE ConstNColsBlockXpr<N>::Type Eigen::DenseBase< Derived >::middleCols ( Index  startCol, Index  n = N  ) const

inline

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

Definition at line 995 of file DenseBase.h.

middleRows() [1/4]

template<typename Derived>

template<typename NRowsType >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE NRowsBlockXpr<internal::get_fixed_value<NRowsType>::value>::Type Eigen::DenseBase< Derived >::middleRows ( Index  startRow, NRowsType  n  )

inline

Returns

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

Parameters

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

Template Parameters

NRowsType

the type of the value handling the number of rows in the block, typically Index.

Example:

#include <Eigen/Core>
#include <iostream>

using namespace Eigen;
using namespace std;

int main(void)
{
    int const N = 5;
    MatrixXi A(N,N);
    A.setRandom();
    cout << "A =\n" << A << '\n' << endl;
    cout << "A(2..3,:) =\n" << A.middleRows(2,2) << endl;
    return 0;
}

Output:

The number of rows n can also be specified at compile-time by passing Eigen::fix<N>, or Eigen::fix<N>(n) as arguments. See block() for the details.

See also

block(Index,Index,NRowsType,NColsType), class Block

Definition at line 722 of file DenseBase.h.

middleRows() [2/4]

template<typename Derived>

template<typename NRowsType >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstNRowsBlockXpr<internal::get_fixed_value<NRowsType>::value>::Type Eigen::DenseBase< Derived >::middleRows ( Index  startRow, NRowsType  n  ) const

inline

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

Definition at line 736 of file DenseBase.h.

middleRows() [3/4]

template<typename Derived>

template<int N>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE NRowsBlockXpr<N>::Type Eigen::DenseBase< Derived >::middleRows ( Index  startRow, Index  n = N  )

inline

Returns

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

Template Parameters

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

Parameters

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

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

Example:

#include <Eigen/Core>
#include <iostream>

using namespace Eigen;
using namespace std;

int main(void)
{
    int const N = 5;
    MatrixXi A(N,N);
    A.setRandom();
    cout << "A =\n" << A << '\n' << endl;
    cout << "A(1..3,:) =\n" << A.middleRows<3>(1) << endl;
    return 0;
}

Output:

See also

block(Index,Index,NRowsType,NColsType), class Block

Definition at line 760 of file DenseBase.h.

middleRows() [4/4]

template<typename Derived>

template<int N>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE ConstNRowsBlockXpr<N>::Type Eigen::DenseBase< Derived >::middleRows ( Index  startRow, Index  n = N  ) const

inline

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

Definition at line 768 of file DenseBase.h.

minCoeff() [1/6]

template<typename Derived>

template<int NaNPropagation>

EIGEN_DEVICE_FUNC internal::traits<Derived>::Scalar Eigen::DenseBase< Derived >::minCoeff

(

)

const

minCoeff() [2/6]

template<typename Derived>

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

inline

Returns

the minimum of all coefficients of *this. In case *this contains NaN, NaNPropagation determines the behavior: NaNPropagation == PropagateFast : undefined NaNPropagation == PropagateNaN : result is NaN NaNPropagation == PropagateNumbers : result is minimum of elements that are not NaN

Warning

the matrix must be not empty, otherwise an assertion is triggered.

Definition at line 462 of file DenseBase.h.

minCoeff() [3/6]

template<typename Derived >

template<int NaNPropagation, typename IndexType >

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

Returns

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

In case *this contains NaN, NaNPropagation determines the behavior: NaNPropagation == PropagateFast : undefined NaNPropagation == PropagateNaN : result is NaN NaNPropagation == PropagateNumbers : result is maximum of elements that are not NaN

Warning

the matrix must be not empty, otherwise an assertion is triggered.

See also

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

Definition at line 292 of file Visitor.h.

minCoeff() [4/6]

template<typename Derived >

template<int NaNPropagation, typename IndexType >

EIGEN_DEVICE_FUNC internal::traits< Derived >::Scalar Eigen::DenseBase< Derived >::minCoeff

(

IndexType *

index

)

const

Returns

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

In case *this contains NaN, NaNPropagation determines the behavior: NaNPropagation == PropagateFast : undefined NaNPropagation == PropagateNaN : result is NaN NaNPropagation == PropagateNumbers : result is maximum of elements that are not NaN

Warning

the matrix must be not empty, otherwise an assertion is triggered.

See also

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

Definition at line 317 of file Visitor.h.

minCoeff() [5/6]

template<typename Derived>

template<typename IndexType >

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

inline

Definition at line 485 of file DenseBase.h.

minCoeff() [6/6]

template<typename Derived>

template<typename IndexType >

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

inline

Definition at line 495 of file DenseBase.h.

nestByValue()

template<typename Derived >

EIGEN_DEVICE_FUNC const NestByValue< Derived > Eigen::DenseBase< Derived >::nestByValue ( ) const

inline

Returns

an expression of the temporary version of *this.

Definition at line 63 of file NestByValue.h.

nonZeros()

template<typename Derived>

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::DenseBase< Derived >::nonZeros ( ) const

inline

Returns

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

Definition at line 215 of file DenseBase.h.

NullaryExpr() [1/6]

template<typename Derived>

template<typename CustomNullaryOp >

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

Returns

an expression of a matrix defined by a custom functor func

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

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

The template parameter CustomNullaryOp is the type of the functor.

See also

class CwiseNullaryOp

Definition at line 114 of file CwiseNullaryOp.h.

NullaryExpr() [2/6]

template<typename Derived>

template<typename CustomNullaryOp >

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

Returns

an expression of a matrix defined by a custom functor func

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

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

The template parameter CustomNullaryOp is the type of the functor.

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

#include <Eigen/Core>
#include <iostream>
#include <random>

using namespace Eigen;

int main() {
  std::default_random_engine generator;
  std::poisson_distribution<int> distribution(4.1);
  auto poisson = [&] () {return distribution(generator);};

  RowVectorXi v = RowVectorXi::NullaryExpr(10, poisson );
  std::cout << v << "\n";
}

Output:

See also

class CwiseNullaryOp

Definition at line 145 of file CwiseNullaryOp.h.

NullaryExpr() [3/6]

template<typename Derived>

template<typename CustomNullaryOp >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseNullaryOp<CustomNullaryOp, typename DenseBase<Derived>::PlainObject> Eigen::DenseBase< Derived >::NullaryExpr

(

const CustomNullaryOp &

func

)

Returns

an expression of a matrix defined by a custom functor func

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

The template parameter CustomNullaryOp is the type of the functor.

See also

class CwiseNullaryOp

Definition at line 169 of file CwiseNullaryOp.h.

NullaryExpr() [4/6]

template<typename Derived>

template<typename CustomNullaryOp >

static EIGEN_DEVICE_FUNC const CwiseNullaryOp<CustomNullaryOp, PlainObject> Eigen::DenseBase< Derived >::NullaryExpr ( Index  rows, Index  cols, const CustomNullaryOp &  func  )

static

NullaryExpr() [5/6]

template<typename Derived>

template<typename CustomNullaryOp >

static EIGEN_DEVICE_FUNC const CwiseNullaryOp<CustomNullaryOp, PlainObject> Eigen::DenseBase< Derived >::NullaryExpr ( Index  size, const CustomNullaryOp &  func  )

static

NullaryExpr() [6/6]

template<typename Derived>

template<typename CustomNullaryOp >

static EIGEN_DEVICE_FUNC const CwiseNullaryOp<CustomNullaryOp, PlainObject> Eigen::DenseBase< Derived >::NullaryExpr ( const CustomNullaryOp &  func )

static

Ones() [1/3]

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const DenseBase< Derived >::ConstantReturnType Eigen::DenseBase< Derived >::Ones ( Index  rows, Index  cols  )

static

Returns

an expression of a matrix where all coefficients equal one.

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

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

Example:

cout << MatrixXi::Ones(2,3) << endl;

Output:

See also

Ones(), Ones(Index), isOnes(), class Ones

Definition at line 630 of file CwiseNullaryOp.h.

Ones() [2/3]

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const DenseBase< Derived >::ConstantReturnType Eigen::DenseBase< Derived >::Ones ( Index  newSize )

static

Returns

an expression of a vector where all coefficients equal one.

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

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

Example:

cout << 6 * RowVectorXi::Ones(4) << endl;
cout << VectorXf::Ones(2) << endl;

Output:

See also

Ones(), Ones(Index,Index), isOnes(), class Ones

Definition at line 653 of file CwiseNullaryOp.h.

Ones() [3/3]

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const DenseBase< Derived >::ConstantReturnType Eigen::DenseBase< Derived >::Ones ( )

static

Returns

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

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

Example:

cout << Matrix2d::Ones() << endl;
cout << 6 * RowVector4i::Ones() << endl;

Output:

See also

Ones(Index), Ones(Index,Index), isOnes(), class Ones

Definition at line 670 of file CwiseNullaryOp.h.

operator()() [1/14]

template<typename Derived>

template<typename RowIndices , typename ColIndices >

internal::enable_if<internal::valid_indexed_view_overload<RowIndices,ColIndices>::value && internal::traits<typename EIGEN_INDEXED_VIEW_METHOD_TYPE<RowIndices,ColIndices>::type>::ReturnAsIndexedView, typename EIGEN_INDEXED_VIEW_METHOD_TYPE<RowIndices,ColIndices>::type >::type Eigen::DenseBase< Derived >::operator() ( const RowIndices &  rowIndices, const ColIndices &  colIndices  )

inline

Definition at line 74 of file DenseBase.h.

operator()() [2/14]

template<typename Derived>

template<typename RowIndices , typename ColIndices >

internal::enable_if<internal::valid_indexed_view_overload<RowIndices,ColIndices>::value && internal::traits<typename EIGEN_INDEXED_VIEW_METHOD_TYPE<RowIndices,ColIndices>::type>::ReturnAsIndexedView, typename EIGEN_INDEXED_VIEW_METHOD_TYPE<RowIndices,ColIndices>::type >::type Eigen::DenseBase< Derived >::operator() ( const RowIndices &  rowIndices, const ColIndices &  colIndices  )

inline

Definition at line 74 of file DenseBase.h.

operator()() [3/14]

template<typename Derived>

template<typename RowIndices , typename ColIndices >

internal::enable_if<internal::valid_indexed_view_overload<RowIndices,ColIndices>::value && internal::traits<typename EIGEN_INDEXED_VIEW_METHOD_TYPE<RowIndices,ColIndices>::type>::ReturnAsBlock, typename internal::traits<typename EIGEN_INDEXED_VIEW_METHOD_TYPE<RowIndices,ColIndices>::type>::BlockType>::type Eigen::DenseBase< Derived >::operator() ( const RowIndices &  rowIndices, const ColIndices &  colIndices  )

inline

Definition at line 86 of file DenseBase.h.

operator()() [4/14]

template<typename Derived>

template<typename RowIndices , typename ColIndices >

internal::enable_if<internal::valid_indexed_view_overload<RowIndices,ColIndices>::value && internal::traits<typename EIGEN_INDEXED_VIEW_METHOD_TYPE<RowIndices,ColIndices>::type>::ReturnAsBlock, typename internal::traits<typename EIGEN_INDEXED_VIEW_METHOD_TYPE<RowIndices,ColIndices>::type>::BlockType>::type Eigen::DenseBase< Derived >::operator() ( const RowIndices &  rowIndices, const ColIndices &  colIndices  )

inline

Definition at line 86 of file DenseBase.h.

operator()() [5/14]

template<typename Derived>

template<typename RowIndices , typename ColIndices >

internal::enable_if<internal::valid_indexed_view_overload<RowIndices,ColIndices>::value && internal::traits<typename EIGEN_INDEXED_VIEW_METHOD_TYPE<RowIndices,ColIndices>::type>::ReturnAsScalar, CoeffReturnType >::type Eigen::DenseBase< Derived >::operator() ( const RowIndices &  rowIndices, const ColIndices &  colIndices  )

inline

Definition at line 104 of file DenseBase.h.

operator()() [6/14]

template<typename Derived>

template<typename RowIndices , typename ColIndices >

internal::enable_if<internal::valid_indexed_view_overload<RowIndices,ColIndices>::value && internal::traits<typename EIGEN_INDEXED_VIEW_METHOD_TYPE<RowIndices,ColIndices>::type>::ReturnAsScalar, CoeffReturnType >::type Eigen::DenseBase< Derived >::operator() ( const RowIndices &  rowIndices, const ColIndices &  colIndices  )

inline

Definition at line 104 of file DenseBase.h.

operator()() [7/14]

template<typename Derived>

template<typename Indices >

internal::enable_if< IsRowMajor && (!(internal::get_compile_time_incr<typename IvcType<Indices>::type>::value==1 || internal::is_valid_index_type<Indices>::value)), IndexedView<EIGEN_INDEXED_VIEW_METHOD_CONST Derived,IvcIndex,typename IvcType<Indices>::type> >::type Eigen::DenseBase< Derived >::operator() ( const Indices &  indices )

inline

Definition at line 145 of file DenseBase.h.

operator()() [8/14]

template<typename Derived>

template<typename Indices >

internal::enable_if< IsRowMajor && (!(internal::get_compile_time_incr<typename IvcType<Indices>::type>::value==1 || internal::is_valid_index_type<Indices>::value)), IndexedView<EIGEN_INDEXED_VIEW_METHOD_CONST Derived,IvcIndex,typename IvcType<Indices>::type> >::type Eigen::DenseBase< Derived >::operator() ( const Indices &  indices )

inline

Definition at line 145 of file DenseBase.h.

operator()() [9/14]

template<typename Derived>

template<typename Indices >

internal::enable_if< (!IsRowMajor) && (!(internal::get_compile_time_incr<typename IvcType<Indices>::type>::value==1 || internal::is_valid_index_type<Indices>::value)), IndexedView<EIGEN_INDEXED_VIEW_METHOD_CONST Derived,typename IvcType<Indices>::type,IvcIndex> >::type Eigen::DenseBase< Derived >::operator() ( const Indices &  indices )

inline

Definition at line 156 of file DenseBase.h.

operator()() [10/14]

template<typename Derived>

template<typename Indices >

internal::enable_if< (!IsRowMajor) && (!(internal::get_compile_time_incr<typename IvcType<Indices>::type>::value==1 || internal::is_valid_index_type<Indices>::value)), IndexedView<EIGEN_INDEXED_VIEW_METHOD_CONST Derived,typename IvcType<Indices>::type,IvcIndex> >::type Eigen::DenseBase< Derived >::operator() ( const Indices &  indices )

inline

Definition at line 156 of file DenseBase.h.

operator()() [11/14]

template<typename Derived>

template<typename Indices >

internal::enable_if< (internal::get_compile_time_incr<typename IvcType<Indices>::type>::value==1) && (!internal::is_valid_index_type<Indices>::value) && (!symbolic::is_symbolic<Indices>::value), VectorBlock<EIGEN_INDEXED_VIEW_METHOD_CONST Derived,internal::array_size<Indices>::value> >::type Eigen::DenseBase< Derived >::operator() ( const Indices &  indices )

inline

Definition at line 167 of file DenseBase.h.

operator()() [12/14]

template<typename Derived>

template<typename Indices >

internal::enable_if< (internal::get_compile_time_incr<typename IvcType<Indices>::type>::value==1) && (!internal::is_valid_index_type<Indices>::value) && (!symbolic::is_symbolic<Indices>::value), VectorBlock<EIGEN_INDEXED_VIEW_METHOD_CONST Derived,internal::array_size<Indices>::value> >::type Eigen::DenseBase< Derived >::operator() ( const Indices &  indices )

inline

Definition at line 167 of file DenseBase.h.

operator()() [13/14]

template<typename Derived>

template<typename IndexType >

internal::enable_if<symbolic::is_symbolic<IndexType>::value, CoeffReturnType >::type Eigen::DenseBase< Derived >::operator() ( const IndexType &  id )

inline

Definition at line 177 of file DenseBase.h.

operator()() [14/14]

template<typename Derived>

template<typename IndexType >

internal::enable_if<symbolic::is_symbolic<IndexType>::value, CoeffReturnType >::type Eigen::DenseBase< Derived >::operator() ( const IndexType &  id )

inline

Definition at line 177 of file DenseBase.h.

operator*=()

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & Eigen::DenseBase< Derived >::operator*=

(

const Scalar &

other

)

Definition at line 18 of file SelfCwiseBinaryOp.h.

operator+=()

template<typename Derived >

template<typename OtherDerived >

EIGEN_DEVICE_FUNC Derived & Eigen::DenseBase< Derived >::operator+=

(

const EigenBase< OtherDerived > &

other

)

Definition at line 143 of file EigenBase.h.

operator-()

template<typename Derived>

EIGEN_DEVICE_FUNC const NegativeReturnType Eigen::DenseBase< Derived >::operator- ( void  ) const

inline

Returns

an expression of the opposite of *this

Definition at line 46 of file DenseBase.h.

operator-=()

template<typename Derived >

template<typename OtherDerived >

EIGEN_DEVICE_FUNC Derived & Eigen::DenseBase< Derived >::operator-=

(

const EigenBase< OtherDerived > &

other

)

Definition at line 152 of file EigenBase.h.

operator/=()

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & Eigen::DenseBase< Derived >::operator/=

(

const Scalar &

other

)

Definition at line 39 of file SelfCwiseBinaryOp.h.

operator<<() [1/2]

template<typename Derived >

EIGEN_DEVICE_FUNC CommaInitializer< Derived > Eigen::DenseBase< Derived >::operator<< ( const Scalar &  s )

inline

Convenient operator to set the coefficients of a matrix.

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

Example:

Matrix3i m1;
m1 << 1, 2, 3,
      4, 5, 6,
      7, 8, 9;
cout << m1 << endl << endl;
Matrix3i m2 = Matrix3i::Identity();
m2.block(0,0, 2,2) << 10, 11, 12, 13;
cout << m2 << endl << endl;
Vector2i v1;
v1 << 14, 15;
m2 << v1.transpose(), 16,
      v1, m1.block(1,1,2,2);
cout << m2 << endl;

Output:

Note

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

See also

CommaInitializer::finished(), class CommaInitializer

Definition at line 148 of file CommaInitializer.h.

operator<<() [2/2]

template<typename Derived >

template<typename OtherDerived >

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

inline

See also

operator<<(const Scalar&)

Definition at line 157 of file CommaInitializer.h.

operator=() [1/4]

template<typename Derived >

template<typename OtherDerived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & Eigen::DenseBase< Derived >::operator=

(

const DenseBase< OtherDerived > &

other

)

Copies other into *this.

Returns

a reference to *this.

Definition at line 39 of file Assign.h.

operator=() [2/4]

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & Eigen::DenseBase< Derived >::operator=

(

const DenseBase< Derived > &

other

)

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

Definition at line 47 of file Assign.h.

operator=() [3/4]

template<typename Derived >

template<typename OtherDerived >

EIGEN_DEVICE_FUNC Derived & Eigen::DenseBase< Derived >::operator=

(

const EigenBase< OtherDerived > &

other

)

Copies the generic expression other into *this.

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

Returns

a reference to *this.

Definition at line 134 of file EigenBase.h.

operator=() [4/4]

template<typename Derived >

template<typename OtherDerived >

EIGEN_DEVICE_FUNC Derived & Eigen::DenseBase< Derived >::operator=

(

const ReturnByValue< OtherDerived > &

func

)

Definition at line 84 of file ReturnByValue.h.

outerSize()

template<typename Derived>

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::DenseBase< Derived >::outerSize ( ) const

inline

Returns

the outer size.

Note

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

Definition at line 223 of file DenseBase.h.

prod()

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE internal::traits< Derived >::Scalar Eigen::DenseBase< Derived >::prod

(

)

const

Returns

the product of all coefficients of *this

Example:

Matrix3d m = Matrix3d::Random();
cout << "Here is the matrix m:" << endl << m << endl;
cout << "Here is the product of all the coefficients:" << endl << m.prod() << endl;

Output:

See also

sum(), mean(), trace()

Definition at line 493 of file Redux.h.

Random() [1/3]

template<typename Derived >

const DenseBase< Derived >::RandomReturnType Eigen::DenseBase< Derived >::Random ( Index  rows, Index  cols  )

inlinestatic

Returns

a random matrix expression

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

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

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

Example:

cout << MatrixXi::Random(2,3) << endl;

Output:

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

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

See also

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

Definition at line 56 of file Random.h.

Random() [2/3]

template<typename Derived >

const DenseBase< Derived >::RandomReturnType Eigen::DenseBase< Derived >::Random ( Index  size )

inlinestatic

Returns

a random vector expression

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

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

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

Example:

cout << VectorXi::Random(2) << endl;

Output:

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

See also

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

Definition at line 87 of file Random.h.

Random() [3/3]

template<typename Derived >

const DenseBase< Derived >::RandomReturnType Eigen::DenseBase< Derived >::Random ( )

inlinestatic

Returns

a fixed-size random matrix or vector expression

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

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

Example:

cout << 100 * Matrix2i::Random() << endl;

Output:

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

See also

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

Definition at line 113 of file Random.h.

real() [1/2]

template<typename Derived>

EIGEN_DEVICE_FUNC RealReturnType Eigen::DenseBase< Derived >::real ( ) const

inline

Returns

a read-only expression of the real part of *this.

See also

imag()

Definition at line 101 of file DenseBase.h.

real() [2/2]

template<typename Derived>

EIGEN_DEVICE_FUNC NonConstRealReturnType Eigen::DenseBase< Derived >::real ( )

inline

Returns

a non const expression of the real part of *this.

See also

imag()

Definition at line 169 of file DenseBase.h.

redux() [1/2]

template<typename Derived>

template<typename Func >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE internal::traits<Derived>::Scalar Eigen::DenseBase< Derived >::redux

(

const Func &

func

)

const

Returns

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

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

Warning

the matrix must be not empty, otherwise an assertion is triggered.

See also

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

Definition at line 409 of file Redux.h.

redux() [2/2]

template<typename Derived>

template<typename BinaryOp >

EIGEN_DEVICE_FUNC Scalar Eigen::DenseBase< Derived >::redux

(

const BinaryOp &

func

)

const

replicate() [1/2]

template<typename Derived >

template<int RowFactor, int ColFactor>

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

(

)

const

Returns

an expression of the replication of *this

Example:

MatrixXi m = MatrixXi::Random(2,3);
cout << "Here is the matrix m:" << endl << m << endl;
cout << "m.replicate<3,2>() = ..." << endl;
cout << m.replicate<3,2>() << endl;

Output:

See also

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

Definition at line 119 of file Replicate.h.

replicate() [2/2]

template<typename Derived>

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

inline

Returns

an expression of the replication of *this

Example:

Vector3i v = Vector3i::Random();
cout << "Here is the vector v:" << endl << v << endl;
cout << "v.replicate(2,5) = ..." << endl;
cout << v.replicate(2,5) << endl;

Output:

See also

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

Definition at line 600 of file DenseBase.h.

reshaped() [1/8]

template<typename Derived>

template<typename NRowsType , typename NColsType >

EIGEN_DEVICE_FUNC Reshaped<EIGEN_RESHAPED_METHOD_CONST Derived, internal::get_compiletime_reshape_size<NRowsType,NColsType,SizeAtCompileTime>::value, internal::get_compiletime_reshape_size<NColsType,NRowsType,SizeAtCompileTime>::value> Eigen::DenseBase< Derived >::reshaped ( NRowsType  nRows, NColsType  nCols  )

inline

Definition at line 94 of file DenseBase.h.

reshaped() [2/8]

template<typename Derived>

template<typename NRowsType , typename NColsType >

EIGEN_DEVICE_FUNC Reshaped<EIGEN_RESHAPED_METHOD_CONST Derived, internal::get_compiletime_reshape_size<NRowsType,NColsType,SizeAtCompileTime>::value, internal::get_compiletime_reshape_size<NColsType,NRowsType,SizeAtCompileTime>::value> Eigen::DenseBase< Derived >::reshaped ( NRowsType  nRows, NColsType  nCols  )

inline

Definition at line 94 of file DenseBase.h.

reshaped() [3/8]

template<typename Derived>

template<int Order, typename NRowsType , typename NColsType >

EIGEN_DEVICE_FUNC Reshaped<EIGEN_RESHAPED_METHOD_CONST Derived, internal::get_compiletime_reshape_size<NRowsType,NColsType,SizeAtCompileTime>::value, internal::get_compiletime_reshape_size<NColsType,NRowsType,SizeAtCompileTime>::value, internal::get_compiletime_reshape_order<Flags,Order>::value> Eigen::DenseBase< Derived >::reshaped ( NRowsType  nRows, NColsType  nCols  )

inline

Definition at line 110 of file DenseBase.h.

reshaped() [4/8]

template<typename Derived>

template<int Order, typename NRowsType , typename NColsType >

EIGEN_DEVICE_FUNC Reshaped<EIGEN_RESHAPED_METHOD_CONST Derived, internal::get_compiletime_reshape_size<NRowsType,NColsType,SizeAtCompileTime>::value, internal::get_compiletime_reshape_size<NColsType,NRowsType,SizeAtCompileTime>::value, internal::get_compiletime_reshape_order<Flags,Order>::value> Eigen::DenseBase< Derived >::reshaped ( NRowsType  nRows, NColsType  nCols  )

inline

Definition at line 110 of file DenseBase.h.

reshaped() [5/8]

template<typename Derived>

EIGEN_DEVICE_FUNC Reshaped<EIGEN_RESHAPED_METHOD_CONST Derived,SizeAtCompileTime,1> Eigen::DenseBase< Derived >::reshaped ( )

inline

Definition at line 125 of file DenseBase.h.

reshaped() [6/8]

template<typename Derived>

EIGEN_DEVICE_FUNC Reshaped<EIGEN_RESHAPED_METHOD_CONST Derived,SizeAtCompileTime,1> Eigen::DenseBase< Derived >::reshaped ( )

inline

Definition at line 125 of file DenseBase.h.

reshaped() [7/8]

template<typename Derived>

template<int Order>

EIGEN_DEVICE_FUNC Reshaped<EIGEN_RESHAPED_METHOD_CONST Derived, SizeAtCompileTime, 1, internal::get_compiletime_reshape_order<Flags,Order>::value> Eigen::DenseBase< Derived >::reshaped ( )

inline

Definition at line 134 of file DenseBase.h.

reshaped() [8/8]

template<typename Derived>

template<int Order>

EIGEN_DEVICE_FUNC Reshaped<EIGEN_RESHAPED_METHOD_CONST Derived, SizeAtCompileTime, 1, internal::get_compiletime_reshape_order<Flags,Order>::value> Eigen::DenseBase< Derived >::reshaped ( )

inline

Definition at line 134 of file DenseBase.h.

resize() [1/2]

template<typename Derived>

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

inline

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

Definition at line 246 of file DenseBase.h.

resize() [2/2]

template<typename Derived>

EIGEN_DEVICE_FUNC void Eigen::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.

Definition at line 257 of file DenseBase.h.

reverse() [1/2]

template<typename Derived >

EIGEN_DEVICE_FUNC DenseBase< Derived >::ReverseReturnType Eigen::DenseBase< Derived >::reverse ( )

inline

Returns

an expression of the reverse of *this.

Example:

MatrixXi m = MatrixXi::Random(3,4);
cout << "Here is the matrix m:" << endl << m << endl;
cout << "Here is the reverse of m:" << endl << m.reverse() << endl;
cout << "Here is the coefficient (1,0) in the reverse of m:" << endl
     << m.reverse()(1,0) << endl;
cout << "Let us overwrite this coefficient with the value 4." << endl;
m.reverse()(1,0) = 4;
cout << "Now the matrix m is:" << endl << m << endl;

Output:

Definition at line 120 of file Reverse.h.

reverse() [2/2]

template<typename Derived>

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

inline

This is the const version of reverse().

Definition at line 610 of file DenseBase.h.

reverseInPlace()

template<typename Derived >

EIGEN_DEVICE_FUNC void Eigen::DenseBase< Derived >::reverseInPlace ( )

inline

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

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

• less error prone: doing the same operation with .reverse() requires special care:

  m = m.reverse().eval(); 

• this API enables reverse operations without the need for a temporary
• it allows future optimizations (cache friendliness, etc.)

See also

VectorwiseOp::reverseInPlace(), reverse()

Definition at line 141 of file Reverse.h.

rightCols() [1/4]

template<typename Derived>

template<typename NColsType >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE NColsBlockXpr<internal::get_fixed_value<NColsType>::value>::Type Eigen::DenseBase< Derived >::rightCols ( NColsType  n )

inline

Returns

a block consisting of the right columns of *this.

Parameters

n	the number of columns in the block

Template Parameters

NColsType

the type of the value handling the number of columns in the block, typically Index.

Example:

Array44i a = Array44i::Random();
cout << "Here is the array a:" << endl << a << endl;
cout << "Here is a.rightCols(2):" << endl;
cout << a.rightCols(2) << endl;
a.rightCols(2).setZero();
cout << "Now the array a is:" << endl << a << endl;

Output:

The number of columns n can also be specified at compile-time by passing Eigen::fix<N>, or Eigen::fix<N>(n) as arguments. See block() for the details.

See also

block(Index,Index,NRowsType,NColsType), class Block

Definition at line 873 of file DenseBase.h.

rightCols() [2/4]

template<typename Derived>

template<typename NColsType >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstNColsBlockXpr<internal::get_fixed_value<NColsType>::value>::Type Eigen::DenseBase< Derived >::rightCols ( NColsType  n ) const

inline

This is the const version of rightCols(NColsType).

Definition at line 887 of file DenseBase.h.

rightCols() [3/4]

template<typename Derived>

template<int N>

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

inline

Returns

a block consisting of the right columns of *this.

Template Parameters

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

Parameters

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

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

Example:

Array44i a = Array44i::Random();
cout << "Here is the array a:" << endl << a << endl;
cout << "Here is a.rightCols<2>():" << endl;
cout << a.rightCols<2>() << endl;
a.rightCols<2>().setZero();
cout << "Now the array a is:" << endl << a << endl;

Output:

See also

block(Index,Index,NRowsType,NColsType), class Block

Definition at line 910 of file DenseBase.h.

rightCols() [4/4]

template<typename Derived>

template<int N>

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

inline

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

Definition at line 918 of file DenseBase.h.

row() [1/2]

template<typename Derived>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE RowXpr Eigen::DenseBase< Derived >::row ( Index  i )

inline

Returns

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

Example:

Matrix3d m = Matrix3d::Identity();
m.row(1) = Vector3d(4,5,6);
cout << m << endl;

Output:

See also

col(), class Block

Definition at line 1119 of file DenseBase.h.

row() [2/2]

template<typename Derived>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE ConstRowXpr Eigen::DenseBase< Derived >::row ( Index  i ) const

inline

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

Definition at line 1126 of file DenseBase.h.

rowwise() [1/2]

template<typename Derived>

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

inline

Returns

a VectorwiseOp wrapper of *this for broadcasting and partial reductions

Example:

Matrix3d m = Matrix3d::Random();
cout << "Here is the matrix m:" << endl << m << endl;
cout << "Here is the sum of each row:" << endl << m.rowwise().sum() << endl;
cout << "Here is the maximum absolute value of each row:"
     << endl << m.cwiseAbs().rowwise().maxCoeff() << endl;

Output:

See also

colwise(), class VectorwiseOp, TutorialReductionsVisitorsBroadcasting

Definition at line 550 of file DenseBase.h.

rowwise() [2/2]

template<typename Derived >

EIGEN_DEVICE_FUNC DenseBase< Derived >::RowwiseReturnType Eigen::DenseBase< Derived >::rowwise ( )

inline

Returns

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

See also

colwise(), class VectorwiseOp, TutorialReductionsVisitorsBroadcasting

Definition at line 777 of file VectorwiseOp.h.

segment() [1/4]

template<typename Derived>

template<typename NType >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedSegmentReturnType<internal::get_fixed_value<NType>::value>::Type Eigen::DenseBase< Derived >::segment ( Index  start, NType  n  )

inline

Returns

an expression of a segment (i.e. a vector block) in *this with either dynamic or fixed sizes.

Parameters

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

Template Parameters

NType

the type of the value handling the number of coefficients in the segment, typically Index.

Example:

RowVector4i v = RowVector4i::Random();
cout << "Here is the vector v:" << endl << v << endl;
cout << "Here is v.segment(1, 2):" << endl << v.segment(1, 2) << endl;
v.segment(1, 2).setZero();
cout << "Now the vector v is:" << endl << v << endl;

Output:

The number of coefficients n can also be specified at compile-time by passing Eigen::fix<N>, or Eigen::fix<N>(n) as arguments. See block() for the details.

Note

Even in the case that 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

block(Index,Index,NRowsType,NColsType), fix<N>, fix<N>(int), class Block

Definition at line 1159 of file DenseBase.h.

segment() [2/4]

template<typename Derived>

template<typename NType >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedSegmentReturnType<internal::get_fixed_value<NType>::value>::Type Eigen::DenseBase< Derived >::segment ( Index  start, NType  n  ) const

inline

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

Definition at line 1175 of file DenseBase.h.

segment() [3/4]

template<typename Derived>

template<int N>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedSegmentReturnType<N>::Type Eigen::DenseBase< Derived >::segment ( Index  start, Index  n = N  )

inline

Returns

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

Template Parameters

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

Parameters

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

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

Example:

RowVector4i v = RowVector4i::Random();
cout << "Here is the vector v:" << endl << v << endl;
cout << "Here is v.segment<2>(1):" << endl << v.segment<2>(1) << endl;
v.segment<2>(2).setZero();
cout << "Now the vector v is:" << endl << v << endl;

Output:

See also

segment(Index,NType), class Block

Definition at line 1298 of file DenseBase.h.

segment() [4/4]

template<typename Derived>

template<int N>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE ConstFixedSegmentReturnType<N>::Type Eigen::DenseBase< Derived >::segment ( Index  start, Index  n = N  ) const

inline

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

Definition at line 1307 of file DenseBase.h.

select() [1/3]

template<typename Derived >

template<typename ThenDerived , typename ElseDerived >

EIGEN_DEVICE_FUNC const Select< Derived, ThenDerived, ElseDerived > Eigen::DenseBase< Derived >::select ( const DenseBase< ThenDerived > &  thenMatrix, const DenseBase< ElseDerived > &  elseMatrix  ) const

inline

Returns

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

Example:

MatrixXi m(3, 3);
m << 1, 2, 3,
     4, 5, 6,
     7, 8, 9;
m = (m.array() >= 5).select(-m, m);
cout << m << endl;

Output:

See also

class Select

Definition at line 126 of file Select.h.

select() [2/3]

template<typename Derived >

template<typename ThenDerived >

EIGEN_DEVICE_FUNC const Select< Derived, ThenDerived, typename ThenDerived::ConstantReturnType > Eigen::DenseBase< Derived >::select ( const DenseBase< ThenDerived > &  thenMatrix, const typename ThenDerived::Scalar &  elseScalar  ) const

inline

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

See also

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

Definition at line 140 of file Select.h.

select() [3/3]

template<typename Derived >

template<typename ElseDerived >

EIGEN_DEVICE_FUNC const Select< Derived, typename ElseDerived::ConstantReturnType, ElseDerived > Eigen::DenseBase< Derived >::select ( const typename ElseDerived::Scalar &  thenScalar, const DenseBase< ElseDerived > &  elseMatrix  ) const

inline

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

See also

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

Definition at line 155 of file Select.h.

setConstant()

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & Eigen::DenseBase< Derived >::setConstant

(

const Scalar &

val

)

Sets all coefficients in this expression to value val.

See also

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

Definition at line 345 of file CwiseNullaryOp.h.

setLinSpaced() [1/2]

template<typename Derived >

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

Sets a linearly spaced vector.

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

Example:

VectorXf v;
v.setLinSpaced(5,0.5f,1.5f);
cout << v << endl;

Output:

For integer scalar types, do not miss the explanations on the definition of even spacing .

See also

LinSpaced(Index,const Scalar&,const Scalar&), CwiseNullaryOp

Definition at line 430 of file CwiseNullaryOp.h.

setLinSpaced() [2/2]

template<typename Derived >

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

Sets a linearly spaced vector.

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

For integer scalar types, do not miss the explanations on the definition of even spacing .

See also

LinSpaced(Index,const Scalar&,const Scalar&), setLinSpaced(Index, const Scalar&, const Scalar&), CwiseNullaryOp

Definition at line 450 of file CwiseNullaryOp.h.

setOnes()

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & Eigen::DenseBase< Derived >::setOnes

(

)

Sets all coefficients in this expression to one.

Example:

Matrix4i m = Matrix4i::Random();
m.row(1).setOnes();
cout << m << endl;

Output:

See also

class CwiseNullaryOp, Ones()

Definition at line 698 of file CwiseNullaryOp.h.

setRandom()

template<typename Derived >

EIGEN_DEVICE_FUNC Derived & Eigen::DenseBase< Derived >::setRandom ( )

inline

Sets all coefficients in this expression to random values.

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

Example:

Matrix4i m = Matrix4i::Zero();
m.col(1).setRandom();
cout << m << endl;

Output:

See also

class CwiseNullaryOp, setRandom(Index), setRandom(Index,Index)

Definition at line 131 of file Random.h.

setZero()

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Derived & Eigen::DenseBase< Derived >::setZero

(

)

Sets all coefficients in this expression to zero.

Example:

Matrix4i m = Matrix4i::Random();
m.row(1).setZero();
cout << m << endl;

Output:

See also

class CwiseNullaryOp, Zero()

Definition at line 546 of file CwiseNullaryOp.h.

subVector() [1/2]

template<typename Derived>

template<DirectionType Direction>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE internal::conditional<Direction==Vertical,ColXpr,RowXpr>::type Eigen::DenseBase< Derived >::subVector ( Index  i )

inline

Returns

the i-th subvector (column or vector) according to the Direction

See also

subVectors()

Definition at line 1423 of file DenseBase.h.

subVector() [2/2]

template<typename Derived>

template<DirectionType Direction>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE internal::conditional<Direction==Vertical,ConstColXpr,ConstRowXpr>::type Eigen::DenseBase< Derived >::subVector ( Index  i ) const

inline

This is the const version of subVector(Index)

Definition at line 1432 of file DenseBase.h.

subVectors()

template<typename Derived>

template<DirectionType Direction>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR Index Eigen::DenseBase< Derived >::subVectors ( ) const

inline

Returns

the number of subvectors (rows or columns) in the direction Direction

See also

subVector(Index)

Definition at line 1442 of file DenseBase.h.

sum()

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE internal::traits< Derived >::Scalar Eigen::DenseBase< Derived >::sum

(

)

const

Returns

the sum of all coefficients of *this

If *this is empty, then the value 0 is returned.

See also

trace(), prod(), mean()

Definition at line 459 of file Redux.h.

swap() [1/2]

template<typename Derived>

template<typename OtherDerived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void Eigen::DenseBase< Derived >::swap ( const DenseBase< OtherDerived > &  other )

inline

swaps *this with the expression other.

Definition at line 420 of file DenseBase.h.

swap() [2/2]

template<typename Derived>

template<typename OtherDerived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE void Eigen::DenseBase< Derived >::swap ( PlainObjectBase< OtherDerived > &  other )

inline

swaps *this with the matrix or array other.

Definition at line 432 of file DenseBase.h.

tail() [1/4]

template<typename Derived>

template<typename NType >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedSegmentReturnType<internal::get_fixed_value<NType>::value>::Type Eigen::DenseBase< Derived >::tail ( NType  n )

inline

Returns

an expression of a last coefficients of *this with either dynamic or fixed sizes.

Parameters

n	the number of coefficients in the segment

Template Parameters

NType

the type of the value handling the number of coefficients in the segment, typically Index.

Example:

RowVector4i v = RowVector4i::Random();
cout << "Here is the vector v:" << endl << v << endl;
cout << "Here is v.tail(2):" << endl << v.tail(2) << endl;
v.tail(2).setZero();
cout << "Now the vector v is:" << endl << v << endl;

Output:

The number of coefficients n can also be specified at compile-time by passing Eigen::fix<N>, or Eigen::fix<N>(n) as arguments. See block() for the details.

Note

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

See also

class Block, block(Index,Index)

Definition at line 1258 of file DenseBase.h.

tail() [2/4]

template<typename Derived>

template<typename NType >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedSegmentReturnType<internal::get_fixed_value<NType>::value>::Type Eigen::DenseBase< Derived >::tail ( NType  n ) const

inline

This is the const version of tail(Index).

Definition at line 1273 of file DenseBase.h.

tail() [3/4]

template<typename Derived>

template<int N>

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

inline

Returns

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

Template Parameters

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

Parameters

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

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

Example:

RowVector4i v = RowVector4i::Random();
cout << "Here is the vector v:" << endl << v << endl;
cout << "Here is v.tail(2):" << endl << v.tail<2>() << endl;
v.tail<2>().setZero();
cout << "Now the vector v is:" << endl << v << endl;

Output:

See also

tail(NType), class Block

Definition at line 1362 of file DenseBase.h.

tail() [4/4]

template<typename Derived>

template<int N>

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

inline

This is the const version of tail<int>.

Definition at line 1371 of file DenseBase.h.

topLeftCorner() [1/6]

template<typename Derived>

template<typename NRowsType , typename NColsType >

EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedBlockXpr<internal::get_fixed_value<NRowsType>::value,internal::get_fixed_value<NColsType>::value>::Type Eigen::DenseBase< Derived >::topLeftCorner ( NRowsType  cRows, NColsType  cCols  )

inline

Returns

an expression of a top-left corner of *this with either dynamic or fixed sizes.

Parameters

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

Template Parameters

NRowsType	the type of the value handling the number of rows in the block, typically Index.
NColsType	the type of the value handling the number of columns in the block, typically Index.

Example:

Matrix4i m = Matrix4i::Random();
cout << "Here is the matrix m:" << endl << m << endl;
cout << "Here is m.topLeftCorner(2, 2):" << endl;
cout << m.topLeftCorner(2, 2) << endl;
m.topLeftCorner(2, 2).setZero();
cout << "Now the matrix m is:" << endl << m << endl;

Output:

The number of rows blockRows and columns blockCols can also be specified at compile-time by passing Eigen::fix<N>, or Eigen::fix<N>(n) as arguments. See block() for the details.

See also

block(Index,Index,NRowsType,NColsType), class Block

Definition at line 250 of file DenseBase.h.

topLeftCorner() [2/6]

template<typename Derived>

template<typename NRowsType , typename NColsType >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedBlockXpr<internal::get_fixed_value<NRowsType>::value,internal::get_fixed_value<NColsType>::value>::Type Eigen::DenseBase< Derived >::topLeftCorner ( NRowsType  cRows, NColsType  cCols  ) const

inline

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

Definition at line 264 of file DenseBase.h.

topLeftCorner() [3/6]

template<typename Derived>

template<int CRows, int CCols>

EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedBlockXpr<CRows,CCols>::Type Eigen::DenseBase< Derived >::topLeftCorner ( )

inline

Returns

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

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

Example:

Matrix4i m = Matrix4i::Random();
cout << "Here is the matrix m:" << endl << m << endl;
cout << "Here is m.topLeftCorner<2,2>():" << endl;
cout << m.topLeftCorner<2,2>() << endl;
m.topLeftCorner<2,2>().setZero();
cout << "Now the matrix m is:" << endl << m << endl;

Output:

See also

block(Index,Index,NRowsType,NColsType), class Block

Definition at line 283 of file DenseBase.h.

topLeftCorner() [4/6]

template<typename Derived>

template<int CRows, int CCols>

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

inline

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

Definition at line 291 of file DenseBase.h.

topLeftCorner() [5/6]

template<typename Derived>

template<int CRows, int CCols>

EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedBlockXpr<CRows,CCols>::Type Eigen::DenseBase< Derived >::topLeftCorner ( Index  cRows, Index  cCols  )

inline

Returns

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

Template Parameters

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

Parameters

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

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

Example:

Matrix4i m = Matrix4i::Random();
cout << "Here is the matrix m:" << endl << m << endl;
cout << "Here is m.topLeftCorner<2,Dynamic>(2,2):" << endl;
cout << m.topLeftCorner<2,Dynamic>(2,2) << endl;
m.topLeftCorner<2,Dynamic>(2,2).setZero();
cout << "Now the matrix m is:" << endl << m << endl;

Output:

See also

class Block

Definition at line 317 of file DenseBase.h.

topLeftCorner() [6/6]

template<typename Derived>

template<int CRows, int CCols>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedBlockXpr<CRows,CCols>::Type Eigen::DenseBase< Derived >::topLeftCorner ( Index  cRows, Index  cCols  ) const

inline

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

Definition at line 325 of file DenseBase.h.

topRightCorner() [1/6]

template<typename Derived>

template<typename NRowsType , typename NColsType >

EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedBlockXpr<internal::get_fixed_value<NRowsType>::value,internal::get_fixed_value<NColsType>::value>::Type Eigen::DenseBase< Derived >::topRightCorner ( NRowsType  cRows, NColsType  cCols  )

inline

Returns

a expression of a top-right corner of *this with either dynamic or fixed sizes.

Parameters

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

Template Parameters

NRowsType	the type of the value handling the number of rows in the block, typically Index.
NColsType	the type of the value handling the number of columns in the block, typically Index.

Example with dynamic sizes:

Matrix4i m = Matrix4i::Random();
cout << "Here is the matrix m:" << endl << m << endl;
cout << "Here is m.topRightCorner(2, 2):" << endl;
cout << m.topRightCorner(2, 2) << endl;
m.topRightCorner(2, 2).setZero();
cout << "Now the matrix m is:" << endl << m << endl;

Output:

The number of rows blockRows and columns blockCols can also be specified at compile-time by passing Eigen::fix<N>, or Eigen::fix<N>(n) as arguments. See block() for the details.

See also

block(Index,Index,NRowsType,NColsType), class Block

Definition at line 143 of file DenseBase.h.

topRightCorner() [2/6]

template<typename Derived>

template<typename NRowsType , typename NColsType >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedBlockXpr<internal::get_fixed_value<NRowsType>::value,internal::get_fixed_value<NColsType>::value>::Type Eigen::DenseBase< Derived >::topRightCorner ( NRowsType  cRows, NColsType  cCols  ) const

inline

This is the const version of topRightCorner(NRowsType, NColsType).

Definition at line 157 of file DenseBase.h.

topRightCorner() [3/6]

template<typename Derived>

template<int CRows, int CCols>

EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedBlockXpr<CRows,CCols>::Type Eigen::DenseBase< Derived >::topRightCorner ( )

inline

Returns

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

Template Parameters

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

Example:

Matrix4i m = Matrix4i::Random();
cout << "Here is the matrix m:" << endl << m << endl;
cout << "Here is m.topRightCorner<2,2>():" << endl;
cout << m.topRightCorner<2,2>() << endl;
m.topRightCorner<2,2>().setZero();
cout << "Now the matrix m is:" << endl << m << endl;

Output:

See also

class Block, block<int,int>(Index,Index)

Definition at line 177 of file DenseBase.h.

topRightCorner() [4/6]

template<typename Derived>

template<int CRows, int CCols>

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

inline

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

Definition at line 185 of file DenseBase.h.

topRightCorner() [5/6]

template<typename Derived>

template<int CRows, int CCols>

EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedBlockXpr<CRows,CCols>::Type Eigen::DenseBase< Derived >::topRightCorner ( Index  cRows, Index  cCols  )

inline

Returns

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

Template Parameters

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

Parameters

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

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

Example:

Matrix4i m = Matrix4i::Random();
cout << "Here is the matrix m:" << endl << m << endl;
cout << "Here is m.topRightCorner<2,Dynamic>(2,2):" << endl;
cout << m.topRightCorner<2,Dynamic>(2,2) << endl;
m.topRightCorner<2,Dynamic>(2,2).setZero();
cout << "Now the matrix m is:" << endl << m << endl;

Output:

See also

class Block

Definition at line 211 of file DenseBase.h.

topRightCorner() [6/6]

template<typename Derived>

template<int CRows, int CCols>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedBlockXpr<CRows,CCols>::Type Eigen::DenseBase< Derived >::topRightCorner ( Index  cRows, Index  cCols  ) const

inline

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

Definition at line 219 of file DenseBase.h.

topRows() [1/4]

template<typename Derived>

template<typename NRowsType >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE NRowsBlockXpr<internal::get_fixed_value<NRowsType>::value>::Type Eigen::DenseBase< Derived >::topRows ( NRowsType  n )

inline

Returns

a block consisting of the top rows of *this.

Parameters

n	the number of rows in the block

Template Parameters

NRowsType

the type of the value handling the number of rows in the block, typically Index.

Example:

Array44i a = Array44i::Random();
cout << "Here is the array a:" << endl << a << endl;
cout << "Here is a.topRows(2):" << endl;
cout << a.topRows(2) << endl;
a.topRows(2).setZero();
cout << "Now the array a is:" << endl << a << endl;

Output:

The number of rows n can also be specified at compile-time by passing Eigen::fix<N>, or Eigen::fix<N>(n) as arguments. See block() for the details.

See also

block(Index,Index,NRowsType,NColsType), class Block

Definition at line 571 of file DenseBase.h.

topRows() [2/4]

template<typename Derived>

template<typename NRowsType >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstNRowsBlockXpr<internal::get_fixed_value<NRowsType>::value>::Type Eigen::DenseBase< Derived >::topRows ( NRowsType  n ) const

inline

This is the const version of topRows(NRowsType).

Definition at line 585 of file DenseBase.h.

topRows() [3/4]

template<typename Derived>

template<int N>

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

inline

Returns

a block consisting of the top rows of *this.

Template Parameters

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

Parameters

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

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

Example:

Array44i a = Array44i::Random();
cout << "Here is the array a:" << endl << a << endl;
cout << "Here is a.topRows<2>():" << endl;
cout << a.topRows<2>() << endl;
a.topRows<2>().setZero();
cout << "Now the array a is:" << endl << a << endl;

Output:

See also

block(Index,Index,NRowsType,NColsType), class Block

Definition at line 608 of file DenseBase.h.

topRows() [4/4]

template<typename Derived>

template<int N>

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

inline

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

Definition at line 616 of file DenseBase.h.

trace()

template<typename Derived>

EIGEN_DEVICE_FUNC Scalar Eigen::DenseBase< Derived >::trace

(

)

const

transpose() [1/2]

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Transpose< Derived > Eigen::DenseBase< Derived >::transpose

(

)

Returns

an expression of the transpose of *this.

Example:

Matrix2i m = Matrix2i::Random();
cout << "Here is the matrix m:" << endl << m << endl;
cout << "Here is the transpose of m:" << endl << m.transpose() << endl;
cout << "Here is the coefficient (1,0) in the transpose of m:" << endl
     << m.transpose()(1,0) << endl;
cout << "Let us overwrite this coefficient with the value 0." << endl;
m.transpose()(1,0) = 0;
cout << "Now the matrix m is:" << endl << m << endl;

Output:

Warning

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

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

Instead, use the transposeInPlace() method:

m.transposeInPlace();

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

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

See also

transposeInPlace(), adjoint()

Definition at line 182 of file Transpose.h.

transpose() [2/2]

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE DenseBase< Derived >::ConstTransposeReturnType Eigen::DenseBase< Derived >::transpose

(

)

const

This is the const version of transpose().

Make sure you read the warning for transpose() !

See also

transposeInPlace(), adjoint()

Definition at line 195 of file Transpose.h.

transposeInPlace()

template<typename Derived >

EIGEN_DEVICE_FUNC void Eigen::DenseBase< Derived >::transposeInPlace ( )

inline

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

m.transposeInPlace();

has the same effect on m as doing

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

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

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

Note

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

See also

transpose(), adjoint(), adjointInPlace()

Definition at line 344 of file Transpose.h.

unaryExpr()

template<typename Derived>

template<typename CustomUnaryOp >

EIGEN_DEVICE_FUNC const CwiseUnaryOp<CustomUnaryOp, const Derived> Eigen::DenseBase< Derived >::unaryExpr ( const CustomUnaryOp &  func = CustomUnaryOp() ) const

inline

Apply a unary operator coefficient-wise.

Parameters

[in]

func

Functor implementing the unary operator

Template Parameters

CustomUnaryOp

Type of func

Returns

An expression of a custom coefficient-wise unary operator func of *this

The function ptr_fun() from the C++ standard library can be used to make functors out of normal functions.

Example:

#include <Eigen/Core>
#include <iostream>
using namespace Eigen;
using namespace std;

// define function to be applied coefficient-wise
double ramp(double x)
{
  if (x > 0)
    return x;
  else 
    return 0;
}

int main(int, char**)
{
  Matrix4d m1 = Matrix4d::Random();
  cout << m1 << endl << "becomes: " << endl << m1.unaryExpr(ptr_fun(ramp)) << endl;
  return 0;
}

Output:

Genuine functors allow for more possibilities, for instance it may contain a state.

Example:

#include <Eigen/Core>
#include <iostream>
using namespace Eigen;
using namespace std;

// define a custom template unary functor
template<typename Scalar>
struct CwiseClampOp {
  CwiseClampOp(const Scalar& inf, const Scalar& sup) : m_inf(inf), m_sup(sup) {}
  const Scalar operator()(const Scalar& x) const { return x<m_inf ? m_inf : (x>m_sup ? m_sup : x); }
  Scalar m_inf, m_sup;
};

int main(int, char**)
{
  Matrix4d m1 = Matrix4d::Random();
  cout << m1 << endl << "becomes: " << endl << m1.unaryExpr(CwiseClampOp<double>(-0.5,0.5)) << endl;
  return 0;
}

Output:

See also

unaryViewExpr, binaryExpr, class CwiseUnaryOp

Definition at line 136 of file DenseBase.h.

unaryViewExpr()

template<typename Derived>

template<typename CustomViewOp >

EIGEN_DEVICE_FUNC const CwiseUnaryView<CustomViewOp, const Derived> Eigen::DenseBase< Derived >::unaryViewExpr ( const CustomViewOp &  func = CustomViewOp() ) const

inline

Returns

an expression of a custom coefficient-wise unary operator func of *this

The template parameter CustomUnaryOp is the type of the functor of the custom unary operator.

Example:

#include <Eigen/Core>
#include <iostream>
using namespace Eigen;
using namespace std;

// define a custom template unary functor
template<typename Scalar>
struct CwiseClampOp {
  CwiseClampOp(const Scalar& inf, const Scalar& sup) : m_inf(inf), m_sup(sup) {}
  const Scalar operator()(const Scalar& x) const { return x<m_inf ? m_inf : (x>m_sup ? m_sup : x); }
  Scalar m_inf, m_sup;
};

int main(int, char**)
{
  Matrix4d m1 = Matrix4d::Random();
  cout << m1 << endl << "becomes: " << endl << m1.unaryExpr(CwiseClampOp<double>(-0.5,0.5)) << endl;
  return 0;
}

Output:

See also

unaryExpr, binaryExpr class CwiseUnaryOp

Definition at line 157 of file DenseBase.h.

value()

template<typename Derived>

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

inline

Returns

the unique coefficient of a 1x1 expression

Definition at line 526 of file DenseBase.h.

visit()

template<typename Derived >

template<typename Visitor >

EIGEN_DEVICE_FUNC void Eigen::DenseBase< Derived >::visit

(

Visitor &

visitor

)

const

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

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

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

Note

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

if the matrix is empty, then the visitor is left unchanged.

See also

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

Definition at line 117 of file Visitor.h.

Zero() [1/3]

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const DenseBase< Derived >::ConstantReturnType Eigen::DenseBase< Derived >::Zero ( Index  rows, Index  cols  )

static

Returns

an expression of a zero matrix.

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

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

Example:

cout << MatrixXi::Zero(2,3) << endl;

Output:

See also

Zero(), Zero(Index)

Definition at line 474 of file CwiseNullaryOp.h.

Zero() [2/3]

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const DenseBase< Derived >::ConstantReturnType Eigen::DenseBase< Derived >::Zero ( Index  size )

static

Returns

an expression of a zero vector.

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

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

Example:

cout << RowVectorXi::Zero(4) << endl;
cout << VectorXf::Zero(2) << endl;

Output:

See also

Zero(), Zero(Index,Index)

Definition at line 497 of file CwiseNullaryOp.h.

Zero() [3/3]

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const DenseBase< Derived >::ConstantReturnType Eigen::DenseBase< Derived >::Zero ( )

static

Returns

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

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

Example:

cout << Matrix2d::Zero() << endl;
cout << RowVector4i::Zero() << endl;

Output:

See also

Zero(Index), Zero(Index,Index)

Definition at line 514 of file CwiseNullaryOp.h.

Friends And Related Function Documentation

operator<<()

template<typename Derived >

std::ostream & operator<< ( std::ostream &  s, const DenseBase< Derived > &  m  )

related

Outputs the matrix, to the given stream.

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

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

See also

DenseBase::format()

Definition at line 250 of file IO.h.

Member Data Documentation

SequentialLinSpacedReturnType

template<typename Derived>

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

Definition at line 269 of file DenseBase.h.

---

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

• DenseBase.h
• Assign.h
• BooleanRedux.h
• CommaInitializer.h
• CwiseNullaryOp.h
• EigenBase.h
• Fuzzy.h
• IO.h
• NestByValue.h
• Random.h
• Redux.h
• Replicate.h
• ReturnByValue.h
• Reverse.h
• Select.h
• SelfCwiseBinaryOp.h
• StlIterators.h
• Transpose.h
• VectorwiseOp.h
• Visitor.h