Eigen::SparseVector< _Scalar, _Options, _Index > Class Template Reference

a sparse vector class More...

#include <SparseVector.h>

Inheritance diagram for Eigen::SparseVector< _Scalar, _Options, _Index >:

Classes
class	InnerIterator
class	ReverseInnerIterator

Public Types
enum	{ IsColVector = internal::traits<SparseVector>::IsColVector }
enum	{ Options = _Options }
typedef internal::CompressedStorage< Scalar, Index >	Storage
Public Types inherited from Eigen::SparseMatrixBase< SparseVector< _Scalar, _Options, _Index > >
enum
typedef internal::traits< SparseVector< _Scalar, _Options, _Index > >::Scalar	Scalar
typedef internal::packet_traits< Scalar >::type	PacketScalar
typedef internal::traits< SparseVector< _Scalar, _Options, _Index > >::StorageKind	StorageKind
typedef internal::traits< SparseVector< _Scalar, _Options, _Index > >::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 SparseVector< _Scalar, _Options, _Index > > >, Transpose< const SparseVector< _Scalar, _Options, _Index > > >::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< SparseVector< _Scalar, _Options, _Index >, Scalar, RealScalar, EigenBase< SparseVector< _Scalar, _Options, _Index > > >	Base
typedef CwiseUnaryOp< internal::scalar_multiple_op< Scalar >, const SparseVector< _Scalar, _Options, _Index > >	ScalarMultipleReturnType
typedef CwiseUnaryOp< internal::scalar_quotient1_op< Scalar >, const SparseVector< _Scalar, _Options, _Index > >	ScalarQuotient1ReturnType
typedef internal::conditional< NumTraits< Scalar >::IsComplex, const CwiseUnaryOp< internal::scalar_conjugate_op< Scalar >, const SparseVector< _Scalar, _Options, _Index > >, const SparseVector< _Scalar, _Options, _Index > & >::type	ConjugateReturnType
typedef internal::conditional< NumTraits< Scalar >::IsComplex, const CwiseUnaryOp< internal::scalar_real_op< Scalar >, const SparseVector< _Scalar, _Options, _Index > >, const SparseVector< _Scalar, _Options, _Index > & >::type	RealReturnType
typedef internal::conditional< NumTraits< Scalar >::IsComplex, CwiseUnaryView< internal::scalar_real_ref_op< Scalar >, SparseVector< _Scalar, _Options, _Index > >, SparseVector< _Scalar, _Options, _Index > & >::type	NonConstRealReturnType
typedef CwiseUnaryOp< internal::scalar_imag_op< Scalar >, const SparseVector< _Scalar, _Options, _Index > >	ImagReturnType
typedef CwiseUnaryView< internal::scalar_imag_ref_op< Scalar >, SparseVector< _Scalar, _Options, _Index > >	NonConstImagReturnType
typedef CwiseBinaryOp< internal::scalar_cmp_op< Scalar, internal::cmp_EQ >, const SparseVector< _Scalar, _Options, _Index >, const ConstantReturnType >	CwiseScalarEqualReturnType
typedef Block< SparseVector< _Scalar, _Options, _Index >, internal::traits< SparseVector< _Scalar, _Options, _Index > >::RowsAtCompileTime, 1, !IsRowMajor >	ColXpr
typedef const Block< const SparseVector< _Scalar, _Options, _Index >, internal::traits< SparseVector< _Scalar, _Options, _Index > >::RowsAtCompileTime, 1, !IsRowMajor >	ConstColXpr
typedef Block< SparseVector< _Scalar, _Options, _Index >, 1, internal::traits< SparseVector< _Scalar, _Options, _Index > >::ColsAtCompileTime, IsRowMajor >	RowXpr
typedef const Block< const SparseVector< _Scalar, _Options, _Index >, 1, internal::traits< SparseVector< _Scalar, _Options, _Index > >::ColsAtCompileTime, IsRowMajor >	ConstRowXpr
typedef Block< SparseVector< _Scalar, _Options, _Index >, internal::traits< SparseVector< _Scalar, _Options, _Index > >::RowsAtCompileTime, Dynamic, !IsRowMajor >	ColsBlockXpr
typedef const Block< const SparseVector< _Scalar, _Options, _Index >, internal::traits< SparseVector< _Scalar, _Options, _Index > >::RowsAtCompileTime, Dynamic, !IsRowMajor >	ConstColsBlockXpr
typedef Block< SparseVector< _Scalar, _Options, _Index >, Dynamic, internal::traits< SparseVector< _Scalar, _Options, _Index > >::ColsAtCompileTime, IsRowMajor >	RowsBlockXpr
typedef const Block< const SparseVector< _Scalar, _Options, _Index >, Dynamic, internal::traits< SparseVector< _Scalar, _Options, _Index > >::ColsAtCompileTime, IsRowMajor >	ConstRowsBlockXpr
typedef VectorBlock< SparseVector< _Scalar, _Options, _Index > >	SegmentReturnType
typedef const VectorBlock< const SparseVector< _Scalar, _Options, _Index > >	ConstSegmentReturnType
typedef Block< SparseVector< _Scalar, _Options, _Index >, IsRowMajor?1:Dynamic, IsRowMajor?Dynamic:1, true >	InnerVectorReturnType
typedef Block< const SparseVector< _Scalar, _Options, _Index >, IsRowMajor?1:Dynamic, IsRowMajor?Dynamic:1, true >	ConstInnerVectorReturnType
typedef Block< SparseVector< _Scalar, _Options, _Index >, Dynamic, Dynamic, true >	InnerVectorsReturnType
typedef Block< const SparseVector< _Scalar, _Options, _Index >, Dynamic, Dynamic, true >	ConstInnerVectorsReturnType
Public Types inherited from Eigen::EigenBase< SparseVector< _Scalar, _Options, _Index > >
typedef internal::traits< SparseVector< _Scalar, _Options, _Index > >::StorageKind	StorageKind
typedef internal::traits< SparseVector< _Scalar, _Options, _Index > >::Index	Index

Public Member Functions
EIGEN_STRONG_INLINE Index	rows () const
EIGEN_STRONG_INLINE Index	cols () const
EIGEN_STRONG_INLINE Index	innerSize () const
EIGEN_STRONG_INLINE Index	outerSize () const
EIGEN_STRONG_INLINE const Scalar *	valuePtr () const
EIGEN_STRONG_INLINE Scalar *	valuePtr ()
EIGEN_STRONG_INLINE const Index *	innerIndexPtr () const
EIGEN_STRONG_INLINE Index *	innerIndexPtr ()
Storage &	data ()
const Storage &	data () const
Scalar	coeff (Index row, Index col) const
Scalar	coeff (Index i) const
Scalar &	coeffRef (Index row, Index col)
Scalar &	coeffRef (Index i)
void	setZero ()
Index	nonZeros () const
void	startVec (Index outer)
Scalar &	insertBackByOuterInner (Index outer, Index inner)
Scalar &	insertBack (Index i)
Scalar &	insert (Index row, Index col)
Scalar &	insert (Index i)
void	reserve (Index reserveSize)
void	finalize ()
void	prune (const Scalar &reference, const RealScalar &epsilon=NumTraits< RealScalar >::dummy_precision())
void	resize (Index rows, Index cols)
void	resize (Index newSize)
void	resizeNonZeros (Index size)
	SparseVector (Index size)
	SparseVector (Index rows, Index cols)
template<typename OtherDerived >
	SparseVector (const SparseMatrixBase< OtherDerived > &other)
	SparseVector (const SparseVector &other)
void	swap (SparseVector &other)
	Swaps the values of *this and other. More...
SparseVector &	operator= (const SparseVector &other)
template<typename OtherDerived >
SparseVector &	operator= (const SparseMatrixBase< OtherDerived > &other)
template<typename Lhs , typename Rhs >
SparseVector &	operator= (const SparseSparseProduct< Lhs, Rhs > &product)
	~SparseVector ()
	Destructor.
Scalar	sum () const
	Overloaded for performance.
EIGEN_DEPRECATED void	startFill (Index reserve)
EIGEN_DEPRECATED Scalar &	fill (Index r, Index c)
EIGEN_DEPRECATED Scalar &	fill (Index i)
EIGEN_DEPRECATED Scalar &	fillrand (Index r, Index c)
EIGEN_DEPRECATED Scalar &	fillrand (Index i)
EIGEN_DEPRECATED void	endFill ()
EIGEN_DEPRECATED Storage &	_data ()
EIGEN_DEPRECATED const Storage &	_data () const
Public Member Functions inherited from Eigen::SparseMatrixBase< SparseVector< _Scalar, _Options, _Index > >
SparseVector< _Scalar, _Options, _Index > &	operator= (const EigenBase< OtherDerived > &other)
SparseVector< _Scalar, _Options, _Index > &	operator= (const ReturnByValue< OtherDerived > &other)
SparseVector< _Scalar, _Options, _Index > &	operator= (const SparseMatrixBase< OtherDerived > &other)
SparseVector< _Scalar, _Options, _Index > &	operator= (const SparseVector< _Scalar, _Options, _Index > &other)
SparseVector< _Scalar, _Options, _Index > &	operator= (const SparseSparseProduct< Lhs, Rhs > &product)
const SparseVector< _Scalar, _Options, _Index > &	derived () const
SparseVector< _Scalar, _Options, _Index > &	derived ()
SparseVector< _Scalar, _Options, _Index > &	const_cast_derived () const
const CwiseUnaryOp< internal::scalar_opposite_op< typename internal::traits< SparseVector< _Scalar, _Options, _Index > >::Scalar >, const SparseVector< _Scalar, _Options, _Index > >	operator- () const
const ScalarMultipleReturnType	operator* (const Scalar &scalar) const
const CwiseUnaryOp< internal::scalar_multiple2_op< Scalar, std::complex< Scalar > >, const SparseVector< _Scalar, _Options, _Index > >	operator* (const std::complex< Scalar > &scalar) const
	Overloaded for efficient real matrix times complex scalar value.
const SparseSparseProductReturnType< SparseVector< _Scalar, _Options, _Index >, OtherDerived >::Type	operator* (const SparseMatrixBase< OtherDerived > &other) const
const SparseDiagonalProduct< SparseVector< _Scalar, _Options, _Index >, OtherDerived >	operator* (const DiagonalBase< OtherDerived > &other) const
const SparseDenseProductReturnType< SparseVector< _Scalar, _Options, _Index >, OtherDerived >::Type	operator* (const MatrixBase< OtherDerived > &other) const
	sparse * dense (returns a dense object unless it is an outer product)
const CwiseUnaryOp< internal::scalar_quotient1_op< typename internal::traits< SparseVector< _Scalar, _Options, _Index > >::Scalar >, const SparseVector< _Scalar, _Options, _Index > >	operator/ (const Scalar &scalar) const
internal::cast_return_type< SparseVector< _Scalar, _Options, _Index >, const CwiseUnaryOp< internal::scalar_cast_op< typename internal::traits< SparseVector< _Scalar, _Options, _Index > >::Scalar, NewType >, const SparseVector< _Scalar, _Options, _Index > > >::type	cast () const
ConjugateReturnType	conjugate () const
RealReturnType	real () const
NonConstRealReturnType	real ()
const ImagReturnType	imag () const
NonConstImagReturnType	imag ()
const CwiseUnaryOp< CustomUnaryOp, const SparseVector< _Scalar, _Options, _Index > >	unaryExpr (const CustomUnaryOp &func=CustomUnaryOp()) const
	Apply a unary operator coefficient-wise. More...
const CwiseUnaryView< CustomViewOp, const SparseVector< _Scalar, _Options, _Index > >	unaryViewExpr (const CustomViewOp &func=CustomViewOp()) const
EIGEN_STRONG_INLINE const CwiseBinaryOp< CustomBinaryOp, const SparseVector< _Scalar, _Options, _Index >, 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 SparseVector< _Scalar, _Options, _Index > >	cwiseAbs () const
EIGEN_STRONG_INLINE const CwiseUnaryOp< internal::scalar_abs2_op< Scalar >, const SparseVector< _Scalar, _Options, _Index > >	cwiseAbs2 () const
const CwiseUnaryOp< internal::scalar_sqrt_op< Scalar >, const SparseVector< _Scalar, _Options, _Index > >	cwiseSqrt () const
const CwiseUnaryOp< internal::scalar_inverse_op< Scalar >, const SparseVector< _Scalar, _Options, _Index > >	cwiseInverse () const
EIGEN_STRONG_INLINE const	EIGEN_CWISE_PRODUCT_RETURN_TYPE (SparseVector< _Scalar, _Options, _Index >, OtherDerived) cwiseProduct(const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
const CwiseBinaryOp< std::equal_to< Scalar >, const SparseVector< _Scalar, _Options, _Index >, const OtherDerived >	cwiseEqual (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
const CwiseScalarEqualReturnType	cwiseEqual (const Scalar &s) const
const CwiseBinaryOp< std::not_equal_to< Scalar >, const SparseVector< _Scalar, _Options, _Index >, const OtherDerived >	cwiseNotEqual (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_min_op< Scalar >, const SparseVector< _Scalar, _Options, _Index >, const OtherDerived >	cwiseMin (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_min_op< Scalar >, const SparseVector< _Scalar, _Options, _Index >, const ConstantReturnType >	cwiseMin (const Scalar &other) const
EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_max_op< Scalar >, const SparseVector< _Scalar, _Options, _Index >, const OtherDerived >	cwiseMax (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_max_op< Scalar >, const SparseVector< _Scalar, _Options, _Index >, const ConstantReturnType >	cwiseMax (const Scalar &other) const
EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_quotient_op< Scalar >, const SparseVector< _Scalar, _Options, _Index >, const OtherDerived >	cwiseQuotient (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
Block< SparseVector< _Scalar, _Options, _Index > >	block (Index startRow, Index startCol, Index blockRows, Index blockCols)
const Block< const SparseVector< _Scalar, _Options, _Index > >	block (Index startRow, Index startCol, Index blockRows, Index blockCols) const
	This is the const version of block(Index,Index,Index,Index). More...
Block< SparseVector< _Scalar, _Options, _Index >, BlockRows, BlockCols >	block (Index startRow, Index startCol)
const Block< const SparseVector< _Scalar, _Options, _Index >, BlockRows, BlockCols >	block (Index startRow, Index startCol) const
	This is the const version of block<>(Index, Index). More...
Block< SparseVector< _Scalar, _Options, _Index >, BlockRows, BlockCols >	block (Index startRow, Index startCol, Index blockRows, Index blockCols)
const Block< const SparseVector< _Scalar, _Options, _Index >, BlockRows, BlockCols >	block (Index startRow, Index startCol, Index blockRows, Index blockCols) const
	This is the const version of block<>(Index, Index, Index, Index). More...
Block< SparseVector< _Scalar, _Options, _Index > >	topRightCorner (Index cRows, Index cCols)
const Block< const SparseVector< _Scalar, _Options, _Index > >	topRightCorner (Index cRows, Index cCols) const
	This is the const version of topRightCorner(Index, Index). More...
Block< SparseVector< _Scalar, _Options, _Index >, CRows, CCols >	topRightCorner ()
const Block< const SparseVector< _Scalar, _Options, _Index >, CRows, CCols >	topRightCorner () const
	This is the const version of topRightCorner<int, int>(). More...
Block< SparseVector< _Scalar, _Options, _Index >, CRows, CCols >	topRightCorner (Index cRows, Index cCols)
const Block< const SparseVector< _Scalar, _Options, _Index >, CRows, CCols >	topRightCorner (Index cRows, Index cCols) const
	This is the const version of topRightCorner<int, int>(Index, Index). More...
Block< SparseVector< _Scalar, _Options, _Index > >	topLeftCorner (Index cRows, Index cCols)
const Block< const SparseVector< _Scalar, _Options, _Index > >	topLeftCorner (Index cRows, Index cCols) const
	This is the const version of topLeftCorner(Index, Index). More...
Block< SparseVector< _Scalar, _Options, _Index >, CRows, CCols >	topLeftCorner ()
const Block< const SparseVector< _Scalar, _Options, _Index >, CRows, CCols >	topLeftCorner () const
	This is the const version of topLeftCorner<int, int>(). More...
Block< SparseVector< _Scalar, _Options, _Index >, CRows, CCols >	topLeftCorner (Index cRows, Index cCols)
const Block< const SparseVector< _Scalar, _Options, _Index >, CRows, CCols >	topLeftCorner (Index cRows, Index cCols) const
	This is the const version of topLeftCorner<int, int>(Index, Index). More...
Block< SparseVector< _Scalar, _Options, _Index > >	bottomRightCorner (Index cRows, Index cCols)
const Block< const SparseVector< _Scalar, _Options, _Index > >	bottomRightCorner (Index cRows, Index cCols) const
	This is the const version of bottomRightCorner(Index, Index). More...
Block< SparseVector< _Scalar, _Options, _Index >, CRows, CCols >	bottomRightCorner ()
const Block< const SparseVector< _Scalar, _Options, _Index >, CRows, CCols >	bottomRightCorner () const
	This is the const version of bottomRightCorner<int, int>(). More...
Block< SparseVector< _Scalar, _Options, _Index >, CRows, CCols >	bottomRightCorner (Index cRows, Index cCols)
const Block< const SparseVector< _Scalar, _Options, _Index >, CRows, CCols >	bottomRightCorner (Index cRows, Index cCols) const
	This is the const version of bottomRightCorner<int, int>(Index, Index). More...
Block< SparseVector< _Scalar, _Options, _Index > >	bottomLeftCorner (Index cRows, Index cCols)
const Block< const SparseVector< _Scalar, _Options, _Index > >	bottomLeftCorner (Index cRows, Index cCols) const
	This is the const version of bottomLeftCorner(Index, Index). More...
Block< SparseVector< _Scalar, _Options, _Index >, CRows, CCols >	bottomLeftCorner ()
const Block< const SparseVector< _Scalar, _Options, _Index >, CRows, CCols >	bottomLeftCorner () const
	This is the const version of bottomLeftCorner<int, int>(). More...
Block< SparseVector< _Scalar, _Options, _Index >, CRows, CCols >	bottomLeftCorner (Index cRows, Index cCols)
const Block< const SparseVector< _Scalar, _Options, _Index >, 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...
NRowsBlockXpr< N >::Type	topRows (Index n=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...
NRowsBlockXpr< N >::Type	bottomRows (Index n=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...
NRowsBlockXpr< N >::Type	middleRows (Index startRow, Index n=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...
NColsBlockXpr< N >::Type	leftCols (Index n=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...
NColsBlockXpr< N >::Type	rightCols (Index n=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...
NColsBlockXpr< N >::Type	middleCols (Index startCol, Index n=N)
ConstNColsBlockXpr< N >::Type	middleCols (Index startCol, Index n=N) const
	This is the const version of middleCols<int>(). 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...
FixedSegmentReturnType< N >::Type	segment (Index start, Index n=N)
ConstFixedSegmentReturnType< N >::Type	segment (Index start, Index n=N) const
	This is the const version of segment<int>(Index). More...
SegmentReturnType	head (Index n)
ConstSegmentReturnType	head (Index n) const
	This is the const version of head(Index). More...
FixedSegmentReturnType< N >::Type	head (Index n=N)
ConstFixedSegmentReturnType< N >::Type	head (Index n=N) const
	This is the const version of head<int>(). More...
SegmentReturnType	tail (Index n)
ConstSegmentReturnType	tail (Index n) const
	This is the const version of tail(Index). More...
FixedSegmentReturnType< N >::Type	tail (Index n=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
SparseVector< _Scalar, _Options, _Index > &	markAsRValue ()
SparseVector< _Scalar, _Options, _Index > &	operator+= (const SparseMatrixBase< OtherDerived > &other)
EIGEN_STRONG_INLINE SparseVector< _Scalar, _Options, _Index > &	operator+= (const SparseMatrixBase< OtherDerived > &other)
SparseVector< _Scalar, _Options, _Index > &	operator-= (const SparseMatrixBase< OtherDerived > &other)
EIGEN_STRONG_INLINE SparseVector< _Scalar, _Options, _Index > &	operator-= (const SparseMatrixBase< OtherDerived > &other)
SparseVector< _Scalar, _Options, _Index > &	operator*= (const Scalar &other)
SparseVector< _Scalar, _Options, _Index > &	operator*= (const SparseMatrixBase< OtherDerived > &other)
SparseVector< _Scalar, _Options, _Index > &	operator/= (const Scalar &other)
EIGEN_STRONG_INLINE const CwiseProductDenseReturnType< OtherDerived >::Type	cwiseProduct (const MatrixBase< OtherDerived > &other) const
EIGEN_STRONG_INLINE const SparseMatrixBase< SparseVector< _Scalar, _Options, _Index > >::template CwiseProductDenseReturnType< OtherDerived >::Type	cwiseProduct (const MatrixBase< OtherDerived > &other) const
SparseSymmetricPermutationProduct< SparseVector< _Scalar, _Options, _Index >, Upper|Lower >	twistedBy (const PermutationMatrix< Dynamic, Dynamic, Index > &perm) const
const SparseTriangularView< SparseVector< _Scalar, _Options, _Index >, Mode >	triangularView () const
const SparseSelfAdjointView< SparseVector< _Scalar, _Options, _Index >, UpLo >	selfadjointView () const
SparseSelfAdjointView< SparseVector< _Scalar, _Options, _Index >, UpLo >	selfadjointView ()
Scalar	dot (const MatrixBase< OtherDerived > &other) const
Scalar	dot (const SparseMatrixBase< OtherDerived > &other) const
internal::traits< SparseVector< _Scalar, _Options, _Index > >::Scalar	dot (const MatrixBase< OtherDerived > &other) const
internal::traits< SparseVector< _Scalar, _Options, _Index > >::Scalar	dot (const SparseMatrixBase< OtherDerived > &other) const
RealScalar	squaredNorm () const
RealScalar	norm () const
RealScalar	blueNorm () const
Transpose< SparseVector< _Scalar, _Options, _Index > >	transpose ()
const Transpose< const SparseVector< _Scalar, _Options, _Index > >	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
void	evalTo (MatrixBase< DenseDerived > &dst) const
Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTime >	toDense () const
bool	isApprox (const SparseMatrixBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
bool	isApprox (const MatrixBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
const internal::eval< SparseVector< _Scalar, _Options, _Index > >::type	eval () const
Scalar	sum () const
Public Member Functions inherited from Eigen::internal::special_scalar_op_base< SparseVector< _Scalar, _Options, _Index >, internal::traits< SparseVector< _Scalar, _Options, _Index > >::Scalar, NumTraits< internal::traits< SparseVector< _Scalar, _Options, _Index > >::Scalar >::Real, EigenBase< SparseVector< _Scalar, _Options, _Index > > >
void	operator* () const
Public Member Functions inherited from Eigen::EigenBase< SparseVector< _Scalar, _Options, _Index > >
SparseVector< _Scalar, _Options, _Index > &	derived ()
const SparseVector< _Scalar, _Options, _Index > &	derived () const
SparseVector< _Scalar, _Options, _Index > &	const_cast_derived () const
const SparseVector< _Scalar, _Options, _Index > &	const_derived () const
Index	rows () const
Index	cols () const
Index	size () const
void	evalTo (Dest &dst) const
void	addTo (Dest &dst) const
void	subTo (Dest &dst) const
void	applyThisOnTheRight (Dest &dst) const
void	applyThisOnTheLeft (Dest &dst) const

Static Protected Member Functions
static void	check_template_parameters ()

Protected Attributes
Storage	m_data
Index	m_size
Protected Attributes inherited from Eigen::SparseMatrixBase< SparseVector< _Scalar, _Options, _Index > >
bool	m_isRValue

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

Additional Inherited Members
Protected Member Functions inherited from Eigen::SparseMatrixBase< SparseVector< _Scalar, _Options, _Index > >
SparseVector< _Scalar, _Options, _Index > &	assign (const OtherDerived &other)
void	assignGeneric (const OtherDerived &other)

Detailed Description

template<typename _Scalar, int _Options, typename _Index>
class Eigen::SparseVector< _Scalar, _Options, _Index >

a sparse vector class

Template Parameters

_Scalar

the scalar type, i.e. the type of the coefficients

See http://www.netlib.org/linalg/html_templates/node91.html for details on the storage scheme.

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

Member Function Documentation

coeffRef()

template<typename _Scalar, int _Options, typename _Index>

Scalar& Eigen::SparseVector< _Scalar, _Options, _Index >::coeffRef ( Index  i )

inline

Returns

a reference to the coefficient value at given index i This operation involes a log(rho*size) binary search. If the coefficient does not exist yet, then a sorted insertion into a sequential buffer is performed.

This insertion might be very costly if the number of nonzeros above i is large.

nonZeros()

template<typename _Scalar, int _Options, typename _Index>

Index Eigen::SparseVector< _Scalar, _Options, _Index >::nonZeros ( ) const

inline

Returns

the number of non zero coefficients

swap()

template<typename _Scalar, int _Options, typename _Index>

void Eigen::SparseVector< _Scalar, _Options, _Index >::swap ( SparseVector< _Scalar, _Options, _Index > &  other )

inline

Swaps the values of *this and other.

Overloaded for performance: this version performs a shallow swap by swaping pointers and attributes only.

See also

SparseMatrixBase::swap()

---

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

• vendor/eigen/Eigen/src/SparseCore/SparseUtil.h
• vendor/eigen/Eigen/src/SparseCore/SparseVector.h
• vendor/eigen/Eigen/src/SparseCore/SparseRedux.h