Function _kl_generator

locust/dispatch.py:26–44

Generator based on Kullback-Leibler divergence For example, given users A, B with weights 5 and 1 respectively, this algorithm will yield AAABAAAAABAA.

(users: Iterable[tuple[T, float]])

def _kl_generator(users: Iterable[tuple[T, float]]) -> Generator[T | None]:
    """Generator based on Kullback-Leibler divergence

    For example, given users A, B with weights 5 and 1 respectively,
    this algorithm will yield AAABAAAAABAA.
    """
    heap = [(x * log2(x / (x + 1.0)), x + 1.0, x, name) for name, x in users if x > 0]
    if not heap:
        while True:
            yield None

    heapify(heap)
    while True:
        _, x, weight, name = heap[0]
        # (divergence diff, number of generated elements + initial weight, initial weight, name) = heap[0]
        yield name
        kl_diff = weight * log2(x / (x + 1.0))
        # calculate how much choosing element i for (x + 1)th time decreases divergence
        heapreplace(heap, (kl_diff, x + 1.0, weight, name))


class UsersDispatcher(Iterator):