crng.h

//==========================================================================
//   CRNG.H  - part of
//                     OMNeT++/OMNEST
//            Discrete System Simulation in C++
//
//
//  cRNG: interface for random number generator 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 __CRNG_H
#define __CRNG_H

#include "simkerneldefs.h"
#include "cobject.h"

NAMESPACE_BEGIN

class cConfiguration;


class SIM_API cRNG : public cObject
{
  protected:
    unsigned long numDrawn;

  public:
    cRNG() {numDrawn=0;}
    virtual ~cRNG() {}

    virtual void initialize(int seedSet, int rngId, int numRngs,
                            int parsimProcId, int parsimNumPartitions,
                            cConfiguration *cfg) = 0;

    virtual void selfTest() = 0;

    virtual unsigned long getNumbersDrawn() const  {return numDrawn;}

    virtual unsigned long intRand() = 0;

    virtual unsigned long intRandMax() = 0;

    virtual unsigned long intRand(unsigned long n) = 0;

    virtual double doubleRand() = 0;

    virtual double doubleRandNonz() = 0;

    virtual double doubleRandIncl1() = 0;

    double doubleRandNonzIncl1() {return 1-doubleRand();}
};

NAMESPACE_END


#endif