agxUtil::Statistic Class Reference

Pure virtual statistic class containing the fundamentals for implementing a statistics method. More...

#include <Statistic.h>

Inheritance diagram for agxUtil::Statistic:

Public Member Functions
virtual	~Statistic ()
virtual agx::Real	get () const =0
virtual agx::Real	update (agx::Real observation)=0
	Updates the statistic given the current observation and returns the current value of this statistic.

Detailed Description

Pure virtual statistic class containing the fundamentals for implementing a statistics method.

Definition at line 36 of file Statistic.h.

Constructor & Destructor Documentation

~Statistic()

virtual agxUtil::Statistic::~Statistic ( )

inlinevirtual

Definition at line 51 of file Statistic.h.

Member Function Documentation

get()

virtual agx::Real agxUtil::Statistic::get ( ) const

pure virtual

Returns

the current value of this statistic

Implemented in agxUtil::ExponentialMovingAverageStatistic, agxUtil::MovingAverageStatistic, and agxUtil::MedianStatistic.

update()

virtual agx::Real agxUtil::Statistic::update ( agx::Real  observation )

pure virtual

Updates the statistic given the current observation and returns the current value of this statistic.

Parameters

observation

- the current observation

Returns

the current value of this statistic

Implemented in agxUtil::ExponentialMovingAverageStatistic, agxUtil::VariableSmoothFactorEMAStatistic, agxUtil::MovingAverageStatistic, and agxUtil::MedianStatistic.

---

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

• Statistic.h