Eigen::Ref< SparseVectorType > Class Template Reference

Detailed Description

template<typename SparseVectorType>
class Eigen::Ref< SparseVectorType >

A sparse vector expression referencing an existing sparse vector expression.

Template Parameters

SparseVectorType

the equivalent sparse vector type of the referenced data, it must be a template instance of class SparseVector.

See also

class Ref

Inheritance diagram for Eigen::Ref< SparseVectorType >:

Public Member Functions
template<typename Derived >
	Ref (SparseCompressedBase< Derived > &expr)
Public Member Functions inherited from Eigen::SparseMapBase< Derived, WriteAccessors >
Scalar &	coeffRef (Index row, Index col)
StorageIndex *	innerIndexPtr ()
StorageIndex *	innerNonZeroPtr ()
StorageIndex *	outerIndexPtr ()
Scalar *	valuePtr ()
	~SparseMapBase ()
Public Member Functions inherited from Eigen::SparseMapBase< Derived, ReadOnlyAccessors >
Scalar	coeff (Index row, Index col) const
Index	cols () const
const StorageIndex *	innerIndexPtr () const
const StorageIndex *	innerNonZeroPtr () const
Index	innerSize () const
bool	isCompressed () const
Index	nonZeros () const
const StorageIndex *	outerIndexPtr () const
Index	outerSize () const
Index	rows () const
const Scalar *	valuePtr () const
	~SparseMapBase ()
Public Member Functions inherited from Eigen::SparseCompressedBase< Derived >
Map< Array< Scalar, Dynamic, 1 > >	coeffs ()
const Map< const Array< Scalar, Dynamic, 1 > >	coeffs () const
StorageIndex *	innerIndexPtr ()
const StorageIndex *	innerIndexPtr () const
StorageIndex *	innerNonZeroPtr ()
const StorageIndex *	innerNonZeroPtr () const
bool	isCompressed () const
Index	nonZeros () const
StorageIndex *	outerIndexPtr ()
const StorageIndex *	outerIndexPtr () const
Scalar *	valuePtr ()
const Scalar *	valuePtr () const
Public Member Functions inherited from Eigen::SparseMatrixBase< Derived >
Index	cols () const
const internal::eval< Derived >::type	eval () const
Index	innerSize () const
bool	isVector () const
template<typename OtherDerived >
const Product< Derived, OtherDerived, AliasFreeProduct >	operator* (const SparseMatrixBase< OtherDerived > &other) const
Index	outerSize () const
const SparseView< Derived >	pruned (const Scalar &reference=Scalar(0), const RealScalar &epsilon=NumTraits< Scalar >::dummy_precision()) const
Index	rows () const
Index	size () const
SparseSymmetricPermutationProduct< Derived, Upper|Lower >	twistedBy (const PermutationMatrix< Dynamic, Dynamic, StorageIndex > &perm) const
Public Member Functions inherited from Eigen::EigenBase< Derived >
EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT
Derived &	derived ()
const Derived &	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< Derived >
enum	{   RowsAtCompileTime ,   ColsAtCompileTime ,   SizeAtCompileTime ,   MaxRowsAtCompileTime ,   MaxColsAtCompileTime ,   MaxSizeAtCompileTime ,   IsVectorAtCompileTime ,   NumDimensions ,   Flags ,   IsRowMajor ,   InnerSizeAtCompileTime }
typedef internal::traits< Derived >::StorageIndex	StorageIndex
typedef Scalar	value_type
Public Types inherited from Eigen::EigenBase< Derived >
typedef Eigen::Index	Index
	The interface type of indices. More...
Protected Member Functions inherited from Eigen::SparseCompressedBase< Derived >
	SparseCompressedBase ()

Constructor & Destructor Documentation

Ref()

template<typename SparseVectorType >

template<typename Derived >

Eigen::Ref< SparseVectorType >::Ref ( SparseCompressedBase< Derived > &  expr )

inline

Implicit constructor from any 1D sparse vector expression

---

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

• SparseRef.h