cvarhist.h

//==========================================================================
//  CVARHIST.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_CVARHIST_H
#define __OMNETPP_CVARHIST_H

#include "clegacyhistogram.h"

#if defined(__clang__) || defined(__GNUC__)
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
#endif

namespace omnetpp {

class _OPPDEPRECATED SIM_API cVarHistogram : public cLegacyHistogramBase
{
  public:
    enum TransformType {
       HIST_TR_NO_TRANSFORM, 
       HIST_TR_AUTO_EPC_DBL, 
       HIST_TR_AUTO_EPC_INT  
    };

  protected:
    TransformType transformType;

    // bin lower boundaries, plus an extra one for the upper bound of the last bin
    // Note: cellLowerBounds[0] = rangeMin, and cellLowerBounds[numCells] = rangeMax
    double *cellLowerBounds;
    int maxNumCells;      // allocated size of cellLowerBounds[] during setup

  private:
    void copy(const cVarHistogram& other);

  protected:
    void createEquiprobableCells();

  public:

    cVarHistogram(const cVarHistogram& r) : cLegacyHistogramBase(r) {cellLowerBounds=nullptr;copy(r);}

    explicit cVarHistogram(const char *name=nullptr,
                           int numcells=11,
                           TransformType transformtype=HIST_TR_AUTO_EPC_DBL);

    virtual ~cVarHistogram();

    cVarHistogram& operator=(const cVarHistogram& res);


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

    virtual void parsimPack(cCommBuffer *buffer) const override;

    virtual void parsimUnpack(cCommBuffer *buffer) override;


    virtual void clear() override;

    virtual void setUpBins() override;

    virtual void collectIntoHistogram(double value) override;

    virtual void collectWeightedIntoHistogram(double value, double weight) override;

    virtual double draw() const override;

    virtual double getPDF(double x) const override;

    virtual double getCDF(double x) const override;

    virtual double getBinEdge(int k) const override;

    virtual double getBinValue(int k) const override;

    virtual void saveToFile(FILE *) const override;

    virtual void loadFromFile(FILE *) override;


    virtual void addBinBound(double x);
};

}  // namespace omnetpp

#if defined(__clang__) || defined(__GNUC__)
#pragma GCC diagnostic pop
#endif

#endif