cvarhist.h

//==========================================================================
//  CVARHIST.H - part of
//
//                     OMNeT++/OMNEST
//            Discrete System Simulation in C++
//
//
//  Declaration of the following classes:
//    cVarHistogram : Variable bin size histogram
//
//==========================================================================

/*--------------------------------------------------------------*
  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 __CVARHIST_H
#define __CVARHIST_H

#include "chistogram.h"

NAMESPACE_BEGIN


enum {
   HIST_TR_NO_TRANSFORM=1, 
   HIST_TR_AUTO_EPC_DBL=0, 
   HIST_TR_AUTO_EPC_INT=2  
};

class SIM_API cVarHistogram : public cHistogramBase
{
  protected:
    int transform_type;     // one of the HIST_TR_xxx constants
    int max_num_cells;      // the length of the allocated cellv
    double *bin_bounds;     // bin/cell boundaries

    // the boundaries of the ordinary cells/bins are:
    // rangemin=bin_bounds[0], bin_bounds[1], ... bin_bounds[num_cells]=rangemax
    // consequence: sizeof(binbounds)=sizeof(cellv)+1

  private:
    void copy(const cVarHistogram& other);

  protected:
    void createEquiprobableCells();

  public:

    cVarHistogram(const cVarHistogram& r) : cHistogramBase(r) {bin_bounds=NULL;copy(r);}

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

    virtual ~cVarHistogram();

    cVarHistogram& operator=(const cVarHistogram& res);


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

    virtual void parsimPack(cCommBuffer *buffer);

    virtual void parsimUnpack(cCommBuffer *buffer);


    virtual void clearResult();

    virtual void transform();

    virtual void collectTransformed(double val);

    virtual double random() const;

    virtual double getPDF(double x) const;

    virtual double getCDF(double x) const;

    virtual double getBasepoint(int k) const;

    virtual double getCellValue(int k) const;

    virtual void saveToFile(FILE *) const;

    virtual void loadFromFile(FILE *);


    virtual void addBinBound(double x);
};

NAMESPACE_END


#endif