Dune::PDELab::ISTL::PatternStatistics< T > Class Template Reference

Statistics about the pattern of a BCRSMatrix. More...

#include <dune/pdelab/backend/istl/patternstatistics.hh>

Public Types
typedef T	size_type
	size_type of the associated BCRSMatrix.

Public Member Functions
size_type	nonZeros () const
	The total number of nonzero entries in the matrix.
size_type	longestRow () const
	The maximum number of nonzero entries in any row of the matrix.
size_type	overflowCount () const
	The number of nonzero entries that had to be temporarily stored in the overflow area during pattern construction.
size_type	estimatedEntriesPerRow () const
	The estimated number of nonzeros per row as provided by the user before pattern construction.
size_type	rows () const
	The number of matrix rows.
double	averageEntriesPerRow () const
	The average number of nonzero entries per row, after matrix construction was completed.

Detailed Description

template<typename T>
class Dune::PDELab::ISTL::PatternStatistics< T >

Statistics about the pattern of a BCRSMatrix.

Member Typedef Documentation

size_type

template<typename T >

typedef T Dune::PDELab::ISTL::PatternStatistics< T >::size_type

size_type of the associated BCRSMatrix.

Member Function Documentation

averageEntriesPerRow()

template<typename T >

double Dune::PDELab::ISTL::PatternStatistics< T >::averageEntriesPerRow ( ) const

inline

The average number of nonzero entries per row, after matrix construction was completed.

estimatedEntriesPerRow()

template<typename T >

size_type Dune::PDELab::ISTL::PatternStatistics< T >::estimatedEntriesPerRow ( ) const

inline

The estimated number of nonzeros per row as provided by the user before pattern construction.

longestRow()

template<typename T >

size_type Dune::PDELab::ISTL::PatternStatistics< T >::longestRow ( ) const

inline

The maximum number of nonzero entries in any row of the matrix.

nonZeros()

template<typename T >

size_type Dune::PDELab::ISTL::PatternStatistics< T >::nonZeros ( ) const

inline

The total number of nonzero entries in the matrix.

overflowCount()

template<typename T >

size_type Dune::PDELab::ISTL::PatternStatistics< T >::overflowCount ( ) const

inline

The number of nonzero entries that had to be temporarily stored in the overflow area during pattern construction.

rows()

template<typename T >

size_type Dune::PDELab::ISTL::PatternStatistics< T >::rows ( ) const

inline

The number of matrix rows.

---

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

• patternstatistics.hh