Please, help us to better know about our user community by answering the following short survey: https://forms.gle/wpyrxWi18ox9Z5ae9
Eigen  3.4.0
Loading...
Searching...
No Matches
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
_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 Extending MatrixBase (and other classes) by defining the preprocessor symbol EIGEN_SPARSEVECTOR_PLUGIN.

Inheritance diagram for Eigen::SparseVector< _Scalar, _Options, _StorageIndex >:

Public Member Functions

ScalarcoeffRef (Index i)
void conservativeResize (Index newSize)
Index nonZeros () const
void prune (const Scalar &reference, const RealScalar &epsilon=NumTraits< RealScalar >::dummy_precision())
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 > >
const Map< const Array< Scalar, Dynamic, 1 > > coeffs () const
const StorageIndexinnerIndexPtr () const
const StorageIndexinnerNonZeroPtr () const
bool isCompressed () const
Index nonZeros () const
const StorageIndexouterIndexPtr () const
const Scalar * valuePtr () const
Public Member Functions inherited from Eigen::SparseMatrixBase< SparseVector< _Scalar, _Options, _StorageIndex > >
const CwiseBinaryOp< CustomBinaryOp, const SparseVector< _Scalar, _Options, _StorageIndex >, const OtherDerived > binaryExpr (const Eigen::SparseMatrixBase< OtherDerived > &other, const CustomBinaryOp &func=CustomBinaryOp()) const
FixedBlockXpr<...,... >::Type block (Index startRow, Index startCol, NRowsType blockRows, NColsType blockCols)
FixedBlockXpr<...,... >::Type bottomLeftCorner (NRowsType cRows, NColsType cCols)
FixedBlockXpr<...,... >::Type bottomRightCorner (NRowsType cRows, NColsType cCols)
NRowsBlockXpr<... >::Type bottomRows (NRowsType n)
CastXpr< NewType >::Type cast () const
ColXpr col (Index i)
Index cols () const
ConjugateReturnType conjugate () const
internal::conditional< Cond, ConjugateReturnType, constDerived & >::type conjugateIf () const
const CwiseAbsReturnType cwiseAbs () const
const CwiseAbs2ReturnType cwiseAbs2 () const
const CwiseArgReturnType cwiseArg () const
const CwiseBinaryOp< numext::equal_to< Scalar >, const SparseVector< _Scalar, _Options, _StorageIndex >, const OtherDerived > cwiseEqual (const Eigen::SparseMatrixBase< OtherDerived > &other) const
const CwiseInverseReturnType cwiseInverse () const
const CwiseBinaryOp< internal::scalar_max_op< Scalar, Scalar >, const SparseVector< _Scalar, _Options, _StorageIndex >, const OtherDerived > cwiseMax (const Eigen::SparseMatrixBase< OtherDerived > &other) const
const CwiseBinaryOp< internal::scalar_min_op< Scalar, Scalar >, const SparseVector< _Scalar, _Options, _StorageIndex >, const OtherDerived > cwiseMin (const Eigen::SparseMatrixBase< OtherDerived > &other) const
const CwiseBinaryOp< numext::not_equal_to< Scalar >, const SparseVector< _Scalar, _Options, _StorageIndex >, const OtherDerived > cwiseNotEqual (const Eigen::SparseMatrixBase< OtherDerived > &other) const
const CwiseBinaryOp< internal::scalar_quotient_op< Scalar >, const SparseVector< _Scalar, _Options, _StorageIndex >, const OtherDerived > cwiseQuotient (const Eigen::SparseMatrixBase< OtherDerived > &other) const
const CwiseSignReturnType cwiseSign () const
const CwiseSqrtReturnType cwiseSqrt () const
const internal::eval< SparseVector< _Scalar, _Options, _StorageIndex > >::type eval () const
FixedSegmentReturnType<... >::Type head (NType n)
const ImagReturnType imag () const
Index innerSize () const
InnerVectorReturnType innerVector (Index outer)
InnerVectorsReturnType innerVectors (Index outerStart, Index outerSize)
bool isVector () const
NColsBlockXpr<... >::Type leftCols (NColsType n)
NColsBlockXpr<... >::Type middleCols (Index startCol, NColsType numCols)
NRowsBlockXpr<... >::Type middleRows (Index startRow, NRowsType n)
const CwiseBinaryOp< internal::scalar_boolean_and_op, const SparseVector< _Scalar, _Options, _StorageIndex >, const OtherDerived > operator&& (const Eigen::SparseMatrixBase< OtherDerived > &other) const
const CwiseBinaryOp< internal::scalar_product_op< Scalar, T >, SparseVector< _Scalar, _Options, _StorageIndex >, Constant< T > > operator* (const T &scalar) const
const CwiseBinaryOp< sum< Scalar >, const SparseVector< _Scalar, _Options, _StorageIndex >, const OtherDerived > operator+ (const Eigen::SparseMatrixBase< OtherDerived > &other) const
const NegativeReturnType operator- () const
const CwiseBinaryOp< internal::scalar_quotient_op< Scalar, T >, SparseVector< _Scalar, _Options, _StorageIndex >, Constant< T > > operator/ (const T &scalar) const
const CwiseBinaryOp< internal::scalar_boolean_or_op, const SparseVector< _Scalar, _Options, _StorageIndex >, const OtherDerived > operator|| (const Eigen::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
RealReturnType real () const
NColsBlockXpr<... >::Type rightCols (NColsType n)
RowXpr row (Index i)
Index rows () const
FixedSegmentReturnType<... >::Type segment (Index start, NType n)
Index size () const
internal::conditional< Direction==Vertical, ColXpr, RowXpr >::type subVector (Index i)
EIGEN_CONSTEXPR Index subVectors () const
FixedSegmentReturnType<... >::Type tail (NType n)
FixedBlockXpr<...,... >::Type topLeftCorner (NRowsType cRows, NColsType cCols)
FixedBlockXpr<...,... >::Type topRightCorner (NRowsType cRows, NColsType cCols)
NRowsBlockXpr<... >::Type topRows (NRowsType n)
SparseSymmetricPermutationProduct< SparseVector< _Scalar, _Options, _StorageIndex >, Upper|LowertwistedBy (const PermutationMatrix< Dynamic, Dynamic, StorageIndex > &perm) const
const CwiseUnaryOp< CustomUnaryOp, const SparseVector< _Scalar, _Options, _StorageIndex > > unaryExpr (const CustomUnaryOp &func=CustomUnaryOp()) const
 Apply a unary operator coefficient-wise.
const CwiseUnaryView< CustomViewOp, const SparseVector< _Scalar, _Options, _StorageIndex > > unaryViewExpr (const CustomViewOp &func=CustomViewOp()) const
Public Member Functions inherited from Eigen::EigenBase< SparseVector< _Scalar, _Options, _StorageIndex > >
EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
SparseVector< _Scalar, _Options, _StorageIndex > & derived ()
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.
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()

template<typename _Scalar, int _Options, typename _StorageIndex>
void 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

◆ 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 ( ) const

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: