cdensityestbase.h

//==========================================================================
//  CDENSITYESTBASE.H - part of
//                     OMNeT++/OMNEST
//            Discrete System Simulation in C++
//
//
//  Declaration of the following classes:
//    cDensityEstBase : common base class for density estimation classes
//
//==========================================================================

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

#include "cstddev.h"

NAMESPACE_BEGIN

class SIM_API cDensityEstBase : public cStdDev
{
  public:
    enum RangeMode {
        RANGE_AUTO,      // automatic range setup, using precollected values and range extension (the default)
        RANGE_AUTOLOWER, // like RANGE_AUTO, but upper limit is fixed
        RANGE_AUTOUPPER, // like RANGE_AUTO, but lower limit is fixed
        RANGE_FIXED,     // fixed range (lower, upper)
        RANGE_NOTSET     // not set, but it is OK (cVarHistogram only)
    };

    struct Cell
    {
        double lower;  // lower cell bound (inclusive)
        double upper;  // lower cell bound (exclusive)
        double value;  // counter (or its estimate)
        double relativeFreq;  // value / total
        Cell() {lower=upper=value=relativeFreq=0;}
    };

  protected:
    double rangemin, rangemax;   // range for distribution density collection
    int num_firstvals;         // number of "pre-collected" observations
                                // before transform() is performed.
    unsigned long cell_under;
    unsigned long cell_over;    // for counting observations that fall out of range

    double range_ext_factor;    // the range of histogram is: [min_vals, max_vals] made
                                // range_ext_factor times larger
    RangeMode range_mode;       // one of RANGE_xxx constants

    bool transfd;
    double *firstvals;         // pointer to array of "pre-collected" observations

  private:
    void copy(const cDensityEstBase& other);

  protected:
    static void plotline (std::ostream& os, const char *pref, double xval, double count, double a);

    // part of merge(); to be implemented in subclasses
    virtual void doMergeCellValues(const cDensityEstBase *other) = 0;
  public:
    // internal, for use in sim_std.msg; note: each call overwrites the previous value!
    const Cell& internalGetCellInfo(int k) const;

  public:

    cDensityEstBase(const cDensityEstBase& other) : cStdDev(other) {firstvals=NULL;copy(other);}

    explicit cDensityEstBase(const char *name=NULL);

    virtual ~cDensityEstBase();

    cDensityEstBase& operator=(const cDensityEstBase& res);


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

    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 void clearResult();

    virtual void saveToFile(FILE *) const;

    virtual void loadFromFile(FILE *);


    virtual void setRange(double lower, double upper);

    virtual void setRangeAuto(int num_firstvals=100, double range_ext_fact=2.0);

    virtual void setRangeAutoLower(double upper, int num_firstvals=100, double range_ext_fact=2.0);

    virtual void setRangeAutoUpper(double lower, int num_firstvals=100, double range_ext_fact=2.0);

    virtual void setNumFirstVals(int num_firstvals);

    virtual int getNumFirstVals() const {return num_firstvals;}

    virtual double getRangeExtensionFactor() const {return range_ext_factor;}

  protected:
    virtual void setupRange();

    virtual void collectTransformed(double value) = 0;

  public:


    virtual bool isTransformed() const   {return transfd;}

    virtual void transform() = 0;


    virtual int getNumCells() const = 0;

    virtual double getBasepoint(int k) const = 0;

    virtual double getCellValue(int k) const = 0;

    virtual double getCellPDF(int k) const;

    virtual unsigned long getUnderflowCell() const {return cell_under;}

    virtual unsigned long getOverflowCell() const {return cell_over;}

    virtual Cell getCellInfo(int k) const;


    virtual double getPDF(double x) const = 0;

    virtual double getCDF(double x) const = 0;
};

NAMESPACE_END


#endif