Function plot_demands

pyvrp/plotting/plot_demands.py:7–57

Plots demands for clients, as vertical bars sorted by demand. Parameters ---------- data Data instance. dimension Load dimension to plot. Defaults to the first dimension. title Title to add to the plot. ax Axes object to draw the plot on.

(
    data: ProblemData,
    dimension: int = 0,
    title: str | None = None,
    ax: plt.Axes | None = None,
)

def plot_demands(
    data: ProblemData,
    dimension: int = 0,
    title: str | None = None,
    ax: plt.Axes | None = None,
):
    """
    Plots demands for clients, as vertical bars sorted by demand.

    Parameters
    ----------
    data
        Data instance.
    dimension
        Load dimension to plot. Defaults to the first dimension.
    title
        Title to add to the plot.
    ax
        Axes object to draw the plot on. One will be created if not provided.

    Raises
    ------
    ValueError
        When the load dimension is out of bounds for the given data instance.
    """
    if dimension >= data.num_load_dimensions:
        raise ValueError(f"Load dimension '{dimension}' is not understood.")

    if not ax:
        _, ax = plt.subplots()

    clients = data.clients()
    demand = np.array([client.delivery[dimension] for client in clients])
    demand = np.sort(demand)

    ax.bar(np.arange(data.num_depots, data.num_locations), demand)

    if title is None:
        veh_types = data.vehicle_types()
        weights = [veh_type.num_available for veh_type in veh_types]
        capacities = [veh_type.capacity[dimension] for veh_type in veh_types]
        mean_capacity = np.average(capacities, weights=weights)

        title = (
            f"Demands (avg. cap = {mean_capacity:.2f}, "
            f"{mean_capacity / demand.mean():.2f} stops/route)"
        )

    ax.set_title(title)
    ax.set_xlabel("Client (sorted by demand)")
    ax.set_ylabel("Demand")