Method add_client

pyvrp/Model.py:208–267

Adds a client with the given attributes to the model. Returns the created :class:`~pyvrp._pyvrp.Client` instance. Raises ------ ValueError When ``group`` is not ``None``, and the given ``group`` is not part of this model instance, or

(
        self,
        x: float,
        y: float,
        delivery: int | list[int] = [],
        pickup: int | list[int] = [],
        service_duration: int = 0,
        tw_early: int = 0,
        tw_late: int = np.iinfo(np.int64).max,
        release_time: int = 0,
        prize: int = 0,
        required: bool = True,
        group: ClientGroup | None = None,
        *,
        name: str = "",
    )

        return self

    def add_client(
        self,
        x: float,
        y: float,
        delivery: int | list[int] = [],
        pickup: int | list[int] = [],
        service_duration: int = 0,
        tw_early: int = 0,
        tw_late: int = np.iinfo(np.int64).max,
        release_time: int = 0,
        prize: int = 0,
        required: bool = True,
        group: ClientGroup | None = None,
        *,
        name: str = "",
    ) -> Client:
        """
        Adds a client with the given attributes to the model. Returns the
        created :class:`~pyvrp._pyvrp.Client` instance.

        Raises
        ------
        ValueError
            When ``group`` is not ``None``, and the given ``group`` is not part
            of this model instance, or when a required client is being added to
            a mutually exclusive client group.
        """
        if group is None:
            group_idx = None
        elif (idx := _idx_by_id(group, self._groups)) is not None:
            group_idx = idx
        else:
            raise ValueError("The given group is not in this model instance.")

        if required and group is not None and group.mutually_exclusive:
            # Required clients cannot be part of a mutually exclusive client
            # group, since then there's nothing to decide about.
            raise ValueError("Required client in mutually exclusive group.")

        client = Client(
            x=x,
            y=y,
            delivery=[delivery] if isinstance(delivery, int) else delivery,
            pickup=[pickup] if isinstance(pickup, int) else pickup,
            service_duration=service_duration,
            tw_early=tw_early,
            tw_late=tw_late,
            release_time=release_time,
            prize=prize,
            required=required,
            group=group_idx,
            name=name,
        )

        if group_idx is not None:
            client_idx = len(self._depots) + len(self._clients)
            self._groups[group_idx].add_client(client_idx)