Opm::RunningStatistics< Scalar > Class Template Reference

#include <RunningStatistics.hpp>

Inheritance diagram for Opm::RunningStatistics< Scalar >:

Public Member Functions
template<class Serializer >
void	serializeOp (Serializer &serializer)
bool	operator== (const RunningStatistics &that) const
void	reset ()
void	addSamplePoint (const Scalar x)
std::size_t	sampleSize () const
Scalar	min () const
	Retrieve smallest sample value seen so far. More...
Scalar	max () const
	Retrieve largest sample value seen so far. More...
Scalar	mean () const
	Retrieve arithmetic average of all sample points seen so far. More...
std::optional< Scalar >	stdev () const

Static Public Member Functions
static RunningStatistics	serializationTestObject ()
	Create a serialisation test object. More...

Detailed Description

template<typename Scalar>
class Opm::RunningStatistics< Scalar >

Facility for calculating simple sample statistics without having full sample available.

Template Parameters

Scalar

Sample element type. Typically a built-in arithmetic type like float or double.

Member Function Documentation

addSamplePoint()

template<typename Scalar >

void Opm::RunningStatistics< Scalar >::addSamplePoint ( const Scalar  x )

inline

Include new element into sample.

Updates internal statistics counters.

Parameters

[in]

x

Sample point.

References Opm::RunningStatistics< Scalar >::mean().

max()

template<typename Scalar >

Scalar Opm::RunningStatistics< Scalar >::max ( ) const

inline

Retrieve largest sample value seen so far.

mean()

template<typename Scalar >

Scalar Opm::RunningStatistics< Scalar >::mean ( ) const

inline

Retrieve arithmetic average of all sample points seen so far.

Referenced by Opm::RunningStatistics< Scalar >::addSamplePoint().

min()

template<typename Scalar >

Scalar Opm::RunningStatistics< Scalar >::min ( ) const

inline

Retrieve smallest sample value seen so far.

operator==()

template<typename Scalar >

bool Opm::RunningStatistics< Scalar >::operator== ( const RunningStatistics< Scalar > &  that ) const

inline

Equality predicate.

Parameters

[in]

that

Object against which *this will be tested for equality.

Returns

Whether or not

*this 

is the same as that.

reset()

template<typename Scalar >

void Opm::RunningStatistics< Scalar >::reset ( )

inline

Reset internal counters to prepare for calculating a new set of sample statistics.

sampleSize()

template<typename Scalar >

std::size_t Opm::RunningStatistics< Scalar >::sampleSize ( ) const

inline

Retrieve current sample size.

Effectively returns the number of calls to addSamplePoint() since object was constructed or since the previous call to reset().

serializationTestObject()

template<typename Scalar >

static RunningStatistics Opm::RunningStatistics< Scalar >::serializationTestObject ( )

inlinestatic

Create a serialisation test object.

serializeOp()

template<typename Scalar >

template<class Serializer >

void Opm::RunningStatistics< Scalar >::serializeOp ( Serializer &  serializer )

inline

Convert between byte array and object representation.

Template Parameters

Serializer

Byte array conversion protocol.

Parameters

[in,out]

serializer

Byte array conversion object.

stdev()

template<typename Scalar >

std::optional< Scalar > Opm::RunningStatistics< Scalar >::stdev ( ) const

inline

Retrieve unbiased standard deviation of all sample points seen so far.

Returns nullopt if number of sample points is less than two.

---

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

• RunningStatistics.hpp