Eigen::Ref< SparseMatrix< MatScalar, MatOptions, MatIndex >, Options, StrideType > Class Template Reference

A sparse matrix expression referencing an existing sparse expression. More...

#include <SparseRef.h>

Inheritance diagram for Eigen::Ref< SparseMatrix< MatScalar, MatOptions, MatIndex >, Options, StrideType >:

Public Types
typedef internal::SparseRefBase< Ref >	Base
Public Types inherited from Eigen::internal::SparseRefBase< Ref< SparseMatrix< MatScalar, MatOptions, MatIndex >, Options, StrideType > >
typedef SparseMapBase< Ref< SparseMatrix< MatScalar, MatOptions, MatIndex >, Options, StrideType > >	Base

Public Member Functions
template<int OtherOptions>
	Ref (SparseMatrix< MatScalar, OtherOptions, MatIndex > &expr)
template<int OtherOptions>
	Ref (MappedSparseMatrix< MatScalar, OtherOptions, MatIndex > &expr)
template<typename Derived >
	Ref (const SparseCompressedBase< Derived > &expr)
Public Member Functions inherited from Eigen::internal::SparseRefBase< Ref< SparseMatrix< MatScalar, MatOptions, MatIndex >, Options, StrideType > >
	SparseRefBase ()

Private Types
typedef SparseMatrix< MatScalar, MatOptions, MatIndex >	PlainObjectType
typedef internal::traits< Ref >	Traits

Private Member Functions
template<int OtherOptions>
	Ref (const SparseMatrix< MatScalar, OtherOptions, MatIndex > &expr)
template<int OtherOptions>
	Ref (const MappedSparseMatrix< MatScalar, OtherOptions, MatIndex > &expr)

Additional Inherited Members
Protected Member Functions inherited from Eigen::internal::SparseRefBase< Ref< SparseMatrix< MatScalar, MatOptions, MatIndex >, Options, StrideType > >
void	construct (Expression &expr)

Detailed Description

template<typename MatScalar, int MatOptions, typename MatIndex, int Options, typename StrideType>
class Eigen::Ref< SparseMatrix< MatScalar, MatOptions, MatIndex >, Options, StrideType >

A sparse matrix expression referencing an existing sparse expression.

Template Parameters

SparseMatrixType	the equivalent sparse matrix type of the referenced data, it must be a template instance of class SparseMatrix.
Options	specifies whether the a standard compressed format is required Options is StandardCompressedFormat, or 0. The default is 0.

See also

class Ref

Definition at line 123 of file SparseRef.h.

Member Typedef Documentation

template<typename MatScalar , int MatOptions, typename MatIndex , int Options, typename StrideType >

typedef internal::SparseRefBase<Ref> Eigen::Ref< SparseMatrix< MatScalar, MatOptions, MatIndex >, Options, StrideType >::Base

Definition at line 139 of file SparseRef.h.

template<typename MatScalar , int MatOptions, typename MatIndex , int Options, typename StrideType >

typedef SparseMatrix<MatScalar,MatOptions,MatIndex> Eigen::Ref< SparseMatrix< MatScalar, MatOptions, MatIndex >, Options, StrideType >::PlainObjectType

private

Definition at line 131 of file SparseRef.h.

template<typename MatScalar , int MatOptions, typename MatIndex , int Options, typename StrideType >

typedef internal::traits<Ref> Eigen::Ref< SparseMatrix< MatScalar, MatOptions, MatIndex >, Options, StrideType >::Traits

private

Definition at line 132 of file SparseRef.h.

Constructor & Destructor Documentation

template<typename MatScalar , int MatOptions, typename MatIndex , int Options, typename StrideType >

template<int OtherOptions>

Eigen::Ref< SparseMatrix< MatScalar, MatOptions, MatIndex >, Options, StrideType >::Ref ( const SparseMatrix< MatScalar, OtherOptions, MatIndex > &  expr )

inlineprivate

template<typename MatScalar , int MatOptions, typename MatIndex , int Options, typename StrideType >

template<int OtherOptions>

Eigen::Ref< SparseMatrix< MatScalar, MatOptions, MatIndex >, Options, StrideType >::Ref ( const MappedSparseMatrix< MatScalar, OtherOptions, MatIndex > &  expr )

inlineprivate

template<typename MatScalar , int MatOptions, typename MatIndex , int Options, typename StrideType >

template<int OtherOptions>

Eigen::Ref< SparseMatrix< MatScalar, MatOptions, MatIndex >, Options, StrideType >::Ref ( SparseMatrix< MatScalar, OtherOptions, MatIndex > &  expr )

inline

Definition at line 145 of file SparseRef.h.

template<typename MatScalar , int MatOptions, typename MatIndex , int Options, typename StrideType >

template<int OtherOptions>

Eigen::Ref< SparseMatrix< MatScalar, MatOptions, MatIndex >, Options, StrideType >::Ref ( MappedSparseMatrix< MatScalar, OtherOptions, MatIndex > &  expr )

inline

Definition at line 153 of file SparseRef.h.

template<typename MatScalar , int MatOptions, typename MatIndex , int Options, typename StrideType >

template<typename Derived >

Eigen::Ref< SparseMatrix< MatScalar, MatOptions, MatIndex >, Options, StrideType >::Ref ( const SparseCompressedBase< Derived > &  expr )

inline

Definition at line 161 of file SparseRef.h.

---

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

• SparseRef.h