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.
voidinit(const convergence_settings & settings)
Initialise (or re-initialise) the object.
voidset_settings(const convergence_settings & settings)
Provide a pointer to the convergence settings.
voidclear()
Clear all convergence data (for all threads)
voidupdate(const AnalysisContainer & ac)
Update the convergence data. This is the only routine meant to be called in parallel.
boolachieved(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 2023-06-26 at 21:36:52 +0000