pypomp.core.rw_sigma.RWSigma.hyperbolic_cooling

RWSigma.hyperbolic_cooling(s: float) → RWSigma

Configure the RWSigma instance to use hyperbolic cooling.

The returned cooling function computes a cooling factor as:

cooling_factor = 1.0 / (1.0 + s * (nt / ntimes + m))

where:

nt: Time step index (integer). m: Current iteration index (integer). ntimes: Total number of time steps (integer).

Parameters:

s (float) – The hyperbolic cooling parameter/rate. Must be non-negative.

Returns:

A new RWSigma instance configured with hyperbolic cooling.

Return type:

RWSigma