SparseVector< _Scalar, _Options > Class Template Reference

a sparse vector class More...

Inheritance diagram for SparseVector< _Scalar, _Options >:

[legend]

List of all members.

Public Member Functions
Scalar &	coeffRef (int i)
int	cols () const
EIGEN_DEPRECATED void	endFill ()
EIGEN_DEPRECATED Scalar &	fill (int i)
EIGEN_DEPRECATED Scalar &	fill (int r, int c)
EIGEN_DEPRECATED Scalar &	fillrand (int i)
EIGEN_DEPRECATED Scalar &	fillrand (int r, int c)
int	innerSize () const
int	nonZeros () const
int	outerSize () const
int	rows () const
EIGEN_DEPRECATED void	startFill (int reserve)
Scalar	sum () const
	~SparseVector ()

---

Detailed Description

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

a sparse vector class

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.

---

Constructor & Destructor Documentation

~SparseVector

(

)

[inline]

Destructor

---

Member Function Documentation

Scalar& coeffRef

(

int

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.

int cols

(

void

)

const [inline]

Returns:

the number of columns.

See also:

rows(), ColsAtCompileTime

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

EIGEN_DEPRECATED void endFill

(

)

[inline]

EIGEN_DEPRECATED Scalar& fill

(

int

i

)

[inline]

EIGEN_DEPRECATED Scalar& fill	(	int	r,
		int	c
	)			[inline]

EIGEN_DEPRECATED Scalar& fillrand

(

int

i

)

[inline]

EIGEN_DEPRECATED Scalar& fillrand	(	int	r,
		int	c
	)			[inline]

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

int nonZeros

(

)

const [inline]

Returns:

the number of non zero coefficients

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

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

int rows

(

void

)

const [inline]

Returns:

the number of rows.

See also:

cols(), RowsAtCompileTime

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

EIGEN_DEPRECATED void startFill

(

int

reserve

)

[inline]

ei_traits< SparseVector< _Scalar, _Options > >::Scalar sum

(

)

const [inline]

Overloaded for performance

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

---

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

• Sparse