source: src/RandomNumbers/RandomNumberGeneratorFactory.hpp@ ad28ef

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 ad28ef was 63839f, checked in by Frederik Heber <heber@…>, 14 years ago

RandomNumberGeneratorFactory does not clone anymore.

  • cloning of the generator was nonsense, as (because of same seed), we always start at same random number sequence. I.e. if we often obtain new random number generator we hardly get random numbers.
  • RandomNumberGeneratorFactory::makeRandomNumberGenerator() returns now reference to avoid accidental free'ing of the instance (that is still contained in the prototype table of the factory).
  • unit test of RandomNumberGenerator now checks for non-copy received.
  • RandomNumberGenerator()::get...Name() are now const members.
  • in many cases where pointer *rng was received and ref &random obtained from it, we now receive ref directly (and then don't accidentally forget to delete the clone anymore. Which is good in any case!).
  • Property mode set to 100644
File size: 3.1 KB
Line 
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 "CodePatterns/Clone.hpp"
19
20#include "RandomNumberDistributionFactory.hpp"
21#include "RandomNumberEngineFactory.hpp"
22
23#include <map>
24
25#include "unittests/RandomNumberGeneratorFactoryUnitTest.hpp"
26
27class RandomNumberGenerator;
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;
42
43protected:
44 RandomNumberGeneratorFactory();
45 virtual ~RandomNumberGeneratorFactory();
46
47public:
48 /** Create a Generator of previously set type.
49 *
50 * \return random number generator instance
51 */
52 RandomNumberGenerator& makeRandomNumberGenerator() const;
53
54 /** Create a Generator of desired combination of engine and distribution.
55 *
56 * Note that this does not affect the default setting of the engine or
57 * distribution type.
58 *
59 * \param engine_type name of engine, give empty string for current default
60 * \param distribution_type name of distribution, give empty string for
61 * current default
62 * \return random number generator instance
63 */
64 RandomNumberGenerator& makeRandomNumberGenerator(std::string engine_type, std::string distribution_type) const;
65
66 /** Specify the precise type of the engine to build
67 *
68 * @param name of engine
69 */
70 void setEngine(std::string engine_type);
71
72 /** Getter for the name of the current type of engine.
73 *
74 * @return name of engine
75 */
76 const std::string &getEngineName() const;
77
78 /** Specify the precise type of the distribution to build
79 *
80 * @param name of distribution
81 */
82 void setDistribution(std::string distribution_type);
83
84 /** Getter for the name of the current type of distribution.
85 *
86 * @return name of distribution
87 */
88 const std::string &getDistributionName() const;
89
90protected:
91private:
92 /** Creates instances of all possible (engine,distribution) combinations
93 * and stores them in \a PrototypeTable.
94 */
95 void FillPrototypeTable();
96
97 typedef std::map<
98 RandomNumberEngineFactory::TypeList,
99 std::map<
100 RandomNumberDistributionFactory::TypeList,
101 RandomNumberGenerator *>
102 > EngineDistributionTable;
103
104 static RandomNumberDistributionFactory::TypeList distribution;
105 static RandomNumberEngineFactory::TypeList engine;
106 static EngineDistributionTable GeneratorPrototypeTable;
107};
108
109#endif /* RANDOMNUMBERGENERATORFACTORY_HPP_ */
Note: See TracBrowser for help on using the repository browser.