cstddev.h

//==========================================================================
//  CSTDDEV.H - part of
//                     OMNeT++/OMNEST
//            Discrete System Simulation in C++
//
//
//  Declaration of the following classes:
//    cStdDev: basic statistics (mean, stddev, min, max, etc)
//    cWeightedStdDev: weighted version
//
//==========================================================================

/*--------------------------------------------------------------*
  Copyright (C) 1992-2008 Andras Varga
  Copyright (C) 2006-2008 OpenSim Ltd.

  This file is distributed WITHOUT ANY WARRANTY. See the file
  `license' for details on this and other legal matters.
*--------------------------------------------------------------*/

#ifndef __CSTDDEV_H
#define __CSTDDEV_H

#include <stdio.h>
#include "cstatistic.h"

NAMESPACE_BEGIN

class SIM_API cStdDev : public cStatistic
{
  protected:
    long num_vals;
    double min_vals, max_vals;
    double sum_vals, sqrsum_vals;

  private:
    void copy(const cStdDev& other);

  protected:
    void doMerge(const cStatistic *other);

  public:

    cStdDev(const cStdDev& r) : cStatistic(r) {copy(r);}

    explicit cStdDev(const char *name=NULL);

    virtual ~cStdDev() {}

    cStdDev& operator=(const cStdDev& res);


    virtual cStdDev *dup() const  {return new cStdDev(*this);}

    virtual std::string info() const;

    virtual std::string detailedInfo() const;

    virtual void parsimPack(cCommBuffer *buffer);

    virtual void parsimUnpack(cCommBuffer *buffer);


    virtual void collect(double value);

    virtual void collect(SimTime value) {collect(value.dbl());}

    virtual void merge(const cStatistic *other);

    virtual bool isWeighted() const  {return false;}

    virtual long getCount() const  {return num_vals;}

    virtual double getSum() const  {return sum_vals;}

    virtual double getSqrSum() const  {return sqrsum_vals;}

    virtual double getMin() const;

    virtual double getMax() const;

    virtual double getMean() const;

    virtual double getStddev() const;

    virtual double getVariance() const;

    virtual double getWeights() const  {return getCount();}

    virtual double getWeightedSum() const  {return getSum();}

    virtual double getSqrSumWeights() const  {return getCount();}

    virtual double getWeightedSqrSum() const  {return getSqrSum();}

    virtual double random() const;

    virtual void clearResult();

    virtual void saveToFile(FILE *) const;

    virtual void loadFromFile(FILE *);
};



class SIM_API cWeightedStdDev : public cStdDev
{
  protected:
    double sum_weights;
    double sum_weighted_vals;
    double sum_squared_weights;
    double sum_weights_squared_vals;

  private:
    void copy(const cWeightedStdDev& other);

  public:

    cWeightedStdDev(const cWeightedStdDev& r) : cStdDev(r) {copy(r);}

    explicit cWeightedStdDev(const char *name=NULL) : cStdDev(name)  {sum_weights=sum_weighted_vals=sum_squared_weights=sum_weights_squared_vals=0.0;}

    virtual ~cWeightedStdDev() {}

    cWeightedStdDev& operator=(const cWeightedStdDev& res);


    virtual cWeightedStdDev *dup() const  {return new cWeightedStdDev(*this);}

    virtual std::string info() const;

    virtual void parsimPack(cCommBuffer *buffer);

    virtual void parsimUnpack(cCommBuffer *buffer);


    virtual void collect(double value)  {collect2(value,1.0);}

    virtual void collect(SimTime value) {collect(value.dbl());}

    virtual bool isWeighted() const  {return true;}

    virtual void collect2(double value, double weight);

    virtual void collect2(SimTime value, double weight) {collect2(value.dbl(), weight);}

    virtual void collect2(double value, SimTime weight) {collect2(value, weight.dbl());}

    virtual void collect2(SimTime value, SimTime weight) {collect2(value.dbl(), weight.dbl());}

    virtual void merge(const cStatistic *other);

    virtual void clearResult();

    virtual double getMean() const;

    virtual double getVariance() const;

    virtual double getWeights() const  {return sum_weights;}

    virtual double getWeightedSum() const  {return sum_weighted_vals;}

    virtual double getSqrSumWeights() const  {return sum_squared_weights;}

    virtual double getWeightedSqrSum() const  {return sum_weights_squared_vals;}

    virtual void saveToFile(FILE *) const;

    virtual void loadFromFile(FILE *);
};

NAMESPACE_END

#endif