Public Types | Public Member Functions | Static Protected Member Functions | Protected Attributes | Private Types | Friends | List of all members
Eigen::SparseVector< _Scalar, _Options, _StorageIndex > Class Template Reference

a sparse vector class More...

#include <SparseUtil.h>

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

Public Types

enum  { IsColVector = internal::traits<SparseVector>::IsColVector }
 
enum  { Options = _Options }
 
typedef Base::InnerIterator InnerIterator
 
typedef Base::ReverseInnerIterator ReverseInnerIterator
 
typedef internal::CompressedStorage< Scalar, StorageIndexStorage
 
- Public Types inherited from Eigen::SparseCompressedBase< SparseVector< _Scalar, _Options, _StorageIndex > >
typedef SparseMatrixBase< SparseVector< _Scalar, _Options, _StorageIndex > > Base
 
- Public Types inherited from Eigen::SparseMatrixBase< SparseVector< _Scalar, _Options, _StorageIndex > >
enum  
 
typedef internal::conditional< NumTraits< Scalar >::IsComplex, CwiseUnaryOp< internal::scalar_conjugate_op< Scalar >, Eigen::Transpose< const SparseVector< _Scalar, _Options, _StorageIndex > > >, Transpose< const SparseVector< _Scalar, _Options, _StorageIndex > > >::type AdjointReturnType
 
typedef EigenBase< SparseVector< _Scalar, _Options, _StorageIndex > > Base
 
typedef Block< SparseVector< _Scalar, _Options, _StorageIndex > > BlockXpr
 
typedef internal::conditional< _HasDirectAccess, const Scalar &, Scalar >::type CoeffReturnType
 
typedef Block< SparseVector< _Scalar, _Options, _StorageIndex >, internal::traits< SparseVector< _Scalar, _Options, _StorageIndex > >::RowsAtCompileTime, Dynamic, !IsRowMajorColsBlockXpr
 
typedef Block< SparseVector< _Scalar, _Options, _StorageIndex >, internal::traits< SparseVector< _Scalar, _Options, _StorageIndex > >::RowsAtCompileTime, 1, !IsRowMajorColXpr
 
typedef internal::conditional< NumTraits< Scalar >::IsComplex, const CwiseUnaryOp< internal::scalar_conjugate_op< Scalar >, const SparseVector< _Scalar, _Options, _StorageIndex > >, const SparseVector< _Scalar, _Options, _StorageIndex > & >::type ConjugateReturnType
 
typedef CwiseNullaryOp< internal::scalar_constant_op< Scalar >, Matrix< Scalar, Dynamic, Dynamic > > ConstantReturnType
 
typedef const Block< const SparseVector< _Scalar, _Options, _StorageIndex > > ConstBlockXpr
 
typedef const Block< const SparseVector< _Scalar, _Options, _StorageIndex >, internal::traits< SparseVector< _Scalar, _Options, _StorageIndex > >::RowsAtCompileTime, Dynamic, !IsRowMajorConstColsBlockXpr
 
typedef const Block< const SparseVector< _Scalar, _Options, _StorageIndex >, internal::traits< SparseVector< _Scalar, _Options, _StorageIndex > >::RowsAtCompileTime, 1, !IsRowMajorConstColXpr
 
typedef Block< const SparseVector< _Scalar, _Options, _StorageIndex >, IsRowMajor?1:Dynamic, IsRowMajor?Dynamic:1, true > ConstInnerVectorReturnType
 
typedef Block< const SparseVector< _Scalar, _Options, _StorageIndex >, Dynamic, Dynamic, true > ConstInnerVectorsReturnType
 
typedef const Block< const SparseVector< _Scalar, _Options, _StorageIndex >, Dynamic, internal::traits< SparseVector< _Scalar, _Options, _StorageIndex > >::ColsAtCompileTime, IsRowMajorConstRowsBlockXpr
 
typedef const Block< const SparseVector< _Scalar, _Options, _StorageIndex >, 1, internal::traits< SparseVector< _Scalar, _Options, _StorageIndex > >::ColsAtCompileTime, IsRowMajorConstRowXpr
 
typedef const VectorBlock< const SparseVector< _Scalar, _Options, _StorageIndex > > ConstSegmentReturnType
 
typedef internal::add_const< Transpose< const SparseVector< _Scalar, _Options, _StorageIndex > > >::type ConstTransposeReturnType
 
typedef CwiseUnaryOp< internal::scalar_abs2_op< Scalar >, const SparseVector< _Scalar, _Options, _StorageIndex > > CwiseAbs2ReturnType
 
typedef CwiseUnaryOp< internal::scalar_abs_op< Scalar >, const SparseVector< _Scalar, _Options, _StorageIndex > > CwiseAbsReturnType
 
typedef CwiseUnaryOp< internal::scalar_arg_op< Scalar >, const SparseVector< _Scalar, _Options, _StorageIndex > > CwiseArgReturnType
 
typedef CwiseUnaryOp< internal::scalar_inverse_op< Scalar >, const SparseVector< _Scalar, _Options, _StorageIndex > > CwiseInverseReturnType
 
typedef CwiseBinaryOp< internal::scalar_cmp_op< Scalar, Scalar, internal::cmp_EQ >, const SparseVector< _Scalar, _Options, _StorageIndex >, const ConstantReturnTypeCwiseScalarEqualReturnType
 
typedef CwiseUnaryOp< internal::scalar_sign_op< Scalar >, const SparseVector< _Scalar, _Options, _StorageIndex > > CwiseSignReturnType
 
typedef CwiseUnaryOp< internal::scalar_sqrt_op< Scalar >, const SparseVector< _Scalar, _Options, _StorageIndex > > CwiseSqrtReturnType
 
typedef Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTimeDenseMatrixType
 
typedef CwiseUnaryOp< internal::scalar_imag_op< Scalar >, const SparseVector< _Scalar, _Options, _StorageIndex > > ImagReturnType
 
typedef Matrix< StorageIndex, Dynamic, 1 > IndexVector
 
typedef Block< SparseVector< _Scalar, _Options, _StorageIndex >, IsRowMajor?1:Dynamic, IsRowMajor?Dynamic:1, true > InnerVectorReturnType
 
typedef Block< SparseVector< _Scalar, _Options, _StorageIndex >, Dynamic, Dynamic, true > InnerVectorsReturnType
 
typedef CwiseUnaryOp< internal::scalar_opposite_op< Scalar >, const SparseVector< _Scalar, _Options, _StorageIndex > > NegativeReturnType
 
typedef CwiseUnaryView< internal::scalar_imag_ref_op< Scalar >, SparseVector< _Scalar, _Options, _StorageIndex > > NonConstImagReturnType
 
typedef internal::conditional< NumTraits< Scalar >::IsComplex, CwiseUnaryView< internal::scalar_real_ref_op< Scalar >, SparseVector< _Scalar, _Options, _StorageIndex > >, SparseVector< _Scalar, _Options, _StorageIndex > & >::type NonConstRealReturnType
 
typedef internal::add_const_on_value_type_if_arithmetic< typename internal::packet_traits< Scalar >::type >::type PacketReturnType
 
typedef internal::packet_traits< Scalar >::type PacketScalar
 
typedef SparseMatrix< Scalar, Flags &RowMajorBit ? RowMajor :ColMajor, StorageIndexPlainObject
 
typedef internal::conditional< NumTraits< Scalar >::IsComplex, const CwiseUnaryOp< internal::scalar_real_op< Scalar >, const SparseVector< _Scalar, _Options, _StorageIndex > >, const SparseVector< _Scalar, _Options, _StorageIndex > & >::type RealReturnType
 
typedef NumTraits< Scalar >::Real RealScalar
 
typedef Block< SparseVector< _Scalar, _Options, _StorageIndex >, Dynamic, internal::traits< SparseVector< _Scalar, _Options, _StorageIndex > >::ColsAtCompileTime, IsRowMajorRowsBlockXpr
 
typedef Block< SparseVector< _Scalar, _Options, _StorageIndex >, 1, internal::traits< SparseVector< _Scalar, _Options, _StorageIndex > >::ColsAtCompileTime, IsRowMajorRowXpr
 
typedef internal::traits< SparseVector< _Scalar, _Options, _StorageIndex > >::Scalar Scalar
 
typedef Matrix< Scalar, Dynamic, 1 > ScalarVector
 
typedef VectorBlock< SparseVector< _Scalar, _Options, _StorageIndex > > SegmentReturnType
 
typedef Matrix< Scalar, EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime), EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime)> SquareMatrixType
 
typedef SparseMatrixBase StorageBaseType
 
typedef internal::traits< SparseVector< _Scalar, _Options, _StorageIndex > >::StorageIndex StorageIndex
 
typedef internal::traits< SparseVector< _Scalar, _Options, _StorageIndex > >::StorageKind StorageKind
 
typedef Transpose< SparseVector< _Scalar, _Options, _StorageIndex > > TransposeReturnType
 
typedef Scalar value_type
 
- Public Types inherited from Eigen::EigenBase< Derived >
typedef Eigen::Index Index
 The interface type of indices. More...
 
typedef internal::traits< Derived >::StorageKind StorageKind
 

Public Member Functions

EIGEN_DEPRECATED Storage_data ()
 
EIGEN_DEPRECATED const Storage_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
 
void conservativeResize (Index newSize)
 
Storagedata ()
 
const Storagedata () 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 StorageIndexinnerIndexPtr () const
 
EIGEN_STRONG_INLINE StorageIndexinnerIndexPtr ()
 
const StorageIndexinnerNonZeroPtr () const
 
StorageIndexinnerNonZeroPtr ()
 
EIGEN_STRONG_INLINE Index innerSize () const
 
Scalarinsert (Index row, Index col)
 
Scalarinsert (Index i)
 
ScalarinsertBack (Index i)
 
ScalarinsertBackByOuterInner (Index outer, Index inner)
 
ScalarinsertBackByOuterInnerUnordered (Index outer, Index inner)
 
ScalarinsertBackUnordered (Index i)
 
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)
 
const StorageIndexouterIndexPtr () const
 
StorageIndexouterIndexPtr ()
 
EIGEN_STRONG_INLINE Index outerSize () const
 
void prune (const Scalar &reference, const 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)
 
template<int OtherOptions>
void swap (SparseMatrix< Scalar, OtherOptions, StorageIndex > &other)
 
EIGEN_STRONG_INLINE const ScalarvaluePtr () const
 
EIGEN_STRONG_INLINE ScalarvaluePtr ()
 
 ~SparseVector ()
 
- Public Member Functions inherited from Eigen::SparseCompressedBase< SparseVector< _Scalar, _Options, _StorageIndex > >
const Map< const Array< Scalar, Dynamic, 1 > > coeffs () const
 
Map< Array< Scalar, Dynamic, 1 > > coeffs ()
 
const StorageIndexinnerIndexPtr () const
 
StorageIndexinnerIndexPtr ()
 
const StorageIndexinnerNonZeroPtr () const
 
StorageIndexinnerNonZeroPtr ()
 
bool isCompressed () const
 
Index nonZeros () const
 
const StorageIndexouterIndexPtr () const
 
StorageIndexouterIndexPtr ()
 
const ScalarvaluePtr () const
 
ScalarvaluePtr ()
 
- Public Member Functions inherited from Eigen::SparseMatrixBase< SparseVector< _Scalar, _Options, _StorageIndex > >
const AdjointReturnType adjoint () const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp< CustomBinaryOp, const SparseVector< _Scalar, _Options, _StorageIndex >, const OtherDerived > binaryExpr (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other, const CustomBinaryOp &func=CustomBinaryOp()) const
 
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedBlockXpr< internal::get_fixed_value< NRowsType >::value, internal::get_fixed_value< NColsType >::value >::Type block (Index startRow, Index startCol, NRowsType blockRows, NColsType blockCols)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedBlockXpr< internal::get_fixed_value< NRowsType >::value, internal::get_fixed_value< NColsType >::value >::Type block (Index startRow, Index startCol, NRowsType blockRows, NColsType blockCols) const
 This is the const version of block(Index,Index,NRowsType,NColsType) More...
 
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedBlockXpr< NRows, NCols >::Type block (Index startRow, Index startCol)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedBlockXpr< NRows, NCols >::Type block (Index startRow, Index startCol) const
 This is the const version of block<>(Index, Index). */. More...
 
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedBlockXpr< NRows, NCols >::Type block (Index startRow, Index startCol, Index blockRows, Index blockCols)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedBlockXpr< NRows, NCols >::Type block (Index startRow, Index startCol, Index blockRows, Index blockCols) const
 This is the const version of block<>(Index, Index, Index, Index). More...
 
RealScalar blueNorm () const
 
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedBlockXpr< internal::get_fixed_value< NRowsType >::value, internal::get_fixed_value< NColsType >::value >::Type bottomLeftCorner (NRowsType cRows, NColsType cCols)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE ConstFixedBlockXpr< internal::get_fixed_value< NRowsType >::value, internal::get_fixed_value< NColsType >::value >::Type bottomLeftCorner (NRowsType cRows, NColsType cCols) const
 This is the const version of bottomLeftCorner(NRowsType, NColsType). More...
 
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedBlockXpr< CRows, CCols >::Type bottomLeftCorner ()
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedBlockXpr< CRows, CCols >::Type bottomLeftCorner () const
 This is the const version of bottomLeftCorner<int, int>(). More...
 
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_STRONG_INLINE FixedBlockXpr< CRows, CCols >::Type bottomLeftCorner (Index cRows, Index cCols)
 
EIGEN_STRONG_INLINE const ConstFixedBlockXpr< CRows, CCols >::Type bottomLeftCorner (Index cRows, Index cCols) const
 This is the const version of bottomLeftCorner<int, int>(Index, Index). More...
 
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedBlockXpr< internal::get_fixed_value< NRowsType >::value, internal::get_fixed_value< NColsType >::value >::Type bottomRightCorner (NRowsType cRows, NColsType cCols)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedBlockXpr< internal::get_fixed_value< NRowsType >::value, internal::get_fixed_value< NColsType >::value >::Type bottomRightCorner (NRowsType cRows, NColsType cCols) const
 This is the const version of bottomRightCorner(NRowsType, NColsType). More...
 
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedBlockXpr< CRows, CCols >::Type bottomRightCorner ()
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedBlockXpr< CRows, CCols >::Type bottomRightCorner () const
 This is the const version of bottomRightCorner<int, int>(). More...
 
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedBlockXpr< CRows, CCols >::Type bottomRightCorner (Index cRows, Index cCols)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedBlockXpr< CRows, CCols >::Type bottomRightCorner (Index cRows, Index cCols) const
 This is the const version of bottomRightCorner<int, int>(Index, Index). More...
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE NRowsBlockXpr< internal::get_fixed_value< NRowsType >::value >::Type bottomRows (NRowsType n)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstNRowsBlockXpr< internal::get_fixed_value< NRowsType >::value >::Type bottomRows (NRowsType n) const
 This is the const version of bottomRows(NRowsType). More...
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE NRowsBlockXpr< N >::Type bottomRows (Index n=N)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE ConstNRowsBlockXpr< N >::Type bottomRows (Index n=N) const
 This is the const version of bottomRows<int>(). More...
 
EIGEN_DEVICE_FUNC CastXpr< NewType >::Type cast () const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE ColXpr col (Index i)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE ConstColXpr col (Index i) const
 This is the const version of col(). More...
 
Index cols () const
 
EIGEN_DEVICE_FUNC ConjugateReturnType conjugate () const
 
EIGEN_DEVICE_FUNC internal::conditional< Cond, ConjugateReturnType, const SparseVector< _Scalar, _Options, _StorageIndex > &>::type conjugateIf () const
 
SparseVector< _Scalar, _Options, _StorageIndex > & const_cast_derived () const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseAbsReturnType cwiseAbs () const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseAbs2ReturnType cwiseAbs2 () const
 
EIGEN_DEVICE_FUNC const CwiseArgReturnType cwiseArg () const
 
EIGEN_DEVICE_FUNC const CwiseBinaryOp< numext::equal_to< Scalar >, const SparseVector< _Scalar, _Options, _StorageIndex >, const OtherDerived > cwiseEqual (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
 
EIGEN_DEVICE_FUNC const CwiseScalarEqualReturnType cwiseEqual (const Scalar &s) const
 
EIGEN_DEVICE_FUNC const CwiseInverseReturnType cwiseInverse () const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_max_op< Scalar, Scalar >, const SparseVector< _Scalar, _Options, _StorageIndex >, const OtherDerived > cwiseMax (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_max_op< Scalar, Scalar >, const SparseVector< _Scalar, _Options, _StorageIndex >, const ConstantReturnTypecwiseMax (const Scalar &other) const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_min_op< Scalar, Scalar >, const SparseVector< _Scalar, _Options, _StorageIndex >, const OtherDerived > cwiseMin (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_min_op< Scalar, Scalar >, const SparseVector< _Scalar, _Options, _StorageIndex >, const ConstantReturnTypecwiseMin (const Scalar &other) const
 
EIGEN_DEVICE_FUNC const CwiseBinaryOp< numext::not_equal_to< Scalar >, const SparseVector< _Scalar, _Options, _StorageIndex >, const OtherDerived > cwiseNotEqual (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
 
EIGEN_STRONG_INLINE const CwiseProductDenseReturnType< OtherDerived >::Type cwiseProduct (const MatrixBase< OtherDerived > &other) const
 
EIGEN_STRONG_INLINE const SparseMatrixBase< SparseVector< _Scalar, _Options, _StorageIndex > >::template CwiseProductDenseReturnType< OtherDerived >::Type cwiseProduct (const MatrixBase< OtherDerived > &other) const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_quotient_op< Scalar >, const SparseVector< _Scalar, _Options, _StorageIndex >, const OtherDerived > cwiseQuotient (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
 
EIGEN_DEVICE_FUNC const CwiseSignReturnType cwiseSign () const
 
EIGEN_DEVICE_FUNC const CwiseSqrtReturnType cwiseSqrt () const
 
const SparseVector< _Scalar, _Options, _StorageIndex > & derived () const
 
SparseVector< _Scalar, _Options, _StorageIndex > & derived ()
 
internal::traits< SparseVector< _Scalar, _Options, _StorageIndex > >::Scalar dot (const MatrixBase< OtherDerived > &other) const
 
internal::traits< SparseVector< _Scalar, _Options, _StorageIndex > >::Scalar dot (const SparseMatrixBase< OtherDerived > &other) const
 
Scalar dot (const MatrixBase< OtherDerived > &other) const
 
Scalar dot (const SparseMatrixBase< OtherDerived > &other) const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const EIGEN_CWISE_BINARY_RETURN_TYPE (SparseVector< _Scalar, _Options, _StorageIndex >, OtherDerived, product) cwiseProduct(const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
 
const internal::eval< SparseVector< _Scalar, _Options, _StorageIndex > >::type eval () const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedSegmentReturnType< internal::get_fixed_value< NType >::value >::Type head (NType n)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedSegmentReturnType< internal::get_fixed_value< NType >::value >::Type head (NType n) const
 This is the const version of head(NType). More...
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedSegmentReturnType< N >::Type head (Index n=N)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE ConstFixedSegmentReturnType< N >::Type head (Index n=N) const
 This is the const version of head<int>(). More...
 
EIGEN_DEVICE_FUNC const ImagReturnType imag () const
 
EIGEN_DEVICE_FUNC NonConstImagReturnType imag ()
 
Index innerSize () const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE InnerVectorReturnType innerVector (Index outer)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstInnerVectorReturnType innerVector (Index outer) const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE InnerVectorsReturnType innerVectors (Index outerStart, Index outerSize)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstInnerVectorsReturnType innerVectors (Index outerStart, Index outerSize) const
 
bool isApprox (const SparseMatrixBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
 
bool isApprox (const MatrixBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
 
bool isRValue () const
 
bool isVector () const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE NColsBlockXpr< internal::get_fixed_value< NColsType >::value >::Type leftCols (NColsType n)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstNColsBlockXpr< internal::get_fixed_value< NColsType >::value >::Type leftCols (NColsType n) const
 This is the const version of leftCols(NColsType). More...
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE NColsBlockXpr< N >::Type leftCols (Index n=N)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE ConstNColsBlockXpr< N >::Type leftCols (Index n=N) const
 This is the const version of leftCols<int>(). More...
 
SparseVector< _Scalar, _Options, _StorageIndex > & markAsRValue ()
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE NColsBlockXpr< internal::get_fixed_value< NColsType >::value >::Type middleCols (Index startCol, NColsType numCols)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstNColsBlockXpr< internal::get_fixed_value< NColsType >::value >::Type middleCols (Index startCol, NColsType numCols) const
 This is the const version of middleCols(Index,NColsType). More...
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE NColsBlockXpr< N >::Type middleCols (Index startCol, Index n=N)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE ConstNColsBlockXpr< N >::Type middleCols (Index startCol, Index n=N) const
 This is the const version of middleCols<int>(). More...
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE NRowsBlockXpr< internal::get_fixed_value< NRowsType >::value >::Type middleRows (Index startRow, NRowsType n)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstNRowsBlockXpr< internal::get_fixed_value< NRowsType >::value >::Type middleRows (Index startRow, NRowsType n) const
 This is the const version of middleRows(Index,NRowsType). More...
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE NRowsBlockXpr< N >::Type middleRows (Index startRow, Index n=N)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE ConstNRowsBlockXpr< N >::Type middleRows (Index startRow, Index n=N) const
 This is the const version of middleRows<int>(). More...
 
RealScalar norm () const
 
EIGEN_DEVICE_FUNC const CwiseBinaryOp< internal::scalar_boolean_and_op, const SparseVector< _Scalar, _Options, _StorageIndex >, const OtherDerived > operator&& (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const
 
const Product< SparseVector< _Scalar, _Options, _StorageIndex >, OtherDerived > operator* (const DiagonalBase< OtherDerived > &other) const
 
const Product< SparseVector< _Scalar, _Options, _StorageIndex >, OtherDerived, AliasFreeProduct > operator* (const SparseMatrixBase< OtherDerived > &other) const
 
const Product< SparseVector< _Scalar, _Options, _StorageIndex >, OtherDerived > operator* (const MatrixBase< OtherDerived > &other) const
 
SparseVector< _Scalar, _Options, _StorageIndex > & operator*= (const Scalar &other)
 
SparseVector< _Scalar, _Options, _StorageIndex > & operator*= (const SparseMatrixBase< OtherDerived > &other)
 
SparseVector< _Scalar, _Options, _StorageIndex > & operator+= (const SparseMatrixBase< OtherDerived > &other)
 
SparseVector< _Scalar, _Options, _StorageIndex > & operator+= (const DiagonalBase< OtherDerived > &other)
 
SparseVector< _Scalar, _Options, _StorageIndex > & operator+= (const EigenBase< OtherDerived > &other)
 
EIGEN_STRONG_INLINE SparseVector< _Scalar, _Options, _StorageIndex > & operator+= (const SparseMatrixBase< OtherDerived > &other)
 
EIGEN_DEVICE_FUNC const NegativeReturnType operator- () const
 
SparseVector< _Scalar, _Options, _StorageIndex > & operator-= (const SparseMatrixBase< OtherDerived > &other)
 
SparseVector< _Scalar, _Options, _StorageIndex > & operator-= (const DiagonalBase< OtherDerived > &other)
 
SparseVector< _Scalar, _Options, _StorageIndex > & operator-= (const EigenBase< OtherDerived > &other)
 
EIGEN_STRONG_INLINE SparseVector< _Scalar, _Options, _StorageIndex > & operator-= (const SparseMatrixBase< OtherDerived > &other)
 
SparseVector< _Scalar, _Options, _StorageIndex > & operator/= (const Scalar &other)
 
SparseVector< _Scalar, _Options, _StorageIndex > & operator= (const EigenBase< OtherDerived > &other)
 
SparseVector< _Scalar, _Options, _StorageIndex > & operator= (const ReturnByValue< OtherDerived > &other)
 
SparseVector< _Scalar, _Options, _StorageIndex > & operator= (const SparseMatrixBase< OtherDerived > &other)
 
SparseVector< _Scalar, _Options, _StorageIndex > & operator= (const SparseVector< _Scalar, _Options, _StorageIndex > &other)
 
EIGEN_DEVICE_FUNC const CwiseBinaryOp< internal::scalar_boolean_or_op, const SparseVector< _Scalar, _Options, _StorageIndex >, const OtherDerived > operator|| (const EIGEN_CURRENT_STORAGE_BASE_CLASS< 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
 
EIGEN_DEVICE_FUNC RealReturnType real () const
 
EIGEN_DEVICE_FUNC NonConstRealReturnType real ()
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE NColsBlockXpr< internal::get_fixed_value< NColsType >::value >::Type rightCols (NColsType n)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstNColsBlockXpr< internal::get_fixed_value< NColsType >::value >::Type rightCols (NColsType n) const
 This is the const version of rightCols(NColsType). More...
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE NColsBlockXpr< N >::Type rightCols (Index n=N)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE ConstNColsBlockXpr< N >::Type rightCols (Index n=N) const
 This is the const version of rightCols<int>(). More...
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE RowXpr row (Index i)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE ConstRowXpr row (Index i) const
 This is the const version of row(). */. More...
 
Index rows () const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedSegmentReturnType< internal::get_fixed_value< NType >::value >::Type segment (Index start, NType n)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedSegmentReturnType< internal::get_fixed_value< NType >::value >::Type segment (Index start, NType n) const
 This is the const version of segment(Index,NType). More...
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedSegmentReturnType< N >::Type segment (Index start, Index n=N)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE ConstFixedSegmentReturnType< N >::Type segment (Index start, Index n=N) const
 This is the const version of segment<int>(Index). More...
 
SparseMatrixBase< SparseVector< _Scalar, _Options, _StorageIndex > >::template ConstSelfAdjointViewReturnType< UpLo >::Type selfadjointView () const
 
SparseMatrixBase< SparseVector< _Scalar, _Options, _StorageIndex > >::template SelfAdjointViewReturnType< UpLo >::Type selfadjointView ()
 
ConstSelfAdjointViewReturnType< UpLo >::Type selfadjointView () const
 
SelfAdjointViewReturnType< UpLo >::Type selfadjointView ()
 
Index size () const
 
 SparseMatrixBase ()
 
RealScalar squaredNorm () const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE internal::conditional< Direction==Vertical, ColXpr, RowXpr >::type subVector (Index i)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE internal::conditional< Direction==Vertical, ConstColXpr, ConstRowXpr >::type subVector (Index i) const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR Index subVectors () const
 
Scalar sum () const
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedSegmentReturnType< internal::get_fixed_value< NType >::value >::Type tail (NType n)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedSegmentReturnType< internal::get_fixed_value< NType >::value >::Type tail (NType n) const
 This is the const version of tail(Index). More...
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedSegmentReturnType< N >::Type tail (Index n=N)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE ConstFixedSegmentReturnType< N >::Type tail (Index n=N) const
 This is the const version of tail<int>. More...
 
DenseMatrixType toDense () const
 
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedBlockXpr< internal::get_fixed_value< NRowsType >::value, internal::get_fixed_value< NColsType >::value >::Type topLeftCorner (NRowsType cRows, NColsType cCols)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedBlockXpr< internal::get_fixed_value< NRowsType >::value, internal::get_fixed_value< NColsType >::value >::Type topLeftCorner (NRowsType cRows, NColsType cCols) const
 This is the const version of topLeftCorner(Index, Index). More...
 
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedBlockXpr< CRows, CCols >::Type topLeftCorner ()
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedBlockXpr< CRows, CCols >::Type topLeftCorner () const
 This is the const version of topLeftCorner<int, int>(). More...
 
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedBlockXpr< CRows, CCols >::Type topLeftCorner (Index cRows, Index cCols)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedBlockXpr< CRows, CCols >::Type topLeftCorner (Index cRows, Index cCols) const
 This is the const version of topLeftCorner<int, int>(Index, Index). More...
 
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedBlockXpr< internal::get_fixed_value< NRowsType >::value, internal::get_fixed_value< NColsType >::value >::Type topRightCorner (NRowsType cRows, NColsType cCols)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedBlockXpr< internal::get_fixed_value< NRowsType >::value, internal::get_fixed_value< NColsType >::value >::Type topRightCorner (NRowsType cRows, NColsType cCols) const
 This is the const version of topRightCorner(NRowsType, NColsType). More...
 
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedBlockXpr< CRows, CCols >::Type topRightCorner ()
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedBlockXpr< CRows, CCols >::Type topRightCorner () const
 This is the const version of topRightCorner<int, int>(). More...
 
EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE FixedBlockXpr< CRows, CCols >::Type topRightCorner (Index cRows, Index cCols)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstFixedBlockXpr< CRows, CCols >::Type topRightCorner (Index cRows, Index cCols) const
 This is the const version of topRightCorner<int, int>(Index, Index). More...
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE NRowsBlockXpr< internal::get_fixed_value< NRowsType >::value >::Type topRows (NRowsType n)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE const ConstNRowsBlockXpr< internal::get_fixed_value< NRowsType >::value >::Type topRows (NRowsType n) const
 This is the const version of topRows(NRowsType). More...
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE NRowsBlockXpr< N >::Type topRows (Index n=N)
 
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE ConstNRowsBlockXpr< N >::Type topRows (Index n=N) const
 This is the const version of topRows<int>(). More...
 
TransposeReturnType transpose ()
 
const ConstTransposeReturnType transpose () const
 
const TriangularView< const SparseVector< _Scalar, _Options, _StorageIndex >, Mode > triangularView () const
 
SparseSymmetricPermutationProduct< SparseVector< _Scalar, _Options, _StorageIndex >, Upper|Lower > twistedBy (const PermutationMatrix< Dynamic, Dynamic, StorageIndex > &perm) const
 
EIGEN_DEVICE_FUNC const CwiseUnaryOp< CustomUnaryOp, const SparseVector< _Scalar, _Options, _StorageIndex > > unaryExpr (const CustomUnaryOp &func=CustomUnaryOp()) const
 Apply a unary operator coefficient-wise. More...
 
EIGEN_DEVICE_FUNC const CwiseUnaryView< CustomViewOp, const SparseVector< _Scalar, _Options, _StorageIndex > > unaryViewExpr (const CustomViewOp &func=CustomViewOp()) const
 
- Public Member Functions inherited from Eigen::EigenBase< Derived >
template<typename Dest >
EIGEN_DEVICE_FUNC void addTo (Dest &dst) const
 
template<typename Dest >
EIGEN_DEVICE_FUNC void applyThisOnTheLeft (Dest &dst) const
 
template<typename Dest >
EIGEN_DEVICE_FUNC void applyThisOnTheRight (Dest &dst) const
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC Derived & const_cast_derived () const
 
EIGEN_DEVICE_FUNC const Derived & const_derived () const
 
EIGEN_DEVICE_FUNC Derived & derived ()
 
EIGEN_DEVICE_FUNC const Derived & derived () const
 
template<typename Dest >
EIGEN_DEVICE_FUNC void evalTo (Dest &dst) const
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index rows () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index size () const EIGEN_NOEXCEPT
 
template<typename Dest >
EIGEN_DEVICE_FUNC void subTo (Dest &dst) const
 

Static Protected Member Functions

static void check_template_parameters ()
 
- Static Protected Member Functions inherited from Eigen::SparseMatrixBase< SparseVector< _Scalar, _Options, _StorageIndex > >
static StorageIndex convert_index (const Index idx)
 

Protected Attributes

Storage m_data
 
Index m_size
 
- Protected Attributes inherited from Eigen::SparseMatrixBase< SparseVector< _Scalar, _Options, _StorageIndex > >
bool m_isRValue
 

Private Types

typedef SparseCompressedBase< SparseVectorBase
 

Friends

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

Additional Inherited Members

- Protected Types inherited from Eigen::SparseCompressedBase< SparseVector< _Scalar, _Options, _StorageIndex > >
typedef Base::IndexVector IndexVector
 
- Protected Member Functions inherited from Eigen::SparseCompressedBase< SparseVector< _Scalar, _Options, _StorageIndex > >
Eigen::Map< IndexVectorinnerNonZeros ()
 
const Eigen::Map< const IndexVectorinnerNonZeros () const
 
internal::LowerBoundIndex lower_bound (Index row, Index col) const
 
 SparseCompressedBase ()
 
- Protected Member Functions inherited from Eigen::SparseMatrixBase< SparseVector< _Scalar, _Options, _StorageIndex > >
SparseVector< _Scalar, _Options, _StorageIndex > & assign (const OtherDerived &other)
 
void assignGeneric (const OtherDerived &other)
 

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.

Definition at line 54 of file SparseUtil.h.

Member Typedef Documentation

◆ Base

template<typename _Scalar, int _Options, typename _StorageIndex>
typedef SparseCompressedBase<SparseVector> Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::Base
private

Definition at line 67 of file SparseVector.h.

◆ InnerIterator

template<typename _Scalar, int _Options, typename _StorageIndex>
typedef Base::InnerIterator Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::InnerIterator

Definition at line 134 of file SparseVector.h.

◆ ReverseInnerIterator

template<typename _Scalar, int _Options, typename _StorageIndex>
typedef Base::ReverseInnerIterator Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::ReverseInnerIterator

Definition at line 135 of file SparseVector.h.

◆ Storage

template<typename _Scalar, int _Options, typename _StorageIndex>
typedef internal::CompressedStorage<Scalar,StorageIndex> Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::Storage

Definition at line 74 of file SparseVector.h.

Member Enumeration Documentation

◆ anonymous enum

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

Definition at line 75 of file SparseVector.h.

◆ anonymous enum

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

Definition at line 77 of file SparseVector.h.

Constructor & Destructor Documentation

◆ SparseVector() [1/5]

template<typename _Scalar, int _Options, typename _StorageIndex>
Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::SparseVector ( )
inline

Definition at line 259 of file SparseVector.h.

◆ SparseVector() [2/5]

template<typename _Scalar, int _Options, typename _StorageIndex>
Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::SparseVector ( Index  size)
inlineexplicit

Definition at line 261 of file SparseVector.h.

◆ SparseVector() [3/5]

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

Definition at line 263 of file SparseVector.h.

◆ SparseVector() [4/5]

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

Definition at line 266 of file SparseVector.h.

◆ SparseVector() [5/5]

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

Definition at line 276 of file SparseVector.h.

◆ ~SparseVector()

template<typename _Scalar, int _Options, typename _StorageIndex>
Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::~SparseVector ( )
inline

Destructor

Definition at line 341 of file SparseVector.h.

Member Function Documentation

◆ _data() [1/2]

template<typename _Scalar, int _Options, typename _StorageIndex>
EIGEN_DEPRECATED Storage& Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::_data ( )
inline

Definition at line 387 of file SparseVector.h.

◆ _data() [2/2]

template<typename _Scalar, int _Options, typename _StorageIndex>
EIGEN_DEPRECATED const Storage& Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::_data ( ) const
inline

Definition at line 389 of file SparseVector.h.

◆ check_template_parameters()

template<typename _Scalar, int _Options, typename _StorageIndex>
static void Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::check_template_parameters ( )
inlinestaticprotected

Definition at line 397 of file SparseVector.h.

◆ coeff() [1/2]

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

Definition at line 102 of file SparseVector.h.

◆ coeff() [2/2]

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

Definition at line 107 of file SparseVector.h.

◆ coeffRef() [1/2]

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

Definition at line 113 of file SparseVector.h.

◆ coeffRef() [2/2]

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.

Definition at line 125 of file SparseVector.h.

◆ cols()

template<typename _Scalar, int _Options, typename _StorageIndex>
EIGEN_STRONG_INLINE Index Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::cols ( void  ) const
inline

Definition at line 82 of file SparseVector.h.

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

Definition at line 246 of file SparseVector.h.

◆ data() [1/2]

template<typename _Scalar, int _Options, typename _StorageIndex>
Storage& Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::data ( )
inline

Definition at line 98 of file SparseVector.h.

◆ data() [2/2]

template<typename _Scalar, int _Options, typename _StorageIndex>
const Storage& Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::data ( ) const
inline

Definition at line 100 of file SparseVector.h.

◆ endFill()

template<typename _Scalar, int _Options, typename _StorageIndex>
EIGEN_DEPRECATED void Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::endFill ( )
inline

Definition at line 383 of file SparseVector.h.

◆ fill() [1/2]

template<typename _Scalar, int _Options, typename _StorageIndex>
EIGEN_DEPRECATED Scalar& Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::fill ( Index  r,
Index  c 
)
inline

Definition at line 356 of file SparseVector.h.

◆ fill() [2/2]

template<typename _Scalar, int _Options, typename _StorageIndex>
EIGEN_DEPRECATED Scalar& Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::fill ( Index  i)
inline

Definition at line 363 of file SparseVector.h.

◆ fillrand() [1/2]

template<typename _Scalar, int _Options, typename _StorageIndex>
EIGEN_DEPRECATED Scalar& Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::fillrand ( Index  r,
Index  c 
)
inline

Definition at line 370 of file SparseVector.h.

◆ fillrand() [2/2]

template<typename _Scalar, int _Options, typename _StorageIndex>
EIGEN_DEPRECATED Scalar& Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::fillrand ( Index  i)
inline

Definition at line 377 of file SparseVector.h.

◆ finalize()

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

Definition at line 207 of file SparseVector.h.

◆ innerIndexPtr() [1/2]

template<typename _Scalar, int _Options, typename _StorageIndex>
EIGEN_STRONG_INLINE const StorageIndex* Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::innerIndexPtr ( ) const
inline

Definition at line 89 of file SparseVector.h.

◆ innerIndexPtr() [2/2]

template<typename _Scalar, int _Options, typename _StorageIndex>
EIGEN_STRONG_INLINE StorageIndex* Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::innerIndexPtr ( )
inline

Definition at line 90 of file SparseVector.h.

◆ innerNonZeroPtr() [1/2]

template<typename _Scalar, int _Options, typename _StorageIndex>
const StorageIndex* Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::innerNonZeroPtr ( ) const
inline

Definition at line 94 of file SparseVector.h.

◆ innerNonZeroPtr() [2/2]

template<typename _Scalar, int _Options, typename _StorageIndex>
StorageIndex* Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::innerNonZeroPtr ( )
inline

Definition at line 95 of file SparseVector.h.

◆ innerSize()

template<typename _Scalar, int _Options, typename _StorageIndex>
EIGEN_STRONG_INLINE Index Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::innerSize ( ) const
inline

Definition at line 83 of file SparseVector.h.

◆ insert() [1/2]

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

Definition at line 172 of file SparseVector.h.

◆ insert() [2/2]

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

Definition at line 182 of file SparseVector.h.

◆ insertBack()

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

Definition at line 154 of file SparseVector.h.

◆ insertBackByOuterInner()

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

Definition at line 148 of file SparseVector.h.

◆ insertBackByOuterInnerUnordered()

template<typename _Scalar, int _Options, typename _StorageIndex>
Scalar& Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::insertBackByOuterInnerUnordered ( Index  outer,
Index  inner 
)
inline

Definition at line 160 of file SparseVector.h.

◆ insertBackUnordered()

template<typename _Scalar, int _Options, typename _StorageIndex>
Scalar& Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::insertBackUnordered ( Index  i)
inline

Definition at line 166 of file SparseVector.h.

◆ nonZeros()

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

Definition at line 140 of file SparseVector.h.

◆ operator=() [1/3]

template<typename _Scalar, int _Options, typename _StorageIndex>
SparseVector& Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::operator= ( const SparseVector< _Scalar, _Options, _StorageIndex > &  other)
inline

Definition at line 301 of file SparseVector.h.

◆ operator=() [2/3]

template<typename _Scalar, int _Options, typename _StorageIndex>
template<typename OtherDerived >
SparseVector& Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::operator= ( const SparseMatrixBase< OtherDerived > &  other)
inline

Definition at line 316 of file SparseVector.h.

◆ operator=() [3/3]

template<typename _Scalar, int _Options, typename _StorageIndex>
template<typename Lhs , typename Rhs >
SparseVector& Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::operator= ( const SparseSparseProduct< Lhs, Rhs > &  product)
inline

Definition at line 326 of file SparseVector.h.

◆ outerIndexPtr() [1/2]

template<typename _Scalar, int _Options, typename _StorageIndex>
const StorageIndex* Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::outerIndexPtr ( ) const
inline

Definition at line 92 of file SparseVector.h.

◆ outerIndexPtr() [2/2]

template<typename _Scalar, int _Options, typename _StorageIndex>
StorageIndex* Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::outerIndexPtr ( )
inline

Definition at line 93 of file SparseVector.h.

◆ outerSize()

template<typename _Scalar, int _Options, typename _StorageIndex>
EIGEN_STRONG_INLINE Index Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::outerSize ( ) const
inline

Definition at line 84 of file SparseVector.h.

◆ 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

Definition at line 210 of file SparseVector.h.

◆ reserve()

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

Definition at line 204 of file SparseVector.h.

◆ resize() [1/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)

Definition at line 223 of file SparseVector.h.

◆ resize() [2/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()

Definition at line 233 of file SparseVector.h.

◆ resizeNonZeros()

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

Definition at line 257 of file SparseVector.h.

◆ rows()

template<typename _Scalar, int _Options, typename _StorageIndex>
EIGEN_STRONG_INLINE Index Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::rows ( void  ) const
inline

Definition at line 81 of file SparseVector.h.

◆ setZero()

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

Definition at line 137 of file SparseVector.h.

◆ startFill()

template<typename _Scalar, int _Options, typename _StorageIndex>
EIGEN_DEPRECATED void Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::startFill ( Index  reserve)
inline

Definition at line 349 of file SparseVector.h.

◆ startVec()

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

Definition at line 142 of file SparseVector.h.

◆ 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

Definition at line 41 of file SparseRedux.h.

◆ swap() [1/2]

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

Definition at line 287 of file SparseVector.h.

◆ swap() [2/2]

template<typename _Scalar, int _Options, typename _StorageIndex>
template<int OtherOptions>
void Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::swap ( SparseMatrix< Scalar, OtherOptions, StorageIndex > &  other)
inline

Definition at line 294 of file SparseVector.h.

◆ valuePtr() [1/2]

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

Definition at line 86 of file SparseVector.h.

◆ valuePtr() [2/2]

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

Definition at line 87 of file SparseVector.h.

Friends And Related Function Documentation

◆ operator<<

template<typename _Scalar, int _Options, typename _StorageIndex>
std::ostream& operator<< ( std::ostream &  s,
const SparseVector< _Scalar, _Options, _StorageIndex > &  m 
)
friend

Definition at line 332 of file SparseVector.h.

Member Data Documentation

◆ m_data

template<typename _Scalar, int _Options, typename _StorageIndex>
Storage Eigen::SparseVector< _Scalar, _Options, _StorageIndex >::m_data
protected

Definition at line 403 of file SparseVector.h.

◆ m_size

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

Definition at line 404 of file SparseVector.h.


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


gtsam
Author(s):
autogenerated on Tue Jul 4 2023 02:43:33