Simple circular buffer to compute average and other quantities over pre-defined temporal windows. More...

Collaboration diagram for olb::util::CircularBuffer< T >:

Public Member Functions
	CircularBuffer (int size)

void	insert (T entry)
	insert a new entry ed eventually erases the oldest one

T	average ()
	average over all the entries

T &	get (int pos)
	get reference to the last entry for pos=0, the second-to-last for pos=1, and so on

int	getSize ()
	return size of the buffer

Detailed Description

template<typename T>
class olb::util::CircularBuffer< T >

Simple circular buffer to compute average and other quantities over pre-defined temporal windows.

Works with every T supporting += (T or scalar), and /= (scalar) operations, including double and Vector<double, size>.

Definition at line 158 of file benchmarkUtil.h.

Constructor & Destructor Documentation

template<typename T >

olb::util::CircularBuffer< T >::CircularBuffer ( int size )

Definition at line 328 of file benchmarkUtil.hh.

329 : _size(size)

330{}

template<typename T >

T olb::util::CircularBuffer< T >::average ( )

average over all the entries

Definition at line 342 of file benchmarkUtil.hh.

{
  T avg = T();
  for (auto i=_data.begin(); i!=_data.end(); i++) {
    avg += *i;
  }
  avg *= 1. / _data.size();
  return avg;
}

template<typename T >

T & olb::util::CircularBuffer< T >::get ( int pos )

get reference to the last entry for pos=0, the second-to-last for pos=1, and so on

Definition at line 353 of file benchmarkUtil.hh.

{
  if (pos < 0) {
    return _data.back();
  }
 
  if (pos >= _size) {
    return _data.front();
  }
 
  return _data[_size - 1 - pos];;
}

template<typename T >

int olb::util::CircularBuffer< T >::getSize ( )

return size of the buffer

Definition at line 367 of file benchmarkUtil.hh.

{
  return _size;
}

template<typename T >

void olb::util::CircularBuffer< T >::insert ( T entry )

insert a new entry ed eventually erases the oldest one

Definition at line 333 of file benchmarkUtil.hh.

{
  _data.push_back(entry);
  if (_data.size() > static_cast<unsigned int>(_size) ) {
    _data.erase( _data.begin() );
  }
}

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