cstddev.h

//==========================================================================
//  CSTDDEV.H - part of
//                     OMNeT++/OMNEST
//            Discrete System Simulation in C++
//
//==========================================================================
 
/*--------------------------------------------------------------*
  Copyright (C) 1992-2017 Andras Varga
  Copyright (C) 2006-2017 OpenSim Ltd.
 
  This file is distributed WITHOUT ANY WARRANTY. See the file
  `license' for details on this and other legal matters.
*--------------------------------------------------------------*/
 
#ifndef __OMNETPP_CSTDDEV_H
#define __OMNETPP_CSTDDEV_H
 
#include <cstdio>
#include "cstatistic.h"
 
namespace omnetpp {
 
class SIM_API cStdDev : public cStatistic
{
  protected:
    bool weighted;
    double minValue;
    double maxValue;
    int64_t numValues; // the actual count of observations, independent of their weights
    double sumWeights;  // equals count in the unweighted case
    double sumWeightedValues; // equals sum in the unweighted case
    double sumSquaredWeights; // equals count in the unweighted case
    double sumWeightedSquaredValues; // sum of squared values in the unweighted case
 
  private:
    void copy(const cStdDev& other);
 
  protected:
    void assertUnweighted() const;
 
  public:
 
    cStdDev(const cStdDev& r) : cStatistic(r) {copy(r);}
 
    explicit cStdDev(const char *name=nullptr, bool weighted=false);
 
    virtual ~cStdDev() {}
 
    cStdDev& operator=(const cStdDev& res);
 
 
    virtual cStdDev *dup() const override  {return new cStdDev(*this);}
 
    virtual std::string str() const override;
 
    virtual void parsimPack(cCommBuffer *buffer) const override;
 
    virtual void parsimUnpack(cCommBuffer *buffer) override;
 
    virtual bool isWeighted() const override  {return weighted;}
 
    virtual void collect(double value) override;
    using cStatistic::collect;
 
    virtual void collectWeighted(double value, double weight) override;
    using cStatistic::collectWeighted;
 
    virtual void merge(const cStatistic *other) override;
 
    virtual int64_t getCount() const override  {return numValues;}
 
    virtual double getSum() const override  {assertUnweighted(); return sumWeightedValues;}
 
    virtual double getSqrSum() const override  {assertUnweighted(); return sumWeightedSquaredValues;}
 
    virtual double getMin() const override;
 
    virtual double getMax() const override;
 
    virtual double getMean() const override;
 
    virtual double getStddev() const override;
 
    virtual double getVariance() const override;
 
    virtual double getSumWeights() const override  {return sumWeights;}
 
    virtual double getWeightedSum() const override  {return sumWeightedValues;}
 
    virtual double getSqrSumWeights() const override  {return sumSquaredWeights;}
 
    virtual double getWeightedSqrSum() const override  {return sumWeightedSquaredValues;}
 
    virtual double draw() const override;
 
    virtual void clear() override;
 
    virtual void saveToFile(FILE *) const override;
 
    virtual void loadFromFile(FILE *) override;
};
 
}  // namespace omnetpp
 
#endif