any_maximum_met#

libcasm.monte.sampling.any_maximum_met(
cutoff_params: CutoffCheckParams,
count: int | None,
time: float | None,
n_samples: int,
clocktime: float,
) → bool#

Check if any cutoff check maximum has been met

Parameters:

  • cutoff_params (CutoffCheckParams) – Cutoff check parameters

  • count (Optional[int]) – Number of steps or passes

  • time (Optional[float]) – Simulated time

  • n_samples (int) – Number of samples taken

  • clocktime (float) – Elapsed clock time.

Returns:

result – If any cutoff check maximum has been met, return True, else False.

Return type:

bool