#include <G4StatDouble.hh>

Public Member Functions
	G4StatDouble ()

	G4StatDouble (G4double)

virtual	~G4StatDouble ()

G4StatDouble &	operator= (const G4double &rhs)

G4StatDouble &	operator= (const G4StatDouble &rhs)

G4StatDouble &	operator+= (const G4double &rhs)

G4StatDouble &	operator+= (const G4StatDouble &rhs)

void	reset ()

void	fill (G4double x, G4double weight=1.)

void	scale (G4double)

G4double	mean () const

G4double	rms ()

G4double	mean (G4double ext_sum_w) const

G4double	rms (G4double ext_sum_w, G4int ext_n)

void	add (const G4StatDouble *)

G4int	n () const

G4double	sum_w () const

G4double	sum_w2 () const

G4double	sum_wx () const

G4double	sum_wx2 () const

Protected Member Functions
G4double	rms (G4double sum_wx, G4double sum_wx2, G4double sum_w, G4int n)

Protected Attributes
G4double	m_sum_wx

G4double	m_sum_wx2

G4int	m_n

G4double	m_sum_w

G4double	m_sum_w2

G4double	m_scale

Detailed Description

Definition at line 45 of file G4StatDouble.hh.

Constructor & Destructor Documentation

G4StatDouble::G4StatDouble ( )

Definition at line 39 of file G4StatDouble.cc.

 {
   reset();
 }

Here is the call graph for this function:

G4StatDouble::G4StatDouble ( G4double x )

Definition at line 44 of file G4StatDouble.cc.

 {
   reset();
   fill(x);
 }

Here is the call graph for this function:

G4StatDouble::~G4StatDouble ( )

virtual

Definition at line 60 of file G4StatDouble.cc.

61 {}

Member Function Documentation

void G4StatDouble::add ( const G4StatDouble * ptr )

Definition at line 167 of file G4StatDouble.cc.

 {
   m_n       += ptr->n();
   m_sum_w   += ptr->sum_w();
   m_sum_w2  += ptr->sum_w2();
   m_sum_wx  += ptr->sum_wx();
   m_sum_wx2 += ptr->sum_wx2();
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void G4StatDouble::fill	(	G4double	x,
		G4double	weight = `1.`
	)

Definition at line 63 of file G4StatDouble.cc.

 {
   m_sum_wx  += value * weight;
   m_sum_wx2 += value * value * weight;
   if(m_n < INT_MAX) { ++m_n; }
   m_sum_w   += weight;
   m_sum_w2  += weight * weight;
 
   if (weight <= 0.)
   {
     G4cout << "[G4StatDouble::fill] WARNING: weight<=0. "
            << weight << G4endl;
   }
 }

Here is the caller graph for this function:

G4double G4StatDouble::mean ( ) const

Definition at line 83 of file G4StatDouble.cc.

 {
   G4double mean_val = 0.;
   if (m_sum_w > 0.)
   {
     mean_val = m_sum_wx / m_sum_w;
   }
   return m_scale * mean_val;
 }

Here is the caller graph for this function:

G4double G4StatDouble::mean ( G4double ext_sum_w ) const

Definition at line 93 of file G4StatDouble.cc.

 {
   G4double factor = 0.;
     // factor to rescale the Mean for the requested number
     // of events (or sum of weights) ext_sum_w
 
   if (ext_sum_w > 0)
   {
     factor  = m_sum_w;
     factor /= ext_sum_w;
   }
   return mean() * factor;
 
 }

Here is the call graph for this function:

G4int G4StatDouble::n ( ) const

inline

Definition at line 95 of file G4StatDouble.hh.

95 { return m_n; }

G4StatDouble::m_n

G4int m_n

Definition: G4StatDouble.hh:109

Here is the caller graph for this function:

G4StatDouble& G4StatDouble::operator+= ( const G4double & rhs )

inline

Definition at line 70 of file G4StatDouble.hh.

71 { fill(rhs); return *this; }

G4StatDouble::fill

void fill(G4double x, G4double weight=1.)

Definition: G4StatDouble.cc:63

Here is the call graph for this function:

G4StatDouble& G4StatDouble::operator+= ( const G4StatDouble & rhs )

inline

Definition at line 72 of file G4StatDouble.hh.

73 { add(&rhs); return *this; }

G4StatDouble::add

void add(const G4StatDouble *)

Definition: G4StatDouble.cc:167

Here is the call graph for this function:

G4StatDouble& G4StatDouble::operator= ( const G4double & rhs )

inline

Definition at line 54 of file G4StatDouble.hh.

     {
       reset();
       fill(rhs);
       return *this;
     }

Here is the call graph for this function:

G4StatDouble& G4StatDouble::operator= ( const G4StatDouble & rhs )

inline

Definition at line 60 of file G4StatDouble.hh.

     {
       m_sum_wx = rhs.m_sum_wx;
       m_sum_wx2 = rhs.m_sum_wx2;
       m_n = rhs.m_n;
       m_sum_w = rhs.m_sum_w;
       m_sum_w2 = rhs.m_sum_w2;
       m_scale = rhs.m_scale;
       return *this;
     }

void G4StatDouble::reset ( )

Definition at line 50 of file G4StatDouble.cc.

 {
   m_sum_wx  = 0.;
   m_sum_wx2 = 0.;
   m_n       = 0;
   m_sum_w   = 0.;
   m_sum_w2  = 0.;
   m_scale   = 1.;
 }

Here is the caller graph for this function:

G4double G4StatDouble::rms ( )

Definition at line 146 of file G4StatDouble.cc.

 {
   // this method computes the RMS with "all internal" parameters:
   // all the sums are the internal ones: m_sum_wx, m_sum_wx2, m_sum_w, m_n
 
   return rms(m_sum_wx, m_sum_wx2, m_sum_w, m_n);
 }

Here is the caller graph for this function:

G4double G4StatDouble::rms	(	G4double	ext_sum_w,
		G4int	ext_n
	)

Definition at line 154 of file G4StatDouble.cc.

 {
   // this method computes the RMS with sum_w and n coming from outside:
   // ext_sum_w and ext_n:
   // this means that the result is normalised to the external events
   // it is useful when, given a number ext_n of events with sum of the weights
   // ext_sum_w, only m_n (with sum of weights m_sum_w) are actually accumulated
   // in the internal summation (e.g. for a dose variable in a volume, because
   // only a few particles reach that volume) 
 
   return rms(m_sum_wx, m_sum_wx2, ext_sum_w, ext_n);
 }

Here is the call graph for this function:

G4double G4StatDouble::rms	(	G4double	sum_wx,
		G4double	sum_wx2,
		G4double	sum_w,
		G4int	n
	)

protected

Definition at line 108 of file G4StatDouble.cc.

 {
   G4double vrms = 0.0;
   if (nn > 1)
   {
     G4double vmean = ssum_wx / ssum_w;
     G4double xn = nn;
     G4double tmp = 
       // from GNU Scientific Library. This part is equivalent to N/(N-1)
       // when w_i = w
       // ((m_sum_w * m_sum_w) / (m_sum_w * m_sum_w - m_sum_w2)) 
 
       // from NIST "DATAPLOT Reference manual", Page 2-66 
       // http://www.itl.nist.gov/div898/software/dataplot/refman2/ch2/weightsd.pdf
       // rewritten based on: SUM[w(x-m)^2]/SUM[w] = SUM[wx^2]/SUM[w] - m^2
       // and dividing it by sqrt[n] to go from rms of distribution to the
       // rms of the mean value
 
       (xn / (xn - 1))
       * ((ssum_wx2 / ssum_w) - (vmean * vmean));
 
     tmp = std::max(tmp, 0.0); // this avoids observed computation problem
     vrms = std::sqrt( tmp );
 //  G4cout << "[G4StatDoubleElement::rms] m_sum_wx: " << m_sum_wx
 //         << "  m_sum_wx2: " << m_sum_wx2 << "  m_sum_w: " << m_sum_w
 //         << "  m_n: " << m_n << "  tmp: " << tmp<< "  rms: " << rms
 //         << G4endl;
 //  G4cout << "[G4StatDoubleElement::rms] (m_n / (m_n - 1)): " << (xn/(xn - 1))
 //     << "  (m_sum_wx2 / m_sum_w): " << (m_sum_wx2 / m_sum_w) 
 //     << "  (mean * mean): " << (mean * mean) 
 //     << "  ((m_sum_wx2 / m_sum_w) - (mean * mean)): "
 //         << ((m_sum_wx2 / m_sum_w) - (mean * mean)) 
 //     << G4endl;
   }
   return vrms * m_scale;
 }