Class Model

pyvrp/Model.py:100–563

A simple interface for modelling vehicle routing problems with PyVRP.

class Model:
    """
    A simple interface for modelling vehicle routing problems with PyVRP.
    """

    def __init__(self) -> None:
        self._clients: list[Client] = []
        self._depots: list[Depot] = []
        self._edges: list[Edge] = []
        self._groups: list[ClientGroup] = []
        self._profiles: list[Profile] = []
        self._vehicle_types: list[VehicleType] = []

    @property
    def clients(self) -> list[Client]:
        """
        Returns all clients currently in the model.
        """
        return self._clients

    @property
    def depots(self) -> list[Depot]:
        """
        Returns all depots currently in the model.
        """
        return self._depots

    @property
    def locations(self) -> list[Client | Depot]:
        """
        Returns all locations (depots and clients) in the current model. The
        clients in the routes of the solution returned by :meth:`~solve` can be
        used to index these locations.
        """
        return self._depots + self._clients

    @property
    def groups(self) -> list[ClientGroup]:
        """
        Returns all client groups currently in the model.
        """
        return self._groups

    @property
    def profiles(self) -> list[Profile]:
        """
        Returns all routing profiles currently in the model.
        """
        return self._profiles

    @property
    def vehicle_types(self) -> list[VehicleType]:
        """
        Returns the vehicle types in the current model. The routes of the
        solution returned by :meth:`~solve` have a property
        :meth:`~pyvrp._pyvrp.Route.vehicle_type()` that can be used to index
        these vehicle types.
        """