User Manual, Developers Guide and API Documentation

wns::WeightedAverage< C > Class Template Reference

Build the weighted average.

#include <WeightedAverage.hpp>

Inheritance diagram for wns::WeightedAverage< C >:

Inheritance graph
[legend]
Collaboration diagram for wns::WeightedAverage< C >:

Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual void put (const C &c, double w)
 Put a value and average.
virtual void put (const C &c)
 Put a value and average (Special: weight is always 1).
virtual void reset ()
 Reset the average to 0.0.
 WeightedAverage ()
 Default constructor.
virtual ~WeightedAverage ()
 Destructor.

Private Attributes

double totalWeight
 Sum of all weights.


Detailed Description

template<typename C>
class wns::WeightedAverage< C >

Definition at line 40 of file WeightedAverage.hpp.


Constructor & Destructor Documentation

template<typename C>
wns::WeightedAverage< C >::WeightedAverage (  )  [inline]

Definition at line 47 of file WeightedAverage.hpp.

template<typename C>
virtual wns::WeightedAverage< C >::~WeightedAverage (  )  [inline, virtual]

Definition at line 55 of file WeightedAverage.hpp.


Member Function Documentation

template<typename C>
virtual void wns::WeightedAverage< C >::put ( const C c,
double  w 
) [inline, virtual]

Reimplemented in wns::TimeWeightedAverage< T, Clock >.

Definition at line 78 of file WeightedAverage.hpp.

template<typename C>
virtual void wns::WeightedAverage< C >::put ( const C c  )  [inline, virtual]

Reimplemented from wns::Average< C >.

Reimplemented in wns::TimeWeightedAverage< T, Clock >.

Definition at line 70 of file WeightedAverage.hpp.

template<typename C>
virtual void wns::WeightedAverage< C >::reset (  )  [inline, virtual]

Reimplemented from wns::AverageBase.

Reimplemented in wns::TimeWeightedAverage< T, Clock >.

Definition at line 61 of file WeightedAverage.hpp.


Member Data Documentation

template<typename C>
double wns::WeightedAverage< C >::totalWeight [private]

Definition at line 86 of file WeightedAverage.hpp.


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

Generated on Sat May 26 03:32:51 2012 for openWNS by  doxygen 1.5.5