Class Profile

pyvrp/Model.py:64–97

Stores a routing profile. A routing profile is a collection of edges with distance and duration attributes that together define a complete distance and duration matrix. These can be used to model, for example, the road uses of different types of vehicles, like trucks, cars, or

class Profile:
    """
    Stores a routing profile.

    A routing profile is a collection of edges with distance and duration
    attributes that together define a complete distance and duration matrix.
    These can be used to model, for example, the road uses of different types
    of vehicles, like trucks, cars, or bicyclists. Each
    :class:`~pyvrp._pyvrp.VehicleType` is associated with a routing profile.
    """

    edges: list[Edge]
    name: str

    def __init__(self, *, name: str = ""):
        self.edges = []
        self.name = name

    def add_edge(
        self,
        frm: Client | Depot,
        to: Client | Depot,
        distance: int,
        duration: int = 0,
    ) -> Edge:
        """
        Adds a new edge to this routing profile.
        """
        edge = Edge(frm, to, distance, duration)
        self.edges.append(edge)
        return edge

    def __str__(self) -> str:
        return self.name


class Model: