averager.h

Go to the documentation of this file.

#ifndef AVERAGER_CLASS
#define AVERAGER_CLASS

/*****************************************************************************\
*                                                                             *
*  Name   : averager                                                          *
*  Author : Chris Koeritz                                                     *
*                                                                             * 
*******************************************************************************
* Copyright (c) 1997-$now By Author.  This program is free software; you can  *
* redistribute it and/or modify it under the terms of the GNU General Public  *
* License as published by the Free Software Foundation; either version 2 of   *
* the License or (at your option) any later version.  This is online at:      *
*     http://www.fsf.org/copyleft/gpl.html                                    *
* Please send any updates to: fred@gruntose.com                               *
\*****************************************************************************/

#include <basis/array.h>


template <class contents>
class averager
{
public:
  averager(int entries = 100, bool compacting = true);

  void add(contents value, int count = 1);

  inline contents average() const { return average(0, length() - 1); }

  int samples() const;

  inline int length() const { return _averages.length(); }

  contents average(int start, int end) const;

  struct weighted_entry { contents value; int count; };

  inline weighted_entry get(int index) const { return _averages.get(index); }

  void compact();

  void check_for_compaction();

private:
  bool _do_compaction;  
  array<weighted_entry> _averages;  
  int _entries;  
};


class int_averager : public averager<int>
{
public:
  int_averager(int entries = 100, bool compacting = true)
          : averager<int>(entries, compacting) {}
};

#endif

---