Class observe::Average

Average observable.

Keeps track of the sum of values and total weight in order to produce the weighted average of recorded data points since the last reset.

Inheritance
observe::Observable
observe::Average
observe::AverageAndCount
Inherited Members

Constructors

Average()

Declaration
observe::Average::Average()

Methods

reset()

Declaration
void observe::Average::reset() override

record()

Declaration
void observe::Average::record(double value, double weight) override

render()

render the object in structured form

Return a structured representation of the object. This is intended for output purposes. For instance, the solution your solver finds should have a render method which allows it to be returned as part of the result. Example:

{c++}
 MySolution : public Component {
  public:
   // Represent the internal bool vector as +-1 output.
   utils::Structure render() const override {
     utils::Structure rendered;
     for (bool item : solution_) rendered.push_back(item ? 1 : -1);
     return rendered;
   }

  private:
   std::vector<bool> solution_;
 }

 MySolution solution;
 std::cout << solution.render().to_string() << std::endl;

utils::Structure

Declaration
Structure observe::Average::render() const override

record()

Declaration
void observe::Observable::record(double value)

record()

Declaration
void observe::Observable::record(int value)

record()

Declaration
void observe::Observable::record(size_t value)

record()

Declaration
virtual void observe::Observable::record(double value, double weight)=0