randomdev.h

Go to the documentation of this file.

/*
 *  randomdev.h
 *
 *  This file is part of NEST.
 *
 *  Copyright (C) 2004 The NEST Initiative
 *
 *  NEST is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  NEST is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with NEST.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef RANDOMDEV_H
#define RANDOMDEV_H

#include <cassert>
#include "randomgen.h"
#include "dictdatum.h"
#include "librandom_exceptions.h"

namespace librandom {

  class RandomDev;
  
  typedef lockPTR<RandomDev> RdvPtr;



  class RandomDev {

  public:

    RandomDev(RngPtr rng = RngPtr(0)) : rng_(rng) {}

    virtual ~RandomDev() {};

    virtual double operator()(void);   
    virtual double operator()(RngPtr) const = 0; 

    virtual long ldev(void);
    virtual long ldev(RngPtr) const;

    virtual bool has_ldev() const { return false; }

    void set_rng(RngPtr rng) { rng_ = rng; }

    virtual void set_status(const DictionaryDatum&) =0; 

    virtual void get_status(DictionaryDatum&) const =0; 

  protected:
    RngPtr rng_;  
  };

  inline 
  double RandomDev::operator()(void)
  {
    assert(rng_.valid());
    return (*this)(rng_);
  }

  inline
  long RandomDev::ldev(void)
  {
    assert(rng_.valid());
    return this->ldev(rng_);
  }


  class GenericRandomDevFactory {
  public:
    virtual ~GenericRandomDevFactory() {}
    virtual RdvPtr create() const =0;
    virtual RdvPtr create(RngPtr rng) const =0;
  };

  template <typename DevType>
  class RandomDevFactory : public GenericRandomDevFactory {

  public:

    RdvPtr create() const
    {
      return RdvPtr(new DevType());
    }    

    RdvPtr create(RngPtr rng) const
    {
      return RdvPtr(new DevType(rng));
    }
    
  };
  

}

#endif