Class Statistics

pyvrp/Statistics.py:24–188

Statistics about the search progress. Parameters ---------- collect_stats Whether to collect statistics at all. This can be turned off to avoid excessive memory use on long runs.

class Statistics:
    """
    Statistics about the search progress.

    Parameters
    ----------
    collect_stats
        Whether to collect statistics at all. This can be turned off to avoid
        excessive memory use on long runs.
    """

    runtimes: list[float]
    num_iterations: int
    data: list[_Datum]

    def __init__(self, collect_stats: bool = True):
        self.runtimes = []
        self.num_iterations = 0
        self.data = []

        self._clock = perf_counter()
        self._collect_stats = collect_stats

    def __eq__(self, other: object) -> bool:
        return (
            isinstance(other, Statistics)
            and self._collect_stats == other._collect_stats
            and self.runtimes == other.runtimes
            and self.num_iterations == other.num_iterations
            and self.data == other.data
        )

    def __iter__(self) -> Iterator[_Datum]:
        """
        Iterates over the collected data points.
        """
        yield from self.data

    def is_collecting(self) -> bool:
        return self._collect_stats

    def collect(
        self,
        current: Solution,
        candidate: Solution,
        best: Solution,
        cost_evaluator: CostEvaluator,
    ):
        """
        Collect iteration statistics.

        Parameters
        ----------
        current
            The current solution.
        candidate
            The candidate solution.
        best