source: src/RandomNumbers/unittests/RandomNumberGeneratorFactoryUnitTest.cpp@ 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: 5.0 KB
Line 
1/*
2 * Project: MoleCuilder
3 * Description: creates and alters molecular systems
4 * Copyright (C) 2010 University of Bonn. All rights reserved.
5 * Please see the LICENSE file or "Copyright notice" in builder.cpp for details.
6 */
7
8/*
9 * RandomNumberGeneratorFactoryUnitTest.cpp
10 *
11 * Created on: Dec 31, 2010
12 * Author: heber
13 */
14
15// include config.h
16#ifdef HAVE_CONFIG_H
17#include <config.h>
18#endif
19
20#include <cppunit/CompilerOutputter.h>
21#include <cppunit/extensions/TestFactoryRegistry.h>
22#include <cppunit/ui/text/TestRunner.h>
23
24#include "CodePatterns/Assert.hpp"
25
26#include "RandomNumberGeneratorFactoryUnitTest.hpp"
27
28#include "RandomNumbers/RandomNumberDistribution_Encapsulation.hpp"
29#include "RandomNumbers/RandomNumberEngine_Encapsulation.hpp"
30#include "RandomNumbers/RandomNumberGenerator_Encapsulation.hpp"
31#include "RandomNumbers/RandomNumberGeneratorFactory.hpp"
32
33#include <boost/nondet_random.hpp>
34#include <boost/random.hpp>
35#include <boost/random/additive_combine.hpp>
36#include <boost/random/discard_block.hpp>
37#include <boost/random/inversive_congruential.hpp>
38#include <boost/random/lagged_fibonacci.hpp>
39#include <boost/random/linear_congruential.hpp>
40#include <boost/random/linear_feedback_shift.hpp>
41#include <boost/random/mersenne_twister.hpp>
42#include <boost/random/random_number_generator.hpp>
43#include <boost/random/ranlux.hpp>
44#include <boost/random/shuffle_output.hpp>
45#include <boost/random/subtract_with_carry.hpp>
46#include <boost/random/xor_combine.hpp>
47#include <boost/random/bernoulli_distribution.hpp>
48#include <boost/random/binomial_distribution.hpp>
49#include <boost/random/cauchy_distribution.hpp>
50#include <boost/random/exponential_distribution.hpp>
51#include <boost/random/gamma_distribution.hpp>
52#include <boost/random/geometric_distribution.hpp>
53#include <boost/random/linear_congruential.hpp>
54#include <boost/random/lognormal_distribution.hpp>
55#include <boost/random/normal_distribution.hpp>
56#include <boost/random/poisson_distribution.hpp>
57#include <boost/random/triangle_distribution.hpp>
58#include <boost/random/uniform_01.hpp>
59#include <boost/random/uniform_int.hpp>
60#include <boost/random/uniform_on_sphere.hpp>
61#include <boost/random/uniform_real.hpp>
62#include <boost/random/uniform_smallint.hpp>
63
64#include <typeinfo>
65
66#ifdef HAVE_TESTRUNNER
67#include "UnitTestMain.hpp"
68#endif /*HAVE_TESTRUNNER*/
69
70/********************************************** Test classes **************************************/
71
72// Registers the fixture into the 'registry'
73CPPUNIT_TEST_SUITE_REGISTRATION( RandomNumberGeneratorFactoryTest );
74
75void RandomNumberGeneratorFactoryTest::setUp()
76{
77 RandomNumberGeneratorFactory::getInstance();
78}
79
80void RandomNumberGeneratorFactoryTest::tearDown()
81{
82 RandomNumberGeneratorFactory::purgeInstance();
83}
84
85void RandomNumberGeneratorFactoryTest::EngineTest()
86{
87 // check default value
88 CPPUNIT_ASSERT_EQUAL(
89 std::string("minstd_rand0"),
90 RandomNumberGeneratorFactory::getInstance().getEngine());
91
92 // check one of the engines in the table
93 CPPUNIT_ASSERT_EQUAL(
94 std::string(typeid(boost::minstd_rand0).name()),
95 RandomNumberGeneratorFactory::getInstance().
96 EnginePrototypeTable[RandomNumberGeneratorFactory::minstd_rand0]->name()
97 );
98}
99
100void RandomNumberGeneratorFactoryTest::DistributionTest()
101{
102 // check default value
103 CPPUNIT_ASSERT_EQUAL(
104 std::string("uniform_smallint"),
105 RandomNumberGeneratorFactory::getInstance().getDistribution());
106
107 // check one of the distributions in the table
108 CPPUNIT_ASSERT_EQUAL(
109 std::string(typeid(boost::uniform_smallint<> ).name()),
110 RandomNumberGeneratorFactory::getInstance().
111 DistributionPrototypeTable[RandomNumberGeneratorFactory::uniform_smallint]->name()
112 );
113}
114
115void RandomNumberGeneratorFactoryTest::GeneratorTest()
116{
117 // check one of the engines and distributions
118 CPPUNIT_ASSERT_EQUAL(
119 std::string(typeid(boost::minstd_rand0).name()),
120 RandomNumberGeneratorFactory::getInstance().
121 GeneratorPrototypeTable[RandomNumberGeneratorFactory::minstd_rand0][RandomNumberGeneratorFactory::uniform_smallint]
122 ->EngineName()
123 );
124 CPPUNIT_ASSERT_EQUAL(
125 std::string(typeid(boost::uniform_smallint<> ).name()),
126 RandomNumberGeneratorFactory::getInstance().
127 GeneratorPrototypeTable[RandomNumberGeneratorFactory::minstd_rand0][RandomNumberGeneratorFactory::uniform_smallint]
128 ->DistributionName()
129 );
130
131 // obtain some random values for uniform_smallint
132 RandomNumberGeneratorFactory::getInstance().setDistribution("uniform_smallint");
133 RandomNumberGenerator &rng = RandomNumberGeneratorFactory::getInstance().makeRandomNumberGenerator();
134 for (size_t i=0; i < 1000; ++i) {
135 const int testint = rng();
136 CPPUNIT_ASSERT_MESSAGE("randon number from uniform_smallint is out of [0:9]!", testint >= 0);
137 CPPUNIT_ASSERT_MESSAGE("randon number from uniform_smallint is out of [0:9]!", testint <= 9);
138 }
139}
140
Note: See TracBrowser for help on using the repository browser.