Gromacs  2026.0-dev-20251119-5f0a571d
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Functions
gmx::anonymous_namespace{histogramsize.cpp} Namespace Reference

Functions

bool histogramIsEquilibrated (ArrayRef< const PointState > pointStates, const double errorTolerance)
 Checks if the histogram has equilibrated to the target distribution. More...
 

Function Documentation

bool gmx::anonymous_namespace{histogramsize.cpp}::histogramIsEquilibrated ( ArrayRef< const PointState >  pointStates,
const double  errorTolerance 
)

Checks if the histogram has equilibrated to the target distribution.

The histogram is considered equilibrated if, for a minimum fraction of the target region, the relative error of the sampled weight relative to the target is less than a tolerance value.

Parameters
[in]pointStatesThe state of the bias points.
[in]errorToleranceThe histogram needs to be within this tolerance over 80% of the range
Returns
true if the histogram is equilibrated.