Public Member Functions
SparseVector< _Scalar, _Options, _Index > Class Template Reference

a sparse vector class More...

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

List of all members.

Public Member Functions

Scalar & coeffRef (Index i)
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)
Index innerSize () const
Index nonZeros () const
Index outerSize () const
Index rows () const
EIGEN_DEPRECATED void startFill (Index reserve)
Scalar sum () const
 ~SparseVector ()

Detailed Description

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

a sparse vector class

Template Parameters:
_Scalarthe 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.


Constructor & Destructor Documentation

~SparseVector ( ) [inline]

Destructor


Member Function Documentation

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

Index cols ( void  ) const [inline]
Returns:
the number of columns.
See also:
rows(), ColsAtCompileTime

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

EIGEN_DEPRECATED void endFill ( ) [inline]
EIGEN_DEPRECATED Scalar& fill ( Index  r,
Index  c 
) [inline]
EIGEN_DEPRECATED Scalar& fill ( Index  i) [inline]
EIGEN_DEPRECATED Scalar& fillrand ( Index  r,
Index  c 
) [inline]
EIGEN_DEPRECATED Scalar& fillrand ( Index  i) [inline]
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 > >.

Index nonZeros ( ) const [inline]
Returns:
the number of non zero coefficients

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

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

Index rows ( void  ) const [inline]
Returns:
the number of rows.
See also:
cols(), RowsAtCompileTime

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

EIGEN_DEPRECATED void startFill ( Index  reserve) [inline]
internal::traits< SparseVector< _Scalar, _Options, _Index > >::Scalar sum ( ) const

Overloaded for performance

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


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