Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/global/HEPNumerics/include/G4StatAnalysis.icc

Version: [ ReleaseNotes ] [ 1.0 ] [ 1.1 ] [ 2.0 ] [ 3.0 ] [ 3.1 ] [ 3.2 ] [ 4.0 ] [ 4.0.p1 ] [ 4.0.p2 ] [ 4.1 ] [ 4.1.p1 ] [ 5.0 ] [ 5.0.p1 ] [ 5.1 ] [ 5.1.p1 ] [ 5.2 ] [ 5.2.p1 ] [ 5.2.p2 ] [ 6.0 ] [ 6.0.p1 ] [ 6.1 ] [ 6.2 ] [ 6.2.p1 ] [ 6.2.p2 ] [ 7.0 ] [ 7.0.p1 ] [ 7.1 ] [ 7.1.p1 ] [ 8.0 ] [ 8.0.p1 ] [ 8.1 ] [ 8.1.p1 ] [ 8.1.p2 ] [ 8.2 ] [ 8.2.p1 ] [ 8.3 ] [ 8.3.p1 ] [ 8.3.p2 ] [ 9.0 ] [ 9.0.p1 ] [ 9.0.p2 ] [ 9.1 ] [ 9.1.p1 ] [ 9.1.p2 ] [ 9.1.p3 ] [ 9.2 ] [ 9.2.p1 ] [ 9.2.p2 ] [ 9.2.p3 ] [ 9.2.p4 ] [ 9.3 ] [ 9.3.p1 ] [ 9.3.p2 ] [ 9.4 ] [ 9.4.p1 ] [ 9.4.p2 ] [ 9.4.p3 ] [ 9.4.p4 ] [ 9.5 ] [ 9.5.p1 ] [ 9.5.p2 ] [ 9.6 ] [ 9.6.p1 ] [ 9.6.p2 ] [ 9.6.p3 ] [ 9.6.p4 ] [ 10.0 ] [ 10.0.p1 ] [ 10.0.p2 ] [ 10.0.p3 ] [ 10.0.p4 ] [ 10.1 ] [ 10.1.p1 ] [ 10.1.p2 ] [ 10.1.p3 ] [ 10.2 ] [ 10.2.p1 ] [ 10.2.p2 ] [ 10.2.p3 ] [ 10.3 ] [ 10.3.p1 ] [ 10.3.p2 ] [ 10.3.p3 ] [ 10.4 ] [ 10.4.p1 ] [ 10.4.p2 ] [ 10.4.p3 ] [ 10.5 ] [ 10.5.p1 ] [ 10.6 ] [ 10.6.p1 ] [ 10.6.p2 ] [ 10.6.p3 ] [ 10.7 ] [ 10.7.p1 ] [ 10.7.p2 ] [ 10.7.p3 ] [ 10.7.p4 ] [ 11.0 ] [ 11.0.p1 ] [ 11.0.p2 ] [ 11.0.p3, ] [ 11.0.p4 ] [ 11.1 ] [ 11.1.1 ] [ 11.1.2 ] [ 11.1.3 ] [ 11.2 ] [ 11.2.1 ] [ 11.2.2 ] [ 11.3.0 ]

Diff markup

Differences between /global/HEPNumerics/include/G4StatAnalysis.icc (Version 11.3.0) and /global/HEPNumerics/include/G4StatAnalysis.icc (Version 8.0)


  1 //                                                  1 
  2 // *******************************************    
  3 // * License and Disclaimer                       
  4 // *                                              
  5 // * The  Geant4 software  is  copyright of th    
  6 // * the Geant4 Collaboration.  It is provided    
  7 // * conditions of the Geant4 Software License    
  8 // * LICENSE and available at  http://cern.ch/    
  9 // * include a list of copyright holders.         
 10 // *                                              
 11 // * Neither the authors of this software syst    
 12 // * institutes,nor the agencies providing fin    
 13 // * work  make  any representation or  warran    
 14 // * regarding  this  software system or assum    
 15 // * use.  Please see the license in the file     
 16 // * for the full disclaimer and the limitatio    
 17 // *                                              
 18 // * This  code  implementation is the result     
 19 // * technical work of the GEANT4 collaboratio    
 20 // * By using,  copying,  modifying or  distri    
 21 // * any work based  on the software)  you  ag    
 22 // * use  in  resulting  scientific  publicati    
 23 // * acceptance of all terms of the Geant4 Sof    
 24 // *******************************************    
 25 //                                                
 26 // G4StatAnalysis inline methods implementatio    
 27 //                                                
 28 // Author: J.Madsen, 25.10.2018                   
 29 // -------------------------------------------    
 30                                                   
 31 #include <cmath>                                  
 32 #include <fstream>                                
 33 #include <iomanip>                                
 34 #include <iostream>                               
 35 #include <limits>                                 
 36                                                   
 37 #include "G4Timer.hh"                             
 38 #include "G4ios.hh"                               
 39 #include "globals.hh"                             
 40 #include "tls.hh"                                 
 41                                                   
 42 #include "G4Allocator.hh"                         
 43 #include "G4Types.hh"                             
 44                                                   
 45 //--------------------------------------------    
 46                                                   
 47 G4StatAnalysis::G4StatAnalysis() {}               
 48                                                   
 49 //--------------------------------------------    
 50                                                   
 51 G4double G4StatAnalysis::GetMean() const          
 52 {                                                 
 53   return (fHits > 0) ? fSum1 / ((G4double) fHi    
 54 }                                                 
 55                                                   
 56 //--------------------------------------------    
 57                                                   
 58 const G4double& G4StatAnalysis::GetSum() const    
 59                                                   
 60 //--------------------------------------------    
 61                                                   
 62 const G4double& G4StatAnalysis::GetSumSquared(    
 63                                                   
 64 //--------------------------------------------    
 65                                                   
 66 const G4double& G4StatAnalysis::GetSum1() cons    
 67                                                   
 68 //--------------------------------------------    
 69                                                   
 70 const G4double& G4StatAnalysis::GetSum2() cons    
 71                                                   
 72 //--------------------------------------------    
 73                                                   
 74 const G4int& G4StatAnalysis::GetHits() const {    
 75                                                   
 76 //--------------------------------------------    
 77                                                   
 78 G4int G4StatAnalysis::GetNumNonZero() const {     
 79                                                   
 80 //--------------------------------------------    
 81                                                   
 82 G4int G4StatAnalysis::GetNumZero() const { ret    
 83                                                   
 84 //--------------------------------------------    
 85                                                   
 86 void G4StatAnalysis::SetSum(const G4double& va    
 87                                                   
 88 //--------------------------------------------    
 89                                                   
 90 void G4StatAnalysis::SetSumSquared(const G4dou    
 91                                                   
 92 //--------------------------------------------    
 93                                                   
 94 void G4StatAnalysis::SetSum1(const G4double& v    
 95                                                   
 96 //--------------------------------------------    
 97                                                   
 98 void G4StatAnalysis::SetSum2(const G4double& v    
 99                                                   
100 //--------------------------------------------    
101                                                   
102 void G4StatAnalysis::SetHits(const G4int& val)    
103                                                   
104 //--------------------------------------------    
105                                                   
106 void G4StatAnalysis::SetZero(const G4int& val)    
107                                                   
108 //--------------------------------------------    
109                                                   
110 G4double G4StatAnalysis::GetFOM() const           
111 {                                                 
112   G4double elapsed_time = this->GetCpuTime();     
113   G4double relative_err = this->GetRelativeErr    
114   // lambda for equation clarity (will be inli    
115   auto compute_figure_of_merit = [&]() {          
116     return (1.0 / (relative_err * relative_err    
117   };                                              
118   return (std::fabs(relative_err) > 0.0 && ela    
119            ? compute_figure_of_merit()            
120            : ((fHits > 0) ? 1.0 : 0.0);           
121 }                                                 
122                                                   
123 //--------------------------------------------    
124                                                   
125 G4double G4StatAnalysis::GetRelativeError() co    
126 {                                                 
127   // lambda for equation clarity (will be inli    
128   auto compute_relative_error = [&]() {           
129     return (GetStdDev() / GetMean() / std::sqr    
130   };                                              
131   return (std::fabs(GetMean()) > 0 && fHits >     
132                                                   
133 }                                                 
134                                                   
135 //--------------------------------------------    
136                                                   
137 G4double G4StatAnalysis::GetStdDev() const        
138 {                                                 
139   return ::sqrt(std::fabs(GetVariance()));        
140 }                                                 
141                                                   
142 //--------------------------------------------    
143                                                   
144 G4double G4StatAnalysis::GetVariance() const      
145 {                                                 
146   // lambda for equation clarity (will be inli    
147   auto compute_variance = [&]() {                 
148     return ((fSum2 - (std::pow(fSum1, 2.0) / f    
149             (((G4double) fHits) - 1.0));          
150   };                                              
151   return (fHits > 1) ? compute_variance() : 0.    
152 }                                                 
153                                                   
154 //--------------------------------------------    
155                                                   
156 G4double G4StatAnalysis::GetCoeffVariation() c    
157 {                                                 
158   // lambda for equation clarity (will be inli    
159   auto coefficient_of_variation = [&]() {         
160     G4double hits = fHits;                        
161     return ::sqrt((hits / (hits - 1.0)) *         
162                   ((fSum2 / (fSum1 * fSum1)) -    
163   };                                              
164   return (fHits > 1) ? coefficient_of_variatio    
165   // return (fHits > 0 && fabs(fSum1) > 0.0)      
166   //        ? (100.0*GetStdDev()/GetMean()) :     
167 }                                                 
168                                                   
169 //--------------------------------------------    
170                                                   
171 G4double G4StatAnalysis::GetEfficiency() const    
172 {                                                 
173   G4double hits  = fHits;                         
174   G4double nzero = fHits - fZero;                 
175   return (fHits > 0) ? (nzero / hits) : 0.0;      
176 }                                                 
177                                                   
178 //--------------------------------------------    
179                                                   
180 G4double G4StatAnalysis::GetR2Int() const         
181 {                                                 
182   G4double hits = fHits;                          
183   return (fHits > 0)                              
184            ? (fSum2 / (fSum1 * fSum1)) - 1.0 /    
185            : 0.0;                                 
186 }                                                 
187                                                   
188 //--------------------------------------------    
189                                                   
190 G4double G4StatAnalysis::GetR2Eff() const         
191 {                                                 
192   G4double hits = fHits;                          
193   return (fHits > 0) ? (1.0 - GetEfficiency())    
194 }                                                 
195                                                   
196 //--------------------------------------------    
197                                                   
198 G4StatAnalysis::operator G4double() const { re    
199                                                   
200 //--------------------------------------------    
201                                                   
202 void G4StatAnalysis::Reset()                      
203 {                                                 
204   fHits = 0;                                      
205   fZero = 0;                                      
206   fSum1 = 0.0;                                    
207   fSum2 = 0.0;                                    
208 }                                                 
209                                                   
210 //--------------------------------------------    
211                                                   
212 void G4StatAnalysis::Add(const G4double& val,     
213 {                                                 
214   fHits += 1;                                     
215   fSum1 += val * weight;                          
216   fSum2 += val * val * weight;                    
217   if(std::fabs(val * weight) <                    
218      std::fabs(GetMean() * std::numeric_limits    
219     fZero += 1;                                   
220 }                                                 
221                                                   
222 //--------------------------------------------    
223                                                   
224 void G4StatAnalysis::Rescale(const G4double& f    
225 {                                                 
226   fSum1 *= factor;                                
227   fSum2 *= factor * factor;                       
228 }                                                 
229                                                   
230 //--------------------------------------------    
231                                                   
232 void G4StatAnalysis::PrintInfo(std::ostream& o    
233 {                                                 
234   G4int _hits     = this->GetHits();              
235   G4double _sum   = this->GetSum();               
236   G4double _sigma = this->GetStdDev();            
237   G4double _coeff = this->GetCoeffVariation();    
238   G4double _error = this->GetRelativeError();     
239   G4double _eff   = this->GetEfficiency();        
240   G4double _fom   = this->GetFOM();               
241   G4double _r2int = this->GetR2Int();             
242   G4double _r2eff = this->GetR2Eff();             
243                                                   
244   using std::fixed;                               
245   using std::ios;                                 
246   using std::left;                                
247   using std::right;                               
248   using std::scientific;                          
249   using std::setprecision;                        
250   using std::setw;                                
251                                                   
252   std::stringstream ss;                           
253   ss << tab  //<< scientific                      
254      << setprecision((G4int)os.precision()) <<    
255      << " [sigma: " << right << _sigma << left    
256      << _error << left << " | coeff: " << righ    
257      << " | eff: " << right << _eff << left <<    
258      << left << " | r2int: " << right << _r2in    
259      << _r2eff << left << " | hits: " << right    
260                                                   
261   os << ss.str();                                 
262 }                                                 
263                                                   
264 //--------------------------------------------    
265                                                   
266 G4double G4StatAnalysis::GetCpuTime() const       
267 {                                                 
268   tms* startTime = GetCpuClock();                 
269   tms endTime;                                    
270   times(&endTime);                                
271   return ((endTime.tms_stime - startTime->tms_    
272           (endTime.tms_utime - startTime->tms_    
273          sysconf(_SC_CLK_TCK);                    
274 }                                                 
275                                                   
276 //--------------------------------------------    
277                                                   
278 G4StatAnalysis& G4StatAnalysis::operator+=(con    
279 {                                                 
280   this->Add(_val);                                
281   return *this;                                   
282 }                                                 
283                                                   
284 //--------------------------------------------    
285                                                   
286 G4StatAnalysis& G4StatAnalysis::operator/=(con    
287 {                                                 
288   fSum1 /= _val;                                  
289   fSum2 /= (_val * _val);                         
290   return *this;                                   
291 }                                                 
292                                                   
293 //--------------------------------------------    
294                                                   
295 G4StatAnalysis& G4StatAnalysis::operator+=(con    
296 {                                                 
297   fHits += rhs.fHits;                             
298   fSum1 += rhs.fSum1;                             
299   fSum2 += rhs.fSum2;                             
300   fZero += rhs.fZero;                             
301   return *this;                                   
302 }                                                 
303                                                   
304 //--------------------------------------------    
305                                                   
306 G4StatAnalysis& G4StatAnalysis::operator-=(con    
307 {                                                 
308   fHits -= rhs.fHits;                             
309   fSum1 -= rhs.fSum1;                             
310   fSum2 -= rhs.fSum2;                             
311   fZero -= rhs.fZero;                             
312   return *this;                                   
313 }                                                 
314                                                   
315 //--------------------------------------------    
316                                                   
317 inline G4Allocator<G4StatAnalysis>*& _aStatAna    
318 {                                                 
319   G4ThreadLocalStatic G4Allocator<G4StatAnalys    
320     new G4Allocator<G4StatAnalysis>();            
321   return _instance;                               
322 }                                                 
323                                                   
324 //--------------------------------------------    
325                                                   
326 void* G4StatAnalysis::operator new(std::size_t    
327 {                                                 
328   G4Allocator<G4StatAnalysis>& _allocator =       
329     *_aStatAnalysisAllocator_G4MT_TLS_();         
330   return (void*) _allocator.MallocSingle();       
331 }                                                 
332                                                   
333 //--------------------------------------------    
334                                                   
335 void G4StatAnalysis::operator delete(void* _pt    
336 {                                                 
337   G4Allocator<G4StatAnalysis>& _allocator =       
338     *_aStatAnalysisAllocator_G4MT_TLS_();         
339   _allocator.FreeSingle((G4StatAnalysis*) _ptr    
340 }                                                 
341                                                   
342 //--------------------------------------------    
343