preCICE v3.1.1
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
precice::utils::statistics::DistanceAccumulator Class Reference

#include <Statistics.hpp>

Public Member Functions

void operator() (double value)
 Accumulates value.
 
double min () const
 Returns the minimum of all accumulated values.
 
double max () const
 Returns the maximum of all accumulated values.
 
double mean () const
 Returns the mean of all accumulated values.
 
double variance () const
 Returns the sample variance based on all accumulated values.
 
std::size_t count () const
 Returns how many values have been accumulated.
 
bool empty () const
 Returns count == 0.
 

Private Attributes

boost::accumulators::accumulator_set< double, boost::accumulators::stats< boost::accumulators::tag::min, boost::accumulators::tag::max, boost::accumulators::tag::mean, boost::accumulators::tag::lazy_variance > > _acc
 

Detailed Description

Accunulates distance measures and provides statistics based on them.

Definition at line 20 of file Statistics.hpp.

Member Function Documentation

◆ count()

std::size_t precice::utils::statistics::DistanceAccumulator::count ( ) const
inline

Returns how many values have been accumulated.

Definition at line 53 of file Statistics.hpp.

◆ empty()

bool precice::utils::statistics::DistanceAccumulator::empty ( ) const
inline

Returns count == 0.

Definition at line 59 of file Statistics.hpp.

Here is the call graph for this function:

◆ max()

double precice::utils::statistics::DistanceAccumulator::max ( ) const
inline

Returns the maximum of all accumulated values.

Definition at line 35 of file Statistics.hpp.

Here is the call graph for this function:

◆ mean()

double precice::utils::statistics::DistanceAccumulator::mean ( ) const
inline

Returns the mean of all accumulated values.

Definition at line 41 of file Statistics.hpp.

Here is the call graph for this function:

◆ min()

double precice::utils::statistics::DistanceAccumulator::min ( ) const
inline

Returns the minimum of all accumulated values.

Definition at line 29 of file Statistics.hpp.

Here is the call graph for this function:

◆ operator()()

void precice::utils::statistics::DistanceAccumulator::operator() ( double value)
inline

Accumulates value.

Definition at line 23 of file Statistics.hpp.

◆ variance()

double precice::utils::statistics::DistanceAccumulator::variance ( ) const
inline

Returns the sample variance based on all accumulated values.

Definition at line 47 of file Statistics.hpp.

Here is the call graph for this function:

Member Data Documentation

◆ _acc

boost::accumulators::accumulator_set<double, boost::accumulators::stats< boost::accumulators::tag::min, boost::accumulators::tag::max, boost::accumulators::tag::mean, boost::accumulators::tag::lazy_variance> > precice::utils::statistics::DistanceAccumulator::_acc
private

Definition at line 70 of file Statistics.hpp.


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