a sparse vector class More...

#include <SparseVector.h>

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

Collaboration diagram for Eigen::SparseVector< _Scalar, _Options, _Index >:

Classes
class	InnerIterator

class	ReverseInnerIterator

Public Types
enum	{ IsColVector = internal::traits<SparseVector>::IsColVector }

enum	{ Options = _Options }

typedef internal::CompressedStorage< Scalar, Index >	Storage

Public Types inherited from Eigen::SparseMatrixBase< SparseVector< _Scalar, _Options, _Index > >
enum

typedef internal::traits< SparseVector< _Scalar, _Options, _Index > >::Scalar	Scalar

typedef internal::packet_traits< Scalar >::type	PacketScalar

typedef internal::traits< SparseVector< _Scalar, _Options, _Index > >::StorageKind	StorageKind

typedef internal::traits< SparseVector< _Scalar, _Options, _Index > >::Index	Index

typedef internal::add_const_on_value_type_if_arithmetic< typename internal::packet_traits< Scalar >::type >::type	PacketReturnType

typedef SparseMatrixBase	StorageBaseType

typedef EigenBase< SparseVector< _Scalar, _Options, _Index > >	Base

typedef internal::conditional< NumTraits< Scalar >::IsComplex, CwiseUnaryOp< internal::scalar_conjugate_op< Scalar >, Eigen::Transpose< const SparseVector< _Scalar, _Options, _Index > > >, Transpose< const SparseVector< _Scalar, _Options, _Index > > >::type	AdjointReturnType

typedef SparseMatrix< Scalar, Flags &RowMajorBit?RowMajor:ColMajor, Index >	PlainObject

typedef NumTraits< Scalar >::Real	RealScalar

typedef internal::conditional< _HasDirectAccess, const Scalar &, Scalar >::type	CoeffReturnType

typedef CwiseNullaryOp< internal::scalar_constant_op< Scalar >, Matrix< Scalar, Dynamic, Dynamic > >	ConstantReturnType

typedef Matrix< Scalar, EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime), EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime)>	SquareMatrixType

typedef CwiseUnaryOp< internal::scalar_multiple_op< Scalar >, const SparseVector< _Scalar, _Options, _Index > >	ScalarMultipleReturnType

typedef CwiseUnaryOp< internal::scalar_quotient1_op< Scalar >, const SparseVector< _Scalar, _Options, _Index > >	ScalarQuotient1ReturnType

typedef internal::conditional< NumTraits< Scalar >::IsComplex, const CwiseUnaryOp< internal::scalar_conjugate_op< Scalar >, const SparseVector< _Scalar, _Options, _Index > >, const SparseVector< _Scalar, _Options, _Index > & >::type	ConjugateReturnType

typedef internal::conditional< NumTraits< Scalar >::IsComplex, const CwiseUnaryOp< internal::scalar_real_op< Scalar >, const SparseVector< _Scalar, _Options, _Index > >, const SparseVector< _Scalar, _Options, _Index > & >::type	RealReturnType

typedef internal::conditional< NumTraits< Scalar >::IsComplex, CwiseUnaryView< internal::scalar_real_ref_op< Scalar >, SparseVector< _Scalar, _Options, _Index > >, SparseVector< _Scalar, _Options, _Index > & >::type	NonConstRealReturnType

typedef CwiseUnaryOp< internal::scalar_imag_op< Scalar >, const SparseVector< _Scalar, _Options, _Index > >	ImagReturnType

typedef CwiseUnaryView< internal::scalar_imag_ref_op< Scalar >, SparseVector< _Scalar, _Options, _Index > >	NonConstImagReturnType

typedef Block< SparseVector< _Scalar, _Options, _Index >, internal::traits< SparseVector< _Scalar, _Options, _Index > >::RowsAtCompileTime, 1,!IsRowMajor >	ColXpr

typedef const Block< const SparseVector< _Scalar, _Options, _Index >, internal::traits< SparseVector< _Scalar, _Options, _Index > >::RowsAtCompileTime, 1,!IsRowMajor >	ConstColXpr

typedef Block< SparseVector< _Scalar, _Options, _Index >, 1, internal::traits< SparseVector< _Scalar, _Options, _Index > >::ColsAtCompileTime, IsRowMajor >	RowXpr

typedef const Block< const SparseVector< _Scalar, _Options, _Index >, 1, internal::traits< SparseVector< _Scalar, _Options, _Index > >::ColsAtCompileTime, IsRowMajor >	ConstRowXpr

typedef Block< SparseVector< _Scalar, _Options, _Index >, internal::traits< SparseVector< _Scalar, _Options, _Index > >::RowsAtCompileTime, Dynamic,!IsRowMajor >	ColsBlockXpr

typedef const Block< const SparseVector< _Scalar, _Options, _Index >, internal::traits< SparseVector< _Scalar, _Options, _Index > >::RowsAtCompileTime, Dynamic,!IsRowMajor >	ConstColsBlockXpr

typedef Block< SparseVector< _Scalar, _Options, _Index >, Dynamic, internal::traits< SparseVector< _Scalar, _Options, _Index > >::ColsAtCompileTime, IsRowMajor >	RowsBlockXpr

typedef const Block< const SparseVector< _Scalar, _Options, _Index >, Dynamic, internal::traits< SparseVector< _Scalar, _Options, _Index > >::ColsAtCompileTime, IsRowMajor >	ConstRowsBlockXpr

typedef VectorBlock< SparseVector< _Scalar, _Options, _Index > >	SegmentReturnType

typedef const VectorBlock< const SparseVector< _Scalar, _Options, _Index > >	ConstSegmentReturnType

typedef Block< SparseVector< _Scalar, _Options, _Index >, IsRowMajor?1:Dynamic, IsRowMajor?Dynamic:1, true >	InnerVectorReturnType

typedef Block< const SparseVector< _Scalar, _Options, _Index >, IsRowMajor?1:Dynamic, IsRowMajor?Dynamic:1, true >	ConstInnerVectorReturnType

Public Types inherited from Eigen::EigenBase< Derived >
typedef internal::traits< Derived >::StorageKind	StorageKind

typedef internal::traits< Derived >::Index	Index

Public Member Functions
EIGEN_STRONG_INLINE Index	rows () const

EIGEN_STRONG_INLINE Index	cols () const

EIGEN_STRONG_INLINE Index	innerSize () const

EIGEN_STRONG_INLINE Index	outerSize () const

EIGEN_STRONG_INLINE const Scalar *	valuePtr () const

EIGEN_STRONG_INLINE Scalar *	valuePtr ()

EIGEN_STRONG_INLINE const Index *	innerIndexPtr () const

EIGEN_STRONG_INLINE Index *	innerIndexPtr ()

Storage &	data ()

const Storage &	data () const

Scalar	coeff (Index row, Index col) const

Scalar	coeff (Index i) const

Scalar &	coeffRef (Index row, Index col)

Scalar &	coeffRef (Index i)

void	setZero ()

Index	nonZeros () const

void	startVec (Index outer)

Scalar &	insertBackByOuterInner (Index outer, Index inner)

Scalar &	insertBack (Index i)

Scalar &	insert (Index row, Index col)

Scalar &	insert (Index i)

void	reserve (Index reserveSize)

void	finalize ()

void	prune (const Scalar &reference, const RealScalar &epsilon=NumTraits< RealScalar >::dummy_precision())

void	resize (Index rows, Index cols)

void	resize (Index newSize)

void	resizeNonZeros (Index size)

	SparseVector (Index size)

	SparseVector (Index rows, Index cols)

template<typename OtherDerived >
	SparseVector (const SparseMatrixBase< OtherDerived > &other)

	SparseVector (const SparseVector &other)

void	swap (SparseVector &other)

SparseVector &	operator= (const SparseVector &other)

template<typename OtherDerived >
SparseVector &	operator= (const SparseMatrixBase< OtherDerived > &other)

template<typename Lhs , typename Rhs >
SparseVector &	operator= (const SparseSparseProduct< Lhs, Rhs > &product)

	~SparseVector ()

Scalar	sum () const

EIGEN_DEPRECATED void	startFill (Index reserve)

EIGEN_DEPRECATED Scalar &	fill (Index r, Index c)

EIGEN_DEPRECATED Scalar &	fill (Index i)

EIGEN_DEPRECATED Scalar &	fillrand (Index r, Index c)

EIGEN_DEPRECATED Scalar &	fillrand (Index i)

EIGEN_DEPRECATED void	endFill ()

EIGEN_DEPRECATED Storage &	_data ()

EIGEN_DEPRECATED const Storage &	_data () const

Public Member Functions inherited from Eigen::SparseMatrixBase< SparseVector< _Scalar, _Options, _Index > >
SparseVector< _Scalar, _Options, _Index > &	operator= (const EigenBase< OtherDerived > &other)

SparseVector< _Scalar, _Options, _Index > &	operator= (const ReturnByValue< OtherDerived > &other)

SparseVector< _Scalar, _Options, _Index > &	operator= (const SparseMatrixBase< OtherDerived > &other)

SparseVector< _Scalar, _Options, _Index > &	operator= (const SparseVector< _Scalar, _Options, _Index > &other)

SparseVector< _Scalar, _Options, _Index > &	operator= (const SparseSparseProduct< Lhs, Rhs > &product)

const SparseVector< _Scalar, _Options, _Index > &	derived () const

SparseVector< _Scalar, _Options, _Index > &	derived ()

SparseVector< _Scalar, _Options, _Index > &	const_cast_derived () const

const CwiseUnaryOp< internal::scalar_opposite_op< typename internal::traits< SparseVector< _Scalar, _Options, _Index > >::Scalar >, const SparseVector< _Scalar, _Options, _Index > >	operator- () const

const ScalarMultipleReturnType	operator* (const Scalar &scalar) const

const CwiseUnaryOp< internal::scalar_multiple2_op< Scalar, std::complex< Scalar > >, const SparseVector< _Scalar, _Options, _Index > >	operator* (const std::complex< Scalar > &scalar) const

const SparseSparseProductReturnType< SparseVector< _Scalar, _Options, _Index >, OtherDerived >::Type	operator* (const SparseMatrixBase< OtherDerived > &other) const

const SparseDiagonalProduct< SparseVector< _Scalar, _Options, _Index >, OtherDerived >	operator* (const DiagonalBase< OtherDerived > &other) const

const SparseDenseProductReturnType< SparseVector< _Scalar, _Options, _Index >, OtherDerived >::Type	operator* (const MatrixBase< OtherDerived > &other) const

const CwiseUnaryOp< internal::scalar_quotient1_op< typename internal::traits< SparseVector< _Scalar, _Options, _Index > >::Scalar >, const SparseVector< _Scalar, _Options, _Index > >	operator/ (const Scalar &scalar) const

internal::cast_return_type< SparseVector< _Scalar, _Options, _Index >, const CwiseUnaryOp< internal::scalar_cast_op< typename internal::traits< SparseVector< _Scalar, _Options, _Index > >::Scalar, NewType >, const SparseVector< _Scalar, _Options, _Index > > >::type	cast () const

ConjugateReturnType	conjugate () const

RealReturnType	real () const

NonConstRealReturnType	real ()

const ImagReturnType	imag () const

NonConstImagReturnType	imag ()

const CwiseUnaryOp< CustomUnaryOp, const SparseVector< _Scalar, _Options, _Index > >	unaryExpr (const CustomUnaryOp &func=CustomUnaryOp()) const
	Apply a unary operator coefficient-wise. More...

const CwiseUnaryView< CustomViewOp, const SparseVector< _Scalar, _Options, _Index > >	unaryViewExpr (const CustomViewOp &func=CustomViewOp()) const

EIGEN_STRONG_INLINE const CwiseBinaryOp< CustomBinaryOp, const SparseVector< _Scalar, _Options, _Index >, const OtherDerived >	binaryExpr (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other, const CustomBinaryOp &func=CustomBinaryOp()) const

EIGEN_STRONG_INLINE const CwiseUnaryOp< internal::scalar_abs_op< Scalar >, const SparseVector< _Scalar, _Options, _Index > >	cwiseAbs () const

EIGEN_STRONG_INLINE const CwiseUnaryOp< internal::scalar_abs2_op< Scalar >, const SparseVector< _Scalar, _Options, _Index > >	cwiseAbs2 () const

const CwiseUnaryOp< internal::scalar_sqrt_op< Scalar >, const SparseVector< _Scalar, _Options, _Index > >	cwiseSqrt () const

const CwiseUnaryOp< internal::scalar_inverse_op< Scalar >, const SparseVector< _Scalar, _Options, _Index > >	cwiseInverse () const

const CwiseUnaryOp< std::binder1st< std::equal_to< Scalar > >, const SparseVector< _Scalar, _Options, _Index > >	cwiseEqual (const Scalar &s) const

const CwiseBinaryOp< std::equal_to< Scalar >, const SparseVector< _Scalar, _Options, _Index >, const OtherDerived >	cwiseEqual (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const

EIGEN_STRONG_INLINE const	EIGEN_CWISE_PRODUCT_RETURN_TYPE (SparseVector< _Scalar, _Options, _Index >, OtherDerived) cwiseProduct(const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const

const CwiseBinaryOp< std::not_equal_to< Scalar >, const SparseVector< _Scalar, _Options, _Index >, const OtherDerived >	cwiseNotEqual (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const

EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_min_op< Scalar >, const SparseVector< _Scalar, _Options, _Index >, const OtherDerived >	cwiseMin (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const

EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_min_op< Scalar >, const SparseVector< _Scalar, _Options, _Index >, const ConstantReturnType >	cwiseMin (const Scalar &other) const

EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_max_op< Scalar >, const SparseVector< _Scalar, _Options, _Index >, const OtherDerived >	cwiseMax (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const

EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_max_op< Scalar >, const SparseVector< _Scalar, _Options, _Index >, const ConstantReturnType >	cwiseMax (const Scalar &other) const

EIGEN_STRONG_INLINE const CwiseBinaryOp< internal::scalar_quotient_op< Scalar >, const SparseVector< _Scalar, _Options, _Index >, const OtherDerived >	cwiseQuotient (const EIGEN_CURRENT_STORAGE_BASE_CLASS< OtherDerived > &other) const

Block< SparseVector< _Scalar, _Options, _Index > >	block (Index startRow, Index startCol, Index blockRows, Index blockCols)

const Block< const SparseVector< _Scalar, _Options, _Index > >	block (Index startRow, Index startCol, Index blockRows, Index blockCols) const

Block< SparseVector< _Scalar, _Options, _Index >, BlockRows, BlockCols >	block (Index startRow, Index startCol)

const Block< const SparseVector< _Scalar, _Options, _Index >, BlockRows, BlockCols >	block (Index startRow, Index startCol) const

Block< SparseVector< _Scalar, _Options, _Index >, BlockRows, BlockCols >	block (Index startRow, Index startCol, Index blockRows, Index blockCols)

const Block< const SparseVector< _Scalar, _Options, _Index >, BlockRows, BlockCols >	block (Index startRow, Index startCol, Index blockRows, Index blockCols) const

Block< SparseVector< _Scalar, _Options, _Index > >	topRightCorner (Index cRows, Index cCols)

const Block< const SparseVector< _Scalar, _Options, _Index > >	topRightCorner (Index cRows, Index cCols) const

Block< SparseVector< _Scalar, _Options, _Index >, CRows, CCols >	topRightCorner ()

const Block< const SparseVector< _Scalar, _Options, _Index >, CRows, CCols >	topRightCorner () const

Block< SparseVector< _Scalar, _Options, _Index >, CRows, CCols >	topRightCorner (Index cRows, Index cCols)

const Block< const SparseVector< _Scalar, _Options, _Index >, CRows, CCols >	topRightCorner (Index cRows, Index cCols) const

Block< SparseVector< _Scalar, _Options, _Index > >	topLeftCorner (Index cRows, Index cCols)

const Block< const SparseVector< _Scalar, _Options, _Index > >	topLeftCorner (Index cRows, Index cCols) const

Block< SparseVector< _Scalar, _Options, _Index >, CRows, CCols >	topLeftCorner ()

const Block< const SparseVector< _Scalar, _Options, _Index >, CRows, CCols >	topLeftCorner () const

Block< SparseVector< _Scalar, _Options, _Index >, CRows, CCols >	topLeftCorner (Index cRows, Index cCols)

const Block< const SparseVector< _Scalar, _Options, _Index >, CRows, CCols >	topLeftCorner (Index cRows, Index cCols) const

Block< SparseVector< _Scalar, _Options, _Index > >	bottomRightCorner (Index cRows, Index cCols)

const Block< const SparseVector< _Scalar, _Options, _Index > >	bottomRightCorner (Index cRows, Index cCols) const

Block< SparseVector< _Scalar, _Options, _Index >, CRows, CCols >	bottomRightCorner ()

const Block< const SparseVector< _Scalar, _Options, _Index >, CRows, CCols >	bottomRightCorner () const

Block< SparseVector< _Scalar, _Options, _Index >, CRows, CCols >	bottomRightCorner (Index cRows, Index cCols)

const Block< const SparseVector< _Scalar, _Options, _Index >, CRows, CCols >	bottomRightCorner (Index cRows, Index cCols) const

Block< SparseVector< _Scalar, _Options, _Index > >	bottomLeftCorner (Index cRows, Index cCols)

const Block< const SparseVector< _Scalar, _Options, _Index > >	bottomLeftCorner (Index cRows, Index cCols) const

Block< SparseVector< _Scalar, _Options, _Index >, CRows, CCols >	bottomLeftCorner ()

const Block< const SparseVector< _Scalar, _Options, _Index >, CRows, CCols >	bottomLeftCorner () const

Block< SparseVector< _Scalar, _Options, _Index >, CRows, CCols >	bottomLeftCorner (Index cRows, Index cCols)

const Block< const SparseVector< _Scalar, _Options, _Index >, CRows, CCols >	bottomLeftCorner (Index cRows, Index cCols) const

RowsBlockXpr	topRows (Index n)

ConstRowsBlockXpr	topRows (Index n) const

NRowsBlockXpr< N >::Type	topRows ()

ConstNRowsBlockXpr< N >::Type	topRows () const

RowsBlockXpr	bottomRows (Index n)

ConstRowsBlockXpr	bottomRows (Index n) const

NRowsBlockXpr< N >::Type	bottomRows ()

ConstNRowsBlockXpr< N >::Type	bottomRows () const

RowsBlockXpr	middleRows (Index startRow, Index numRows)

ConstRowsBlockXpr	middleRows (Index startRow, Index numRows) const

NRowsBlockXpr< N >::Type	middleRows (Index startRow)

ConstNRowsBlockXpr< N >::Type	middleRows (Index startRow) const

ColsBlockXpr	leftCols (Index n)

ConstColsBlockXpr	leftCols (Index n) const

NColsBlockXpr< N >::Type	leftCols ()

ConstNColsBlockXpr< N >::Type	leftCols () const

ColsBlockXpr	rightCols (Index n)

ConstColsBlockXpr	rightCols (Index n) const

NColsBlockXpr< N >::Type	rightCols ()

ConstNColsBlockXpr< N >::Type	rightCols () const

ColsBlockXpr	middleCols (Index startCol, Index numCols)

ConstColsBlockXpr	middleCols (Index startCol, Index numCols) const

NColsBlockXpr< N >::Type	middleCols (Index startCol)

ConstNColsBlockXpr< N >::Type	middleCols (Index startCol) const

ColXpr	col (Index i)

ConstColXpr	col (Index i) const

RowXpr	row (Index i)

ConstRowXpr	row (Index i) const

SegmentReturnType	segment (Index start, Index vecSize)

ConstSegmentReturnType	segment (Index start, Index vecSize) const

FixedSegmentReturnType< Size >::Type	segment (Index start)

ConstFixedSegmentReturnType< Size >::Type	segment (Index start) const

SegmentReturnType	head (Index vecSize)

ConstSegmentReturnType	head (Index vecSize) const

FixedSegmentReturnType< Size >::Type	head ()

ConstFixedSegmentReturnType< Size >::Type	head () const

SegmentReturnType	tail (Index vecSize)

ConstSegmentReturnType	tail (Index vecSize) const

FixedSegmentReturnType< Size >::Type	tail ()

ConstFixedSegmentReturnType< Size >::Type	tail () const

Index	rows () const

Index	cols () const

Index	size () const

Index	nonZeros () const

bool	isVector () const

Index	outerSize () const

Index	innerSize () const

bool	isRValue () const

SparseVector< _Scalar, _Options, _Index > &	markAsRValue ()

SparseVector< _Scalar, _Options, _Index > &	operator+= (const SparseMatrixBase< OtherDerived > &other)

SparseVector< _Scalar, _Options, _Index > &	operator-= (const SparseMatrixBase< OtherDerived > &other)

SparseVector< _Scalar, _Options, _Index > &	*operator=** (const Scalar &other)

SparseVector< _Scalar, _Options, _Index > &	*operator=** (const SparseMatrixBase< OtherDerived > &other)

SparseVector< _Scalar, _Options, _Index > &	operator/= (const Scalar &other)

EIGEN_STRONG_INLINE const EIGEN_SPARSE_CWISE_PRODUCT_RETURN_TYPE	cwiseProduct (const MatrixBase< OtherDerived > &other) const

SparseSymmetricPermutationProduct< SparseVector< _Scalar, _Options, _Index >, Upper\|Lower >	twistedBy (const PermutationMatrix< Dynamic, Dynamic, Index > &perm) const

const SparseTriangularView< SparseVector< _Scalar, _Options, _Index >, Mode >	triangularView () const

const SparseSelfAdjointView< SparseVector< _Scalar, _Options, _Index >, UpLo >	selfadjointView () const

SparseSelfAdjointView< SparseVector< _Scalar, _Options, _Index >, UpLo >	selfadjointView ()

Scalar	dot (const MatrixBase< OtherDerived > &other) const

Scalar	dot (const SparseMatrixBase< OtherDerived > &other) const

RealScalar	squaredNorm () const

RealScalar	norm () const

RealScalar	blueNorm () const

Transpose< SparseVector< _Scalar, _Options, _Index > >	transpose ()

const Transpose< const SparseVector< _Scalar, _Options, _Index > >	transpose () const

const AdjointReturnType	adjoint () const

InnerVectorReturnType	innerVector (Index outer)

const ConstInnerVectorReturnType	innerVector (Index outer) const

Block< SparseVector< _Scalar, _Options, _Index >, Dynamic, Dynamic, true >	innerVectors (Index outerStart, Index outerSize)

const Block< const SparseVector< _Scalar, _Options, _Index >, Dynamic, Dynamic, true >	innerVectors (Index outerStart, Index outerSize) const

void	evalTo (MatrixBase< DenseDerived > &dst) const

Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTime >	toDense () 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

const internal::eval< SparseVector< _Scalar, _Options, _Index > >::type	eval () const

Scalar	sum () const

Public Member Functions inherited from Eigen::EigenBase< Derived >
Derived &	derived ()

const Derived &	derived () const

Derived &	const_cast_derived () const

const Derived &	const_derived () const

Index	rows () const

Index	cols () const

Index	size () const

template<typename Dest >
void	evalTo (Dest &dst) const

template<typename Dest >
void	addTo (Dest &dst) const

template<typename Dest >
void	subTo (Dest &dst) const

template<typename Dest >
void	applyThisOnTheRight (Dest &dst) const

template<typename Dest >
void	applyThisOnTheLeft (Dest &dst) const

Static Protected Member Functions
static void	check_template_parameters ()

Protected Attributes
Storage	m_data

Index	m_size

Protected Attributes inherited from Eigen::SparseMatrixBase< SparseVector< _Scalar, _Options, _Index > >
bool	m_isRValue

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

Additional Inherited Members
Protected Member Functions inherited from Eigen::SparseMatrixBase< SparseVector< _Scalar, _Options, _Index > >
SparseVector< _Scalar, _Options, _Index > &	assign (const OtherDerived &other)

void	assignGeneric (const OtherDerived &other)

Detailed Description

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

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

Definition at line 73 of file SparseUtil.h.

Constructor & Destructor Documentation

template<typename _Scalar , int _Options, typename _Index >

Eigen::SparseVector< _Scalar, _Options, _Index >::~SparseVector ( )

inline

Destructor

Definition at line 281 of file SparseVector.h.

281 {}

Member Function Documentation

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 121 of file SparseVector.h.

     {
       eigen_assert(i>=0 && i<m_size);
       return m_data.atWithInsertion(i);
     }

template<typename _Scalar , int _Options, typename _Index >

Index Eigen::SparseVector< _Scalar, _Options, _Index >::nonZeros ( ) const

inline

Returns: the number of non zero coefficients

Definition at line 135 of file SparseVector.h.

135 { return static_cast<Index>(m_data.size()); }

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 37 of file SparseRedux.h.

 {
   eigen_assert(rows()>0 && cols()>0 && "you are using a non initialized matrix");
   return Matrix<Scalar,1,Dynamic>::Map(&m_data.value(0), m_data.size()).sum();
 }

template<typename _Scalar , int _Options, typename _Index >

void Eigen::SparseVector< _Scalar, _Options, _Index >::swap ( SparseVector< _Scalar, _Options, _Index > & other )

inline

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

See also: SparseMatrixBase::swap()

Definition at line 235 of file SparseVector.h.

     {
       std::swap(m_size, other.m_size);
       m_data.swap(other.m_data);
     }

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

C:/Users/Brig/Documents/ShapeWorksStudio/src/Surfworks/Eigen/src/SparseCore/SparseUtil.h
C:/Users/Brig/Documents/ShapeWorksStudio/src/Surfworks/Eigen/src/SparseCore/SparseVector.h
C:/Users/Brig/Documents/ShapeWorksStudio/src/Surfworks/Eigen/src/SparseCore/SparseRedux.h

Classes

Public Types

Public Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

Member Function Documentation

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