Eigen  3.4.90 (git rev 67eeba6e720c5745abc77ae6c92ce0a44aa7b7ae)
Eigen::SparseVector< Scalar_, Options_, StorageIndex_ > Class Template Reference

Detailed Description

template<typename Scalar_, int Options_, typename StorageIndex_>
class Eigen::SparseVector< Scalar_, Options_, StorageIndex_ >

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 Extending MatrixBase (and other classes) by defining the preprocessor symbol EIGEN_SPARSEVECTOR_PLUGIN.

+ Inheritance diagram for Eigen::SparseVector< Scalar_, Options_, StorageIndex_ >:

Public Member Functions

Scalar & coeffRef (Index i)
 
void conservativeResize (Index newSize)
 
Index nonZeros () const
 
Index prune (const Scalar &reference, const RealScalar &epsilon=NumTraits< RealScalar >::dummy_precision())
 
template<class F >
Index prune (F &&keep_predicate)
 Prunes the entries of the vector based on a predicate More...
 
void resize (Index newSize)
 
void resize (Index rows, Index cols)
 
Scalar sum () const
 
void swap (SparseVector &other)
 
 ~SparseVector ()
 
- Public Member Functions inherited from Eigen::SparseCompressedBase< SparseVector< Scalar_, Options_, StorageIndex_ > >
Map< Array< Scalar, Dynamic, 1 > > coeffs ()
 
const Map< const Array< Scalar, Dynamic, 1 > > coeffs () const
 
StorageIndexinnerIndexPtr ()
 
const StorageIndexinnerIndexPtr () const
 
StorageIndexinnerNonZeroPtr ()
 
const StorageIndexinnerNonZeroPtr () const
 
bool isCompressed () const
 
Index nonZeros () const
 
StorageIndexouterIndexPtr ()
 
const StorageIndexouterIndexPtr () const
 
Scalar * valuePtr ()
 
const Scalar * valuePtr () const
 
- Public Member Functions inherited from Eigen::SparseMatrixBase< SparseVector< Scalar_, Options_, StorageIndex_ > >
Index cols () const
 
const internal::eval< SparseVector< Scalar_, Options_, StorageIndex_ > >::type eval () const
 
Index innerSize () const
 
bool isVector () const
 
const Product< SparseVector< Scalar_, Options_, StorageIndex_ >, OtherDerived, AliasFreeProduct > operator* (const SparseMatrixBase< OtherDerived > &other) const
 
Index outerSize () const
 
const SparseView< SparseVector< Scalar_, Options_, StorageIndex_ > > pruned (const Scalar &reference=Scalar(0), const RealScalar &epsilon=NumTraits< Scalar >::dummy_precision()) const
 
Index rows () const
 
Index size () const
 
SparseSymmetricPermutationProduct< SparseVector< Scalar_, Options_, StorageIndex_ >, Upper|Lower > twistedBy (const PermutationMatrix< Dynamic, Dynamic, StorageIndex > &perm) const
 
- Public Member Functions inherited from Eigen::EigenBase< SparseVector< Scalar_, Options_, StorageIndex_ > >
EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
 
SparseVector< Scalar_, Options_, StorageIndex_ > & derived ()
 
const SparseVector< Scalar_, Options_, StorageIndex_ > & derived () const
 
EIGEN_CONSTEXPR Index rows () const EIGEN_NOEXCEPT
 
EIGEN_CONSTEXPR Index size () const EIGEN_NOEXCEPT
 

Additional Inherited Members

- Public Types inherited from Eigen::SparseMatrixBase< SparseVector< Scalar_, Options_, StorageIndex_ > >
typedef internal::traits< SparseVector< Scalar_, Options_, StorageIndex_ > >::StorageIndex StorageIndex
 
typedef Scalar value_type
 
- Public Types inherited from Eigen::EigenBase< SparseVector< Scalar_, Options_, StorageIndex_ > >
typedef Eigen::Index Index
 The interface type of indices. More...
 
- Protected Member Functions inherited from Eigen::SparseCompressedBase< SparseVector< Scalar_, Options_, StorageIndex_ > >
 SparseCompressedBase ()
 

Constructor & Destructor Documentation

◆ ~SparseVector()

template<typename Scalar_ , int Options_, typename StorageIndex_ >
Eigen::SparseVector< Scalar_, Options_, StorageIndex_ >::~SparseVector ( )
inline

Destructor

Member Function Documentation

◆ coeffRef()

template<typename Scalar_ , int Options_, typename StorageIndex_ >
Scalar& Eigen::SparseVector< Scalar_, Options_, StorageIndex_ >::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.

◆ conservativeResize()

template<typename Scalar_ , int Options_, typename StorageIndex_ >
void Eigen::SparseVector< Scalar_, Options_, StorageIndex_ >::conservativeResize ( Index  newSize)
inline

Resizes the sparse vector to newSize, while leaving old values untouched.

If the size of the vector is decreased, then the storage of the out-of bounds coefficients is kept and reserved. Call .data().squeeze() to free extra memory.

See also
reserve(), setZero()

◆ nonZeros()

template<typename Scalar_ , int Options_, typename StorageIndex_ >
Index Eigen::SparseVector< Scalar_, Options_, StorageIndex_ >::nonZeros ( ) const
inline
Returns
the number of non zero coefficients

◆ prune() [1/2]

template<typename Scalar_ , int Options_, typename StorageIndex_ >
Index Eigen::SparseVector< Scalar_, Options_, StorageIndex_ >::prune ( const Scalar &  reference,
const RealScalar &  epsilon = NumTraits<RealScalar>::dummy_precision() 
)
inline

Suppresses all nonzeros which are much smaller than reference under the tolerance epsilon

◆ prune() [2/2]

template<typename Scalar_ , int Options_, typename StorageIndex_ >
template<class F >
Index Eigen::SparseVector< Scalar_, Options_, StorageIndex_ >::prune ( F &&  keep_predicate)
inline

Prunes the entries of the vector based on a predicate

Template Parameters
FType of the predicate.
Parameters
keep_predicateThe predicate that is used to test whether a value should be kept. A callable that gets passed om a Scalar value and returns a boolean. If the predicate returns true, the value is kept.
Returns
The new number of structural non-zeros.

◆ resize() [1/2]

template<typename Scalar_ , int Options_, typename StorageIndex_ >
void Eigen::SparseVector< Scalar_, Options_, StorageIndex_ >::resize ( Index  newSize)
inline

Resizes the sparse vector to newSize This method deletes all entries, thus leaving an empty sparse vector

See also
conservativeResize(), setZero()

◆ resize() [2/2]

template<typename Scalar_ , int Options_, typename StorageIndex_ >
void Eigen::SparseVector< Scalar_, Options_, StorageIndex_ >::resize ( Index  rows,
Index  cols 
)
inline

Resizes the sparse vector to rows x cols

This method is provided for compatibility with matrices. For a column vector, cols must be equal to 1. For a row vector, rows must be equal to 1.

See also
resize(Index)

◆ sum()

template<typename Scalar_ , int Options_, typename Index_ >
internal::traits< SparseVector< Scalar_, Options_, Index_ > >::Scalar Eigen::SparseVector< Scalar_, Options_, Index_ >::sum

Overloaded for performance

◆ swap()

template<typename Scalar_ , int Options_, typename StorageIndex_ >
void Eigen::SparseVector< Scalar_, Options_, StorageIndex_ >::swap ( SparseVector< Scalar_, Options_, StorageIndex_ > &  other)
inline

Swaps the values of *this and other. Overloaded for performance: this version performs a shallow swap by swapping pointers and attributes only.

See also
SparseMatrixBase::swap()

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