Classes | Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Friends
Eigen::SparseVector< _Scalar, _Options, _Index > Class Template Reference

a sparse vector class More...

#include <SparseVector.h>

Inheritance diagram for Eigen::SparseVector< _Scalar, _Options, _Index >:
Inheritance graph
[legend]

List of all members.

Classes

class  InnerIterator
class  ReverseInnerIterator

Public Types

enum  { IsColVector = internal::traits<SparseVector>::IsColVector }
enum  { Options = _Options }
typedef SparseMatrixBase
< SparseVector
SparseBase

Public Member Functions

internal::CompressedStorage
< Scalar, Index > & 
_data ()
internal::CompressedStorage
< Scalar, Index > & 
_data () const
Scalar coeff (Index row, Index col) const
Scalar coeff (Index i) const
ScalarcoeffRef (Index row, Index col)
ScalarcoeffRef (Index i)
EIGEN_STRONG_INLINE Index cols () const
EIGEN_DEPRECATED void endFill ()
EIGEN_DEPRECATED Scalarfill (Index r, Index c)
EIGEN_DEPRECATED Scalarfill (Index i)
EIGEN_DEPRECATED Scalarfillrand (Index r, Index c)
EIGEN_DEPRECATED Scalarfillrand (Index i)
void finalize ()
EIGEN_STRONG_INLINE const IndexinnerIndexPtr () const
EIGEN_STRONG_INLINE IndexinnerIndexPtr ()
EIGEN_STRONG_INLINE Index innerSize () const
Scalarinsert (Index row, Index col)
Scalarinsert (Index i)
ScalarinsertBack (Index i)
ScalarinsertBackByOuterInner (Index outer, Index inner)
Index nonZeros () const
SparseVectoroperator= (const SparseVector &other)
template<typename OtherDerived >
SparseVectoroperator= (const SparseMatrixBase< OtherDerived > &other)
template<typename Lhs , typename Rhs >
SparseVectoroperator= (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 SparseMatrixBase< OtherDerived > &other)
 SparseVector (const SparseVector &other)
EIGEN_DEPRECATED void startFill (Index reserve)
void startVec (Index outer)
Scalar sum () const
void swap (SparseVector &other)
EIGEN_STRONG_INLINE const ScalarvaluePtr () const
EIGEN_STRONG_INLINE ScalarvaluePtr ()
 ~SparseVector ()

Public Attributes

internal::CompressedStorage
< Scalar, Index
m_data
Index m_size

Protected Member Functions

template<typename OtherDerived >
EIGEN_DONT_INLINE SparseVectorassign (const SparseMatrixBase< OtherDerived > &_other)

Friends

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

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 TopicCustomizingEigen by defining the preprocessor symbol EIGEN_SPARSEVECTOR_PLUGIN.

Definition at line 51 of file SparseVector.h.


Member Typedef Documentation

template<typename _Scalar , int _Options, typename _Index >
typedef SparseMatrixBase<SparseVector> Eigen::SparseVector< _Scalar, _Options, _Index >::SparseBase

Definition at line 62 of file SparseVector.h.


Member Enumeration Documentation

template<typename _Scalar , int _Options, typename _Index >
anonymous enum
Enumerator:
IsColVector 

Definition at line 63 of file SparseVector.h.

template<typename _Scalar , int _Options, typename _Index >
anonymous enum
Enumerator:
Options 

Definition at line 65 of file SparseVector.h.


Constructor & Destructor Documentation

template<typename _Scalar , int _Options, typename _Index >
Eigen::SparseVector< _Scalar, _Options, _Index >::SparseVector ( ) [inline]

Definition at line 191 of file SparseVector.h.

template<typename _Scalar , int _Options, typename _Index >
Eigen::SparseVector< _Scalar, _Options, _Index >::SparseVector ( Index  size) [inline]

Definition at line 193 of file SparseVector.h.

template<typename _Scalar , int _Options, typename _Index >
Eigen::SparseVector< _Scalar, _Options, _Index >::SparseVector ( Index  rows,
Index  cols 
) [inline]

Definition at line 195 of file SparseVector.h.

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

Definition at line 198 of file SparseVector.h.

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

Definition at line 204 of file SparseVector.h.

template<typename _Scalar , int _Options, typename _Index >
Eigen::SparseVector< _Scalar, _Options, _Index >::~SparseVector ( ) [inline]

Destructor

Definition at line 256 of file SparseVector.h.


Member Function Documentation

template<typename _Scalar , int _Options, typename _Index >
internal::CompressedStorage<Scalar,Index>& Eigen::SparseVector< _Scalar, _Options, _Index >::_data ( ) [inline]

Definition at line 72 of file SparseVector.h.

template<typename _Scalar , int _Options, typename _Index >
internal::CompressedStorage<Scalar,Index>& Eigen::SparseVector< _Scalar, _Options, _Index >::_data ( ) const [inline]

Definition at line 73 of file SparseVector.h.

template<typename _Scalar , int _Options, typename _Index >
template<typename OtherDerived >
EIGEN_DONT_INLINE SparseVector& Eigen::SparseVector< _Scalar, _Options, _Index >::assign ( const SparseMatrixBase< OtherDerived > &  _other) [inline, protected]

Definition at line 306 of file SparseVector.h.

template<typename _Scalar , int _Options, typename _Index >
Scalar Eigen::SparseVector< _Scalar, _Options, _Index >::coeff ( Index  row,
Index  col 
) const [inline]

Definition at line 88 of file SparseVector.h.

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

Definition at line 93 of file SparseVector.h.

template<typename _Scalar , int _Options, typename _Index >
Scalar& Eigen::SparseVector< _Scalar, _Options, _Index >::coeffRef ( Index  row,
Index  col 
) [inline]

Definition at line 95 of file SparseVector.h.

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.

Definition at line 107 of file SparseVector.h.

template<typename _Scalar , int _Options, typename _Index >
EIGEN_STRONG_INLINE Index Eigen::SparseVector< _Scalar, _Options, _Index >::cols ( void  ) const [inline]
Returns:
the number of columns.
See also:
rows()

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

Definition at line 78 of file SparseVector.h.

template<typename _Scalar , int _Options, typename _Index >
EIGEN_DEPRECATED void Eigen::SparseVector< _Scalar, _Options, _Index >::endFill ( ) [inline]
Deprecated:
use finalize()

Definition at line 298 of file SparseVector.h.

template<typename _Scalar , int _Options, typename _Index >
EIGEN_DEPRECATED Scalar& Eigen::SparseVector< _Scalar, _Options, _Index >::fill ( Index  r,
Index  c 
) [inline]
Deprecated:
use insertBack(Index,Index)

Definition at line 271 of file SparseVector.h.

template<typename _Scalar , int _Options, typename _Index >
EIGEN_DEPRECATED Scalar& Eigen::SparseVector< _Scalar, _Options, _Index >::fill ( Index  i) [inline]
Deprecated:
use insertBack(Index)

Definition at line 278 of file SparseVector.h.

template<typename _Scalar , int _Options, typename _Index >
EIGEN_DEPRECATED Scalar& Eigen::SparseVector< _Scalar, _Options, _Index >::fillrand ( Index  r,
Index  c 
) [inline]
Deprecated:
use insert(Index,Index)

Definition at line 285 of file SparseVector.h.

template<typename _Scalar , int _Options, typename _Index >
EIGEN_DEPRECATED Scalar& Eigen::SparseVector< _Scalar, _Options, _Index >::fillrand ( Index  i) [inline]
Deprecated:
use insert(Index)

Definition at line 292 of file SparseVector.h.

template<typename _Scalar , int _Options, typename _Index >
void Eigen::SparseVector< _Scalar, _Options, _Index >::finalize ( ) [inline]

Definition at line 170 of file SparseVector.h.

template<typename _Scalar , int _Options, typename _Index >
EIGEN_STRONG_INLINE const Index* Eigen::SparseVector< _Scalar, _Options, _Index >::innerIndexPtr ( ) const [inline]

Definition at line 85 of file SparseVector.h.

template<typename _Scalar , int _Options, typename _Index >
EIGEN_STRONG_INLINE Index* Eigen::SparseVector< _Scalar, _Options, _Index >::innerIndexPtr ( ) [inline]

Definition at line 86 of file SparseVector.h.

template<typename _Scalar , int _Options, typename _Index >
EIGEN_STRONG_INLINE Index Eigen::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 Eigen::SparseMatrixBase< SparseVector< _Scalar, _Options, _Index > >.

Definition at line 79 of file SparseVector.h.

template<typename _Scalar , int _Options, typename _Index >
Scalar& Eigen::SparseVector< _Scalar, _Options, _Index >::insert ( Index  row,
Index  col 
) [inline]

Definition at line 140 of file SparseVector.h.

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

Definition at line 147 of file SparseVector.h.

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

Definition at line 134 of file SparseVector.h.

template<typename _Scalar , int _Options, typename _Index >
Scalar& Eigen::SparseVector< _Scalar, _Options, _Index >::insertBackByOuterInner ( Index  outer,
Index  inner 
) [inline]

Definition at line 128 of file SparseVector.h.

template<typename _Scalar , int _Options, typename _Index >
Index Eigen::SparseVector< _Scalar, _Options, _Index >::nonZeros ( ) const [inline]
Returns:
the number of non zero coefficients

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

Definition at line 120 of file SparseVector.h.

template<typename _Scalar , int _Options, typename _Index >
SparseVector& Eigen::SparseVector< _Scalar, _Options, _Index >::operator= ( const SparseVector< _Scalar, _Options, _Index > &  other) [inline]
template<typename _Scalar , int _Options, typename _Index >
template<typename OtherDerived >
SparseVector& Eigen::SparseVector< _Scalar, _Options, _Index >::operator= ( const SparseMatrixBase< OtherDerived > &  other) [inline]
template<typename _Scalar , int _Options, typename _Index >
template<typename Lhs , typename Rhs >
SparseVector& Eigen::SparseVector< _Scalar, _Options, _Index >::operator= ( const SparseSparseProduct< Lhs, Rhs > &  product) [inline]
template<typename _Scalar , int _Options, typename _Index >
EIGEN_STRONG_INLINE Index Eigen::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 Eigen::SparseMatrixBase< SparseVector< _Scalar, _Options, _Index > >.

Definition at line 80 of file SparseVector.h.

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

Definition at line 172 of file SparseVector.h.

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

Definition at line 167 of file SparseVector.h.

template<typename _Scalar , int _Options, typename _Index >
void Eigen::SparseVector< _Scalar, _Options, _Index >::resize ( Index  rows,
Index  cols 
) [inline]

Definition at line 177 of file SparseVector.h.

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

Definition at line 183 of file SparseVector.h.

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

Definition at line 189 of file SparseVector.h.

template<typename _Scalar , int _Options, typename _Index >
EIGEN_STRONG_INLINE Index Eigen::SparseVector< _Scalar, _Options, _Index >::rows ( void  ) const [inline]
Returns:
the number of rows.
See also:
cols()

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

Definition at line 77 of file SparseVector.h.

template<typename _Scalar , int _Options, typename _Index >
void Eigen::SparseVector< _Scalar, _Options, _Index >::setZero ( ) [inline]

Definition at line 117 of file SparseVector.h.

template<typename _Scalar , int _Options, typename _Index >
EIGEN_DEPRECATED void Eigen::SparseVector< _Scalar, _Options, _Index >::startFill ( Index  reserve) [inline]
Deprecated:
use setZero() and reserve()

Definition at line 264 of file SparseVector.h.

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

Definition at line 122 of file SparseVector.h.

template<typename _Scalar , int _Options, typename _Index >
internal::traits< SparseVector< _Scalar, _Options, _Index > >::Scalar Eigen::SparseVector< _Scalar, _Options, _Index >::sum ( ) const

Overloaded for performance

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

Definition at line 37 of file SparseRedux.h.

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

Definition at line 210 of file SparseVector.h.

template<typename _Scalar , int _Options, typename _Index >
EIGEN_STRONG_INLINE const Scalar* Eigen::SparseVector< _Scalar, _Options, _Index >::valuePtr ( ) const [inline]

Definition at line 82 of file SparseVector.h.

template<typename _Scalar , int _Options, typename _Index >
EIGEN_STRONG_INLINE Scalar* Eigen::SparseVector< _Scalar, _Options, _Index >::valuePtr ( ) [inline]

Definition at line 83 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 247 of file SparseVector.h.


Member Data Documentation

template<typename _Scalar , int _Options, typename _Index >
internal::CompressedStorage<Scalar,Index> Eigen::SparseVector< _Scalar, _Options, _Index >::m_data

Definition at line 69 of file SparseVector.h.

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

Definition at line 70 of file SparseVector.h.


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


win_eigen
Author(s): Daniel Stonier
autogenerated on Mon Oct 6 2014 12:27:20