Please, help us to better know about our user community by answering the following short survey: https://forms.gle/wpyrxWi18ox9Z5ae9
Eigen  3.3.71
Eigen::Ref< SparseMatrixType, Options > Class Template Reference

Detailed Description

template<typename SparseMatrixType, int Options>
class Eigen::Ref< SparseMatrixType, Options >

A sparse matrix expression referencing an existing sparse expression.

Template Parameters
SparseMatrixTypethe equivalent sparse matrix type of the referenced data, it must be a template instance of class SparseMatrix.
Optionsspecifies whether the a standard compressed format is required Options is StandardCompressedFormat, or 0. The default is 0.
See also
class Ref
+ Inheritance diagram for Eigen::Ref< SparseMatrixType, Options >:

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
 

Additional Inherited Members

- Protected Member Functions inherited from Eigen::SparseCompressedBase< Derived >
 SparseCompressedBase ()
 

Constructor & Destructor Documentation

◆ Ref()

template<typename SparseMatrixType , int Options>
template<typename Derived >
Eigen::Ref< SparseMatrixType, Options >::Ref ( SparseCompressedBase< Derived > &  expr)
inline

Implicit constructor from any sparse expression (2D matrix or 1D vector)


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