herwig is hosted by Hepforge, IPPP Durham
Herwig  7.2.1
exsample::statistics Class Reference

statistics is a helper class for keeping track of event generation statistics. More...

#include <statistics.h>

Public Member Functions

 statistics ()
 default constructor
 
void presampled (double weight)
 update the statistics for a weight encountered during presampling
 
void select (double weight, bool calculate_integral=true)
 indicate that a weight has been selected; optionally preven the weight from entering the caluclation of the integral
 
void accept (double weight)
 indicate that a point has been accepted
 
void reject (double weight)
 reject a prviously accepted event
 
void reset ()
 reset the statistics object
 
std::pair< double, double > current () const
 return the integral's estimate and its uncertainty at the currently accumulated statistics
 
double average_weight () const
 the average weight
 
double average_abs_weight () const
 the average absolute weight
 
double average_weight_variance () const
 the variance of the weight
 
unsigned long iteration_points () const
 the number of points in this iteration
 
unsigned long n_iterations () const
 the number of iterations
 
unsigned long attempted () const
 the total number of attempted in this bin
 
unsigned long accepted () const
 the total number of finally accepted events in this bin
 
unsigned long accepted_negative () const
 the total number of acceptet events with negative weights
 
double sum_weights () const
 the sum of weights
 
double sum_abs_weights () const
 the sum of absolute values of the weights
 
double sum_weights_squared () const
 the sum of weights squared
 
double max_weight () const
 the maximum weight
 
template<class OStream >
void put (OStream &os) const
 put ostream
 
template<class IStream >
void get (IStream &is)
 get from istream
 

Private Attributes

double average_weight_
 the average weight
 
double average_abs_weight_
 the average absolute weight
 
double average_weight_variance_
 the variance of the weight
 
unsigned long iteration_points_
 the number of points in this iteration
 
unsigned long attempted_
 the total number of attempted in this bin
 
unsigned long accepted_
 the total number of finally accepted events in this bin
 
unsigned long accepted_negative_
 the total number of acceptet events with negative weights
 
double sum_weights_
 the sum of weights
 
double sum_abs_weights_
 the sum of absolute values of the weights
 
double sum_weights_squared_
 the sum of weights squared
 
double max_weight_
 the maximum weight
 
unsigned long n_iterations_
 the number of iterations used to calculate the integral
 

Detailed Description

statistics is a helper class for keeping track of event generation statistics.

Definition at line 20 of file statistics.h.


The documentation for this class was generated from the following file: