G4ConvergenceTester Class Reference

#include <G4ConvergenceTester.hh>

Public Member Functions
	G4ConvergenceTester (const G4String &theName="NONAME")
	~G4ConvergenceTester ()
	G4ConvergenceTester (G4double)
void	AddScore (G4double)
G4ConvergenceTester &	operator+= (G4double val)
void	ShowHistory (std::ostream &out=G4cout)
void	ShowResult (std::ostream &out=G4cout)
G4double	GetValueOfMinimizingFunction (std::vector< G4double > x)
void	ComputeStatistics ()
G4double	GetMean ()
G4double	GetStandardDeviation ()
G4double	GetVariance ()
G4double	GetR ()
G4double	GetEfficiency ()
G4double	GetR2eff ()
G4double	GetR2int ()
G4double	GetShift ()
G4double	GetVOV ()
G4double	GetFOM ()

Detailed Description

Definition at line 54 of file G4ConvergenceTester.hh.

Constructor & Destructor Documentation

G4ConvergenceTester() [1/2]

G4ConvergenceTester::G4ConvergenceTester

(

const G4String &

theName = "NONAME"

)

Definition at line 40 of file G4ConvergenceTester.cc.

  : name(theName)
{
  nonzero_histories.clear();
  largest_scores.clear();
  largest_scores.push_back(0.0);
 
  history_grid.resize(noBinOfHistory, 0);
  mean_history.resize(noBinOfHistory, 0.0);
  var_history.resize(noBinOfHistory, 0.0);
  sd_history.resize(noBinOfHistory, 0.0);
  r_history.resize(noBinOfHistory, 0.0);
  vov_history.resize(noBinOfHistory, 0.0);
  fom_history.resize(noBinOfHistory, 0.0);
  shift_history.resize(noBinOfHistory, 0.0);
  e_history.resize(noBinOfHistory, 0.0);
  r2eff_history.resize(noBinOfHistory, 0.0);
  r2int_history.resize(noBinOfHistory, 0.0);
 
  timer = new G4Timer();
  timer->Start();
  cpu_time.clear();
  cpu_time.push_back(0.0);
}

~G4ConvergenceTester()

G4ConvergenceTester::~G4ConvergenceTester

(

)

Definition at line 65 of file G4ConvergenceTester.cc.

{
  delete timer;
}

G4ConvergenceTester() [2/2]

G4ConvergenceTester::G4ConvergenceTester

(

G4double

)

Member Function Documentation

AddScore()

void G4ConvergenceTester::AddScore

(

G4double

x

)

Definition at line 70 of file G4ConvergenceTester.cc.

{
  G4AutoLock l(&aMutex);
 
  timer->Stop();
  cpu_time.push_back(timer->GetSystemElapsed() + timer->GetUserElapsed());
 
  if(x < 0.0)
  {
    std::ostringstream message;
    message << "Expecting zero or positive number as inputs,\n"
            << "but received a negative number.";
    G4Exception("G4ConvergenceTester::AddScore()", "Warning",
                JustWarning, message);
  }
 
  if(x == 0.0)
  {
  }
  else
  {
    nonzero_histories.insert(std::pair<G4int, G4double>(n, x));
    if(x > largest_scores.back())
    {
      // Following search should become faster if begin from bottom.
      for(auto it = largest_scores.begin(); it != largest_scores.end(); ++it)
      {
        if(x > *it)
        {
          largest_scores.insert(it, x);
          break;
        }
      }
 
      if(largest_scores.size() > 201)
      {
        largest_scores.pop_back();
      }
    }
    sum += x;
  }
 
  // Data has been added so statistics have now been updated to new values
  statsAreUpdated = false;
  ++n;
  l.unlock();
  return;
}

Referenced by operator+=().

ComputeStatistics()

void G4ConvergenceTester::ComputeStatistics ( )

inline

Definition at line 79 of file G4ConvergenceTester.hh.

{ calStat(); }

GetEfficiency()

G4double G4ConvergenceTester::GetEfficiency ( )

inline

Definition at line 88 of file G4ConvergenceTester.hh.

{ CheckIsUpdated(); return efficiency; }

GetFOM()

G4double G4ConvergenceTester::GetFOM ( )

inline

Definition at line 93 of file G4ConvergenceTester.hh.

{ CheckIsUpdated(); return fom; }

GetMean()

G4double G4ConvergenceTester::GetMean ( )

inline

Definition at line 84 of file G4ConvergenceTester.hh.

{ CheckIsUpdated(); return mean; }

GetR()

G4double G4ConvergenceTester::GetR ( )

inline

Definition at line 87 of file G4ConvergenceTester.hh.

{ CheckIsUpdated(); return r; }

GetR2eff()

G4double G4ConvergenceTester::GetR2eff ( )

inline

Definition at line 89 of file G4ConvergenceTester.hh.

{ CheckIsUpdated(); return r2eff; }

GetR2int()

G4double G4ConvergenceTester::GetR2int ( )

inline

Definition at line 90 of file G4ConvergenceTester.hh.

{ CheckIsUpdated(); return r2int; }

GetShift()

G4double G4ConvergenceTester::GetShift ( )

inline

Definition at line 91 of file G4ConvergenceTester.hh.

{ CheckIsUpdated(); return shift; }

GetStandardDeviation()

G4double G4ConvergenceTester::GetStandardDeviation ( )

inline

Definition at line 85 of file G4ConvergenceTester.hh.

{ CheckIsUpdated(); return sd; }

GetValueOfMinimizingFunction()

G4double G4ConvergenceTester::GetValueOfMinimizingFunction ( std::vector< G4double >  x )

inline

Definition at line 74 of file G4ConvergenceTester.hh.

    {
      return slope_fitting_function(x);
    }

GetVariance()

G4double G4ConvergenceTester::GetVariance ( )

inline

Definition at line 86 of file G4ConvergenceTester.hh.

{ CheckIsUpdated(); return var; }

GetVOV()

G4double G4ConvergenceTester::GetVOV ( )

inline

Definition at line 92 of file G4ConvergenceTester.hh.

{ CheckIsUpdated(); return vov; }

operator+=()

G4ConvergenceTester & G4ConvergenceTester::operator+= ( G4double  val )

inline

Definition at line 64 of file G4ConvergenceTester.hh.

    {
      this->AddScore(val);
      return *this;
    }

ShowHistory()

void G4ConvergenceTester::ShowHistory

(

std::ostream &

out = G4cout

)

Definition at line 471 of file G4ConvergenceTester.cc.

{
  if(!showHistory)
  {
    out << "Number of events of this run is too small to show history."
        << G4endl;
    return;
  }
 
  out << std::setprecision(6);
 
  out << G4endl;
  out << "G4ConvergenceTester Output History of " << name << G4endl;
  out << "i/" << noBinOfHistory << " till_ith      mean" << std::setw(13)
      << "var" << std::setw(13) << "sd" << std::setw(13) << "r" << std::setw(13)
      << "vov" << std::setw(13) << "fom" << std::setw(13) << "shift"
      << std::setw(13) << "e" << std::setw(13) << "r2eff" << std::setw(13)
      << "r2int" << G4endl;
  for(G4int i = 1; i <= noBinOfHistory; i++)
  {
    out << std::setw(4) << i << " " << std::setw(5) << history_grid[i - 1]
        << std::setw(13) << mean_history[i - 1] << std::setw(13)
        << var_history[i - 1] << std::setw(13) << sd_history[i - 1]
        << std::setw(13) << r_history[i - 1] << std::setw(13)
        << vov_history[i - 1] << std::setw(13) << fom_history[i - 1]
        << std::setw(13) << shift_history[i - 1] << std::setw(13)
        << e_history[i - 1] << std::setw(13) << r2eff_history[i - 1]
        << std::setw(13) << r2int_history[i - 1] << G4endl;
  }
}

ShowResult()

void G4ConvergenceTester::ShowResult

(

std::ostream &

out = G4cout

)

Definition at line 363 of file G4ConvergenceTester.cc.

{
  // if data has been added since the last computation of the statistical values
  // (not statsAreUpdated) call calStat to recompute the statistical values
  if(!statsAreUpdated)
  {
    calStat();
  }
 
  out << std::setprecision(6);
 
  out << G4endl;
  out << "G4ConvergenceTester Output Result of " << name << G4endl;
  out << std::setw(20) << "EFFICIENCY = " << std::setw(13) << efficiency
      << G4endl;
  out << std::setw(20) << "MEAN = " << std::setw(13) << mean << G4endl;
  out << std::setw(20) << "VAR = " << std::setw(13) << var << G4endl;
  out << std::setw(20) << "SD = " << std::setw(13) << sd << G4endl;
  out << std::setw(20) << "R = " << std::setw(13) << r << G4endl;
  out << std::setw(20) << "SHIFT = " << std::setw(13) << shift << G4endl;
  out << std::setw(20) << "VOV = " << std::setw(13) << vov << G4endl;
  out << std::setw(20) << "FOM = " << std::setw(13) << fom << G4endl;
 
  out << std::setw(20) << "THE LARGEST SCORE = " << std::setw(13) << largest
      << " and it happened at " << largest_score_happened << "th event"
      << G4endl;
  if(mean != 0)
  {
    out << std::setw(20) << "Affected Mean = " << std::setw(13) << mean_1
        << " and its ratio to original is " << mean_1 / mean << G4endl;
  }
  else
  {
    out << std::setw(20) << "Affected Mean = " << std::setw(13) << mean_1
        << G4endl;
  }
  if(var != 0)
  {
    out << std::setw(20) << "Affected VAR = " << std::setw(13) << var_1
        << " and its ratio to original is " << var_1 / var << G4endl;
  }
  else
  {
    out << std::setw(20) << "Affected VAR = " << std::setw(13) << var_1
        << G4endl;
  }
  if(r != 0)
  {
    out << std::setw(20) << "Affected R = " << std::setw(13) << r_1
        << " and its ratio to original is " << r_1 / r << G4endl;
  }
  else
  {
    out << std::setw(20) << "Affected R = " << std::setw(13) << r_1 << G4endl;
  }
  if(shift != 0)
  {
    out << std::setw(20) << "Affected SHIFT = " << std::setw(13) << shift_1
        << " and its ratio to original is " << shift_1 / shift << G4endl;
  }
  else
  {
    out << std::setw(20) << "Affected SHIFT = " << std::setw(13) << shift_1
        << G4endl;
  }
  if(fom != 0)
  {
    out << std::setw(20) << "Affected FOM = " << std::setw(13) << fom_1
        << " and its ratio to original is " << fom_1 / fom << G4endl;
  }
  else
  {
    out << std::setw(20) << "Affected FOM = " << std::setw(13) << fom_1
        << G4endl;
  }
 
  if(!showHistory)
  {
    out << "Number of events of this run is too small to do convergence tests."
        << G4endl;
    return;
  }
 
  check_stat_history(out);
 
  // check SLOPE and output result
  if(calcSLOPE)
  {
    if(slope >= 3)
    {
      noPass++;
      out << "SLOPE is large enough" << G4endl;
    }
    else
    {
      out << "SLOPE is not large enough" << G4endl;
    }
  }
  else
  {
    out << "Number of non zero history too small to calculate SLOPE" << G4endl;
  }
 
  out << "This result passes " << noPass << " / " << noTotal
      << " Convergence Test." << G4endl;
  out << G4endl;
}

---

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

• G4ConvergenceTester.hh
• G4ConvergenceTester.cc