Eigen::SparseView Class Reference

Expression of a dense or sparse matrix with zero or too small values removed. More...

#include <ForwardDeclarations.h>

Public Types
typedef internal::remove_all< MatrixType >::type	NestedExpression

Public Member Functions
Index	cols () const
RealScalar	epsilon () const
Index	innerSize () const
const internal::remove_all< MatrixTypeNested >::type &	nestedExpression () const
Index	outerSize () const
Scalar	reference () const
Index	rows () const
	SparseView (const MatrixType &mat, const Scalar &reference=Scalar(0), const RealScalar &epsilon=NumTraits< Scalar >::dummy_precision())

Protected Attributes
RealScalar	m_epsilon
MatrixTypeNested	m_matrix
Scalar	m_reference

Private Types
typedef internal::remove_all< MatrixTypeNested >::type	_MatrixTypeNested
typedef SparseMatrixBase< SparseView >	Base
typedef MatrixType::Nested	MatrixTypeNested

Detailed Description

Expression of a dense or sparse matrix with zero or too small values removed.

Template Parameters

MatrixType

the type of the object of which we are removing the small entries

This class represents an expression of a given dense or sparse matrix with entries smaller than reference * epsilon are removed. It is the return type of MatrixBase::sparseView() and SparseMatrixBase::pruned() and most of the time this is the only way it is used.

See also

MatrixBase::sparseView(), SparseMatrixBase::pruned()

Definition at line 124 of file ForwardDeclarations.h.

Member Typedef Documentation

_MatrixTypeNested

typedef internal::remove_all<MatrixTypeNested>::type Eigen::SparseView::_MatrixTypeNested

private

Definition at line 48 of file SparseView.h.

Base

typedef SparseMatrixBase<SparseView > Eigen::SparseView::Base

private

Definition at line 49 of file SparseView.h.

MatrixTypeNested

typedef MatrixType::Nested Eigen::SparseView::MatrixTypeNested

private

Definition at line 47 of file SparseView.h.

NestedExpression

typedef internal::remove_all<MatrixType>::type Eigen::SparseView::NestedExpression

Definition at line 52 of file SparseView.h.

Constructor & Destructor Documentation

SparseView()

Eigen::SparseView::SparseView ( const MatrixType &  mat, const Scalar &  reference = Scalar(0), const RealScalar &  epsilon = NumTraits<Scalar>::dummy_precision()  )

inlineexplicit

Definition at line 54 of file SparseView.h.

Member Function Documentation

cols()

Index Eigen::SparseView::cols ( ) const

inline

Definition at line 59 of file SparseView.h.

epsilon()

RealScalar Eigen::SparseView::epsilon ( ) const

inline

Definition at line 69 of file SparseView.h.

innerSize()

Index Eigen::SparseView::innerSize ( ) const

inline

Definition at line 61 of file SparseView.h.

nestedExpression()

const internal::remove_all<MatrixTypeNested>::type& Eigen::SparseView::nestedExpression ( ) const

inline

Returns

the nested expression

Definition at line 66 of file SparseView.h.

outerSize()

Index Eigen::SparseView::outerSize ( ) const

inline

Definition at line 62 of file SparseView.h.

reference()

Scalar Eigen::SparseView::reference ( ) const

inline

Definition at line 68 of file SparseView.h.

rows()

Index Eigen::SparseView::rows ( ) const

inline

Definition at line 58 of file SparseView.h.

Member Data Documentation

m_epsilon

RealScalar Eigen::SparseView::m_epsilon

protected

Definition at line 74 of file SparseView.h.

m_matrix

MatrixTypeNested Eigen::SparseView::m_matrix

protected

Definition at line 72 of file SparseView.h.

m_reference

Scalar Eigen::SparseView::m_reference

protected

Definition at line 73 of file SparseView.h.

---

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

• ForwardDeclarations.h
• SparseView.h