File: GeneralStatistics.h

package info (click to toggle)
herwig%2B%2B 2.6.0-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 27,128 kB
  • ctags: 24,739
  • sloc: cpp: 188,949; fortran: 23,193; sh: 11,365; python: 5,069; ansic: 3,539; makefile: 1,865; perl: 2
file content (321 lines) | stat: -rw-r--r-- 6,967 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
// -*- C++ -*-
//
// GeneralStatictis.h is a part of Herwig++ - A multi-purpose Monte Carlo event generator
// Copyright (C) 2002-2012 The Herwig Collaboration
//
// Herwig++ is licenced under version 2 of the GPL, see COPYING for details.
// Please respect the MCnet academic guidelines, see GUIDELINES for details.
//
#ifndef Herwig_GeneralStatistics_H
#define Herwig_GeneralStatistics_H
//
// This is the declaration of the GeneralStatistics class.
//

#include "ThePEG/Persistency/PersistentOStream.h"
#include "ThePEG/Persistency/PersistentIStream.h"

namespace Herwig {

using namespace ThePEG;

/**
 * \ingroup Matchbox
 * \author Simon Platzer
 *
 * \brief General Monte Carlo statistics.
 *
 */
class GeneralStatistics {

public:

  /** @name Standard constructors and destructors. */
  //@{
  /**
   * The default constructor.
   */
  GeneralStatistics()
    : theBias(1.), theMaxWeight(0.), 
      theMinWeight(Constants::MaxDouble), theSumWeights(0.), 
      theSumSquaredWeights(0.), theSumAbsWeights(0.), 
      theSelectedPoints(0), theAcceptedPoints(0),
      theNanPoints(0), theAllPoints(0),
      theLastWeight(0.) {}

  /**
   * The destructor.
   */
  virtual ~GeneralStatistics();
  //@}

public:

  /**
   * Set the weight by which events entering this statistics have been
   * biased.
   */
  void bias(double w) { theBias = w; }

  /**
   * Return the weight by which events entering this statistics have been
   * biased.
   */
  double bias() const { return theBias; }

  /**
   * Return the last calculated chi^2.
   */
  virtual double chi2() const { return 0.; }

  /**
   * Reset these statistics.
   */
  void reset() {
    *this = GeneralStatistics();
  }

public:

  /**
   * Return the last weight encountered.
   */
  double lastWeight() const { return theLastWeight; }

  /**
   * Return the maximum absolute weight
   */
  double maxWeight() const { return theMaxWeight; }

  /**
   * Return the minimum absolute weight
   */
  double minWeight() const { return theMinWeight; }

  /**
   * Set the maximum absolute weight
   */
  void maxWeight(double w) { theMaxWeight = w; }

  /**
   * Set the minimum absolute weight
   */
  void minWeight(double w) { theMinWeight = w; }

  /**
   * Return the sum of weights
   */
  double sumWeights() const { return theSumWeights; }

  /**
   * Return the sum of squared weights 
   */
  double sumSquaredWeights() const { return theSumSquaredWeights; }

  /**
   * Return the sum of absolute weights 
   */
  double sumAbsWeights() const { return theSumAbsWeights; }

  /**
   * Return the number of selected points.
   */
  unsigned long selectedPoints() const { return theSelectedPoints; }

  /**
   * Return the nnumber of accepted points.
   */
  unsigned long acceptedPoints() const { return theAcceptedPoints; }

  /**
   * Return the number of points where a nan or inf weight has been
   * encountered.
   */
  unsigned long nanPoints() const { return theNanPoints; }

  /**
   * Return the number of all points.
   */
  unsigned long allPoints() const { return theAllPoints; }

  /**
   * Return the average weight.
   */
  virtual double averageWeight() const {
    return selectedPoints() > 0 ? sumWeights()/selectedPoints() : 0.;
  }

  /**
   * Return the average absolute weight.
   */
  virtual double averageAbsWeight() const {
    return selectedPoints() > 0 ? sumAbsWeights()/selectedPoints() : 0.;
  }

  /**
   * Return the variance of weights.
   */
  double weightVariance() const {
    return 
      selectedPoints() > 1 ? 
      abs(sumSquaredWeights() - sqr(sumWeights())/selectedPoints())/(selectedPoints()-1) : 0.;
  }

  /**
   * Return the variance of absolute weights.
   */
  double absWeightVariance() const {
    return 
      selectedPoints() > 1 ? 
      abs(sumSquaredWeights() - sqr(sumAbsWeights())/selectedPoints())/(selectedPoints()-1) : 0.;
  }

  /**
   * Return the variance of the average weight.
   */
  virtual double averageWeightVariance() const {
    return selectedPoints() > 1 ? weightVariance()/selectedPoints() : 0.;
  }

  /**
   * Return the variance of the average absolute weight.
   */
  virtual double averageAbsWeightVariance() const {
    return selectedPoints() > 1 ? absWeightVariance()/selectedPoints() : 0;
  }

  /**
   * Select an event
   */
  virtual void select(double weight, bool doIntegral = true) {
    if ( isnan(weight) || isinf(weight) ) {
      theLastWeight = weight;
      theNanPoints += 1;
      theAllPoints += 1;
      return;
    }
    theLastWeight = weight;
    theMaxWeight = max(theMaxWeight,abs(weight));
    theMinWeight = min(theMinWeight,abs(weight));
    if ( !doIntegral )
      return;
    theSumWeights += weight;
    theSumSquaredWeights += sqr(weight);
    theSumAbsWeights += abs(weight);
    theSelectedPoints += 1;
    theAllPoints += 1;
  }

  /**
   * Accept an event.
   */
  virtual void accept() {
    theAcceptedPoints += 1;
  }

  /**
   * Reject an event.
   */
  virtual void reject() {
    if ( isnan(lastWeight()) || isinf(lastWeight()) ) {
      theNanPoints -= 1;
      theAllPoints -= 1;
      return;
    }
    theSumWeights -= lastWeight();
    theSumSquaredWeights -= sqr(lastWeight());
    theSumAbsWeights -= abs(lastWeight());
    theSelectedPoints -= 1;
    theAcceptedPoints -= 1;
    theAllPoints -= 1;
  }

public:

  /** @name Functions used by the persistent I/O system. */
  //@{
  /**
   * Function used to write out object persistently.
   * @param os the persistent output stream written to.
   */
  void put(PersistentOStream & os) const;

  /**
   * Function used to read in object persistently.
   * @param is the persistent input stream read from.
   * @param version the version number of the object when written.
   */
  void get(PersistentIStream & is);
  //@}

private:

  /**
   * A weight by which events entering this statistics have been
   * biased.
   */
  double theBias;

  /**
   * The maximum weight encountered.
   */
  double theMaxWeight;

  /**
   * The minimum weight encountered.
   */
  double theMinWeight;

  /**
   * The sum of weights.
   */
  double theSumWeights;

  /**
   * The sum of weights squared.
   */
  double theSumSquaredWeights;

  /**
   * The sum of absolute values of weights
   */
  double theSumAbsWeights;

  /**
   * The number of selected points
   */
  unsigned long theSelectedPoints;

  /**
   * The number of accepted points
   */
  unsigned long theAcceptedPoints;

  /**
   * The number of points where an nan or inf weight was encountered.
   */
  unsigned long theNanPoints;

  /**
   * The number of all points.
   */
  unsigned long theAllPoints;

  /**
   * The last weight encountered
   */
  double theLastWeight;

};

inline PersistentOStream& operator<<(PersistentOStream& os, const GeneralStatistics& s) {
  s.put(os); return os;
}

inline PersistentIStream& operator>>(PersistentIStream& is, GeneralStatistics& s) {
  s.get(is); return is;
}

}

#endif /* Herwig_GeneralStatistics_H */