The circular_accumulator template. More...

#include <circular_accumulator.h>

Public Member Functions
	circular_accumulator (int _size)
	Constructor for circular_accumulator. More...

void	add (T sample)
	Adds a sample to the accumulator. More...

Public Attributes
T	sum
	The sum of the current samples in the samples vector. More...

std::vector< T >	samples
	The vector containing the past size samples of type T. More...

int	index
	The current index where the newest sample will be inserted on the next call to add(). More...

int	size
	The max number of samples the accumulator holds at any give time. More...

Detailed Description

template<typename T>
struct fun::circular_accumulator< T >

The circular_accumulator template.

This class is a template class for the circular accumulator which is used to keep a running sum of the past size samples

Definition at line 25 of file circular_accumulator.h.

Constructor & Destructor Documentation

template<typename T>

fun::circular_accumulator< T >::circular_accumulator ( int _size)

inline

Constructor for circular_accumulator.

Parameters

_size The max number of samples that the accumulator can hold at any given time.

Initializes the samples vector to contain size elements and sets each element to 0 along with the initial sum.

Definition at line 69 of file circular_accumulator.h.

         {
             size = _size;
             samples.resize(size);
             index = 0;
             for(int x = 0; x < size; x++) samples[x] = T(0);
             sum = T(0);
         }

Member Function Documentation

template<typename T>

void fun::circular_accumulator< T >::add ( T sample)

inline

Adds a sample to the accumulator.

Parameters

sample The sample to add to the accumulator

If the accumulator is full the oldest sample in the accumulator is overwritten by the new sample and the current value of sum is updated accordingly.

Definition at line 88 of file circular_accumulator.h.

Referenced by fun::frame_detector::work().

         {
             if(sample != sample) sample = 0;
             sum -= samples[index];
             sum += sample;
             samples[index++] = sample;
             if(index >= size) index = 0;
         }