source: src/RandomNumbers/RandomNumberDistributionFactory.hpp@ c9bc2b7

/*
 * RandomNumberDistributionFactory.hpp
 *
 *  Created on: Jan 03, 2011
 *      Author: heber
 */

#ifndef RANDOMNUMBERDISTRIBUTIONFACTORY_HPP_
#define RANDOMNUMBERDISTRIBUTIONFACTORY_HPP_

// include config.h
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#include "CodePatterns/Singleton.hpp"

#include <map>

#include "TemplatePowerSetGenerator.hpp"
#include "RandomNumberDistributionFactory.def"

#include "RandomNumberDistribution_Creator.hpp"

#include "unittests/RandomNumberDistributionFactoryUnitTest.hpp"

class RandomNumberDistribution;

/** This is the abstract factory class for random number distributions.
 *
 * The reason for creating the distributions as this is that we would like to set
 * the distributions parameters, via some Action, and then onward only have
 * random number distributions of this type using these parameters. Hence, we have
 * a singleton factory that is controlled by the Action and can then create
 * distributions wherever we like in the code by having the factory create one.
 *
 */
class RandomNumberDistributionFactory : public Singleton<RandomNumberDistributionFactory>
{
  friend class Singleton<RandomNumberDistributionFactory>;
  friend class RandomNumberDistributionFactoryTest;
public:

protected:
  RandomNumberDistributionFactory();
  virtual ~RandomNumberDistributionFactory();

public:
  /** Enumeration of all distribution implemented in random::boost.
   */
  enum Distribution {
BOOST_PP_REPEAT( distribution_seq_size, seqitems_as_enum, distribution_seq)
  };

  /** Getter for current type of distribution.
   *
   * @param enumeration index of distribution
   * @return reference to copy of distribution
   */
  RandomNumberDistribution* getDistribution(enum Distribution distribution_type) const;

  /** Getter for current type of distribution.
   *
   * @param name of distribution
   * @return reference to copy of distribution
   */
  RandomNumberDistribution* getDistribution(const std::string distribution_name) const;

  /** Getter for the name of the current type of distribution.
   *
   * @return name of distribution
   */
  const std::string &getName(enum Distribution distribution_type) const;

  /** Getter for the enumeration index of the current type of distribution.
   *
   * @return enum of distribution
   */
  enum Distribution getEnum(const std::string distribution_name) const;


protected:
private:

  /** Creates instances of all possible distribution types
   *  and stores them in \a DistributionPrototypeTable.
   */
  void FillPrototypeTable();

  /** Create association for enums to strings and vice versa
   *  and stores them in \a distributions tables.
   */
  void FillEnumTable();

  typedef std::map<
      std::string,
      enum Distribution
      > DistributionMap;
  typedef std::map<
      enum Distribution,
      IRandomNumberDistribution_Creator *
      > DistributionTable;
  typedef std::map<
      enum Distribution,
      std::string
      > DistributionNamesMap;

  //static enum Distribution distribution;
  static DistributionMap distributions;
  static DistributionTable DistributionPrototypeTable;
  static DistributionNamesMap distributionNames;
};

#include "RandomNumberDistributionFactory.undef"

#endif /* RANDOMNUMBERDISTRIBUTIONFACTORY_HPP_ */