Class Solution

pyvrp/cpp/Solution.h:39–277

* Solution(data: ProblemData, routes: list[Route] | list[list[int]]) * * Encodes VRP solutions. * * Parameters * ---------- * data * Data instance. * routes * Route list to use. Can be a list of :class:`~Route` objects, or a lists * of client visits. In case of the latter, all routes are assigned * vehicles of the first type. That need not be a feasible assignment! * *

 *     type have been used, or when a client is visited more than once.
 */
class Solution
{
    using Client = size_t;
    using Depot = size_t;
    using VehicleType = size_t;

    using Routes = std::vector<Route>;
    using Neighbours = std::vector<std::optional<std::pair<Client, Client>>>;

    size_t numClients_ = 0;         // Number of clients in the solution
    size_t numMissingClients_ = 0;  // Number of required but missing clients
    Distance distance_ = 0;         // Total travel distance over all routes
    Cost distanceCost_ = 0;         // Total cost of all routes' travel distance
    Duration duration_ = 0;         // Total duration over all routes
    Duration overtime_ = 0;         // Total overtime over all routes
    Cost durationCost_ = 0;         // Total cost of all routes' duration
    Distance excessDistance_ = 0;   // Total excess distance over all routes
    std::vector<Load> excessLoad_;  // Total excess load over all routes
    Cost fixedVehicleCost_ = 0;     // Fixed cost of all used vehicles
    Cost prizes_ = 0;               // Total collected prize value
    Cost uncollectedPrizes_ = 0;    // Total uncollected prize value
    Duration timeWarp_ = 0;         // Total time warp over all routes
    bool isGroupFeas_ = true;       // Is feasible w.r.t. client groups?

    Routes routes_;
    Neighbours neighbours_;  // client [pred, succ] pairs, null if unassigned

    // Determines the [pred, succ] pairs for assigned clients.
    void makeNeighbours();

    // Evaluates this solution's characteristics.
    void evaluate(ProblemData const &data);

    // These are only available within a solution; from the outside a solution
    // is immutable.
    Solution &operator=(Solution const &other) = default;
    Solution &operator=(Solution &&other) = default;

public:
    // Solution is empty when it has no routes and no clients.
    [[nodiscard]] bool empty() const;

    /**
     * Number of routes in this solution.
     */
    [[nodiscard]] size_t numRoutes() const;

    /**
     * Number of trips in this solution.
     */
    [[nodiscard]] size_t numTrips() const;

    /**
     * Number of clients in this solution.
     *
     * .. warning::
     *
     *    An empty solution typically indicates that there is a significant