Changeset 15911c for src/RandomNumbers/RandomNumberEngine.hpp

Timestamp:

Feb 3, 2011, 9:51:19 AM (15 years ago)

Author:

Frederik Heber <heber@…>

Branches:

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, Candidate_v1.7.0, 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

Children:

081e5d

Parents:

9b3476

git-author:

Frederik Heber <heber@…> (01/05/11 16:09:12)

git-committer:

Frederik Heber <heber@…> (02/03/11 09:51:19)

Message:

Made some cstor of RandomNumber... protected.

• RandomNumberGenerator now contains refs to engine and distribution instead of encapsulation as it can be made friend of these classes to allow acccess to dstor.

File:

• src/RandomNumbers/RandomNumberEngine.hpp (modified) (4 diffs)

src/RandomNumbers/RandomNumberEngine.hpp

@@ -14 +14 @@
 #endif
 
+class RandomNumberEngineFactoryTest;
+class RandomNumberGenerator;
+
 /** Abstract base class for a random number engine.
  *
@@ -23 +26 @@
 class RandomNumberEngine
 {
+  /**
+   * test has to access cstor/dstor.
+   */
+  friend class RandomNumberEngineFactoryTest;
+
+  /**
+   * RandomNumberGenerator(_Encapsulation) needs access to dstor.
+   */
+  friend class RandomNumberGenerator;
+
 public:
   /** Set the generator's seed.
@@ -30 +43 @@
   virtual void seed(unsigned int _seed)=0;
 
-  /** Getter for the generator's seed.
-   *
-   * @return _seed seed to set to
-   */
-  virtual unsigned int getseed() const = 0;
-
   /** Getter for the type name of the internal engine.
    *
@@ -41 +48 @@
   virtual std::string name()=0;
 
+  /** Destructor of class RandomNumberEngine.
+   *
+   * @note must be public such that instances from factory can be destroyed.
+   *
+   */
+  virtual ~RandomNumberEngine() {};
+protected:
+  /** Constructor of class RandomNumberEngine.
+   *
+   * @note is protected such that instances can only be created by the factory.
+   */
   RandomNumberEngine() {};
-  virtual ~RandomNumberEngine() {};
 
+  /** Getter for the generator's seed.
+   *
+   * @note is only used internally for unit test.
+   *
+   * @return _seed seed to set to
+   */
+  virtual unsigned int getseed() const = 0;
 };