class Gambit::ColliderBit::MC_convergence_checker
Helper class for testing for convergence of analyses.
#include <MC_convergence.hpp>
Public Functions
Name | |
---|---|
MC_convergence_checker() Constructor. | |
~MC_convergence_checker() Destructor. | |
void | init(const convergence_settings & settings) Initialise (or re-initialise) the object. |
void | set_settings(const convergence_settings & settings) Provide a pointer to the convergence settings. |
void | clear() Clear all convergence data (for all threads) |
void | update(const AnalysisContainer & ac) Update the convergence data. This is the only routine meant to be called in parallel. |
bool | achieved(const AnalysisContainer & ac) Check if convergence has been achieved across threads, and across all instances of this class. |
Public Functions Documentation
function MC_convergence_checker
MC_convergence_checker()
Constructor.
function ~MC_convergence_checker
~MC_convergence_checker()
Destructor.
Deconstructor.
function init
void init(
const convergence_settings & settings
)
Initialise (or re-initialise) the object.
function set_settings
void set_settings(
const convergence_settings & settings
)
Provide a pointer to the convergence settings.
function clear
void clear()
Clear all convergence data (for all threads)
function update
void update(
const AnalysisContainer & ac
)
Update the convergence data. This is the only routine meant to be called in parallel.
function achieved
bool achieved(
const AnalysisContainer & ac
)
Check if convergence has been achieved across threads, and across all instances of this class.
Updated on 2024-07-18 at 13:53:31 +0000