Common base class for Map and Ref instance of sparse matrix and vector. More...

#include <SparseMap.h>

Inheritance diagram for Eigen::SparseMapBase< Derived, ReadOnlyAccessors >:

[legend]

Public Types
enum	{ IsRowMajor = Base::IsRowMajor }

typedef SparseCompressedBase< Derived >	Base

typedef Base::Scalar	Scalar

typedef Base::StorageIndex	StorageIndex

Public Types inherited from Eigen::SparseCompressedBase< Derived >
typedef SparseMatrixBase< Derived >	Base

Public Types inherited from Eigen::SparseMatrixBase< Derived >
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
Scalar	coeff (Index row, Index col) const

Index	cols () const

const StorageIndex *	innerIndexPtr () const

const StorageIndex *	innerNonZeroPtr () const

Index	innerSize () const

bool	isCompressed () const

Index	nonZeros () const

const StorageIndex *	outerIndexPtr () const

Index	outerSize () const

Index	rows () const

	SparseMapBase (Index rows, Index cols, Index nnz, IndexPointer outerIndexPtr, IndexPointer innerIndexPtr, ScalarPointer valuePtr, IndexPointer innerNonZerosPtr=0)

	SparseMapBase (Index size, Index nnz, IndexPointer innerIndexPtr, ScalarPointer valuePtr)

const Scalar *	valuePtr () const

	~SparseMapBase ()

Public Member Functions inherited from Eigen::SparseCompressedBase< Derived >
const Map< const Array< Scalar, Dynamic, 1 > >	coeffs () const

Map< Array< Scalar, Dynamic, 1 > >	coeffs ()

const StorageIndex *	innerIndexPtr () const

StorageIndex *	innerIndexPtr ()

const StorageIndex *	innerNonZeroPtr () const

StorageIndex *	innerNonZeroPtr ()

bool	isCompressed () const

Index	nonZeros () const

const StorageIndex *	outerIndexPtr () const

StorageIndex *	outerIndexPtr ()

const Scalar *	valuePtr () const

Scalar *	valuePtr ()

Public Member Functions inherited from Eigen::SparseMatrixBase< Derived >
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 Types
typedef internal::conditional< bool(internal::is_lvalue< Derived >::value), StorageIndex , const StorageIndex >::type	IndexPointer

typedef internal::conditional< bool(internal::is_lvalue< Derived >::value), Scalar , const Scalar >::type	ScalarPointer

Protected Types inherited from Eigen::SparseCompressedBase< Derived >
typedef Base::IndexVector	IndexVector

Protected Member Functions
	SparseMapBase ()

Protected Member Functions inherited from Eigen::SparseCompressedBase< Derived >
Eigen::Map< IndexVector >	innerNonZeros ()

const Eigen::Map< const IndexVector >	innerNonZeros () const

internal::LowerBoundIndex	lower_bound (Index row, Index col) const

	SparseCompressedBase ()

Protected Member Functions inherited from Eigen::SparseMatrixBase< Derived >
template<typename OtherDerived >
Derived &	assign (const OtherDerived &other)

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

Protected Attributes
IndexPointer	m_innerIndices

IndexPointer	m_innerNonZeros

Index	m_innerSize

IndexPointer	m_outerIndex

Index	m_outerSize

ScalarPointer	m_values

Array< StorageIndex, 2, 1 >	m_zero_nnz

Protected Attributes inherited from Eigen::SparseMatrixBase< Derived >
bool	m_isRValue

Additional Inherited Members
Static Protected Member Functions inherited from Eigen::SparseMatrixBase< Derived >
static StorageIndex	convert_index (const Index idx)

Detailed Description

template<typename Derived>
class Eigen::SparseMapBase< Derived, ReadOnlyAccessors >

Common base class for Map and Ref instance of sparse matrix and vector.

class SparseMapBase

Definition at line 50 of file SparseMap.h.

Member Typedef Documentation

◆ Base

template<typename Derived >

typedef SparseCompressedBase<Derived> Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::Base

Definition at line 54 of file SparseMap.h.

◆ IndexPointer

template<typename Derived >

typedef internal::conditional< bool(internal::is_lvalue<Derived>::value), StorageIndex *, const StorageIndex *>::type Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::IndexPointer

protected

Definition at line 66 of file SparseMap.h.

◆ Scalar

template<typename Derived >

typedef Base::Scalar Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::Scalar

Definition at line 55 of file SparseMap.h.

◆ ScalarPointer

template<typename Derived >

typedef internal::conditional< bool(internal::is_lvalue<Derived>::value), Scalar *, const Scalar *>::type Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::ScalarPointer

protected

Definition at line 63 of file SparseMap.h.

◆ StorageIndex

template<typename Derived >

typedef Base::StorageIndex Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::StorageIndex

Definition at line 56 of file SparseMap.h.

Member Enumeration Documentation

◆ anonymous enum

template<typename Derived >

anonymous enum

Enumerator
IsRowMajor

Definition at line 57 of file SparseMap.h.

Constructor & Destructor Documentation

◆ SparseMapBase() [1/3]

template<typename Derived >

Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::SparseMapBase	(	Index	rows,
		Index	cols,
		Index	nnz,
		IndexPointer	outerIndexPtr,
		IndexPointer	innerIndexPtr,
		ScalarPointer	valuePtr,
		IndexPointer	innerNonZerosPtr = `0`
	)

inline

Definition at line 124 of file SparseMap.h.

◆ SparseMapBase() [2/3]

template<typename Derived >

Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::SparseMapBase	(	Index	size,
		Index	nnz,
		IndexPointer	innerIndexPtr,
		ScalarPointer	valuePtr
	)

inline

Definition at line 131 of file SparseMap.h.

◆ ~SparseMapBase()

template<typename Derived >

Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::~SparseMapBase ( )

inline

Empty destructor

Definition at line 137 of file SparseMap.h.

◆ SparseMapBase() [3/3]

template<typename Derived >

Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::SparseMapBase ( )

inlineprotected

Definition at line 140 of file SparseMap.h.

Member Function Documentation

◆ coeff()

template<typename Derived >

Scalar Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::coeff	(	Index	row,
		Index	col
	)		const

inline

Returns: the value of the matrix at position i, j This function returns Scalar(0) if the element is an explicit zero

Definition at line 105 of file SparseMap.h.

◆ cols()

template<typename Derived >

Index Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::cols ( void ) const

inline

Returns: the number of columns.

See also: rows()

Definition at line 81 of file SparseMap.h.

◆ innerIndexPtr()

template<typename Derived >

const StorageIndex* Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::innerIndexPtr ( ) const

inline

Returns: a const pointer to the array of inner indices. This function is aimed at interoperability with other libraries.

See also: valuePtr(), outerIndexPtr()

Definition at line 97 of file SparseMap.h.

◆ innerNonZeroPtr()

template<typename Derived >

const StorageIndex* Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::innerNonZeroPtr ( ) const

inline

Returns: a const pointer to the array of the number of non zeros of the inner vectors. This function is aimed at interoperability with other libraries.

Warning: it returns the null pointer 0 in compressed mode

Definition at line 101 of file SparseMap.h.

◆ innerSize()

template<typename Derived >

Index Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::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 83 of file SparseMap.h.

◆ isCompressed()

template<typename Derived >

bool Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::isCompressed ( ) const

inline

Returns: whether *this is in compressed form.

Definition at line 90 of file SparseMap.h.

◆ nonZeros()

template<typename Derived >

Index Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::nonZeros ( ) const

inline

Returns: the number of non zero coefficients

Definition at line 87 of file SparseMap.h.

◆ outerIndexPtr()

template<typename Derived >

const StorageIndex* Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::outerIndexPtr ( ) const

inline

Returns: a const pointer to the array of the starting positions of the inner vectors. This function is aimed at interoperability with other libraries.

See also: valuePtr(), innerIndexPtr()

Definition at line 99 of file SparseMap.h.

◆ outerSize()

template<typename Derived >

Index Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::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 85 of file SparseMap.h.

◆ rows()

template<typename Derived >

Index Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::rows ( void ) const

inline

Returns: the number of rows.

See also: cols()

Definition at line 79 of file SparseMap.h.

◆ valuePtr()

template<typename Derived >

const Scalar* Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::valuePtr ( ) const

inline

Returns: a const pointer to the array of values. This function is aimed at interoperability with other libraries.

See also: innerIndexPtr(), outerIndexPtr()

Definition at line 95 of file SparseMap.h.

Member Data Documentation

◆ m_innerIndices

template<typename Derived >

IndexPointer Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::m_innerIndices

protected

Definition at line 72 of file SparseMap.h.

◆ m_innerNonZeros

template<typename Derived >

IndexPointer Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::m_innerNonZeros

protected

Definition at line 74 of file SparseMap.h.

◆ m_innerSize

template<typename Derived >

Index Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::m_innerSize

protected

Definition at line 69 of file SparseMap.h.

◆ m_outerIndex

template<typename Derived >

IndexPointer Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::m_outerIndex

protected

Definition at line 71 of file SparseMap.h.

◆ m_outerSize

template<typename Derived >

Index Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::m_outerSize

protected

Definition at line 68 of file SparseMap.h.

◆ m_values

template<typename Derived >

ScalarPointer Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::m_values

protected

Definition at line 73 of file SparseMap.h.

◆ m_zero_nnz

template<typename Derived >

Array<StorageIndex,2,1> Eigen::SparseMapBase< Derived, ReadOnlyAccessors >::m_zero_nnz

protected

Definition at line 70 of file SparseMap.h.

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

SparseMap.h

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<typename Derived> class Eigen::SparseMapBase< Derived, ReadOnlyAccessors >

Member Typedef Documentation

◆ Base

◆ IndexPointer

◆ Scalar

◆ ScalarPointer

◆ StorageIndex

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ SparseMapBase() [1/3]

◆ SparseMapBase() [2/3]

◆ ~SparseMapBase()

◆ SparseMapBase() [3/3]

Member Function Documentation

◆ coeff()

◆ cols()

◆ innerIndexPtr()

◆ innerNonZeroPtr()

◆ innerSize()

◆ isCompressed()

◆ nonZeros()

◆ outerIndexPtr()

◆ outerSize()

◆ rows()

◆ valuePtr()

Member Data Documentation

◆ m_innerIndices

◆ m_innerNonZeros

◆ m_innerSize

◆ m_outerIndex

◆ m_outerSize

◆ m_values

◆ m_zero_nnz

template<typename Derived>
class Eigen::SparseMapBase< Derived, ReadOnlyAccessors >