clegacyhistogram.h

//==========================================================================
//  CLEGACYHISTOGRAM.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_CLEGACYHISTOGRAM_H
#define __OMNETPP_CLEGACYHISTOGRAM_H

#include <cmath>
#include "cprecolldensityest.h"

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

namespace omnetpp {

class _OPPDEPRECATED SIM_API cLegacyHistogramBase : public cPrecollectionBasedDensityEst
{
  protected:
    int numCells;     // number of histogram cells or bins
    double *cellv;    // counts, type double because of weighted statistics

  private:
    void copy(const cLegacyHistogramBase& other);

  protected:
    // abstract method in cPrecollectionBasedDensityEst
    virtual void doMergeBinValues(const cPrecollectionBasedDensityEst *other) override;

  public:

    cLegacyHistogramBase(const cLegacyHistogramBase& r) : cPrecollectionBasedDensityEst(r) {cellv=nullptr;copy(r);}

    cLegacyHistogramBase(const char *name, int numcells, bool weighted=false);

    virtual ~cLegacyHistogramBase();

    cLegacyHistogramBase& operator=(const cLegacyHistogramBase& res);


    /* No dup() because this is an abstract class. */

    virtual void parsimPack(cCommBuffer *buffer) const override;

    virtual void parsimUnpack(cCommBuffer *buffer) override;


    virtual void clear() override;

    virtual void setUpBins() override;

    virtual int getNumBins() const override;

    virtual void saveToFile(FILE *) const override;

    virtual void loadFromFile(FILE *) override;

    virtual void setNumCells(int numcells);
};


class _OPPDEPRECATED SIM_API cLegacyHistogram : public cLegacyHistogramBase
{
  public:
    enum Mode {MODE_AUTO, MODE_INTEGERS, MODE_DOUBLES};
    typedef Mode HistogramMode;

  protected:
    Mode mode;
    double cellSize;  // cell (bin) size; <=0 if unset

  private:
    void copy(const cLegacyHistogram& other);

  protected:
    virtual void setupRangeInteger();
    virtual void setupRangeDouble();
    virtual void getAttributesToRecord(opp_string_map& attributes) override;

  public:

    cLegacyHistogram(const cLegacyHistogram& r) : cLegacyHistogramBase(r) {copy(r);}

    explicit cLegacyHistogram(const char *name=nullptr, int numcells=-1, Mode mode=MODE_AUTO, bool weighted=false);

    cLegacyHistogram& operator=(const cLegacyHistogram& res);


    /* No dup() because this is an abstract class. */

    virtual void parsimPack(cCommBuffer *buffer) const override;

    virtual void parsimUnpack(cCommBuffer *buffer) override;

  protected:
    virtual void collectIntoHistogram(double value) override;

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

    virtual void setupRange() override;

  public:

    virtual double getBinEdge(int k) const override;

    virtual double getBinValue(int k) const override;

    virtual double getPDF(double x) const override;

    virtual double getCDF(double x) const override;

    virtual double draw() const override;

    virtual void saveToFile(FILE *) const override;

    virtual void loadFromFile(FILE *) override;

    virtual void setMode(Mode mode);

    virtual Mode getMode() const {return mode;}

    virtual void setCellSize(double d);

    virtual double getCellSize() const {return cellSize;}

};


class _OPPDEPRECATED SIM_API cLongHistogram : public cLegacyHistogram
{
  private:
    void copy(const cLongHistogram& other) {}

  public:
    cLongHistogram(const cLongHistogram& r) : cLegacyHistogram(r) {copy(r);}

    explicit cLongHistogram(const char *name=nullptr, int numcells=-1, bool weighted=false) :
        cLegacyHistogram(name, numcells, MODE_INTEGERS, weighted) {}

    virtual ~cLongHistogram() {}

    cLongHistogram& operator=(const cLongHistogram& other);


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

  public:

    virtual void collect(double value) override {cLegacyHistogram::collect(std::floor(value));}

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


class _OPPDEPRECATED SIM_API cDoubleHistogram : public cLegacyHistogram
{
  private:
    void copy(const cDoubleHistogram& other) {}

  public:

    cDoubleHistogram(const cDoubleHistogram& r) : cLegacyHistogram(r) {copy(r);}

    explicit cDoubleHistogram(const char *name=nullptr, int numcells=-1, bool weighted=false) :
        cLegacyHistogram(name, numcells, MODE_DOUBLES, weighted) {}

    virtual ~cDoubleHistogram() {}

    cDoubleHistogram& operator=(const cDoubleHistogram& other);


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

}  // namespace omnetpp

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

#endif