optim_results.stabilization_it

optim_results.stabilization_it(parts=None, nit=None, threshold=None)[source]

Estimate the last iteration at which selected particles were not yet stabilized.

Parameters:

parts (int | iterable | None, optional) – Particle identifier, iterable of identifiers, or None for the whole swarm.
nit (int | None, optional) – Number of iterations to inspect.
threshold (float | None, optional) – Stabilization threshold. If omitted, derive it from particle 1 velocity history.

Returns:

Stabilization iteration index or indices.

Return type:

int | np.ndarray | None