dune-istl  2.7.1
Classes | Public Types | Public Member Functions | List of all members
Dune::MatrixRowSubset< M, S > Class Template Reference

Provides access to an iterator over an arbitrary subset of matrix rows. More...

#include <dune/istl/colcompmatrix.hh>

Classes

class  const_iterator
 The matrix row iterator type. More...
 

Public Types

typedef M Matrix
 the type of the matrix class. More...
 
typedef S RowIndexSet
 the type of the set of valid row indices. More...
 

Public Member Functions

 MatrixRowSubset (const Matrix &m, const RowIndexSet &s)
 Construct an row set over all matrix rows. More...
 
const Matrixmatrix () const
 
const RowIndexSetrowIndexSet () const
 
const_iterator begin () const
 Get the row iterator at the first row. More...
 
const_iterator end () const
 Get the row iterator at the end of all rows. More...
 

Detailed Description

template<class M, class S>
class Dune::MatrixRowSubset< M, S >

Provides access to an iterator over an arbitrary subset of matrix rows.

Template Parameters
MThe type of the matrix.
Sthe type of the set of valid row indices.

Member Typedef Documentation

◆ Matrix

template<class M , class S >
typedef M Dune::MatrixRowSubset< M, S >::Matrix

the type of the matrix class.

◆ RowIndexSet

template<class M , class S >
typedef S Dune::MatrixRowSubset< M, S >::RowIndexSet

the type of the set of valid row indices.

Constructor & Destructor Documentation

◆ MatrixRowSubset()

template<class M , class S >
Dune::MatrixRowSubset< M, S >::MatrixRowSubset ( const Matrix m,
const RowIndexSet s 
)
inline

Construct an row set over all matrix rows.

Parameters
mThe matrix for which we manage the rows.
sThe set of row indices we manage.

Member Function Documentation

◆ begin()

template<class M , class S >
const_iterator Dune::MatrixRowSubset< M, S >::begin ( ) const
inline

Get the row iterator at the first row.

◆ end()

template<class M , class S >
const_iterator Dune::MatrixRowSubset< M, S >::end ( ) const
inline

Get the row iterator at the end of all rows.

◆ matrix()

template<class M , class S >
const Matrix& Dune::MatrixRowSubset< M, S >::matrix ( ) const
inline

◆ rowIndexSet()

template<class M , class S >
const RowIndexSet& Dune::MatrixRowSubset< M, S >::rowIndexSet ( ) const
inline

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