Base class of any sparse matrices or sparse expressions. More...

#include <ForwardDeclarations.h>

Inheritance diagram for Eigen::SparseMatrixBase< Derived >:

[legend]

Classes
struct	CastXpr

struct	ConstFixedBlockXpr

struct	ConstFixedSegmentReturnType

struct	ConstNColsBlockXpr

struct	ConstNRowsBlockXpr

struct	ConstSelfAdjointViewReturnType

struct	CwiseProductDenseReturnType

struct	FixedBlockXpr

struct	FixedSegmentReturnType

struct	NColsBlockXpr

struct	NRowsBlockXpr

struct	SelfAdjointViewReturnType

Public Types
enum	{ RowsAtCompileTime = internal::traits<Derived>::RowsAtCompileTime, ColsAtCompileTime = internal::traits<Derived>::ColsAtCompileTime, SizeAtCompileTime, MaxRowsAtCompileTime = RowsAtCompileTime, MaxColsAtCompileTime = ColsAtCompileTime, MaxSizeAtCompileTime, IsVectorAtCompileTime = RowsAtCompileTime == 1 \|\| ColsAtCompileTime == 1, NumDimensions = int(MaxSizeAtCompileTime) == 1 ? 0 : bool(IsVectorAtCompileTime) ? 1 : 2, Flags = internal::traits<Derived>::Flags, IsRowMajor = Flags&RowMajorBit ? 1 : 0, InnerSizeAtCompileTime, _HasDirectAccess = (int(Flags)&DirectAccessBit) ? 1 : 0 }

typedef internal::conditional< NumTraits< Scalar >::IsComplex, CwiseUnaryOp< internal::scalar_conjugate_op< Scalar >, Eigen::Transpose< const Derived > >, Transpose< const Derived > >::type	AdjointReturnType

typedef EigenBase< Derived >	Base

typedef Block< Derived >	BlockXpr

typedef internal::conditional< _HasDirectAccess, const Scalar &, Scalar >::type	CoeffReturnType

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

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 CwiseNullaryOp< internal::scalar_constant_op< Scalar >, Matrix< Scalar, Dynamic, Dynamic > >	ConstantReturnType

typedef const Block< const Derived >	ConstBlockXpr

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

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 Block< const Derived, Dynamic, internal::traits< Derived >::ColsAtCompileTime, IsRowMajor >	ConstRowsBlockXpr

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 CwiseUnaryOp< internal::scalar_abs2_op< Scalar >, const Derived >	CwiseAbs2ReturnType

typedef CwiseUnaryOp< internal::scalar_abs_op< Scalar >, const Derived >	CwiseAbsReturnType

typedef CwiseUnaryOp< internal::scalar_arg_op< Scalar >, const Derived >	CwiseArgReturnType

typedef CwiseUnaryOp< internal::scalar_inverse_op< Scalar >, const Derived >	CwiseInverseReturnType

typedef CwiseBinaryOp< internal::scalar_cmp_op< Scalar, Scalar, internal::cmp_EQ >, const Derived, const ConstantReturnType >	CwiseScalarEqualReturnType

typedef CwiseUnaryOp< internal::scalar_sign_op< Scalar >, const Derived >	CwiseSignReturnType

typedef CwiseUnaryOp< internal::scalar_sqrt_op< Scalar >, const Derived >	CwiseSqrtReturnType

typedef Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTime >	DenseMatrixType

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

typedef Matrix< StorageIndex, Dynamic, 1 >	IndexVector

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

typedef Block< Derived, Dynamic, Dynamic, true >	InnerVectorsReturnType

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::add_const_on_value_type_if_arithmetic< typename internal::packet_traits< Scalar >::type >::type	PacketReturnType

typedef internal::packet_traits< Scalar >::type	PacketScalar

typedef SparseMatrix< Scalar, Flags &RowMajorBit ? RowMajor :ColMajor, StorageIndex >	PlainObject

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 Block< Derived, Dynamic, internal::traits< Derived >::ColsAtCompileTime, IsRowMajor >	RowsBlockXpr

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

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

typedef Matrix< Scalar, Dynamic, 1 >	ScalarVector

typedef VectorBlock< Derived >	SegmentReturnType

typedef Matrix< Scalar, EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime), EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime)>	SquareMatrixType

typedef SparseMatrixBase	StorageBaseType

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

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

typedef Transpose< Derived >	TransposeReturnType

typedef Scalar	value_type

Public Types inherited from Eigen::EigenBase< Derived >
typedef Eigen::Index	Index
	The interface type of indices. More...

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

Public Member Functions
const AdjointReturnType	adjoint () const

template<typename CustomBinaryOp , typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp< CustomBinaryOp, const Derived, const OtherDerived >	binaryExpr (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other, const CustomBinaryOp &func=CustomBinaryOp()) 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...

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

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

Index	cols () const

EIGEN_DEVICE_FUNC ConjugateReturnType	conjugate () const

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

Derived &	const_cast_derived () const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseAbsReturnType	cwiseAbs () const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseAbs2ReturnType	cwiseAbs2 () const

EIGEN_DEVICE_FUNC const CwiseArgReturnType	cwiseArg () const

template<typename OtherDerived >
EIGEN_DEVICE_FUNC const CwiseBinaryOp< numext::equal_to< Scalar >, const Derived, const OtherDerived >	cwiseEqual (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const

EIGEN_DEVICE_FUNC const CwiseScalarEqualReturnType	cwiseEqual (const Scalar &s) const

EIGEN_DEVICE_FUNC const CwiseInverseReturnType	cwiseInverse () const

template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_max_op< Scalar, Scalar >, const Derived, const OtherDerived >	cwiseMax (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_max_op< Scalar, Scalar >, const Derived, const ConstantReturnType >	cwiseMax (const Scalar &other) const

template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_min_op< Scalar, Scalar >, const Derived, const OtherDerived >	cwiseMin (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_min_op< Scalar, Scalar >, const Derived, const ConstantReturnType >	cwiseMin (const Scalar &other) const

template<typename OtherDerived >
EIGEN_DEVICE_FUNC const CwiseBinaryOp< numext::not_equal_to< Scalar >, const Derived, const OtherDerived >	cwiseNotEqual (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const

template<typename OtherDerived >
EIGEN_STRONG_INLINE const CwiseProductDenseReturnType< OtherDerived >::Type	cwiseProduct (const MatrixBase< OtherDerived > &other) const

template<typename OtherDerived >
EIGEN_STRONG_INLINE const SparseMatrixBase< Derived >::template CwiseProductDenseReturnType< OtherDerived >::Type	cwiseProduct (const MatrixBase< OtherDerived > &other) const

template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_quotient_op< Scalar >, const Derived, const OtherDerived >	cwiseQuotient (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const

EIGEN_DEVICE_FUNC const CwiseSignReturnType	cwiseSign () const

EIGEN_DEVICE_FUNC const CwiseSqrtReturnType	cwiseSqrt () const

const Derived &	derived () const

Derived &	derived ()

template<typename OtherDerived >
internal::traits< Derived >::Scalar	dot (const MatrixBase< OtherDerived > &other) const

template<typename OtherDerived >
internal::traits< Derived >::Scalar	dot (const SparseMatrixBase< OtherDerived > &other) const

template<typename OtherDerived >
Scalar	dot (const MatrixBase< OtherDerived > &other) const

template<typename OtherDerived >
Scalar	dot (const SparseMatrixBase< OtherDerived > &other) const

template<typename OtherDerived >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const	EIGEN_CWISE_BINARY_RETURN_TYPE (Derived, OtherDerived, product) cwiseProduct(const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const

const internal::eval< Derived >::type	eval () 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 ()

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 >
bool	isApprox (const SparseMatrixBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const

template<typename OtherDerived >
bool	isApprox (const MatrixBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const

bool	isRValue () const

bool	isVector () const

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

Derived &	markAsRValue ()

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

RealScalar	norm () const

template<typename OtherDerived >
EIGEN_DEVICE_FUNC const CwiseBinaryOp< internal::scalar_boolean_and_op, const Derived, const OtherDerived >	operator && (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const

template<typename OtherDerived >
const Product< Derived, OtherDerived >	operator* (const DiagonalBase< OtherDerived > &other) const

template<typename OtherDerived >
const Product< Derived, OtherDerived, AliasFreeProduct >	operator* (const SparseMatrixBase< OtherDerived > &other) const

template<typename OtherDerived >
const Product< Derived, OtherDerived >	operator* (const MatrixBase< OtherDerived > &other) const

Derived &	operator*= (const Scalar &other)

template<typename OtherDerived >
Derived &	operator*= (const SparseMatrixBase< OtherDerived > &other)

template<typename OtherDerived >
Derived &	operator+= (const SparseMatrixBase< OtherDerived > &other)

template<typename OtherDerived >
Derived &	operator+= (const DiagonalBase< OtherDerived > &other)

template<typename OtherDerived >
Derived &	operator+= (const EigenBase< OtherDerived > &other)

template<typename OtherDerived >
EIGEN_STRONG_INLINE Derived &	operator+= (const SparseMatrixBase< OtherDerived > &other)

EIGEN_DEVICE_FUNC const NegativeReturnType	operator- () const

template<typename OtherDerived >
Derived &	operator-= (const SparseMatrixBase< OtherDerived > &other)

template<typename OtherDerived >
Derived &	operator-= (const DiagonalBase< OtherDerived > &other)

template<typename OtherDerived >
Derived &	operator-= (const EigenBase< OtherDerived > &other)

template<typename OtherDerived >
EIGEN_STRONG_INLINE Derived &	operator-= (const SparseMatrixBase< OtherDerived > &other)

Derived &	operator/= (const Scalar &other)

template<typename OtherDerived >
Derived &	operator= (const EigenBase< OtherDerived > &other)

template<typename OtherDerived >
Derived &	operator= (const ReturnByValue< OtherDerived > &other)

template<typename OtherDerived >
Derived &	operator= (const SparseMatrixBase< OtherDerived > &other)

Derived &	operator= (const Derived &other)

template<typename OtherDerived >
EIGEN_DEVICE_FUNC const CwiseBinaryOp< internal::scalar_boolean_or_op, const Derived, const OtherDerived >	operator\|\| (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const

Index	outerSize () const

const SparseView< Derived >	pruned (const Scalar &reference=Scalar(0), const RealScalar &epsilon=NumTraits< Scalar >::dummy_precision()) const

EIGEN_DEVICE_FUNC RealReturnType	real () const

EIGEN_DEVICE_FUNC NonConstRealReturnType	real ()

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

Index	rows () const

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<unsigned int UpLo>
SparseMatrixBase< Derived >::template ConstSelfAdjointViewReturnType< UpLo >::Type	selfadjointView () const

template<unsigned int UpLo>
SparseMatrixBase< Derived >::template SelfAdjointViewReturnType< UpLo >::Type	selfadjointView ()

template<unsigned int UpLo>
ConstSelfAdjointViewReturnType< UpLo >::Type	selfadjointView () const

template<unsigned int UpLo>
SelfAdjointViewReturnType< UpLo >::Type	selfadjointView ()

Index	size () const

	SparseMatrixBase ()

RealScalar	squaredNorm () const

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

Scalar	sum () const

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

DenseMatrixType	toDense () 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	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...

TransposeReturnType	transpose ()

const ConstTransposeReturnType	transpose () const

template<int Mode>
const TriangularView< const Derived, Mode >	triangularView () const

SparseSymmetricPermutationProduct< Derived, Upper\|Lower >	twistedBy (const PermutationMatrix< Dynamic, Dynamic, StorageIndex > &perm) const

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

Public Member Functions inherited from Eigen::EigenBase< Derived >
template<typename Dest >
EIGEN_DEVICE_FUNC void	addTo (Dest &dst) const

template<typename Dest >
EIGEN_DEVICE_FUNC void	applyThisOnTheLeft (Dest &dst) const

template<typename Dest >
EIGEN_DEVICE_FUNC void	applyThisOnTheRight (Dest &dst) const

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT

EIGEN_DEVICE_FUNC Derived &	const_cast_derived () const

EIGEN_DEVICE_FUNC const Derived &	const_derived () const

EIGEN_DEVICE_FUNC Derived &	derived ()

EIGEN_DEVICE_FUNC const Derived &	derived () const

template<typename Dest >
EIGEN_DEVICE_FUNC void	evalTo (Dest &dst) const

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	size () const EIGEN_NOEXCEPT

template<typename Dest >
EIGEN_DEVICE_FUNC void	subTo (Dest &dst) const

Protected Member Functions
template<typename OtherDerived >
Derived &	assign (const OtherDerived &other)

template<typename OtherDerived >
void	assignGeneric (const OtherDerived &other)

Static Protected Member Functions
static StorageIndex	convert_index (const Index idx)

Protected Attributes
bool	m_isRValue

Private Member Functions
template<typename Dest >
void	evalTo (Dest &) const

Friends
template<typename OtherDerived >
const Product< OtherDerived, Derived >	operator* (const DiagonalBase< OtherDerived > &lhs, const SparseMatrixBase &rhs)

template<typename OtherDerived >
const Product< OtherDerived, Derived >	operator* (const MatrixBase< OtherDerived > &lhs, const SparseMatrixBase &rhs)

std::ostream &	operator<< (std::ostream &s, const SparseMatrixBase &m)

Detailed Description

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

Base class of any sparse matrices or sparse expressions.

Template Parameters

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

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

Definition at line 301 of file ForwardDeclarations.h.

Member Typedef Documentation

◆ AdjointReturnType

template<typename Derived>

typedef internal::conditional<NumTraits<Scalar>::IsComplex, CwiseUnaryOp<internal::scalar_conjugate_op<Scalar>, Eigen::Transpose<const Derived> >, Transpose<const Derived> >::type Eigen::SparseMatrixBase< Derived >::AdjointReturnType

Definition at line 114 of file SparseMatrixBase.h.

◆ Base

template<typename Derived>

typedef EigenBase<Derived> Eigen::SparseMatrixBase< Derived >::Base

Definition at line 148 of file SparseMatrixBase.h.

◆ BlockXpr

template<typename Derived>

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

Definition at line 33 of file SparseMatrixBase.h.

◆ CoeffReturnType

template<typename Derived>

typedef internal::conditional<_HasDirectAccess, const Scalar&, Scalar>::type Eigen::SparseMatrixBase< Derived >::CoeffReturnType

Definition at line 132 of file SparseMatrixBase.h.

◆ ColsBlockXpr

template<typename Derived>

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

Definition at line 21 of file SparseMatrixBase.h.

◆ ColXpr

template<typename Derived>

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

Definition at line 15 of file SparseMatrixBase.h.

◆ ConjugateReturnType

template<typename Derived>

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

Definition at line 20 of file SparseMatrixBase.h.

◆ ConstantReturnType

template<typename Derived>

typedef CwiseNullaryOp<internal::scalar_constant_op<Scalar>,Matrix<Scalar,Dynamic,Dynamic> > Eigen::SparseMatrixBase< Derived >::ConstantReturnType

Definition at line 135 of file SparseMatrixBase.h.

◆ ConstBlockXpr

template<typename Derived>

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

Definition at line 34 of file SparseMatrixBase.h.

◆ ConstColsBlockXpr

template<typename Derived>

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

Definition at line 22 of file SparseMatrixBase.h.

◆ ConstColXpr

template<typename Derived>

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

Definition at line 16 of file SparseMatrixBase.h.

◆ ConstInnerVectorReturnType

template<typename Derived>

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

Definition at line 46 of file SparseMatrixBase.h.

◆ ConstInnerVectorsReturnType

template<typename Derived>

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

Definition at line 50 of file SparseMatrixBase.h.

◆ ConstRowsBlockXpr

template<typename Derived>

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

Definition at line 25 of file SparseMatrixBase.h.

◆ ConstRowXpr

template<typename Derived>

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

Definition at line 19 of file SparseMatrixBase.h.

◆ ConstSegmentReturnType

template<typename Derived>

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

Definition at line 40 of file SparseMatrixBase.h.

◆ ConstTransposeReturnType

template<typename Derived>

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

Definition at line 116 of file SparseMatrixBase.h.

◆ CwiseAbs2ReturnType

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_abs2_op<Scalar>, const Derived> Eigen::SparseMatrixBase< Derived >::CwiseAbs2ReturnType

Definition at line 17 of file SparseMatrixBase.h.

◆ CwiseAbsReturnType

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_abs_op<Scalar>, const Derived> Eigen::SparseMatrixBase< Derived >::CwiseAbsReturnType

Definition at line 16 of file SparseMatrixBase.h.

◆ CwiseArgReturnType

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_arg_op<Scalar>, const Derived> Eigen::SparseMatrixBase< Derived >::CwiseArgReturnType

Definition at line 18 of file SparseMatrixBase.h.

◆ CwiseInverseReturnType

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_inverse_op<Scalar>, const Derived> Eigen::SparseMatrixBase< Derived >::CwiseInverseReturnType

Definition at line 21 of file SparseMatrixBase.h.

◆ CwiseScalarEqualReturnType

template<typename Derived>

typedef CwiseBinaryOp<internal::scalar_cmp_op<Scalar,Scalar,internal::cmp_EQ>, const Derived, const ConstantReturnType> Eigen::SparseMatrixBase< Derived >::CwiseScalarEqualReturnType

Definition at line 137 of file SparseMatrixBase.h.

◆ CwiseSignReturnType

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_sign_op<Scalar>, const Derived> Eigen::SparseMatrixBase< Derived >::CwiseSignReturnType

Definition at line 20 of file SparseMatrixBase.h.

◆ CwiseSqrtReturnType

template<typename Derived>

typedef CwiseUnaryOp<internal::scalar_sqrt_op<Scalar>, const Derived> Eigen::SparseMatrixBase< Derived >::CwiseSqrtReturnType

Definition at line 19 of file SparseMatrixBase.h.

◆ DenseMatrixType

template<typename Derived>

typedef Matrix<Scalar,RowsAtCompileTime,ColsAtCompileTime> Eigen::SparseMatrixBase< Derived >::DenseMatrixType

type of the equivalent dense matrix

Definition at line 138 of file SparseMatrixBase.h.

◆ ImagReturnType

template<typename Derived>

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

Definition at line 32 of file SparseMatrixBase.h.

◆ IndexVector

template<typename Derived>

typedef Matrix<StorageIndex,Dynamic,1> Eigen::SparseMatrixBase< Derived >::IndexVector

Definition at line 51 of file SparseMatrixBase.h.

◆ InnerVectorReturnType

template<typename Derived>

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

Definition at line 45 of file SparseMatrixBase.h.

◆ InnerVectorsReturnType

template<typename Derived>

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

Definition at line 49 of file SparseMatrixBase.h.

◆ NegativeReturnType

template<typename Derived>

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

Definition at line 36 of file SparseMatrixBase.h.

◆ NonConstImagReturnType

template<typename Derived>

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

Definition at line 34 of file SparseMatrixBase.h.

◆ NonConstRealReturnType

template<typename Derived>

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

Definition at line 30 of file SparseMatrixBase.h.

◆ PacketReturnType

template<typename Derived>

typedef internal::add_const_on_value_type_if_arithmetic< typename internal::packet_traits<Scalar>::type >::type Eigen::SparseMatrixBase< Derived >::PacketReturnType

Definition at line 47 of file SparseMatrixBase.h.

◆ PacketScalar

template<typename Derived>

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

Definition at line 38 of file SparseMatrixBase.h.

◆ PlainObject

template<typename Derived>

typedef SparseMatrix<Scalar, Flags&RowMajorBit ? RowMajor : ColMajor, StorageIndex> Eigen::SparseMatrixBase< Derived >::PlainObject

Definition at line 119 of file SparseMatrixBase.h.

◆ RealReturnType

template<typename Derived>

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

Definition at line 25 of file SparseMatrixBase.h.

◆ RealScalar

template<typename Derived>

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

This is the "real scalar" type; if the Scalar type is already real numbers (e.g. int, float or double) then RealScalar is just the same as Scalar. If Scalar is std::complex<T> then RealScalar is T.

See also: class NumTraits

Definition at line 128 of file SparseMatrixBase.h.

◆ RowsBlockXpr

template<typename Derived>

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

Definition at line 24 of file SparseMatrixBase.h.

◆ RowXpr

template<typename Derived>

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

Definition at line 18 of file SparseMatrixBase.h.

◆ Scalar

template<typename Derived>

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

Definition at line 31 of file SparseMatrixBase.h.

◆ ScalarVector

template<typename Derived>

typedef Matrix<Scalar,Dynamic,1> Eigen::SparseMatrixBase< Derived >::ScalarVector

Definition at line 52 of file SparseMatrixBase.h.

◆ SegmentReturnType

template<typename Derived>

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

Definition at line 39 of file SparseMatrixBase.h.

◆ SquareMatrixType

template<typename Derived>

typedef Matrix<Scalar,EIGEN_SIZE_MAX(RowsAtCompileTime,ColsAtCompileTime), EIGEN_SIZE_MAX(RowsAtCompileTime,ColsAtCompileTime)> Eigen::SparseMatrixBase< Derived >::SquareMatrixType

type of the equivalent square matrix

Definition at line 141 of file SparseMatrixBase.h.

◆ StorageBaseType

template<typename Derived>

typedef SparseMatrixBase Eigen::SparseMatrixBase< Derived >::StorageBaseType

Definition at line 49 of file SparseMatrixBase.h.

◆ StorageIndex

template<typename Derived>

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

The integer type used to store indices within a SparseMatrix. For a SparseMatrix<Scalar,Options,IndexType> it an alias of the third template parameter IndexType.

Definition at line 43 of file SparseMatrixBase.h.

◆ StorageKind

template<typename Derived>

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

Definition at line 39 of file SparseMatrixBase.h.

◆ TransposeReturnType

template<typename Derived>

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

Definition at line 115 of file SparseMatrixBase.h.

◆ value_type

template<typename Derived>

typedef Scalar Eigen::SparseMatrixBase< 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 36 of file SparseMatrixBase.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
MaxColsAtCompileTime
MaxSizeAtCompileTime
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
InnerSizeAtCompileTime
_HasDirectAccess

Definition at line 57 of file SparseMatrixBase.h.

Constructor & Destructor Documentation

◆ SparseMatrixBase()

template<typename Derived>

Eigen::SparseMatrixBase< Derived >::SparseMatrixBase ( )

inline

Definition at line 197 of file SparseMatrixBase.h.

Member Function Documentation

◆ adjoint()

template<typename Derived>

const AdjointReturnType Eigen::SparseMatrixBase< Derived >::adjoint ( ) const

inline

Definition at line 356 of file SparseMatrixBase.h.

◆ assign()

template<typename Derived>

template<typename OtherDerived >

Derived& Eigen::SparseMatrixBase< Derived >::assign ( const OtherDerived & other )

inlineprotected

◆ assignGeneric()

template<typename Derived>

template<typename OtherDerived >

void Eigen::SparseMatrixBase< Derived >::assignGeneric ( const OtherDerived & other )

inlineprotected

◆ binaryExpr()

template<typename Derived>

template<typename CustomBinaryOp , typename OtherDerived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp<CustomBinaryOp, const Derived, const OtherDerived> Eigen::SparseMatrixBase< Derived >::binaryExpr	(	const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &	other,
		const CustomBinaryOp &	func = `CustomBinaryOp()`
	)		const

inline

Returns: an expression of the difference of *this and other

Note: If you want to substract a given scalar from all coefficients, see Cwise::operator-().

See also: class CwiseBinaryOp, operator-=()

Returns: an expression of the sum of *this and other

Note: If you want to add a given scalar to all coefficients, see Cwise::operator+().

See also: class CwiseBinaryOp, operator+=()

Returns: an expression of a custom coefficient-wise operator func of *this and other

The template parameter CustomBinaryOp is the type of the functor of the custom operator (see class CwiseBinaryOp for an example)

Here is an example illustrating the use of custom functors:

#include <Eigen/Core>
#include <iostream>
using namespace Eigen;
using namespace std;
// define a custom template binary functor
template<typename Scalar> struct MakeComplexOp {
  EIGEN_EMPTY_STRUCT_CTOR(MakeComplexOp)
  typedef complex<Scalar> result_type;
  complex<Scalar> operator()(const Scalar& a, const Scalar& b) const { return complex<Scalar>(a,b); }
};
int main(int, char**)
{
  Matrix4d m1 = Matrix4d::Random(), m2 = Matrix4d::Random();
  cout << m1.binaryExpr(m2, MakeComplexOp<double>()) << endl;
  return 0;
}

Output:

See also: class CwiseBinaryOp, operator+(), operator-(), cwiseProduct()

Definition at line 44 of file SparseMatrixBase.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::SparseMatrixBase< 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 SparseMatrixBase.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::SparseMatrixBase< 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 SparseMatrixBase.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::SparseMatrixBase< 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 SparseMatrixBase.h.

◆ block() [4/6]

template<typename Derived>

template<int NRows, int NCols>

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

inline

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

Definition at line 1036 of file SparseMatrixBase.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::SparseMatrixBase< 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 SparseMatrixBase.h.

◆ block() [6/6]

template<typename Derived>

template<int NRows, int NCols>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedBlockXpr<NRows,NCols>::Type Eigen::SparseMatrixBase< 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 SparseMatrixBase.h.

◆ blueNorm()

template<typename Derived >

NumTraits< typename internal::traits< Derived >::Scalar >::Real Eigen::SparseMatrixBase< Derived >::blueNorm ( ) const

inline

Definition at line 92 of file SparseDot.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::SparseMatrixBase< 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 SparseMatrixBase.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::SparseMatrixBase< Derived >::bottomLeftCorner	(	NRowsType	cRows,
		NColsType	cCols
	)		const

inline

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

Definition at line 479 of file SparseMatrixBase.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::SparseMatrixBase< 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 SparseMatrixBase.h.

◆ bottomLeftCorner() [4/6]

template<typename Derived>

template<int CRows, int CCols>

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

inline

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

Definition at line 507 of file SparseMatrixBase.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::SparseMatrixBase< 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 SparseMatrixBase.h.

◆ bottomLeftCorner() [6/6]

template<typename Derived>

template<int CRows, int CCols>

EIGEN_STRONG_INLINE const ConstFixedBlockXpr<CRows,CCols>::Type Eigen::SparseMatrixBase< 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 SparseMatrixBase.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::SparseMatrixBase< 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 SparseMatrixBase.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::SparseMatrixBase< Derived >::bottomRightCorner	(	NRowsType	cRows,
		NColsType	cCols
	)		const

inline

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

Definition at line 371 of file SparseMatrixBase.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::SparseMatrixBase< 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 SparseMatrixBase.h.

◆ bottomRightCorner() [4/6]

template<typename Derived>

template<int CRows, int CCols>

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

inline

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

Definition at line 399 of file SparseMatrixBase.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::SparseMatrixBase< 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 SparseMatrixBase.h.

◆ bottomRightCorner() [6/6]

template<typename Derived>

template<int CRows, int CCols>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedBlockXpr<CRows,CCols>::Type Eigen::SparseMatrixBase< 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 SparseMatrixBase.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::SparseMatrixBase< 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 SparseMatrixBase.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::SparseMatrixBase< Derived >::bottomRows ( NRowsType n ) const

inline

This is the const version of bottomRows(NRowsType).

Definition at line 660 of file SparseMatrixBase.h.

◆ bottomRows() [3/4]

template<typename Derived>

template<int N>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE NRowsBlockXpr<N>::Type Eigen::SparseMatrixBase< 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 SparseMatrixBase.h.

◆ bottomRows() [4/4]

template<typename Derived>

template<int N>

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

inline

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

Definition at line 691 of file SparseMatrixBase.h.

◆ cast()

template<typename Derived>

template<typename NewType >

EIGEN_DEVICE_FUNC CastXpr<NewType>::Type Eigen::SparseMatrixBase< 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 SparseMatrixBase.h.

◆ col() [1/2]

template<typename Derived>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE ColXpr Eigen::SparseMatrixBase< 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 SparseMatrixBase.h.

◆ col() [2/2]

template<typename Derived>

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

inline

This is the const version of col().

Definition at line 1105 of file SparseMatrixBase.h.

◆ cols()

template<typename Derived>

Index Eigen::SparseMatrixBase< Derived >::cols ( void ) const

inline

Returns: the number of columns.

See also: rows()

Definition at line 178 of file SparseMatrixBase.h.

◆ conjugate()

template<typename Derived>

EIGEN_DEVICE_FUNC ConjugateReturnType Eigen::SparseMatrixBase< 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 SparseMatrixBase.h.

◆ conjugateIf()

template<typename Derived>

template<bool Cond>

EIGEN_DEVICE_FUNC internal::conditional<Cond,ConjugateReturnType,const Derived&>::type Eigen::SparseMatrixBase< 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 SparseMatrixBase.h.

◆ const_cast_derived()

template<typename Derived>

Derived& Eigen::SparseMatrixBase< Derived >::const_cast_derived ( ) const

inline

Definition at line 145 of file SparseMatrixBase.h.

◆ convert_index()

template<typename Derived>

static StorageIndex Eigen::SparseMatrixBase< Derived >::convert_index ( const Index idx )

inlinestaticprotected

Definition at line 389 of file SparseMatrixBase.h.

◆ cwiseAbs()

template<typename Derived>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseAbsReturnType Eigen::SparseMatrixBase< Derived >::cwiseAbs ( ) const

inline

Returns: an expression of the coefficient-wise absolute value of *this

Example:

MatrixXd m(2,3);
m << 2, -4, 6,   
     -5, 1, 0;
cout << m.cwiseAbs() << endl;

Output:

See also: cwiseAbs2()

Definition at line 34 of file SparseMatrixBase.h.

◆ cwiseAbs2()

template<typename Derived>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseAbs2ReturnType Eigen::SparseMatrixBase< Derived >::cwiseAbs2 ( ) const

inline

Returns: an expression of the coefficient-wise squared absolute value of *this

Example:

MatrixXd m(2,3);
m << 2, -4, 6,   
     -5, 1, 0;
cout << m.cwiseAbs2() << endl;

Output:

See also: cwiseAbs()

Definition at line 47 of file SparseMatrixBase.h.

◆ cwiseArg()

template<typename Derived>

EIGEN_DEVICE_FUNC const CwiseArgReturnType Eigen::SparseMatrixBase< Derived >::cwiseArg ( ) const

inline

Returns: an expression of the coefficient-wise phase angle of *this

Example:

MatrixXcf v = MatrixXcf::Random(2, 3);
cout << v << endl << endl;
cout << v.cwiseArg() << endl;

Output:

Definition at line 96 of file SparseMatrixBase.h.

◆ cwiseEqual() [1/2]

template<typename Derived>

template<typename OtherDerived >

EIGEN_DEVICE_FUNC const CwiseBinaryOp<numext::equal_to<Scalar>, const Derived, const OtherDerived> Eigen::SparseMatrixBase< Derived >::cwiseEqual ( const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > & other ) const

inline

Returns: an expression of the coefficient-wise == operator of *this and other

Warning: this performs an exact comparison, which is generally a bad idea with floating-point types. In order to check for equality between two vectors or matrices with floating-point coefficients, it is generally a far better idea to use a fuzzy comparison as provided by isApprox() and isMuchSmallerThan().

Example:

MatrixXi m(2,2);
m << 1, 0,
     1, 1;
cout << "Comparing m with identity matrix:" << endl;
cout << m.cwiseEqual(MatrixXi::Identity(2,2)) << endl;
Index count = m.cwiseEqual(MatrixXi::Identity(2,2)).count();
cout << "Number of coefficients that are equal: " << count << endl;

Output:

See also: cwiseNotEqual(), isApprox(), isMuchSmallerThan()

Definition at line 44 of file SparseMatrixBase.h.

◆ cwiseEqual() [2/2]

template<typename Derived>

EIGEN_DEVICE_FUNC const CwiseScalarEqualReturnType Eigen::SparseMatrixBase< Derived >::cwiseEqual ( const Scalar & s ) const

inline

Returns: an expression of the coefficient-wise == operator of *this and a scalar s

Warning: this performs an exact comparison, which is generally a bad idea with floating-point types. In order to check for equality between two vectors or matrices with floating-point coefficients, it is generally a far better idea to use a fuzzy comparison as provided by isApprox() and isMuchSmallerThan().

See also: cwiseEqual(const MatrixBase<OtherDerived> &) const

Definition at line 150 of file SparseMatrixBase.h.

◆ cwiseInverse()

template<typename Derived>

EIGEN_DEVICE_FUNC const CwiseInverseReturnType Eigen::SparseMatrixBase< Derived >::cwiseInverse ( ) const

inline

Returns: an expression of the coefficient-wise inverse of *this.

Example:

MatrixXd m(2,3);
m << 2, 0.5, 1,   
     3, 0.25, 1;
cout << m.cwiseInverse() << endl;

Output:

See also: cwiseProduct()

Definition at line 85 of file SparseMatrixBase.h.

◆ cwiseMax() [1/2]

template<typename Derived>

template<typename OtherDerived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp<internal::scalar_max_op<Scalar,Scalar>, const Derived, const OtherDerived> Eigen::SparseMatrixBase< Derived >::cwiseMax ( const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > & other ) const

inline

Returns: an expression of the coefficient-wise max of *this and other

Example:

Vector3d v(2,3,4), w(4,2,3);

cout << v.cwiseMax(w) << endl;

Output:

See also: class CwiseBinaryOp, min()

Definition at line 105 of file SparseMatrixBase.h.

◆ cwiseMax() [2/2]

template<typename Derived>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp<internal::scalar_max_op<Scalar,Scalar>, const Derived, const ConstantReturnType> Eigen::SparseMatrixBase< Derived >::cwiseMax ( const Scalar & other ) const

inline

Returns: an expression of the coefficient-wise max of *this and scalar other

See also: class CwiseBinaryOp, min()

Definition at line 116 of file SparseMatrixBase.h.

◆ cwiseMin() [1/2]

template<typename Derived>

template<typename OtherDerived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp<internal::scalar_min_op<Scalar,Scalar>, const Derived, const OtherDerived> Eigen::SparseMatrixBase< Derived >::cwiseMin ( const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > & other ) const

inline

Returns: an expression of the coefficient-wise min of *this and other

Example:

Vector3d v(2,3,4), w(4,2,3);

cout << v.cwiseMin(w) << endl;

Output:

See also: class CwiseBinaryOp, max()

Definition at line 79 of file SparseMatrixBase.h.

◆ cwiseMin() [2/2]

template<typename Derived>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp<internal::scalar_min_op<Scalar,Scalar>, const Derived, const ConstantReturnType> Eigen::SparseMatrixBase< Derived >::cwiseMin ( const Scalar & other ) const

inline

Returns: an expression of the coefficient-wise min of *this and scalar other

See also: class CwiseBinaryOp, min()

Definition at line 90 of file SparseMatrixBase.h.

◆ cwiseNotEqual()

template<typename Derived>

template<typename OtherDerived >

EIGEN_DEVICE_FUNC const CwiseBinaryOp<numext::not_equal_to<Scalar>, const Derived, const OtherDerived> Eigen::SparseMatrixBase< Derived >::cwiseNotEqual ( const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > & other ) const

inline

Returns: an expression of the coefficient-wise != operator of *this and other

Warning: this performs an exact comparison, which is generally a bad idea with floating-point types. In order to check for equality between two vectors or matrices with floating-point coefficients, it is generally a far better idea to use a fuzzy comparison as provided by isApprox() and isMuchSmallerThan().

Example:

MatrixXi m(2,2);
m << 1, 0,
     1, 1;
cout << "Comparing m with identity matrix:" << endl;
cout << m.cwiseNotEqual(MatrixXi::Identity(2,2)) << endl;
Index count = m.cwiseNotEqual(MatrixXi::Identity(2,2)).count();
cout << "Number of coefficients that are not equal: " << count << endl;

Output:

See also: cwiseEqual(), isApprox(), isMuchSmallerThan()

Definition at line 64 of file SparseMatrixBase.h.

◆ cwiseProduct() [1/2]

template<typename Derived>

template<typename OtherDerived >

EIGEN_STRONG_INLINE const CwiseProductDenseReturnType<OtherDerived>::Type Eigen::SparseMatrixBase< Derived >::cwiseProduct ( const MatrixBase< OtherDerived > & other ) const

◆ cwiseProduct() [2/2]

template<typename Derived>

template<typename OtherDerived >

EIGEN_STRONG_INLINE const SparseMatrixBase<Derived>::template CwiseProductDenseReturnType<OtherDerived>::Type Eigen::SparseMatrixBase< Derived >::cwiseProduct ( const MatrixBase< OtherDerived > & other ) const

Definition at line 687 of file SparseCwiseBinaryOp.h.

◆ cwiseQuotient()

template<typename Derived>

template<typename OtherDerived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp<internal::scalar_quotient_op<Scalar>, const Derived, const OtherDerived> Eigen::SparseMatrixBase< Derived >::cwiseQuotient ( const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > & other ) const

inline

Returns: an expression of the coefficient-wise quotient of *this and other

Example:

Vector3d v(2,3,4), w(4,2,3);

cout << v.cwiseQuotient(w) << endl;

Output:

See also: class CwiseBinaryOp, cwiseProduct(), cwiseInverse()

Definition at line 132 of file SparseMatrixBase.h.

◆ cwiseSign()

template<typename Derived>

EIGEN_DEVICE_FUNC const CwiseSignReturnType Eigen::SparseMatrixBase< Derived >::cwiseSign ( ) const

inline

Returns: an expression of the coefficient-wise signum of *this.

Example:

MatrixXd m(2,3);
m <<  2, -4, 6,
     -5,  1, 0;
cout << m.cwiseSign() << endl;

Output:

Definition at line 71 of file SparseMatrixBase.h.

◆ cwiseSqrt()

template<typename Derived>

EIGEN_DEVICE_FUNC const CwiseSqrtReturnType Eigen::SparseMatrixBase< Derived >::cwiseSqrt ( ) const

inline

Returns: an expression of the coefficient-wise square root of *this.

Example:

Vector3d v(1,2,4);

cout << v.cwiseSqrt() << endl;

Output:

See also: cwisePow(), cwiseSquare()

Definition at line 60 of file SparseMatrixBase.h.

◆ derived() [1/2]

template<typename Derived>

const Derived& Eigen::SparseMatrixBase< Derived >::derived ( ) const

inline

Definition at line 143 of file SparseMatrixBase.h.

◆ derived() [2/2]

template<typename Derived>

Derived& Eigen::SparseMatrixBase< Derived >::derived ( )

inline

Definition at line 144 of file SparseMatrixBase.h.

◆ dot() [1/4]

template<typename Derived>

template<typename OtherDerived >

internal::traits<Derived>::Scalar Eigen::SparseMatrixBase< Derived >::dot ( const MatrixBase< OtherDerived > & other ) const

Definition at line 18 of file SparseDot.h.

◆ dot() [2/4]

template<typename Derived>

template<typename OtherDerived >

internal::traits<Derived>::Scalar Eigen::SparseMatrixBase< Derived >::dot ( const SparseMatrixBase< OtherDerived > & other ) const

Definition at line 43 of file SparseDot.h.

◆ dot() [3/4]

template<typename Derived>

template<typename OtherDerived >

Scalar Eigen::SparseMatrixBase< Derived >::dot ( const MatrixBase< OtherDerived > & other ) const

◆ dot() [4/4]

template<typename Derived>

template<typename OtherDerived >

Scalar Eigen::SparseMatrixBase< Derived >::dot ( const SparseMatrixBase< OtherDerived > & other ) const

◆ EIGEN_CWISE_BINARY_RETURN_TYPE()

template<typename Derived>

template<typename OtherDerived >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const Eigen::SparseMatrixBase< Derived >::EIGEN_CWISE_BINARY_RETURN_TYPE	(	Derived	,
		OtherDerived	,
		product
	)		const &

inline

Returns: an expression of the Schur product (coefficient wise product) of *this and other

Example:

Matrix3i a = Matrix3i::Random(), b = Matrix3i::Random();
Matrix3i c = a.cwiseProduct(b);
cout << "a:\n" << a << "\nb:\n" << b << "\nc:\n" << c << endl;

Output:

See also: class CwiseBinaryOp, cwiseAbs2

Definition at line 23 of file SparseMatrixBase.h.

◆ eval()

template<typename Derived>

const internal::eval<Derived>::type Eigen::SparseMatrixBase< Derived >::eval ( ) const

inline

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

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

Definition at line 377 of file SparseMatrixBase.h.

◆ evalTo()

template<typename Derived>

template<typename Dest >

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

private

◆ head() [1/4]

template<typename Derived>

template<typename NType >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedSegmentReturnType<internal::get_fixed_value<NType>::value>::Type Eigen::SparseMatrixBase< 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 SparseMatrixBase.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::SparseMatrixBase< Derived >::head ( NType n ) const

inline

This is the const version of head(NType).

Definition at line 1224 of file SparseMatrixBase.h.

◆ head() [3/4]

template<typename Derived>

template<int N>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedSegmentReturnType<N>::Type Eigen::SparseMatrixBase< 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 SparseMatrixBase.h.

◆ head() [4/4]

template<typename Derived>

template<int N>

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

inline

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

Definition at line 1339 of file SparseMatrixBase.h.

◆ imag() [1/2]

template<typename Derived>

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

inline

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

See also: real()

Definition at line 110 of file SparseMatrixBase.h.

◆ imag() [2/2]

template<typename Derived>

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

inline

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

See also: real()

Definition at line 178 of file SparseMatrixBase.h.

◆ innerSize()

template<typename Derived>

Index Eigen::SparseMatrixBase< Derived >::innerSize ( ) const

inline

Returns: the size of the inner dimension according to the storage order, i.e., the number of rows for a columns major matrix, and the number of cols otherwise

Definition at line 192 of file SparseMatrixBase.h.

◆ innerVector() [1/2]

template<typename Derived>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE InnerVectorReturnType Eigen::SparseMatrixBase< 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 SparseMatrixBase.h.

◆ innerVector() [2/2]

template<typename Derived>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstInnerVectorReturnType Eigen::SparseMatrixBase< 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 SparseMatrixBase.h.

◆ innerVectors() [1/2]

template<typename Derived>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE InnerVectorsReturnType Eigen::SparseMatrixBase< 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 SparseMatrixBase.h.

◆ innerVectors() [2/2]

template<typename Derived>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstInnerVectorsReturnType Eigen::SparseMatrixBase< 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 SparseMatrixBase.h.

◆ isApprox() [1/2]

template<typename Derived >

template<typename OtherDerived >

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

Definition at line 17 of file SparseFuzzy.h.

◆ isApprox() [2/2]

template<typename Derived>

template<typename OtherDerived >

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

inline

Definition at line 368 of file SparseMatrixBase.h.

◆ isRValue()

template<typename Derived>

bool Eigen::SparseMatrixBase< Derived >::isRValue ( ) const

inline

Definition at line 194 of file SparseMatrixBase.h.

◆ isVector()

template<typename Derived>

bool Eigen::SparseMatrixBase< Derived >::isVector ( ) const

inline

Returns: true if either the number of rows or the number of columns is equal to 1. In other words, this function returns
rows()==1 || cols()==1

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

Definition at line 186 of file SparseMatrixBase.h.

◆ leftCols() [1/4]

template<typename Derived>

template<typename NColsType >

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE NColsBlockXpr<internal::get_fixed_value<NColsType>::value>::Type Eigen::SparseMatrixBase< 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 SparseMatrixBase.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::SparseMatrixBase< Derived >::leftCols ( NColsType n ) const

inline

This is the const version of leftCols(NColsType).

Definition at line 812 of file SparseMatrixBase.h.

◆ leftCols() [3/4]

template<typename Derived>

template<int N>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE NColsBlockXpr<N>::Type Eigen::SparseMatrixBase< 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 SparseMatrixBase.h.

◆ leftCols() [4/4]

template<typename Derived>

template<int N>

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

inline

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

Definition at line 843 of file SparseMatrixBase.h.

◆ markAsRValue()

template<typename Derived>

Derived& Eigen::SparseMatrixBase< Derived >::markAsRValue ( )

inline

Definition at line 195 of file SparseMatrixBase.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::SparseMatrixBase< 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 SparseMatrixBase.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::SparseMatrixBase< Derived >::middleCols	(	Index	startCol,
		NColsType	numCols
	)		const

inline

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

Definition at line 963 of file SparseMatrixBase.h.

◆ middleCols() [3/4]

template<typename Derived>

template<int N>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE NColsBlockXpr<N>::Type Eigen::SparseMatrixBase< 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 SparseMatrixBase.h.

◆ middleCols() [4/4]

template<typename Derived>

template<int N>

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

inline

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

Definition at line 995 of file SparseMatrixBase.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::SparseMatrixBase< 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 SparseMatrixBase.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::SparseMatrixBase< Derived >::middleRows	(	Index	startRow,
		NRowsType	n
	)		const

inline

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

Definition at line 736 of file SparseMatrixBase.h.

◆ middleRows() [3/4]

template<typename Derived>

template<int N>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE NRowsBlockXpr<N>::Type Eigen::SparseMatrixBase< 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 SparseMatrixBase.h.

◆ middleRows() [4/4]

template<typename Derived>

template<int N>

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

inline

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

Definition at line 768 of file SparseMatrixBase.h.

◆ norm()

template<typename Derived >

NumTraits< typename internal::traits< Derived >::Scalar >::Real Eigen::SparseMatrixBase< Derived >::norm ( ) const

inline

Definition at line 84 of file SparseDot.h.

◆ operator &&()

template<typename Derived>

template<typename OtherDerived >

EIGEN_DEVICE_FUNC const CwiseBinaryOp<internal::scalar_boolean_and_op, const Derived, const OtherDerived> Eigen::SparseMatrixBase< Derived >::operator&& ( const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > & other ) const

inline

Returns: an expression of the coefficient-wise boolean and operator of *this and other

Warning: this operator is for expression of bool only.

Example:

Array3d v(-1,2,1), w(-3,2,3);

cout << ((v<w) && (v<0)) << endl;

Output:

See also: operator||(), select()

Definition at line 92 of file SparseMatrixBase.h.

◆ operator*() [1/3]

template<typename Derived>

template<typename OtherDerived >

const Product<Derived,OtherDerived> Eigen::SparseMatrixBase< Derived >::operator* ( const DiagonalBase< OtherDerived > & other ) const

inline

Definition at line 302 of file SparseMatrixBase.h.

◆ operator*() [2/3]

template<typename Derived >

template<typename OtherDerived >

const Product< Derived, OtherDerived, AliasFreeProduct > Eigen::SparseMatrixBase< Derived >::operator* ( const SparseMatrixBase< OtherDerived > & other ) const

inline

Returns: an expression of the product of two sparse matrices. By default a conservative product preserving the symbolic non zeros is performed. The automatic pruning of the small values can be achieved by calling the pruned() function in which case a totally different product algorithm is employed:
C = (A*B).pruned(); // suppress numerical zeros (exact)
C = (A*B).pruned(ref);
C = (A*B).pruned(ref,epsilon);
where ref is a meaningful non zero reference value.

Definition at line 29 of file SparseProduct.h.

◆ operator*() [3/3]

template<typename Derived>

template<typename OtherDerived >

const Product<Derived,OtherDerived> Eigen::SparseMatrixBase< Derived >::operator* ( const MatrixBase< OtherDerived > & other ) const

inline

Definition at line 319 of file SparseMatrixBase.h.

◆ operator*=() [1/2]

template<typename Derived >

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

Definition at line 126 of file SparseCwiseUnaryOp.h.

◆ operator*=() [2/2]

template<typename Derived>

template<typename OtherDerived >

Derived& Eigen::SparseMatrixBase< Derived >::operator*= ( const SparseMatrixBase< OtherDerived > & other )

◆ operator+=() [1/4]

template<typename Derived>

template<typename OtherDerived >

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

◆ operator+=() [2/4]

template<typename Derived >

template<typename OtherDerived >

Derived & Eigen::SparseMatrixBase< Derived >::operator+= ( const DiagonalBase< OtherDerived > & other )

Definition at line 670 of file SparseCwiseBinaryOp.h.

◆ operator+=() [3/4]

template<typename Derived >

template<typename OtherDerived >

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

Definition at line 638 of file SparseCwiseBinaryOp.h.

◆ operator+=() [4/4]

template<typename Derived>

template<typename OtherDerived >

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

Definition at line 663 of file SparseCwiseBinaryOp.h.

◆ operator-()

template<typename Derived>

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

inline

Returns: an expression of the opposite of *this

Definition at line 46 of file SparseMatrixBase.h.

◆ operator-=() [1/4]

template<typename Derived>

template<typename OtherDerived >

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

◆ operator-=() [2/4]

template<typename Derived >

template<typename OtherDerived >

Derived & Eigen::SparseMatrixBase< Derived >::operator-= ( const DiagonalBase< OtherDerived > & other )

Definition at line 678 of file SparseCwiseBinaryOp.h.

◆ operator-=() [3/4]

template<typename Derived >

template<typename OtherDerived >

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

Definition at line 646 of file SparseCwiseBinaryOp.h.

◆ operator-=() [4/4]

template<typename Derived>

template<typename OtherDerived >

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

Definition at line 655 of file SparseCwiseBinaryOp.h.

◆ operator/=()

template<typename Derived >

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

Definition at line 138 of file SparseCwiseUnaryOp.h.

◆ operator=() [1/4]

template<typename Derived >

template<typename OtherDerived >

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

Definition at line 17 of file SparseAssign.h.

◆ operator=() [2/4]

template<typename Derived >

template<typename OtherDerived >

Derived & Eigen::SparseMatrixBase< Derived >::operator= ( const ReturnByValue< OtherDerived > & other )

Definition at line 25 of file SparseAssign.h.

◆ operator=() [3/4]

template<typename Derived >

template<typename OtherDerived >

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

inline

Definition at line 34 of file SparseAssign.h.

◆ operator=() [4/4]

template<typename Derived>

Derived & Eigen::SparseMatrixBase< Derived >::operator= ( const Derived & other )

inline

Definition at line 43 of file SparseAssign.h.

◆ operator||()

template<typename Derived>

template<typename OtherDerived >

EIGEN_DEVICE_FUNC const CwiseBinaryOp<internal::scalar_boolean_or_op, const Derived, const OtherDerived> Eigen::SparseMatrixBase< Derived >::operator|| ( const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > & other ) const

inline

Returns: an expression of the coefficient-wise boolean or operator of *this and other

Warning: this operator is for expression of bool only.

Example:

Array3d v(-1,2,1), w(-3,2,3);

cout << ((v<w) || (v<0)) << endl;

Output:

See also: operator&&(), select()

Definition at line 111 of file SparseMatrixBase.h.

◆ outerSize()

template<typename Derived>

Index Eigen::SparseMatrixBase< Derived >::outerSize ( ) const

inline

Returns: the size of the storage major dimension, i.e., the number of columns for a columns major matrix, and the number of rows otherwise

Definition at line 189 of file SparseMatrixBase.h.

◆ pruned()

template<typename Derived >

const SparseView< Derived > Eigen::SparseMatrixBase< Derived >::pruned	(	const Scalar &	reference = `Scalar(0)`,
		const RealScalar &	epsilon = `NumTraits<Scalar>::dummy_precision()`
	)		const

inline

Returns: an expression of *this with values smaller than reference * epsilon removed.

This method is typically used in conjunction with the product of two sparse matrices to automatically prune the smallest values as follows:

C = (A*B).pruned();             // suppress numerical zeros (exact)
C = (A*B).pruned(ref);
C = (A*B).pruned(ref,epsilon);

where ref is a meaningful non zero reference value.

Definition at line 246 of file SparseView.h.

◆ real() [1/2]

template<typename Derived>

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

inline

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

See also: imag()

Definition at line 101 of file SparseMatrixBase.h.

◆ real() [2/2]

template<typename Derived>

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

inline

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

See also: imag()

Definition at line 169 of file SparseMatrixBase.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::SparseMatrixBase< 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 SparseMatrixBase.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::SparseMatrixBase< Derived >::rightCols ( NColsType n ) const

inline

This is the const version of rightCols(NColsType).

Definition at line 887 of file SparseMatrixBase.h.

◆ rightCols() [3/4]

template<typename Derived>

template<int N>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE NColsBlockXpr<N>::Type Eigen::SparseMatrixBase< 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 SparseMatrixBase.h.

◆ rightCols() [4/4]

template<typename Derived>

template<int N>

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

inline

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

Definition at line 918 of file SparseMatrixBase.h.

◆ row() [1/2]

template<typename Derived>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE RowXpr Eigen::SparseMatrixBase< 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 SparseMatrixBase.h.

◆ row() [2/2]

template<typename Derived>

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

inline

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

Definition at line 1126 of file SparseMatrixBase.h.

◆ rows()

template<typename Derived>

Index Eigen::SparseMatrixBase< Derived >::rows ( void ) const

inline

Returns: the number of rows.

See also: cols()

Definition at line 176 of file SparseMatrixBase.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::SparseMatrixBase< 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 SparseMatrixBase.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::SparseMatrixBase< Derived >::segment	(	Index	start,
		NType	n
	)		const

inline

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

Definition at line 1175 of file SparseMatrixBase.h.

◆ segment() [3/4]

template<typename Derived>

template<int N>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedSegmentReturnType<N>::Type Eigen::SparseMatrixBase< 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 SparseMatrixBase.h.

◆ segment() [4/4]

template<typename Derived>

template<int N>

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

inline

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

Definition at line 1307 of file SparseMatrixBase.h.

◆ selfadjointView() [1/4]

template<typename Derived>

template<unsigned int UpLo>

SparseMatrixBase<Derived>::template ConstSelfAdjointViewReturnType<UpLo>::Type Eigen::SparseMatrixBase< Derived >::selfadjointView ( ) const

Definition at line 178 of file SparseSelfAdjointView.h.

◆ selfadjointView() [2/4]

template<typename Derived>

template<unsigned int UpLo>

SparseMatrixBase<Derived>::template SelfAdjointViewReturnType<UpLo>::Type Eigen::SparseMatrixBase< Derived >::selfadjointView ( )

Definition at line 185 of file SparseSelfAdjointView.h.

◆ selfadjointView() [3/4]

template<typename Derived>

template<unsigned int UpLo>

ConstSelfAdjointViewReturnType<UpLo>::Type Eigen::SparseMatrixBase< Derived >::selfadjointView ( ) const

inline

◆ selfadjointView() [4/4]

template<typename Derived>

template<unsigned int UpLo>

SelfAdjointViewReturnType<UpLo>::Type Eigen::SparseMatrixBase< Derived >::selfadjointView ( )

inline

◆ size()

template<typename Derived>

Index Eigen::SparseMatrixBase< Derived >::size ( ) const

inline

Returns: the number of coefficients, which is rows()*cols().

See also: rows(), cols().

Definition at line 181 of file SparseMatrixBase.h.

◆ squaredNorm()

template<typename Derived >

NumTraits< typename internal::traits< Derived >::Scalar >::Real Eigen::SparseMatrixBase< Derived >::squaredNorm ( ) const

inline

Definition at line 77 of file SparseDot.h.

◆ subVector() [1/2]

template<typename Derived>

template<DirectionType Direction>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE internal::conditional<Direction==Vertical,ColXpr,RowXpr>::type Eigen::SparseMatrixBase< 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 SparseMatrixBase.h.

◆ subVector() [2/2]

template<typename Derived>

template<DirectionType Direction>

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

inline

This is the const version of subVector(Index)

Definition at line 1432 of file SparseMatrixBase.h.

◆ subVectors()

template<typename Derived>

template<DirectionType Direction>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR Index Eigen::SparseMatrixBase< 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 SparseMatrixBase.h.

◆ sum()

template<typename Derived >

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

Definition at line 17 of file SparseRedux.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::SparseMatrixBase< 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 SparseMatrixBase.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::SparseMatrixBase< Derived >::tail ( NType n ) const

inline

This is the const version of tail(Index).

Definition at line 1273 of file SparseMatrixBase.h.

◆ tail() [3/4]

template<typename Derived>

template<int N>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedSegmentReturnType<N>::Type Eigen::SparseMatrixBase< 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 SparseMatrixBase.h.

◆ tail() [4/4]

template<typename Derived>

template<int N>

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

inline

This is the const version of tail<int>.

Definition at line 1371 of file SparseMatrixBase.h.

◆ toDense()

template<typename Derived>

DenseMatrixType Eigen::SparseMatrixBase< Derived >::toDense ( ) const

inline

Definition at line 358 of file SparseMatrixBase.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::SparseMatrixBase< 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 SparseMatrixBase.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::SparseMatrixBase< Derived >::topLeftCorner	(	NRowsType	cRows,
		NColsType	cCols
	)		const

inline

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

Definition at line 264 of file SparseMatrixBase.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::SparseMatrixBase< 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 SparseMatrixBase.h.

◆ topLeftCorner() [4/6]

template<typename Derived>

template<int CRows, int CCols>

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

inline

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

Definition at line 291 of file SparseMatrixBase.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::SparseMatrixBase< 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 SparseMatrixBase.h.

◆ topLeftCorner() [6/6]

template<typename Derived>

template<int CRows, int CCols>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedBlockXpr<CRows,CCols>::Type Eigen::SparseMatrixBase< 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 SparseMatrixBase.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::SparseMatrixBase< 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 SparseMatrixBase.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::SparseMatrixBase< Derived >::topRightCorner	(	NRowsType	cRows,
		NColsType	cCols
	)		const

inline

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

Definition at line 157 of file SparseMatrixBase.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::SparseMatrixBase< 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 SparseMatrixBase.h.

◆ topRightCorner() [4/6]

template<typename Derived>

template<int CRows, int CCols>

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

inline

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

Definition at line 185 of file SparseMatrixBase.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::SparseMatrixBase< 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 SparseMatrixBase.h.

◆ topRightCorner() [6/6]

template<typename Derived>

template<int CRows, int CCols>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedBlockXpr<CRows,CCols>::Type Eigen::SparseMatrixBase< 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 SparseMatrixBase.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::SparseMatrixBase< 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 SparseMatrixBase.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::SparseMatrixBase< Derived >::topRows ( NRowsType n ) const

inline

This is the const version of topRows(NRowsType).

Definition at line 585 of file SparseMatrixBase.h.

◆ topRows() [3/4]

template<typename Derived>

template<int N>

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE NRowsBlockXpr<N>::Type Eigen::SparseMatrixBase< 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 SparseMatrixBase.h.

◆ topRows() [4/4]

template<typename Derived>

template<int N>

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

inline

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

Definition at line 616 of file SparseMatrixBase.h.

◆ transpose() [1/2]

template<typename Derived>

TransposeReturnType Eigen::SparseMatrixBase< Derived >::transpose ( )

inline

Definition at line 354 of file SparseMatrixBase.h.

◆ transpose() [2/2]

template<typename Derived>

const ConstTransposeReturnType Eigen::SparseMatrixBase< Derived >::transpose ( ) const

inline

Definition at line 355 of file SparseMatrixBase.h.

◆ triangularView()

template<typename Derived >

template<int Mode>

const TriangularView< const Derived, Mode > Eigen::SparseMatrixBase< Derived >::triangularView ( ) const

inline

Definition at line 182 of file SparseTriangularView.h.

◆ twistedBy()

template<typename Derived>

SparseSymmetricPermutationProduct<Derived,Upper|Lower> Eigen::SparseMatrixBase< Derived >::twistedBy ( const PermutationMatrix< Dynamic, Dynamic, StorageIndex > & perm ) const

inline

Returns: an expression of P H P^-1 where H is the matrix represented by *this

Definition at line 329 of file SparseMatrixBase.h.

◆ unaryExpr()

template<typename Derived>

template<typename CustomUnaryOp >

EIGEN_DEVICE_FUNC const CwiseUnaryOp<CustomUnaryOp, const Derived> Eigen::SparseMatrixBase< 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 SparseMatrixBase.h.

◆ unaryViewExpr()

template<typename Derived>

template<typename CustomViewOp >

EIGEN_DEVICE_FUNC const CwiseUnaryView<CustomViewOp, const Derived> Eigen::SparseMatrixBase< 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 SparseMatrixBase.h.

Friends And Related Function Documentation

◆ operator* [1/2]

template<typename Derived>

template<typename OtherDerived >

const Product<OtherDerived,Derived> operator*	(	const DiagonalBase< OtherDerived > &	lhs,
		const SparseMatrixBase< Derived > &	rhs
	)

friend

Definition at line 308 of file SparseMatrixBase.h.

◆ operator* [2/2]

template<typename Derived>

template<typename OtherDerived >

const Product<OtherDerived,Derived> operator*	(	const MatrixBase< OtherDerived > &	lhs,
		const SparseMatrixBase< Derived > &	rhs
	)

friend

Definition at line 325 of file SparseMatrixBase.h.

◆ operator<<

template<typename Derived>

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

friend

Definition at line 218 of file SparseMatrixBase.h.

Member Data Documentation

◆ m_isRValue

template<typename Derived>

bool Eigen::SparseMatrixBase< Derived >::m_isRValue

protected

Definition at line 387 of file SparseMatrixBase.h.

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

Classes

Public Types

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Friends

Detailed Description

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

Member Typedef Documentation

◆ AdjointReturnType

◆ Base

◆ BlockXpr

◆ CoeffReturnType

◆ ColsBlockXpr

◆ ColXpr

◆ ConjugateReturnType

◆ ConstantReturnType

◆ ConstBlockXpr

◆ ConstColsBlockXpr

◆ ConstColXpr

◆ ConstInnerVectorReturnType

◆ ConstInnerVectorsReturnType

◆ ConstRowsBlockXpr

◆ ConstRowXpr

◆ ConstSegmentReturnType

◆ ConstTransposeReturnType

◆ CwiseAbs2ReturnType

◆ CwiseAbsReturnType

◆ CwiseArgReturnType

◆ CwiseInverseReturnType

◆ CwiseScalarEqualReturnType

◆ CwiseSignReturnType

◆ CwiseSqrtReturnType

◆ DenseMatrixType

◆ ImagReturnType

◆ IndexVector

◆ InnerVectorReturnType

◆ InnerVectorsReturnType

◆ NegativeReturnType

◆ NonConstImagReturnType

◆ NonConstRealReturnType

◆ PacketReturnType

◆ PacketScalar

◆ PlainObject

◆ RealReturnType

◆ RealScalar

◆ RowsBlockXpr

◆ RowXpr

◆ Scalar

◆ ScalarVector

◆ SegmentReturnType

◆ SquareMatrixType

◆ StorageBaseType

◆ StorageIndex

◆ StorageKind

◆ TransposeReturnType

◆ value_type

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ SparseMatrixBase()

Member Function Documentation

◆ adjoint()

◆ assign()

◆ assignGeneric()

◆ binaryExpr()

◆ block() [1/6]

◆ block() [2/6]

◆ block() [3/6]

◆ block() [4/6]

◆ block() [5/6]

◆ block() [6/6]

◆ blueNorm()

◆ bottomLeftCorner() [1/6]

◆ bottomLeftCorner() [2/6]

◆ bottomLeftCorner() [3/6]

◆ bottomLeftCorner() [4/6]

◆ bottomLeftCorner() [5/6]

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