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

#include <SparseMatrixBase.h>

Inheritance diagram for Eigen::SparseMatrixBase< Derived >:

Classes
struct	ConstFixedSegmentReturnType

struct	ConstNColsBlockXpr

struct	ConstNRowsBlockXpr

struct	CwiseProductDenseReturnType

struct	FixedSegmentReturnType

struct	NColsBlockXpr

struct	NRowsBlockXpr

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

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

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

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

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

typedef internal::add_const_on_value_type_if_arithmetic< typename internal::packet_traits< Scalar >::type >::type	PacketReturnType

typedef SparseMatrixBase	StorageBaseType

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

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

typedef NumTraits< Scalar >::Real	RealScalar
	This is the "real scalar" type; if the Scalar type is already real numbers (e.g. More...

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

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

typedef Matrix< Scalar, EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime), EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime)>	SquareMatrixType
	type of the equivalent square matrix

typedef internal::special_scalar_op_base< Derived, Scalar, RealScalar, EigenBase< Derived > >	Base

typedef CwiseUnaryOp< internal::scalar_multiple_op< Scalar >, const Derived >	ScalarMultipleReturnType

typedef CwiseUnaryOp< internal::scalar_quotient1_op< Scalar >, const Derived >	ScalarQuotient1ReturnType

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

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

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

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

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

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

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

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

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

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

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

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

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

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

typedef VectorBlock< Derived >	SegmentReturnType

typedef const VectorBlock< const Derived >	ConstSegmentReturnType

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

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

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

typedef Block< const Derived, Dynamic, Dynamic, true >	ConstInnerVectorsReturnType

Public Types inherited from Eigen::EigenBase< Derived >
typedef internal::traits< Derived >::StorageKind	StorageKind

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

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

const Derived &	derived () const

Derived &	derived ()

Derived &	const_cast_derived () const

const CwiseUnaryOp< internal::scalar_opposite_op< typename internal::traits< Derived >::Scalar >, const Derived >	operator- () const

const ScalarMultipleReturnType	operator* (const Scalar &scalar) const

const CwiseUnaryOp< internal::scalar_quotient1_op< typename internal::traits< Derived >::Scalar >, const Derived >	operator/ (const Scalar &scalar) const

const CwiseUnaryOp< internal::scalar_multiple2_op< Scalar, std::complex< Scalar > >, const Derived >	operator* (const std::complex< Scalar > &scalar) const
	Overloaded for efficient real matrix times complex scalar value.

template<typename NewType >
internal::cast_return_type< Derived, const CwiseUnaryOp< internal::scalar_cast_op< typename internal::traits< Derived >::Scalar, NewType >, const Derived > >::type	cast () const

ConjugateReturnType	conjugate () const

RealReturnType	real () const

const ImagReturnType	imag () const

template<typename CustomUnaryOp >
const CwiseUnaryOp< CustomUnaryOp, const Derived >	unaryExpr (const CustomUnaryOp &func=CustomUnaryOp()) const
	Apply a unary operator coefficient-wise. More...

template<typename CustomViewOp >
const CwiseUnaryView< CustomViewOp, const Derived >	unaryViewExpr (const CustomViewOp &func=CustomViewOp()) const

NonConstRealReturnType	real ()

NonConstImagReturnType	imag ()

template<typename CustomBinaryOp , typename OtherDerived >
EIGEN_STRONG_INLINE const CwiseBinaryOp< CustomBinaryOp, const Derived, const OtherDerived >	binaryExpr (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other, const CustomBinaryOp &func=CustomBinaryOp()) const

EIGEN_STRONG_INLINE const CwiseUnaryOp< internal::scalar_abs_op< Scalar >, const Derived >	cwiseAbs () const

EIGEN_STRONG_INLINE const CwiseUnaryOp< internal::scalar_abs2_op< Scalar >, const Derived >	cwiseAbs2 () const

const CwiseUnaryOp< internal::scalar_sqrt_op< Scalar >, const Derived >	cwiseSqrt () const

const CwiseUnaryOp< internal::scalar_inverse_op< Scalar >, const Derived >	cwiseInverse () const

template<typename OtherDerived >
EIGEN_STRONG_INLINE const	EIGEN_CWISE_PRODUCT_RETURN_TYPE (Derived, OtherDerived) cwiseProduct(const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const

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

template<typename OtherDerived >
const CwiseBinaryOp< std::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 CwiseBinaryOp< internal::scalar_min_op< Scalar >, const Derived, const OtherDerived >	cwiseMin (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const

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

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

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

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

const CwiseScalarEqualReturnType	cwiseEqual (const Scalar &s) const

Block< Derived >	block (Index startRow, Index startCol, Index blockRows, Index blockCols)

const Block< const Derived >	block (Index startRow, Index startCol, Index blockRows, Index blockCols) const
	This is the const version of block(Index,Index,Index,Index). More...

Block< Derived >	topRightCorner (Index cRows, Index cCols)

const Block< const Derived >	topRightCorner (Index cRows, Index cCols) const
	This is the const version of topRightCorner(Index, Index). More...

template<int CRows, int CCols>
Block< Derived, CRows, CCols >	topRightCorner ()

template<int CRows, int CCols>
const Block< const Derived, CRows, CCols >	topRightCorner () const
	This is the const version of topRightCorner<int, int>(). More...

template<int CRows, int CCols>
Block< Derived, CRows, CCols >	topRightCorner (Index cRows, Index cCols)

template<int CRows, int CCols>
const Block< const Derived, CRows, CCols >	topRightCorner (Index cRows, Index cCols) const
	This is the const version of topRightCorner<int, int>(Index, Index). More...

Block< Derived >	topLeftCorner (Index cRows, Index cCols)

const Block< const Derived >	topLeftCorner (Index cRows, Index cCols) const
	This is the const version of topLeftCorner(Index, Index). More...

template<int CRows, int CCols>
Block< Derived, CRows, CCols >	topLeftCorner ()

template<int CRows, int CCols>
const Block< const Derived, CRows, CCols >	topLeftCorner () const
	This is the const version of topLeftCorner<int, int>(). More...

template<int CRows, int CCols>
Block< Derived, CRows, CCols >	topLeftCorner (Index cRows, Index cCols)

template<int CRows, int CCols>
const Block< const Derived, CRows, CCols >	topLeftCorner (Index cRows, Index cCols) const
	This is the const version of topLeftCorner<int, int>(Index, Index). More...

Block< Derived >	bottomRightCorner (Index cRows, Index cCols)

const Block< const Derived >	bottomRightCorner (Index cRows, Index cCols) const
	This is the const version of bottomRightCorner(Index, Index). More...

template<int CRows, int CCols>
Block< Derived, CRows, CCols >	bottomRightCorner ()

template<int CRows, int CCols>
const Block< const Derived, CRows, CCols >	bottomRightCorner () const
	This is the const version of bottomRightCorner<int, int>(). More...

template<int CRows, int CCols>
Block< Derived, CRows, CCols >	bottomRightCorner (Index cRows, Index cCols)

template<int CRows, int CCols>
const Block< const Derived, CRows, CCols >	bottomRightCorner (Index cRows, Index cCols) const
	This is the const version of bottomRightCorner<int, int>(Index, Index). More...

Block< Derived >	bottomLeftCorner (Index cRows, Index cCols)

const Block< const Derived >	bottomLeftCorner (Index cRows, Index cCols) const
	This is the const version of bottomLeftCorner(Index, Index). More...

template<int CRows, int CCols>
Block< Derived, CRows, CCols >	bottomLeftCorner ()

template<int CRows, int CCols>
const Block< const Derived, CRows, CCols >	bottomLeftCorner () const
	This is the const version of bottomLeftCorner<int, int>(). More...

template<int CRows, int CCols>
Block< Derived, CRows, CCols >	bottomLeftCorner (Index cRows, Index cCols)

template<int CRows, int CCols>
const Block< const Derived, CRows, CCols >	bottomLeftCorner (Index cRows, Index cCols) const
	This is the const version of bottomLeftCorner<int, int>(Index, Index). More...

RowsBlockXpr	topRows (Index n)

ConstRowsBlockXpr	topRows (Index n) const
	This is the const version of topRows(Index). More...

template<int N>
NRowsBlockXpr< N >::Type	topRows (Index n=N)

template<int N>
ConstNRowsBlockXpr< N >::Type	topRows (Index n=N) const
	This is the const version of topRows<int>(). More...

RowsBlockXpr	bottomRows (Index n)

ConstRowsBlockXpr	bottomRows (Index n) const
	This is the const version of bottomRows(Index). More...

template<int N>
NRowsBlockXpr< N >::Type	bottomRows (Index n=N)

template<int N>
ConstNRowsBlockXpr< N >::Type	bottomRows (Index n=N) const
	This is the const version of bottomRows<int>(). More...

RowsBlockXpr	middleRows (Index startRow, Index n)

ConstRowsBlockXpr	middleRows (Index startRow, Index n) const
	This is the const version of middleRows(Index,Index). More...

template<int N>
NRowsBlockXpr< N >::Type	middleRows (Index startRow, Index n=N)

template<int N>
ConstNRowsBlockXpr< N >::Type	middleRows (Index startRow, Index n=N) const
	This is the const version of middleRows<int>(). More...

ColsBlockXpr	leftCols (Index n)

ConstColsBlockXpr	leftCols (Index n) const
	This is the const version of leftCols(Index). More...

template<int N>
NColsBlockXpr< N >::Type	leftCols (Index n=N)

template<int N>
ConstNColsBlockXpr< N >::Type	leftCols (Index n=N) const
	This is the const version of leftCols<int>(). More...

ColsBlockXpr	rightCols (Index n)

ConstColsBlockXpr	rightCols (Index n) const
	This is the const version of rightCols(Index). More...

template<int N>
NColsBlockXpr< N >::Type	rightCols (Index n=N)

template<int N>
ConstNColsBlockXpr< N >::Type	rightCols (Index n=N) const
	This is the const version of rightCols<int>(). More...

ColsBlockXpr	middleCols (Index startCol, Index numCols)

ConstColsBlockXpr	middleCols (Index startCol, Index numCols) const
	This is the const version of middleCols(Index,Index). More...

template<int N>
NColsBlockXpr< N >::Type	middleCols (Index startCol, Index n=N)

template<int N>
ConstNColsBlockXpr< N >::Type	middleCols (Index startCol, Index n=N) const
	This is the const version of middleCols<int>(). More...

template<int BlockRows, int BlockCols>
Block< Derived, BlockRows, BlockCols >	block (Index startRow, Index startCol)

template<int BlockRows, int BlockCols>
const Block< const Derived, BlockRows, BlockCols >	block (Index startRow, Index startCol) const
	This is the const version of block<>(Index, Index). More...

template<int BlockRows, int BlockCols>
Block< Derived, BlockRows, BlockCols >	block (Index startRow, Index startCol, Index blockRows, Index blockCols)

template<int BlockRows, int BlockCols>
const Block< const Derived, BlockRows, BlockCols >	block (Index startRow, Index startCol, Index blockRows, Index blockCols) const
	This is the const version of block<>(Index, Index, Index, Index). More...

ColXpr	col (Index i)

ConstColXpr	col (Index i) const
	This is the const version of col(). More...

RowXpr	row (Index i)

ConstRowXpr	row (Index i) const
	This is the const version of row(). More...

SegmentReturnType	segment (Index start, Index n)

ConstSegmentReturnType	segment (Index start, Index n) const
	This is the const version of segment(Index,Index). More...

SegmentReturnType	head (Index n)

ConstSegmentReturnType	head (Index n) const
	This is the const version of head(Index). More...

SegmentReturnType	tail (Index n)

ConstSegmentReturnType	tail (Index n) const
	This is the const version of tail(Index). More...

template<int N>
FixedSegmentReturnType< N >::Type	segment (Index start, Index n=N)

template<int N>
ConstFixedSegmentReturnType< N >::Type	segment (Index start, Index n=N) const
	This is the const version of segment<int>(Index). More...

template<int N>
FixedSegmentReturnType< N >::Type	head (Index n=N)

template<int N>
ConstFixedSegmentReturnType< N >::Type	head (Index n=N) const
	This is the const version of head<int>(). More...

template<int N>
FixedSegmentReturnType< N >::Type	tail (Index n=N)

template<int N>
ConstFixedSegmentReturnType< N >::Type	tail (Index n=N) const
	This is the const version of tail<int>. More...

Index	rows () const

Index	cols () const

Index	size () const

Index	nonZeros () const

bool	isVector () const

Index	outerSize () const

Index	innerSize () const

bool	isRValue () const

Derived &	markAsRValue ()

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 Lhs , typename Rhs >
Derived &	operator= (const SparseSparseProduct< Lhs, Rhs > &product)

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

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

Derived &	*operator=** (const Scalar &other)

Derived &	operator/= (const Scalar &other)

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

template<typename OtherDerived >
const SparseSparseProductReturnType< Derived, OtherDerived >::Type	operator* (const SparseMatrixBase< OtherDerived > &other) const

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

template<typename OtherDerived >
const SparseDenseProductReturnType< Derived, OtherDerived >::Type	operator* (const MatrixBase< OtherDerived > &other) const
	sparse * dense (returns a dense object unless it is an outer product)

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

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

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

template<unsigned int UpLo>
const SparseSelfAdjointView< Derived, UpLo >	selfadjointView () const

template<unsigned int UpLo>
SparseSelfAdjointView< Derived, UpLo >	selfadjointView ()

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

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

RealScalar	squaredNorm () const

RealScalar	norm () const

RealScalar	blueNorm () const

Transpose< Derived >	transpose ()

const Transpose< const Derived >	transpose () const

const AdjointReturnType	adjoint () const

InnerVectorReturnType	innerVector (Index outer)

const ConstInnerVectorReturnType	innerVector (Index outer) const

InnerVectorsReturnType	innerVectors (Index outerStart, Index outerSize)

const ConstInnerVectorsReturnType	innerVectors (Index outerStart, Index outerSize) const

template<typename DenseDerived >
void	evalTo (MatrixBase< DenseDerived > &dst) const

Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTime >	toDense () 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

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

Scalar	sum () const

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

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

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

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

Public Member Functions inherited from Eigen::internal::special_scalar_op_base< Derived, internal::traits< Derived >::Scalar, NumTraits< internal::traits< Derived >::Scalar >::Real, EigenBase< Derived > >
void	operator* () const

Public Member Functions inherited from Eigen::EigenBase< Derived >
Derived &	derived ()

const Derived &	derived () const

Derived &	const_cast_derived () const

const Derived &	const_derived () const

Index	rows () const

Index	cols () const

Index	size () const

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

template<typename Dest >
void	addTo (Dest &dst) const

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

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

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

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

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

Protected Attributes
bool	m_isRValue

Friends
const ScalarMultipleReturnType	operator* (const Scalar &scalar, const StorageBaseType &matrix)

const CwiseUnaryOp< internal::scalar_multiple2_op< Scalar, std::complex< Scalar > >, const Derived >	operator* (const std::complex< Scalar > &scalar, const StorageBaseType &matrix)

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

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

template<typename OtherDerived >
const DenseSparseProductReturnType< OtherDerived, Derived >::Type	operator* (const MatrixBase< OtherDerived > &lhs, const Derived &rhs)
	dense * sparse (return a dense object unless it is an outer product)

Detailed Description

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

Base class of any sparse matrices or sparse expressions.

Template Parameters

Derived This class can be extended with the help of the plugin mechanism described on the page Customizing/Extending Eigen by defining the preprocessor symbol EIGEN_SPARSEMATRIXBASE_PLUGIN.

Member Typedef Documentation

§ 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

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
IsVectorAtCompileTime	This is set to true if either the number of rows or the number of columns is known at compile-time to be equal to 1. Indeed, in that case, we are dealing with a column-vector (if there is only one column) or with a row-vector (if there is only one row).
Flags	This stores expression Flags flags which may or may not be inherited by new expressions constructed from this one. See the list of flags.
CoeffReadCost	This is a rough measure of how expensive it is to read one coefficient from this expression.

Member Function Documentation

§ binaryExpr()

template<typename Derived>

template<typename CustomBinaryOp , typename OtherDerived >

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:

Output:

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

§ block() [1/6]

template<typename Derived>

Block<Derived> Eigen::SparseMatrixBase< Derived >::block	(	Index	startRow,
		Index	startCol,
		Index	blockRows,
		Index	blockCols
	)

inline

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

Parameters

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

Example:

Output:

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

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

§ block() [2/6]

template<typename Derived>

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

§ block() [3/6]

template<typename Derived>

template<int BlockRows, int BlockCols>

Block<Derived, BlockRows, BlockCols> Eigen::SparseMatrixBase< Derived >::block	(	Index	startRow,
		Index	startCol
	)

inline

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

The template parameters BlockRows and BlockCols are the number of rows and columns in the block.

Parameters

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

Example:

Output:

Note: since block is a templated member, the keyword template has to be used if the matrix type is also a template parameter:
m.template block<3,3>(1,1);

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

§ block() [4/6]

template<typename Derived>

template<int BlockRows, int BlockCols>

const Block<const Derived, BlockRows, BlockCols> Eigen::SparseMatrixBase< Derived >::block	(	Index	startRow,
		Index	startCol
	)		const

inline

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

§ block() [5/6]

template<typename Derived>

template<int BlockRows, int BlockCols>

Block<Derived, BlockRows, BlockCols> Eigen::SparseMatrixBase< Derived >::block	(	Index	startRow,
		Index	startCol,
		Index	blockRows,
		Index	blockCols
	)

inline

Returns: an expression of a block in *this.

Template Parameters

BlockRows	number of rows in block as specified at compile-time
BlockCols	number of columns in block as specified at compile-time

Parameters

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

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

Example:

Output:

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

§ block() [6/6]

template<typename Derived>

template<int BlockRows, int BlockCols>

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

§ bottomLeftCorner() [1/6]

template<typename Derived>

Block<Derived> Eigen::SparseMatrixBase< Derived >::bottomLeftCorner	(	Index	cRows,
		Index	cCols
	)

inline

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

Parameters

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

Example:

Output:

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

§ bottomLeftCorner() [2/6]

template<typename Derived>

const Block<const Derived> Eigen::SparseMatrixBase< Derived >::bottomLeftCorner	(	Index	cRows,
		Index	cCols
	)		const

inline

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

§ bottomLeftCorner() [3/6]

template<typename Derived>

template<int CRows, int CCols>

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

Output:

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

§ bottomLeftCorner() [4/6]

template<typename Derived>

template<int CRows, int CCols>

const Block<const Derived, CRows, CCols> Eigen::SparseMatrixBase< Derived >::bottomLeftCorner ( ) const

inline

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

§ bottomLeftCorner() [5/6]

template<typename Derived>

template<int CRows, int CCols>

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

Output:

See also: class Block

§ bottomLeftCorner() [6/6]

template<typename Derived>

template<int CRows, int CCols>

const Block<const Derived, CRows, CCols> Eigen::SparseMatrixBase< Derived >::bottomLeftCorner	(	Index	cRows,
		Index	cCols
	)		const

inline

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

§ bottomRightCorner() [1/6]

template<typename Derived>

Block<Derived> Eigen::SparseMatrixBase< Derived >::bottomRightCorner	(	Index	cRows,
		Index	cCols
	)

inline

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

Parameters

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

Example:

Output:

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

§ bottomRightCorner() [2/6]

template<typename Derived>

const Block<const Derived> Eigen::SparseMatrixBase< Derived >::bottomRightCorner	(	Index	cRows,
		Index	cCols
	)		const

inline

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

§ bottomRightCorner() [3/6]

template<typename Derived>

template<int CRows, int CCols>

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

Output:

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

§ bottomRightCorner() [4/6]

template<typename Derived>

template<int CRows, int CCols>

const Block<const Derived, CRows, CCols> Eigen::SparseMatrixBase< Derived >::bottomRightCorner ( ) const

inline

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

§ bottomRightCorner() [5/6]

template<typename Derived>

template<int CRows, int CCols>

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

Output:

See also: class Block

§ bottomRightCorner() [6/6]

template<typename Derived>

template<int CRows, int CCols>

const Block<const Derived, CRows, CCols> Eigen::SparseMatrixBase< Derived >::bottomRightCorner	(	Index	cRows,
		Index	cCols
	)		const

inline

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

§ bottomRows() [1/4]

template<typename Derived>

RowsBlockXpr Eigen::SparseMatrixBase< Derived >::bottomRows ( Index n )

inline

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

Parameters

n	the number of rows in the block

Example:

Output:

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

§ bottomRows() [2/4]

template<typename Derived>

ConstRowsBlockXpr Eigen::SparseMatrixBase< Derived >::bottomRows ( Index n ) const

inline

This is the const version of bottomRows(Index).

§ bottomRows() [3/4]

template<typename Derived>

template<int N>

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:

Output:

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

§ bottomRows() [4/4]

template<typename Derived>

template<int N>

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

inline

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

§ cast()

template<typename Derived>

template<typename NewType >

internal::cast_return_type<Derived,const CwiseUnaryOp<internal::scalar_cast_op<typename internal::traits<Derived>::Scalar, NewType>, const Derived> >::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

§ col() [1/2]

template<typename Derived>

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:

Output:

See also: row(), class Block

§ col() [2/2]

template<typename Derived>

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

inline

This is the const version of col().

§ cols()

template<typename Derived>

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

inline

Returns: the number of columns.

See also: rows()

§ conjugate()

template<typename Derived>

ConjugateReturnType Eigen::SparseMatrixBase< Derived >::conjugate ( void ) const

inline

Returns: an expression of the complex conjugate of *this.

See also: adjoint()

§ cwiseAbs()

template<typename Derived>

EIGEN_STRONG_INLINE const CwiseUnaryOp<internal::scalar_abs_op<Scalar>, const Derived> Eigen::SparseMatrixBase< Derived >::cwiseAbs ( ) const

inline

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

Example:

Output:

See also: cwiseAbs2()

§ cwiseAbs2()

template<typename Derived>

EIGEN_STRONG_INLINE const CwiseUnaryOp<internal::scalar_abs2_op<Scalar>, const Derived> Eigen::SparseMatrixBase< Derived >::cwiseAbs2 ( ) const

inline

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

Example:

Output:

See also: cwiseAbs()

§ cwiseEqual() [1/2]

template<typename Derived>

template<typename OtherDerived >

const CwiseBinaryOp<std::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:

Output:

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

§ cwiseEqual() [2/2]

template<typename Derived>

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

§ cwiseInverse()

template<typename Derived>

const CwiseUnaryOp<internal::scalar_inverse_op<Scalar>, const Derived> Eigen::SparseMatrixBase< Derived >::cwiseInverse ( ) const

inline

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

Example:

Output:

See also: cwiseProduct()

§ cwiseMax() [1/2]

template<typename Derived>

template<typename OtherDerived >

EIGEN_STRONG_INLINE const CwiseBinaryOp<internal::scalar_max_op<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:

Output:

See also: class CwiseBinaryOp, min()

§ cwiseMax() [2/2]

template<typename Derived>

EIGEN_STRONG_INLINE const CwiseBinaryOp<internal::scalar_max_op<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()

§ cwiseMin() [1/2]

template<typename Derived>

template<typename OtherDerived >

EIGEN_STRONG_INLINE const CwiseBinaryOp<internal::scalar_min_op<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:

Output:

See also: class CwiseBinaryOp, max()

§ cwiseMin() [2/2]

template<typename Derived>

EIGEN_STRONG_INLINE const CwiseBinaryOp<internal::scalar_min_op<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()

§ cwiseNotEqual()

template<typename Derived>

template<typename OtherDerived >

const CwiseBinaryOp<std::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:

Output:

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

§ cwiseQuotient()

template<typename Derived>

template<typename OtherDerived >

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:

Output:

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

§ cwiseSqrt()

template<typename Derived>

const CwiseUnaryOp<internal::scalar_sqrt_op<Scalar>, const Derived> Eigen::SparseMatrixBase< Derived >::cwiseSqrt ( ) const

inline

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

Example:

Output:

See also: cwisePow(), cwiseSquare()

§ EIGEN_CWISE_PRODUCT_RETURN_TYPE()

template<typename Derived>

template<typename OtherDerived >

EIGEN_STRONG_INLINE const Eigen::SparseMatrixBase< Derived >::EIGEN_CWISE_PRODUCT_RETURN_TYPE	(	Derived	,
		OtherDerived
	)		const

inline

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

Example:

Output:

See also: class CwiseBinaryOp, cwiseAbs2

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

§ head() [1/4]

template<typename Derived>

SegmentReturnType Eigen::SparseMatrixBase< Derived >::head ( Index n )

inline

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

Parameters

n	the number of coefficients in the segment

Example:

Output:

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

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

§ head() [2/4]

template<typename Derived>

ConstSegmentReturnType Eigen::SparseMatrixBase< Derived >::head ( Index n ) const

inline

This is the const version of head(Index).

§ head() [3/4]

template<typename Derived>

template<int N>

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:

Output:

See also: class Block

§ head() [4/4]

template<typename Derived>

template<int N>

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

inline

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

§ imag() [1/2]

template<typename Derived>

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

inline

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

See also: real()

§ imag() [2/2]

template<typename Derived>

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

inline

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

See also: real()

§ 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

§ innerVector() [1/2]

template<typename Derived >

SparseMatrixBase< Derived >::InnerVectorReturnType Eigen::SparseMatrixBase< Derived >::innerVector ( Index outer )

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

§ innerVector() [2/2]

template<typename Derived >

const SparseMatrixBase< Derived >::ConstInnerVectorReturnType Eigen::SparseMatrixBase< Derived >::innerVector ( Index outer ) const

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

§ innerVectors() [1/2]

template<typename Derived >

SparseMatrixBase< Derived >::InnerVectorsReturnType Eigen::SparseMatrixBase< Derived >::innerVectors	(	Index	outerStart,
		Index	outerSize
	)

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

§ innerVectors() [2/2]

template<typename Derived >

const SparseMatrixBase< Derived >::ConstInnerVectorsReturnType Eigen::SparseMatrixBase< Derived >::innerVectors	(	Index	outerStart,
		Index	outerSize
	)		const

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

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

§ leftCols() [1/4]

template<typename Derived>

ColsBlockXpr Eigen::SparseMatrixBase< Derived >::leftCols ( Index n )

inline

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

Parameters

n	the number of columns in the block

Example:

Output:

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

§ leftCols() [2/4]

template<typename Derived>

ConstColsBlockXpr Eigen::SparseMatrixBase< Derived >::leftCols ( Index n ) const

inline

This is the const version of leftCols(Index).

§ leftCols() [3/4]

template<typename Derived>

template<int N>

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:

Output:

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

§ leftCols() [4/4]

template<typename Derived>

template<int N>

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

inline

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

§ middleCols() [1/4]

template<typename Derived>

ColsBlockXpr Eigen::SparseMatrixBase< Derived >::middleCols	(	Index	startCol,
		Index	numCols
	)

inline

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

Parameters

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

Example:

Output:

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

§ middleCols() [2/4]

template<typename Derived>

ConstColsBlockXpr Eigen::SparseMatrixBase< Derived >::middleCols	(	Index	startCol,
		Index	numCols
	)		const

inline

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

§ middleCols() [3/4]

template<typename Derived>

template<int N>

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:

Output:

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

§ middleCols() [4/4]

template<typename Derived>

template<int N>

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

inline

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

§ middleRows() [1/4]

template<typename Derived>

RowsBlockXpr Eigen::SparseMatrixBase< Derived >::middleRows	(	Index	startRow,
		Index	n
	)

inline

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

Parameters

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

Example:

Output:

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

§ middleRows() [2/4]

template<typename Derived>

ConstRowsBlockXpr Eigen::SparseMatrixBase< Derived >::middleRows	(	Index	startRow,
		Index	n
	)		const

inline

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

§ middleRows() [3/4]

template<typename Derived>

template<int N>

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:

Output:

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

§ middleRows() [4/4]

template<typename Derived>

template<int N>

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

inline

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

§ nonZeros()

template<typename Derived>

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

inline

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

§ operator*() [1/2]

template<typename Derived>

const ScalarMultipleReturnType Eigen::SparseMatrixBase< Derived >::operator* ( const Scalar & scalar ) const

inline

Returns: an expression of *this scaled by the scalar factor scalar

§ operator*() [2/2]

template<typename Derived >

template<typename OtherDerived >

const SparseSparseProductReturnType< Derived, OtherDerived >::Type 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(); // supress numerical zeros (exact)
C = (A*B).pruned(ref);
C = (A*B).pruned(ref,epsilon);
where ref is a meaningful non zero reference value.

§ operator-()

template<typename Derived>

const CwiseUnaryOp<internal::scalar_opposite_op<typename internal::traits<Derived>::Scalar>, const Derived> Eigen::SparseMatrixBase< Derived >::operator- ( ) const

inline

Returns: an expression of the opposite of *this

§ operator/()

template<typename Derived>

const CwiseUnaryOp<internal::scalar_quotient1_op<typename internal::traits<Derived>::Scalar>, const Derived> Eigen::SparseMatrixBase< Derived >::operator/ ( const Scalar & scalar ) const

inline

Returns: an expression of *this divided by the scalar value scalar

§ 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

§ real() [1/2]

template<typename Derived>

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

inline

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

See also: imag()

§ real() [2/2]

template<typename Derived>

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

inline

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

See also: imag()

§ rightCols() [1/4]

template<typename Derived>

ColsBlockXpr Eigen::SparseMatrixBase< Derived >::rightCols ( Index n )

inline

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

Parameters

n	the number of columns in the block

Example:

Output:

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

§ rightCols() [2/4]

template<typename Derived>

ConstColsBlockXpr Eigen::SparseMatrixBase< Derived >::rightCols ( Index n ) const

inline

This is the const version of rightCols(Index).

§ rightCols() [3/4]

template<typename Derived>

template<int N>

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:

Output:

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

§ rightCols() [4/4]

template<typename Derived>

template<int N>

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

inline

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

§ row() [1/2]

template<typename Derived>

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:

Output:

See also: col(), class Block

§ row() [2/2]

template<typename Derived>

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

inline

This is the const version of row().

§ rows()

template<typename Derived>

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

inline

Returns: the number of rows.

See also: cols()

§ segment() [1/4]

template<typename Derived>

SegmentReturnType Eigen::SparseMatrixBase< Derived >::segment	(	Index	start,
		Index	n
	)

inline

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

Parameters

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

Example:

Output:

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

See also: class Block, segment(Index)

§ segment() [2/4]

template<typename Derived>

ConstSegmentReturnType Eigen::SparseMatrixBase< Derived >::segment	(	Index	start,
		Index	n
	)		const

inline

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

§ segment() [3/4]

template<typename Derived>

template<int N>

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:

Output:

See also: class Block

§ segment() [4/4]

template<typename Derived>

template<int N>

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

inline

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

§ size()

template<typename Derived>

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

inline

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

See also: rows(), cols().

§ tail() [1/4]

template<typename Derived>

SegmentReturnType Eigen::SparseMatrixBase< Derived >::tail ( Index n )

inline

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

Parameters

n	the number of coefficients in the segment

Example:

Output:

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

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

§ tail() [2/4]

template<typename Derived>

ConstSegmentReturnType Eigen::SparseMatrixBase< Derived >::tail ( Index n ) const

inline

This is the const version of tail(Index).

§ tail() [3/4]

template<typename Derived>

template<int N>

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:

Output:

See also: class Block

§ tail() [4/4]

template<typename Derived>

template<int N>

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

inline

This is the const version of tail<int>.

§ topLeftCorner() [1/6]

template<typename Derived>

Block<Derived> Eigen::SparseMatrixBase< Derived >::topLeftCorner	(	Index	cRows,
		Index	cCols
	)

inline

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

Parameters

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

Example:

Output:

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

§ topLeftCorner() [2/6]

template<typename Derived>

const Block<const Derived> Eigen::SparseMatrixBase< Derived >::topLeftCorner	(	Index	cRows,
		Index	cCols
	)		const

inline

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

§ topLeftCorner() [3/6]

template<typename Derived>

template<int CRows, int CCols>

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

Output:

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

§ topLeftCorner() [4/6]

template<typename Derived>

template<int CRows, int CCols>

const Block<const Derived, CRows, CCols> Eigen::SparseMatrixBase< Derived >::topLeftCorner ( ) const

inline

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

§ topLeftCorner() [5/6]

template<typename Derived>

template<int CRows, int CCols>

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

Output:

See also: class Block

§ topLeftCorner() [6/6]

template<typename Derived>

template<int CRows, int CCols>

const Block<const Derived, CRows, CCols> Eigen::SparseMatrixBase< Derived >::topLeftCorner	(	Index	cRows,
		Index	cCols
	)		const

inline

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

§ topRightCorner() [1/6]

template<typename Derived>

Block<Derived> Eigen::SparseMatrixBase< Derived >::topRightCorner	(	Index	cRows,
		Index	cCols
	)

inline

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

Parameters

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

Example:

Output:

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

§ topRightCorner() [2/6]

template<typename Derived>

const Block<const Derived> Eigen::SparseMatrixBase< Derived >::topRightCorner	(	Index	cRows,
		Index	cCols
	)		const

inline

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

§ topRightCorner() [3/6]

template<typename Derived>

template<int CRows, int CCols>

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

Output:

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

§ topRightCorner() [4/6]

template<typename Derived>

template<int CRows, int CCols>

const Block<const Derived, CRows, CCols> Eigen::SparseMatrixBase< Derived >::topRightCorner ( ) const

inline

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

§ topRightCorner() [5/6]

template<typename Derived>

template<int CRows, int CCols>

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

Output:

See also: class Block

§ topRightCorner() [6/6]

template<typename Derived>

template<int CRows, int CCols>

const Block<const Derived, CRows, CCols> Eigen::SparseMatrixBase< Derived >::topRightCorner	(	Index	cRows,
		Index	cCols
	)		const

inline

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

§ topRows() [1/4]

template<typename Derived>

RowsBlockXpr Eigen::SparseMatrixBase< Derived >::topRows ( Index n )

inline

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

Parameters

n	the number of rows in the block

Example:

Output:

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

§ topRows() [2/4]

template<typename Derived>

ConstRowsBlockXpr Eigen::SparseMatrixBase< Derived >::topRows ( Index n ) const

inline

This is the const version of topRows(Index).

§ topRows() [3/4]

template<typename Derived>

template<int N>

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:

Output:

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

§ topRows() [4/4]

template<typename Derived>

template<int N>

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

inline

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

§ twistedBy()

template<typename Derived>

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

inline

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

§ unaryExpr()

template<typename Derived>

template<typename CustomUnaryOp >

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:

Output:

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

Example:

Output:

See also: class CwiseUnaryOp, class CwiseBinaryOp

§ unaryViewExpr()

template<typename Derived>

template<typename CustomViewOp >

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:

Output:

See also: class CwiseUnaryOp, class CwiseBinaryOp

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

vendor/eigen/Eigen/src/Core/util/ForwardDeclarations.h
vendor/eigen/Eigen/src/SparseCore/SparseMatrixBase.h
vendor/eigen/Eigen/src/SparseCore/SparseBlock.h
vendor/eigen/Eigen/src/SparseCore/SparseCwiseBinaryOp.h
vendor/eigen/Eigen/src/SparseCore/SparseCwiseUnaryOp.h
vendor/eigen/Eigen/src/SparseCore/SparseDiagonalProduct.h
vendor/eigen/Eigen/src/SparseCore/SparseDot.h
vendor/eigen/Eigen/src/SparseCore/SparseProduct.h
vendor/eigen/Eigen/src/SparseCore/SparseRedux.h
vendor/eigen/Eigen/src/SparseCore/SparseSelfAdjointView.h
vendor/eigen/Eigen/src/SparseCore/SparseTriangularView.h

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

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

Member Typedef Documentation

§ RealScalar

Member Enumeration Documentation

§ anonymous enum

Member Function Documentation

§ binaryExpr()

§ block() [1/6]

§ block() [2/6]

§ block() [3/6]

§ block() [4/6]

§ block() [5/6]

§ block() [6/6]

§ bottomLeftCorner() [1/6]

§ bottomLeftCorner() [2/6]

§ bottomLeftCorner() [3/6]

§ bottomLeftCorner() [4/6]

§ bottomLeftCorner() [5/6]

§ bottomLeftCorner() [6/6]

§ bottomRightCorner() [1/6]

§ bottomRightCorner() [2/6]

§ bottomRightCorner() [3/6]

§ bottomRightCorner() [4/6]

§ bottomRightCorner() [5/6]

§ bottomRightCorner() [6/6]

§ bottomRows() [1/4]

§ bottomRows() [2/4]

§ bottomRows() [3/4]

§ bottomRows() [4/4]

§ cast()

§ col() [1/2]

§ col() [2/2]

§ cols()

§ conjugate()

§ cwiseAbs()

§ cwiseAbs2()

§ cwiseEqual() [1/2]

§ cwiseEqual() [2/2]

§ cwiseInverse()

§ cwiseMax() [1/2]

§ cwiseMax() [2/2]

§ cwiseMin() [1/2]

§ cwiseMin() [2/2]

§ cwiseNotEqual()

§ cwiseQuotient()

§ cwiseSqrt()

§ EIGEN_CWISE_PRODUCT_RETURN_TYPE()

§ eval()

§ head() [1/4]

§ head() [2/4]

§ head() [3/4]

§ head() [4/4]

§ imag() [1/2]

§ imag() [2/2]

§ innerSize()

§ innerVector() [1/2]

§ innerVector() [2/2]

§ innerVectors() [1/2]

§ innerVectors() [2/2]

§ isVector()

§ leftCols() [1/4]

§ leftCols() [2/4]

§ leftCols() [3/4]

§ leftCols() [4/4]

§ middleCols() [1/4]

§ middleCols() [2/4]

§ middleCols() [3/4]

§ middleCols() [4/4]

§ middleRows() [1/4]

§ middleRows() [2/4]

§ middleRows() [3/4]

§ middleRows() [4/4]

§ nonZeros()

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