cabstracthistogram.h

//==========================================================================
//  CABSTRACTHISTOGRAM.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_CABSTRACTHISTOGRAM_H
#define __OMNETPP_CABSTRACTHISTOGRAM_H

#include "cstddev.h"

namespace omnetpp {

class SIM_API cAbstractHistogram : public cStdDev
{
  public:
    struct Bin
    {
        double lower;  // lower bin bound (inclusive)
        double upper;  // lower bin bound (exclusive)
        double value;  // count or sum of weights (or its estimate)
        double relativeFreq;  // value / total
        Bin() {lower=upper=value=relativeFreq=0;}
    };

  private:
    void copy(const cAbstractHistogram& other) {}

  public:
    // internal, for use in sim_std.msg; note: each call overwrites the previous value!
    const Bin& internalGetBinInfo(int k) const;

  public:

    cAbstractHistogram(const cAbstractHistogram& other) : cStdDev(other) {}

    explicit cAbstractHistogram(const char *name=nullptr, bool weighted=false) : cStdDev(name, weighted) {}

    virtual ~cAbstractHistogram() {};

    cAbstractHistogram& operator=(const cAbstractHistogram& res) {
        if (this == &res)
           return *this;
       cStdDev::operator=(res);
       copy(res);
       return *this;
    }

    virtual bool binsAlreadySetUp() const = 0;

    virtual void setUpBins() = 0;

    virtual int getNumBins() const = 0;

    virtual double getBinEdge(int k) const = 0;

    virtual double getBinValue(int k) const = 0;

    virtual double getBinPDF(int k) const;

    virtual int64_t getNumUnderflows() const = 0;

    virtual int64_t getNumOverflows() const = 0;

    virtual double getUnderflowSumWeights() const = 0;

    virtual double getOverflowSumWeights() const = 0;

    virtual Bin getBinInfo(int k) const;


    virtual double getPDF(double x) const;

    virtual double getCDF(double x) const;

    virtual double draw() const override;


    _OPPDEPRECATED virtual bool isTransformed() const final {return binsAlreadySetUp();}

    _OPPDEPRECATED virtual void transform() final {setUpBins();}

    _OPPDEPRECATED virtual int getNumCells() const final {return getNumBins();}

    _OPPDEPRECATED virtual double getBasepoint(int k) const final {return getBinEdge(k);}

    _OPPDEPRECATED virtual double getCellValue(int k) const final {return getBinValue(k);}

    _OPPDEPRECATED virtual double getCellPDF(int k) const final {return getBinPDF(k);}

    _OPPDEPRECATED virtual int64_t getUnderflowCell() const final {return getNumUnderflows();}

    _OPPDEPRECATED virtual int64_t getOverflowCell() const final {return getNumOverflows();}

    _OPPDEPRECATED virtual Bin getCellInfo(int k) const final {return getBinInfo(k);}
};

_OPPDEPRECATED typedef cAbstractHistogram cDensityEstBase;

}  // namespace omnetpp


#endif