a sparse vector class More...

#include <SparseVector.h>

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

Classes
class	InnerIterator
Public Types
enum	{ IsColVector = internal::traits<SparseVector>::IsColVector }
enum	{ Options = _Options }
typedef SparseMatrixBase < SparseVector >	SparseBase
Public Member Functions
CompressedStorage< Scalar, Index > &	_data ()
CompressedStorage< Scalar, Index > &	_data () const
EIGEN_STRONG_INLINE const Index *	_innerIndexPtr () const
EIGEN_STRONG_INLINE Index *	_innerIndexPtr ()
EIGEN_STRONG_INLINE const Scalar *	_valuePtr () const
EIGEN_STRONG_INLINE Scalar *	_valuePtr ()
Scalar	coeff (Index row, Index col) const
Scalar	coeff (Index i) const
Scalar &	coeffRef (Index row, Index col)
Scalar &	coeffRef (Index i)
EIGEN_STRONG_INLINE Index	cols () const
EIGEN_DEPRECATED void	endFill ()
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)
void	finalize ()
EIGEN_STRONG_INLINE Index	innerNonZeros (Index j) const
EIGEN_STRONG_INLINE Index	innerSize () const
Scalar &	insert (Index row, Index col)
Scalar &	insert (Index i)
Scalar &	insertBack (Index i)
Scalar &	insertBackByOuterInner (Index outer, Index inner)
Index	nonZeros () const
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)
EIGEN_STRONG_INLINE Index	outerSize () const
void	prune (Scalar reference, RealScalar epsilon=NumTraits< RealScalar >::dummy_precision())
void	reserve (Index reserveSize)
void	resize (Index rows, Index cols)
void	resize (Index newSize)
void	resizeNonZeros (Index size)
EIGEN_STRONG_INLINE Index	rows () const
void	setZero ()
	SparseVector ()
	SparseVector (Index size)
	SparseVector (Index rows, Index cols)
template<typename OtherDerived >
	SparseVector (const MatrixBase< OtherDerived > &other)
template<typename OtherDerived >
	SparseVector (const SparseMatrixBase< OtherDerived > &other)
	SparseVector (const SparseVector &other)
EIGEN_DEPRECATED void	startFill (Index reserve)
void	startVec (Index outer)
Scalar	sum () const
void	swap (SparseVector &other)
	~SparseVector ()
Public Attributes
CompressedStorage< Scalar, Index >	m_data
Index	m_size
Friends
std::ostream &	operator<< (std::ostream &s, const SparseVector &m)

Detailed Description

template<typename _Scalar, int _Options, typename _Index>
class 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.

Definition at line 63 of file SparseVector.h.

Member Typedef Documentation

template<typename _Scalar, int _Options, typename _Index>

typedef SparseMatrixBase<SparseVector> SparseVector< _Scalar, _Options, _Index >::SparseBase

Definition at line 75 of file SparseVector.h.

Member Enumeration Documentation

template<typename _Scalar, int _Options, typename _Index>

anonymous enum

Enumerator:

IsColVector

Definition at line 76 of file SparseVector.h.

template<typename _Scalar, int _Options, typename _Index>

anonymous enum

Enumerator:

Options

Definition at line 78 of file SparseVector.h.

Constructor & Destructor Documentation

template<typename _Scalar, int _Options, typename _Index>

SparseVector< _Scalar, _Options, _Index >::SparseVector ( ) [inline]

Definition at line 202 of file SparseVector.h.

template<typename _Scalar, int _Options, typename _Index>

SparseVector< _Scalar, _Options, _Index >::SparseVector ( Index size ) [inline]

Definition at line 204 of file SparseVector.h.

template<typename _Scalar, int _Options, typename _Index>

SparseVector< _Scalar, _Options, _Index >::SparseVector	(	Index	rows,
		Index	cols
	)		`[inline]`

Definition at line 206 of file SparseVector.h.

template<typename _Scalar, int _Options, typename _Index>

template<typename OtherDerived >

SparseVector< _Scalar, _Options, _Index >::SparseVector ( const MatrixBase< OtherDerived > & other ) [inline]

Definition at line 209 of file SparseVector.h.

template<typename _Scalar, int _Options, typename _Index>

template<typename OtherDerived >

SparseVector< _Scalar, _Options, _Index >::SparseVector ( const SparseMatrixBase< OtherDerived > & other ) [inline]

Definition at line 216 of file SparseVector.h.

template<typename _Scalar, int _Options, typename _Index>

SparseVector< _Scalar, _Options, _Index >::SparseVector ( const SparseVector< _Scalar, _Options, _Index > & other ) [inline]

Definition at line 222 of file SparseVector.h.

template<typename _Scalar, int _Options, typename _Index>

SparseVector< _Scalar, _Options, _Index >::~SparseVector ( ) [inline]

Destructor

Definition at line 346 of file SparseVector.h.

Member Function Documentation

template<typename _Scalar, int _Options, typename _Index>

CompressedStorage<Scalar,Index>& SparseVector< _Scalar, _Options, _Index >::_data ( ) [inline]

Definition at line 85 of file SparseVector.h.

template<typename _Scalar, int _Options, typename _Index>

CompressedStorage<Scalar,Index>& SparseVector< _Scalar, _Options, _Index >::_data ( ) const [inline]

Definition at line 86 of file SparseVector.h.

template<typename _Scalar, int _Options, typename _Index>

EIGEN_STRONG_INLINE const Index* SparseVector< _Scalar, _Options, _Index >::_innerIndexPtr ( ) const [inline]

Definition at line 99 of file SparseVector.h.

template<typename _Scalar, int _Options, typename _Index>

EIGEN_STRONG_INLINE Index* SparseVector< _Scalar, _Options, _Index >::_innerIndexPtr ( ) [inline]

Definition at line 100 of file SparseVector.h.

template<typename _Scalar, int _Options, typename _Index>

EIGEN_STRONG_INLINE const Scalar* SparseVector< _Scalar, _Options, _Index >::_valuePtr ( ) const [inline]

Definition at line 96 of file SparseVector.h.

template<typename _Scalar, int _Options, typename _Index>

EIGEN_STRONG_INLINE Scalar* SparseVector< _Scalar, _Options, _Index >::_valuePtr ( ) [inline]

Definition at line 97 of file SparseVector.h.

template<typename _Scalar, int _Options, typename _Index>

Scalar SparseVector< _Scalar, _Options, _Index >::coeff	(	Index	row,
		Index	col
	)		const `[inline]`

Definition at line 102 of file SparseVector.h.

template<typename _Scalar, int _Options, typename _Index>

Scalar SparseVector< _Scalar, _Options, _Index >::coeff ( Index i ) const [inline]

Definition at line 107 of file SparseVector.h.

template<typename _Scalar, int _Options, typename _Index>

Scalar& SparseVector< _Scalar, _Options, _Index >::coeffRef	(	Index	row,
		Index	col
	)		`[inline]`

Definition at line 109 of file SparseVector.h.

template<typename _Scalar, int _Options, typename _Index>

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

Definition at line 121 of file SparseVector.h.

template<typename _Scalar, int _Options, typename _Index>

EIGEN_STRONG_INLINE Index SparseVector< _Scalar, _Options, _Index >::cols ( void ) const [inline]

Returns:: the number of columns.

See also:: rows(), ColsAtCompileTime

Reimplemented from SparseMatrixBase< SparseVector< _Scalar, _Options, _Index > >.

Definition at line 91 of file SparseVector.h.

template<typename _Scalar, int _Options, typename _Index>

EIGEN_DEPRECATED void SparseVector< _Scalar, _Options, _Index >::endFill ( ) [inline]

Deprecated:: use finalize()

Definition at line 388 of file SparseVector.h.

template<typename _Scalar, int _Options, typename _Index>

EIGEN_DEPRECATED Scalar& SparseVector< _Scalar, _Options, _Index >::fill	(	Index	r,
		Index	c
	)		`[inline]`

Deprecated:: use insertBack(Index,Index)

Definition at line 361 of file SparseVector.h.

template<typename _Scalar, int _Options, typename _Index>

EIGEN_DEPRECATED Scalar& SparseVector< _Scalar, _Options, _Index >::fill ( Index i ) [inline]

Deprecated:: use insertBack(Index)

Definition at line 368 of file SparseVector.h.

template<typename _Scalar, int _Options, typename _Index>

EIGEN_DEPRECATED Scalar& SparseVector< _Scalar, _Options, _Index >::fillrand	(	Index	r,
		Index	c
	)		`[inline]`

Deprecated:: use insert(Index,Index)

Definition at line 375 of file SparseVector.h.

template<typename _Scalar, int _Options, typename _Index>

EIGEN_DEPRECATED Scalar& SparseVector< _Scalar, _Options, _Index >::fillrand ( Index i ) [inline]

Deprecated:: use insert(Index)

Definition at line 382 of file SparseVector.h.

template<typename _Scalar, int _Options, typename _Index>

void SparseVector< _Scalar, _Options, _Index >::finalize ( ) [inline]

Definition at line 181 of file SparseVector.h.

template<typename _Scalar, int _Options, typename _Index>

EIGEN_STRONG_INLINE Index SparseVector< _Scalar, _Options, _Index >::innerNonZeros ( Index j ) const [inline]

Definition at line 94 of file SparseVector.h.

template<typename _Scalar, int _Options, typename _Index>

EIGEN_STRONG_INLINE Index SparseVector< _Scalar, _Options, _Index >::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

Reimplemented from SparseMatrixBase< SparseVector< _Scalar, _Options, _Index > >.

Definition at line 92 of file SparseVector.h.

template<typename _Scalar, int _Options, typename _Index>

Scalar& SparseVector< _Scalar, _Options, _Index >::insert	(	Index	row,
		Index	col
	)		`[inline]`

Definition at line 151 of file SparseVector.h.

template<typename _Scalar, int _Options, typename _Index>

Scalar& SparseVector< _Scalar, _Options, _Index >::insert ( Index i ) [inline]

Definition at line 158 of file SparseVector.h.

template<typename _Scalar, int _Options, typename _Index>

Scalar& SparseVector< _Scalar, _Options, _Index >::insertBack ( Index i ) [inline]

Definition at line 145 of file SparseVector.h.

template<typename _Scalar, int _Options, typename _Index>

Scalar& SparseVector< _Scalar, _Options, _Index >::insertBackByOuterInner	(	Index	outer,
		Index	inner
	)		`[inline]`

Definition at line 140 of file SparseVector.h.

template<typename _Scalar, int _Options, typename _Index>

Index SparseVector< _Scalar, _Options, _Index >::nonZeros ( ) const [inline]

Returns:: the number of non zero coefficients

Reimplemented from SparseMatrixBase< SparseVector< _Scalar, _Options, _Index > >.

Definition at line 133 of file SparseVector.h.

template<typename _Scalar, int _Options, typename _Index>

SparseVector& SparseVector< _Scalar, _Options, _Index >::operator= ( const SparseVector< _Scalar, _Options, _Index > & other ) [inline]

Reimplemented from SparseMatrixBase< SparseVector< _Scalar, _Options, _Index > >.

Definition at line 234 of file SparseVector.h.

template<typename _Scalar, int _Options, typename _Index>

template<typename OtherDerived >

SparseVector& SparseVector< _Scalar, _Options, _Index >::operator= ( const SparseMatrixBase< OtherDerived > & other ) [inline]

Reimplemented from SparseMatrixBase< SparseVector< _Scalar, _Options, _Index > >.

Definition at line 249 of file SparseVector.h.

template<typename _Scalar, int _Options, typename _Index>

template<typename Lhs , typename Rhs >

SparseVector& SparseVector< _Scalar, _Options, _Index >::operator= ( const SparseSparseProduct< Lhs, Rhs > & product ) [inline]

Reimplemented from SparseMatrixBase< SparseVector< _Scalar, _Options, _Index > >.

Definition at line 259 of file SparseVector.h.

template<typename _Scalar, int _Options, typename _Index>

EIGEN_STRONG_INLINE Index SparseVector< _Scalar, _Options, _Index >::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

Reimplemented from SparseMatrixBase< SparseVector< _Scalar, _Options, _Index > >.

Definition at line 93 of file SparseVector.h.

template<typename _Scalar, int _Options, typename _Index>

void SparseVector< _Scalar, _Options, _Index >::prune	(	Scalar	reference,
		RealScalar	epsilon = `NumTraits<RealScalar>::dummy_precision()`
	)		`[inline]`

Definition at line 183 of file SparseVector.h.

template<typename _Scalar, int _Options, typename _Index>

void SparseVector< _Scalar, _Options, _Index >::reserve ( Index reserveSize ) [inline]

Definition at line 178 of file SparseVector.h.

template<typename _Scalar, int _Options, typename _Index>

void SparseVector< _Scalar, _Options, _Index >::resize	(	Index	rows,
		Index	cols
	)		`[inline]`

Definition at line 188 of file SparseVector.h.

template<typename _Scalar, int _Options, typename _Index>

void SparseVector< _Scalar, _Options, _Index >::resize ( Index newSize ) [inline]

Definition at line 194 of file SparseVector.h.

template<typename _Scalar, int _Options, typename _Index>

void SparseVector< _Scalar, _Options, _Index >::resizeNonZeros ( Index size ) [inline]

Definition at line 200 of file SparseVector.h.

template<typename _Scalar, int _Options, typename _Index>

EIGEN_STRONG_INLINE Index SparseVector< _Scalar, _Options, _Index >::rows ( void ) const [inline]

Returns:: the number of rows.

See also:: cols(), RowsAtCompileTime

Reimplemented from SparseMatrixBase< SparseVector< _Scalar, _Options, _Index > >.

Definition at line 90 of file SparseVector.h.

template<typename _Scalar, int _Options, typename _Index>

void SparseVector< _Scalar, _Options, _Index >::setZero ( ) [inline]

Definition at line 130 of file SparseVector.h.

template<typename _Scalar, int _Options, typename _Index>

EIGEN_DEPRECATED void SparseVector< _Scalar, _Options, _Index >::startFill ( Index reserve ) [inline]

Deprecated:: use setZero() and reserve()

Definition at line 354 of file SparseVector.h.

template<typename _Scalar, int _Options, typename _Index>

void SparseVector< _Scalar, _Options, _Index >::startVec ( Index outer ) [inline]

Definition at line 135 of file SparseVector.h.

template<typename _Scalar , int _Options, typename _Index >

internal::traits< SparseVector< _Scalar, _Options, _Index > >::Scalar SparseVector< _Scalar, _Options, _Index >::sum ( ) const

Overloaded for performance

Reimplemented from SparseMatrixBase< SparseVector< _Scalar, _Options, _Index > >.

Definition at line 50 of file SparseRedux.h.

template<typename _Scalar, int _Options, typename _Index>

void SparseVector< _Scalar, _Options, _Index >::swap ( SparseVector< _Scalar, _Options, _Index > & other ) [inline]

Definition at line 228 of file SparseVector.h.

Friends And Related Function Documentation

template<typename _Scalar, int _Options, typename _Index>

std::ostream& operator<<	(	std::ostream &	s,
		const SparseVector< _Scalar, _Options, _Index > &	m
	)		`[friend]`

Definition at line 315 of file SparseVector.h.

Member Data Documentation

template<typename _Scalar, int _Options, typename _Index>

CompressedStorage<Scalar,Index> SparseVector< _Scalar, _Options, _Index >::m_data

Definition at line 82 of file SparseVector.h.

template<typename _Scalar, int _Options, typename _Index>

Index SparseVector< _Scalar, _Options, _Index >::m_size

Definition at line 83 of file SparseVector.h.

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

Classes

Public Types

Public Member Functions

Public Attributes

Friends

Detailed Description

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

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

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