Faunus::AverageObj< T, counter_type > Class Template Reference

Simple class to average data contained in objects. More...

#include <average.h>

Collaboration diagram for Faunus::AverageObj< T, counter_type >:

Public Member Functions
	AverageObj (const T &value)
	Construct from empty object.
AverageObj &	operator+= (const T &value)
	Add to average.
T	avg () const
	Calculate average.
	operator T () const
	Convert to T.
bool	operator< (const AverageObj &other) const
	Compare operator.
bool	empty () const
	True if empty. More...
void	clear ()
auto	size () const
	Number of samples.

Protected Attributes
counter_type	number_of_samples = 0
T	sum

Detailed Description

template<Averageable T, typename counter_type = unsigned long int>
class Faunus::AverageObj< T, counter_type >

Simple class to average data contained in objects.

Template Parameters

T	Type to average
int_t	Unsigned interger type

It is required that T has the following operator overloads:

• T operator*(double) const
• T operator*(const T&) const
• T& operator+=(const &T)

Member Function Documentation

empty()

template<Averageable T, typename counter_type = unsigned long int>

bool Faunus::AverageObj< T, counter_type >::empty ( ) const

inline

True if empty.

Clear all data

---

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

• src/average.h