source: src/Patterns/Cacheable.hpp@ d346b6

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
Last change on this file since d346b6 was 314ff6, checked in by Tillmann Crueger <crueger@…>, 16 years ago

Assigned best priority to cached values.
  • Property mode set to 100644
File size: 3.5 KB
Line 
1/*
2 * Cacheable.hpp
3 *
4 * Created on: Feb 2, 2010
5 * Author: crueger
6 */
7
8#ifndef CACHEABLE_HPP_
9#define CACHEABLE_HPP_
10
11#include "Patterns/Observer.hpp"
12#include <boost/function.hpp>
13
14#ifndef NO_CACHING
15
16 template<typename T>
17 class Cacheable : public Observer
18 {
19 public:
20 Cacheable(Observable *_owner, boost::function<T()> _recalcMethod);
21 virtual ~Cacheable();
22
23 const bool isValid();
24 const T& operator*();
25 const bool operator==(const T&);
26 const bool operator!=(const T&);
27
28 // methods implemented for base-class Observer
29 void update(Observable *subject);
30 void subjectKilled(Observable *subject);
31 private:
32 void checkValid();
33
34 T content;
35 Observable *owner;
36 bool valid;
37 bool canBeUsed;
38 boost::function<T()> recalcMethod;
39 };
40
41
42 template<typename T>
43 Cacheable<T>::Cacheable(Observable *_owner, boost::function<T()> _recalcMethod) :
44 owner(_owner),
45 recalcMethod(_recalcMethod),
46 valid(false),
47 canBeUsed(true)
48 {
49 // we sign on with the best(=lowest) priority, so cached values are recalculated before
50 // anybody else might ask for updated values
51 owner->signOn(this,-20);
52 }
53
54 template<typename T>
55 const T& Cacheable<T>::operator*(){
56 checkValid();
57 return content;
58 }
59
60 template<typename T>
61 const bool Cacheable<T>::operator==(const T& rval){
62 checkValid();
63 return (content == rval);
64 }
65
66 template<typename T>
67 const bool Cacheable<T>::operator!=(const T& rval){
68 checkValid();
69 return (content != rval);
70 }
71
72 template<typename T>
73 Cacheable<T>::~Cacheable()
74 {
75 owner->signOff(this);
76 }
77
78 template<typename T>
79 const bool Cacheable<T>::isValid(){
80 return valid;
81 }
82
83 template<typename T>
84 void Cacheable<T>::update(Observable *subject) {
85 valid = false;
86 }
87
88 template<typename T>
89 void Cacheable<T>::subjectKilled(Observable *subject) {
90 valid = false;
91 canBeUsed = false;
92 }
93
94 template<typename T>
95 void Cacheable<T>::checkValid(){
96 assert(canBeUsed && "Cacheable used after owner was deleted");
97 if(!isValid()){
98 content = recalcMethod();
99 }
100 }
101#else
102 template<typename T>
103 class Cacheable : public Observer
104 {
105 public:
106 Cacheable(Observable *_owner, boost::function<T()> _recalcMethod);
107 virtual ~Cacheable();
108
109 const bool isValid();
110 const T& operator*();
111 const bool operator==(const T&);
112 const bool operator!=(const T&);
113
114 // methods implemented for base-class Observer
115 void update(Observable *subject);
116 void subjectKilled(Observable *subject);
117 private:
118
119 boost::function<T()> recalcMethod;
120 };
121
122 template<typename T>
123 Cacheable<T>::Cacheable(Observable *_owner, boost::function<T()> _recalcMethod) :
124 recalcMethod(_recalcMethod)
125 {}
126
127 template<typename T>
128 const T& Cacheable<T>::operator*(){
129 return recalcMethod();
130 }
131
132 template<typename T>
133 const bool Cacheable<T>::operator==(const T& rval){
134 return (recalcMethod() == rval);
135 }
136
137 template<typename T>
138 const bool Cacheable<T>::operator!=(const T& rval){
139 return (recalcMethod() != rval);
140 }
141
142 template<typename T>
143 Cacheable<T>::~Cacheable()
144 {}
145
146 template<typename T>
147 const bool Cacheable<T>::isValid(){
148 return true;
149 }
150
151 template<typename T>
152 void Cacheable<T>::update(Observable *subject) {
153 assert(0 && "Cacheable::update should never be called when caching is disabled");
154 }
155
156 template<typename T>
157 void Cacheable<T>::subjectKilled(Observable *subject) {
158 assert(0 && "Cacheable::subjectKilled should never be called when caching is disabled");
159 }
160#endif
161
162#endif /* CACHEABLE_HPP_ */
Note: See TracBrowser for help on using the repository browser.