G4StatDouble Class Reference

#include <G4StatDouble.hh>

Public Member Functions
void	add (const G4StatDouble *)
void	fill (G4double x, G4double weight=1.)
	G4StatDouble ()
	G4StatDouble (const G4StatDouble &)=default
	G4StatDouble (G4double)
G4double	mean () const
G4double	mean (G4double ext_sum_w) const
G4int	n () const
G4StatDouble &	operator+= (const G4double &rhs)
G4StatDouble &	operator+= (const G4StatDouble &rhs)
G4StatDouble &	operator= (const G4double &rhs)
G4StatDouble &	operator= (const G4StatDouble &rhs)
void	reset ()
G4double	rms ()
G4double	rms (G4double ext_sum_w, G4int ext_n)
void	scale (G4double)
G4double	sum_w () const
G4double	sum_w2 () const
G4double	sum_wx () const
G4double	sum_wx2 () const
virtual	~G4StatDouble ()

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

Protected Attributes
G4int	m_n = 0
G4double	m_scale = 0.0
G4double	m_sum_w = 0.0
G4double	m_sum_w2 = 0.0
G4double	m_sum_wx = 0.0
G4double	m_sum_wx2 = 0.0

Detailed Description

Definition at line 40 of file G4StatDouble.hh.

Constructor & Destructor Documentation

G4StatDouble() [1/3]

G4StatDouble::G4StatDouble

(

)

Definition at line 33 of file G4StatDouble.cc.

{ reset(); }

References reset().

G4StatDouble() [2/3]

G4StatDouble::G4StatDouble

(

G4double

x

)

Definition at line 35 of file G4StatDouble.cc.

{ fill(x); }

References fill().

~G4StatDouble()

G4StatDouble::~G4StatDouble ( )

virtual

Definition at line 47 of file G4StatDouble.cc.

{}

G4StatDouble() [3/3]

G4StatDouble::G4StatDouble ( const G4StatDouble &  )

default

Member Function Documentation

add()

void G4StatDouble::add

(

const G4StatDouble *

ptr

)

Definition at line 151 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();
}

References m_n, m_sum_w, m_sum_w2, m_sum_wx, m_sum_wx2, n(), sum_w(), sum_w2(), sum_wx(), and sum_wx2().

Referenced by operator+=().

fill()

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

Definition at line 49 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;
  }
}

References G4cout, G4endl, INT_MAX, m_n, m_sum_w, m_sum_w2, m_sum_wx, and m_sum_wx2.

Referenced by G4StatDouble(), operator+=(), and operator=().

mean() [1/2]

G4double G4StatDouble::mean

(

)

const

Definition at line 68 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;
}

References m_scale, m_sum_w, and m_sum_wx.

Referenced by mean().

mean() [2/2]

G4double G4StatDouble::mean

(

G4double

ext_sum_w

)

const

Definition at line 78 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;
}

References m_sum_w, and mean().

n()

G4int G4StatDouble::n ( ) const

inline

Definition at line 94 of file G4StatDouble.hh.

{ return m_n; }

References m_n.

Referenced by add().

operator+=() [1/2]

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

inline

Definition at line 65 of file G4StatDouble.hh.

  {
    fill(rhs);
    return *this;
  }

References fill().

operator+=() [2/2]

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

inline

Definition at line 70 of file G4StatDouble.hh.

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

References add().

operator=() [1/2]

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

inline

Definition at line 49 of file G4StatDouble.hh.

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

References fill(), and reset().

operator=() [2/2]

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

inline

Definition at line 55 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;
  }

References m_n, m_scale, m_sum_w, m_sum_w2, m_sum_wx, and m_sum_wx2.

reset()

void G4StatDouble::reset

(

)

Definition at line 37 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.;
}

References m_n, m_scale, m_sum_w, m_sum_w2, m_sum_wx, and m_sum_wx2.

Referenced by G4StatDouble(), and operator=().

rms() [1/3]

G4double G4StatDouble::rms

(

)

Definition at line 130 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);
}

References m_n, m_sum_w, m_sum_wx, m_sum_wx2, and rms().

Referenced by rms().

rms() [2/3]

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

Definition at line 138 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);
}

References m_sum_wx, m_sum_wx2, and rms().

rms() [3/3]

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

protected

Definition at line 92 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;
}

References m_scale, G4INCL::Math::max(), and G4InuclParticleNames::nn.

scale()

void G4StatDouble::scale

(

G4double

value

)

Definition at line 66 of file G4StatDouble.cc.

{ m_scale = m_scale * value; }

References m_scale.

sum_w()

G4double G4StatDouble::sum_w ( ) const

inline

Definition at line 95 of file G4StatDouble.hh.

{ return m_sum_w; }

References m_sum_w.

Referenced by add().

sum_w2()

G4double G4StatDouble::sum_w2 ( ) const

inline

Definition at line 96 of file G4StatDouble.hh.

{ return m_sum_w2; }

References m_sum_w2.

Referenced by add().

sum_wx()

G4double G4StatDouble::sum_wx ( ) const

inline

Definition at line 97 of file G4StatDouble.hh.

{ return m_sum_wx; }

References m_sum_wx.

Referenced by add().

sum_wx2()

G4double G4StatDouble::sum_wx2 ( ) const

inline

Definition at line 98 of file G4StatDouble.hh.

{ return m_sum_wx2; }

References m_sum_wx2.

Referenced by add().

Field Documentation

m_n

G4int G4StatDouble::m_n = 0

protected

Definition at line 106 of file G4StatDouble.hh.

Referenced by add(), fill(), n(), operator=(), reset(), and rms().

m_scale

G4double G4StatDouble::m_scale = 0.0

protected

Definition at line 109 of file G4StatDouble.hh.

Referenced by mean(), operator=(), reset(), rms(), and scale().

m_sum_w

G4double G4StatDouble::m_sum_w = 0.0

protected

Definition at line 107 of file G4StatDouble.hh.

Referenced by add(), fill(), mean(), operator=(), reset(), rms(), and sum_w().

m_sum_w2

G4double G4StatDouble::m_sum_w2 = 0.0

protected

Definition at line 108 of file G4StatDouble.hh.

Referenced by add(), fill(), operator=(), reset(), and sum_w2().

m_sum_wx

G4double G4StatDouble::m_sum_wx = 0.0

protected

Definition at line 104 of file G4StatDouble.hh.

Referenced by add(), fill(), mean(), operator=(), reset(), rms(), and sum_wx().

m_sum_wx2

G4double G4StatDouble::m_sum_wx2 = 0.0

protected

Definition at line 105 of file G4StatDouble.hh.

Referenced by add(), fill(), operator=(), reset(), rms(), and sum_wx2().

---

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

• source/global/HEPNumerics/include/G4StatDouble.hh
• source/global/HEPNumerics/src/G4StatDouble.cc