Dune::PDELab::SolverStatistics< T > Class Template Reference

Class for collecting statistics over several invocations. More...

#include <dune/pdelab/backend/istl/matrixfree/solverstatistics.hh>

Inheritance diagram for Dune::PDELab::SolverStatistics< T >:

Public Member Functions
	SolverStatistics (const Dune::CollectiveCommunication< MPI_Comm > &comm_)
	Create new instance of class.
void	append (const T x)
	Add new data point.
void	clear ()
	clear out data
const size_t	size () const
	Total number of calls.
const double	avg () const
	Calculate global average.
const double	stddev () const
	Calculate standard deviation.
const T	min () const
	Calculate global minimum.
const T	max () const
	Calculate global maximum.
const StatisticsResult< T >	result () const
	Convert to statistics result.

Detailed Description

template<typename T>
class Dune::PDELab::SolverStatistics< T >

Class for collecting statistics over several invocations.

Records data for every invocation and provides methods for calculating min/max/avg/stddev over all invocations. This can then be used to calculate statistics on the block-solves

Constructor & Destructor Documentation

SolverStatistics()

template<typename T >

Dune::PDELab::SolverStatistics< T >::SolverStatistics ( const Dune::CollectiveCommunication< MPI_Comm > &  comm_ )

inline

Create new instance of class.

Parameters

[in]

comm_

Collective communication object

Member Function Documentation

append()

template<typename T >

void Dune::PDELab::SolverStatistics< T >::append ( const T  x )

inline

Add new data point.

Parameters

[in]

x

Data point to add

avg()

template<typename T >

const double Dune::PDELab::SolverStatistics< T >::avg ( ) const

inline

Calculate global average.

Calculates global average over all processors and invocations

clear()

template<typename T >

void Dune::PDELab::SolverStatistics< T >::clear ( )

inline

clear out data

max()

template<typename T >

const T Dune::PDELab::SolverStatistics< T >::max ( ) const

inline

Calculate global maximum.

Calculates global maximum over all processors and invocations

min()

template<typename T >

const T Dune::PDELab::SolverStatistics< T >::min ( ) const

inline

Calculate global minimum.

Calculates global minimum over all processors and invocations

result()

template<typename T >

const StatisticsResult< T > Dune::PDELab::SolverStatistics< T >::result ( ) const

inline

Convert to statistics result.

size()

template<typename T >

const size_t Dune::PDELab::SolverStatistics< T >::size ( ) const

inline

Total number of calls.

Calculates total number of invocations

stddev()

template<typename T >

const double Dune::PDELab::SolverStatistics< T >::stddev ( ) const

inline

Calculate standard deviation.

Calculates standard deviation

---

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

• solverstatistics.hh