source: src/RandomNumbers/RandomNumberGeneratorFactory.hpp@ 3f9eba

Action_Thermostats Add_AtomRandomPerturbation Add_FitFragmentPartialChargesAction Add_RotateAroundBondAction Add_SelectAtomByNameAction Added_ParseSaveFragmentResults AddingActions_SaveParseParticleParameters Adding_Graph_to_ChangeBondActions Adding_MD_integration_tests Adding_ParticleName_to_Atom Adding_StructOpt_integration_tests AtomFragments Automaking_mpqc_open AutomationFragmentation_failures Candidate_v1.5.4 Candidate_v1.6.0 Candidate_v1.6.1 ChangeBugEmailaddress ChangingTestPorts ChemicalSpaceEvaluator CombiningParticlePotentialParsing Combining_Subpackages Debian_Package_split Debian_package_split_molecuildergui_only Disabling_MemDebug Docu_Python_wait EmpiricalPotential_contain_HomologyGraph EmpiricalPotential_contain_HomologyGraph_documentation Enable_parallel_make_install Enhance_userguide Enhanced_StructuralOptimization Enhanced_StructuralOptimization_continued Example_ManyWaysToTranslateAtom Exclude_Hydrogens_annealWithBondGraph FitPartialCharges_GlobalError Fix_BoundInBox_CenterInBox_MoleculeActions Fix_ChargeSampling_PBC Fix_ChronosMutex Fix_FitPartialCharges Fix_FitPotential_needs_atomicnumbers Fix_ForceAnnealing Fix_IndependentFragmentGrids Fix_ParseParticles Fix_ParseParticles_split_forward_backward_Actions Fix_PopActions Fix_QtFragmentList_sorted_selection Fix_Restrictedkeyset_FragmentMolecule Fix_StatusMsg Fix_StepWorldTime_single_argument Fix_Verbose_Codepatterns Fix_fitting_potentials Fixes ForceAnnealing_goodresults ForceAnnealing_oldresults ForceAnnealing_tocheck ForceAnnealing_with_BondGraph ForceAnnealing_with_BondGraph_continued ForceAnnealing_with_BondGraph_continued_betteresults ForceAnnealing_with_BondGraph_contraction-expansion FragmentAction_writes_AtomFragments FragmentMolecule_checks_bonddegrees GeometryObjects Gui_Fixes Gui_displays_atomic_force_velocity ImplicitCharges IndependentFragmentGrids IndependentFragmentGrids_IndividualZeroInstances IndependentFragmentGrids_IntegrationTest IndependentFragmentGrids_Sole_NN_Calculation JobMarket_RobustOnKillsSegFaults JobMarket_StableWorkerPool JobMarket_unresolvable_hostname_fix MoreRobust_FragmentAutomation ODR_violation_mpqc_open PartialCharges_OrthogonalSummation PdbParser_setsAtomName PythonUI_with_named_parameters QtGui_reactivate_TimeChanged_changes Recreated_GuiChecks Rewrite_FitPartialCharges RotateToPrincipalAxisSystem_UndoRedo SaturateAtoms_findBestMatching SaturateAtoms_singleDegree StoppableMakroAction Subpackage_CodePatterns Subpackage_JobMarket Subpackage_LinearAlgebra Subpackage_levmar Subpackage_mpqc_open Subpackage_vmg Switchable_LogView ThirdParty_MPQC_rebuilt_buildsystem TrajectoryDependenant_MaxOrder TremoloParser_IncreasedPrecision TremoloParser_MultipleTimesteps TremoloParser_setsAtomName Ubuntu_1604_changes stable
Last change on this file since 3f9eba was 3f9eba, checked in by Frederik Heber <heber@…>, 14 years ago

New classes for random number generation.

  • we use boost::random as a basis. It implements a lot of pseudo-random engines and various distributions. However, everything is templated and there are no base classes to store prototypes of the instances in a map. We need these such that we are able to offer the user at run-time every choice possible.
  • Hence, we need to encapsulate all engines, distributions and (engine, distribution) tuples: RandomNumber..._Encapsulation classes.
  • each with an abstract base class as the interface: RandomNumber... classes.
  • RandomNumberGeneratorFactory is then a singleton that contains all the Maps and tables:
    • from string (user input is string) to enum (storing enum is more efficient that a lengthy string)
    • from enum to instance (of the abstract class).
  • RandomNumberGeneratorFactory is a singleton to allow for global control of what kind of numbers are generated, hence there are also two new Actions:
  • The user in the end only uses two classes: RandomNumberGeneratorFactory and RandomNumberGenerator. The first only for obtaining a specific variant of the latter and the latter to generate the numbers (operator() is passed on to boost::variate_generator::operator()).
  • There is a unit test on the RandomNumberGeneratorFactory that checks some of the table entries and whether one of the RandomNumberGenerator is working (uniform_smallint so far).

Details:

  • As there are ~25 engines and ~15 distributions this makes an enormous amount of possible combinations. To automatically construct these, we use some stuff from boost::preprocessor in order to generate enums, tables and maps automatically just from a sequence of the typenames.
  • we have be-friended the unit test a lot to allow for easier testing, e.g. we need access to internal ..._type to test whether their type is correct.
  • cleanUp() purges the instance of RandomNumberGeneratorFactory.
  • in RandomNumber..._Encapsulation::name() functions are only used for the unit tests.
  • this all resides in its own subfolder RandomNumbers. So far, it is completely independent of everything else.
  • Property mode set to 100644
File size: 4.3 KB
RevLine 
[3f9eba]1/*
2 * RandomNumberGeneratorFactory.hpp
3 *
4 * Created on: Dec 31, 2010
5 * Author: heber
6 */
7
8#ifndef RANDOMNUMBERGENERATORFACTORY_HPP_
9#define RANDOMNUMBERGENERATORFACTORY_HPP_
10
11// include config.h
12#ifdef HAVE_CONFIG_H
13#include <config.h>
14#endif
15
16#include "CodePatterns/Singleton.hpp"
17
18#include "RandomNumberDistribution.hpp"
19#include "RandomNumberEngine.hpp"
20#include "RandomNumberGenerator.hpp"
21
22#include <map>
23
24#include "TemplatePowerSetGenerator.hpp"
25#include "RandomNumberGeneratorFactory.def"
26
27#include "unittests/RandomNumberGeneratorFactoryUnitTest.hpp"
28
29/** This is the abstract factory class for random number generators.
30 *
31 * The reason for creating the generators as this is that we would like to set
32 * the generator's parameters, via some Action, and then onward only have
33 * random number generator of this type using these parameters. Hence, we have
34 * a singleton factory that is controlled by the Action and can then create
35 * generators wherever we like in the code by having the factory create one.
36 *
37 */
38class RandomNumberGeneratorFactory : public Singleton<RandomNumberGeneratorFactory>
39{
40 friend class Singleton<RandomNumberGeneratorFactory>;
41 friend class RandomNumberGeneratorFactoryTest;
42public:
43
44protected:
45 RandomNumberGeneratorFactory();
46 virtual ~RandomNumberGeneratorFactory();
47
48public:
49 /** Enumeration of all (pseudo-)random number engines implemented in
50 * boost::random, see
51 * http://www.boost.org/doc/libs/1_45_0/doc/html/boost_random/reference.html#boost_random.reference.concepts
52 */
53 enum Engine {
54BOOST_PP_REPEAT( engine_seq_size, seqitems_as_enum, engine_seq)
55,
56BOOST_PP_REPEAT( engine_seq_a_size, seqitems_as_enum, engine_seq_a)
57 };
58
59 /** Enumeration of all distribution implemented in random::boost.
60 */
61 enum Distribution {
62BOOST_PP_REPEAT( distribution_seq_size, seqitems_as_enum, distribution_seq)
63 };
64
65 /** Create a Generator of previously set type.
66 *
67 * \return random number generator instance
68 */
69 RandomNumberGenerator& makeRandomNumberGenerator() const;
70
71 /** Create a Generator of desired combination of engine and distribution.
72 *
73 * Note that this does not affect the default setting of the engine or
74 * distribution type.
75 *
76 * \param engine_type name of engine, give empty string for current default
77 * \param distribution_type name of distribution, give empty string for current default
78 * \return random number generator instance
79 */
80 RandomNumberGenerator& makeRandomNumberGenerator(std::string engine_type, std::string distribution_type) const;
81
82 /** Specify the precise type of the engine to build
83 *
84 * @param name of engine
85 */
86 void setEngine(std::string engine_type);
87
88 /** Getter for current type of engine.
89 *
90 * @return name of engine
91 */
92 const std::string &getEngine() const;
93
94 /** Specify the precise type of the distribution to build
95 *
96 * @param name of distribution
97 */
98 void setDistribution(std::string distribution_type);
99
100 /** Getter for current type of distribution.
101 *
102 * @return name of distribution
103 */
104 const std::string &getDistribution() const;
105
106protected:
107private:
108 /** Creates instances of all possible (engine,distribution) combinations
109 * and stores them in \a PrototypeTable.
110 */
111 void FillPrototypeTables();
112
113 typedef std::map<
114 std::string,
115 enum Engine
116 > EngineMap;
117 typedef std::map<
118 enum Engine,
119 RandomNumberEngine *
120 > EngineTable;
121 typedef std::map<
122 enum Engine,
123 std::string
124 > EngineNamesMap;
125
126 typedef std::map<
127 std::string,
128 enum Distribution
129 > DistributionMap;
130 typedef std::map<
131 enum Distribution,
132 RandomNumberDistribution *
133 > DistributionTable;
134 typedef std::map<
135 enum Distribution,
136 std::string
137 > DistributionNamesMap;
138
139 typedef std::map<
140 enum Engine,
141 std::map<
142 enum Distribution,
143 RandomNumberGenerator *>
144 > EngineDistributionTable;
145
146 static enum Engine engine;
147 static enum Distribution distribution;
148 static EngineMap engines;
149 static EngineTable EnginePrototypeTable;
150 static EngineNamesMap engineNames;
151 static DistributionMap distributions;
152 static DistributionTable DistributionPrototypeTable;
153 static DistributionNamesMap distributionNames;
154 static EngineDistributionTable GeneratorPrototypeTable;
155};
156
157#include "RandomNumberGeneratorFactory.undef"
158
159#endif /* RANDOMNUMBERGENERATORFACTORY_HPP_ */
Note: See TracBrowser for help on using the repository browser.