Estimator Class Referenceabstract
Base class for estimation of various stochastic properties. More...
Inheritance diagram for Estimator:
Public Member Functions | |
| Estimator (StochasticProcess *src, Time *time, const string &name="", const string &type="Estimator") | |
| Construct. More... | |
| virtual void | init ()=0 |
| Reset all estimation dependent values. | |
| virtual | ~Estimator () |
| Destroy. More... | |
| virtual void | collect ()=0 |
| Eat the next data point. | |
| virtual Matrix | getEstimate (const Property &)=0 |
| Return an estimation. | |
 Public Member Functions inherited from Parametric | |
| string | getType () const |
| Type of object. | |
| string | getName () const |
| Name of object. | |
| void | setName (const string &name) |
| Name of object. | |
| string | getConfiguration () const |
| Returns the configuration of the object. More... | |
| string | getAllParameters () const |
| String with all parameter settings. | |
| void | addParameter (const string &name) |
| Add a parameter. More... | |
| void | rmParameter (const string &name) |
| Remove a parameter. More... | |
| virtual void | setParameter (const string &name, const string &value) |
| Set parameter. More... | |
| virtual string | getParameter (const string &name) const |
| Get parameter. More... | |
Protected Attributes | |
| Property | nEstimate |
| what to record | |
| StochasticProcess * | pSource |
| the source of data | |
| uint | nSamples |
| number of samples recorded | |
| Time * | estimatorTime |
| Time process for registering and running. | |
Additional Inherited Members | |
| Protected Member Functions inherited from Parametric | |
| Parametric (const string &name, const string &type) | |
| Create object of type and name. | |
| virtual | ~Parametric () |
| Destroy object. | |
Detailed Description
Base class for estimation of various stochastic properties.
Estimates various properties of stochastic variables (like mean, variance, density). An estimator receives a source of the type StochasticProcess, of which it receives the data during every step (every time proceedToNextState() is called).
Constructor & Destructor Documentation
| Estimator::Estimator | ( | StochasticProcess * | src, |
| Time * | time, | ||
| const string & | name = "", |
||
| const string & | type = "Estimator" |
||
| ) |
Construct.
Registers the class with the Time class for automatic running.
|
virtual |
Destroy.
Un-Registers the class with the Time class for automatic running.
