Skip to content

inverse

inverse #

A regularized 1/(d+ε) inverse distance energy function.

inverse(max_energy=10 ** 6) #

Create a regularized inverse energy function.

Uses energy(d) = 1/(d + ε) where ε = 1/max_energy to avoid division by zero. It maps a numpy array of distances to an array of energies elementwise.

Parameters:

Name Type Description Default
max_energy float

Maximum energy value (returned when distance ≈ 0). Default is 10^6.

10 ** 6

Returns:

Type Description
EnergyFunction

A function distances -> energies for use with select_sessions.

Source code in capturegraph-recipes/capturegraph_recipes/scheduling/energy/inverse.py
def inverse(max_energy: float = 10**6) -> EnergyFunction:
    """Create a regularized inverse energy function.

    Uses `energy(d) = 1/(d + ε)` where ε = 1/max_energy to avoid division by zero.
    It maps a numpy array of distances to an array of energies elementwise.

    Args:
        max_energy: Maximum energy value (returned when distance ≈ 0).
            Default is 10^6.

    Returns:
        A function `distances -> energies` for use with `select_sessions`.
    """
    epsilon = 1.0 / max_energy

    def energy(distances: np.ndarray) -> np.ndarray:
        return 1.0 / (distances + epsilon)

    return energy