Eigen  3.3.3
Eigen::SparseView< MatrixType > Class Template Reference

Detailed Description

template<typename MatrixType>
class Eigen::SparseView< MatrixType >

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

Template Parameters:
MatrixTypethe 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()
+ Inheritance diagram for Eigen::SparseView< MatrixType >:

List of all members.

Public Member Functions

Index cols () const
Index innerSize () const
const internal::remove_all
< MatrixTypeNested >::type & 
nestedExpression () const
Index outerSize () const
Index rows () const

Member Function Documentation

template<typename MatrixType>
Index Eigen::SparseView< MatrixType >::cols ( void  ) const [inline]
Returns:
the number of columns.
See also:
rows()

Reimplemented from Eigen::SparseMatrixBase< SparseView< MatrixType > >.

template<typename MatrixType>
Index Eigen::SparseView< MatrixType >::innerSize ( ) const [inline]
Returns:
the size of the inner dimension according to the storage order, i.e., the number of rows for a columns major matrix, and the number of cols otherwise

Reimplemented from Eigen::SparseMatrixBase< SparseView< MatrixType > >.

template<typename MatrixType>
const internal::remove_all<MatrixTypeNested>::type& Eigen::SparseView< MatrixType >::nestedExpression ( ) const [inline]
Returns:
the nested expression
template<typename MatrixType>
Index Eigen::SparseView< MatrixType >::outerSize ( ) const [inline]
Returns:
the size of the storage major dimension, i.e., the number of columns for a columns major matrix, and the number of rows otherwise

Reimplemented from Eigen::SparseMatrixBase< SparseView< MatrixType > >.

template<typename MatrixType>
Index Eigen::SparseView< MatrixType >::rows ( void  ) const [inline]
Returns:
the number of rows.
See also:
cols()

Reimplemented from Eigen::SparseMatrixBase< SparseView< MatrixType > >.


The documentation for this class was generated from the following file:
 All Classes Functions Variables Typedefs Enumerations Enumerator Friends