Utils::Averaged< T > Class Template Reference

Averaged template class provides an average value from a fixed size array. More...

#include <Averaged.h>

Public Member Functions
	Averaged ()
	Averaged (int numValues, T initValue=0)
void	init (int numValues, T initValue)
	Initializes the average value array to a given value. More...
void	set (T value)
	Sets the current value in the value array and builds the average. More...
T	average ()
size_t	size ()

Private Attributes
float	_oneOverNumValues {}
	multiplier instead of divider More...
vector< T >	_values
	value array More...
int	_currentValueIndex {}
	current value index within _values More...
T	_sum
	sum of all values More...
T	_average
	average value More...

Detailed Description

template<class T>
class Utils::Averaged< T >

Averaged template class provides an average value from a fixed size array.

The Average template class provides a simple moving average value continuously averaged from a fixed size vector. The template class can be used for any template type T that provides the following operators: =, -, +, T* float

Definition at line 31 of file Averaged.h.

Constructor & Destructor Documentation

Averaged() [1/2]

template<class T >

Utils::Averaged< T >::Averaged ( )

inline

Definition at line 34 of file Averaged.h.

: _currentValueIndex(0), _sum(0), _average(0) {}

Averaged() [2/2]

template<class T >

Utils::Averaged< T >::Averaged ( int  numValues, T  initValue = 0  )

inline

Definition at line 35 of file Averaged.h.

    {
        init(numValues, initValue);
    }

Member Function Documentation

average()

template<class T >

T Utils::Averaged< T >::average ( )

inline

Definition at line 74 of file Averaged.h.

{ return _average; }

init()

template<class T >

void Utils::Averaged< T >::init ( int  numValues, T  initValue  )

inline

Initializes the average value array to a given value.

Definition at line 41 of file Averaged.h.

    {
        assert(numValues > 0 && "Num. of values must be greater than zero");
        _values.clear();
        _values.resize(numValues, initValue);
        _oneOverNumValues  = 1.0f / (float)_values.size();
        _sum               = initValue * numValues;
        _average           = initValue;
        _currentValueIndex = 0;
    }

set()

template<class T >

void Utils::Averaged< T >::set ( T  value )

inline

Sets the current value in the value array and builds the average.

Definition at line 53 of file Averaged.h.

    {
        assert(_values.size() > 0 && "_value vector not initialized");
 
        // Shortcut for no averaging
        if (_values.size() == 1)
            _sum = _average = value;
        else
        {
            if (_currentValueIndex == _values.size())
                _currentValueIndex = 0;
 
            // Correct the sum continuously
            _sum                        = _sum - _values[_currentValueIndex];
            _values[_currentValueIndex] = value;
            _sum                        = _sum + _values[_currentValueIndex];
            _average                    = _sum * _oneOverNumValues; // avoid division
            _currentValueIndex++;
        }
    }

size()

template<class T >

size_t Utils::Averaged< T >::size ( )

inline

Definition at line 75 of file Averaged.h.

{ return _values.size(); }

Member Data Documentation

_average

template<class T >

T Utils::Averaged< T >::_average

private

average value

Definition at line 82 of file Averaged.h.

_currentValueIndex

template<class T >

int Utils::Averaged< T >::_currentValueIndex {}

private

current value index within _values

Definition at line 80 of file Averaged.h.

_oneOverNumValues

template<class T >

float Utils::Averaged< T >::_oneOverNumValues {}

private

multiplier instead of divider

Definition at line 78 of file Averaged.h.

_sum

template<class T >

T Utils::Averaged< T >::_sum

private

sum of all values

Definition at line 81 of file Averaged.h.

_values

template<class T >

vector<T> Utils::Averaged< T >::_values

private

value array

Definition at line 79 of file Averaged.h.

---

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

• Averaged.h