Represents a single route in a VRP solution.
A route is a sequence of client visits performed by one vehicle, starting and ending at designated depots.
PyVRP Parity
This module provides the same interface as PyVRP's Route class.
Methods like distance/1, duration/1, etc. require the route
to have a solution_ref and route_idx set. Use Solution.route/2
or Solution.routes/1 to get Route structs with proper context.
Example
{:ok, result} = Solver.solve(model)
[route | _] = Solution.routes(result.best)
# Now you can call route methods
Route.distance(route)
Route.feasible?(route)Summary
Functions
Returns the centroid of this route as {x, y}.
Returns the total delivery load of this route per dimension.
Returns the distance of this route.
Returns the distance cost of this route.
Returns the duration of this route.
Returns the duration cost of this route.
Returns the end depot of this route.
Returns the end time of this route.
Returns the excess distance of this route.
Returns the excess load of this route per dimension.
Checks if this route is feasible.
Checks if this route has excess distance.
Checks if this route has excess load in any dimension.
Checks if this route has time warp.
Returns the number of clients visited in this route.
Returns the number of trips in this route.
Returns the overtime of this route.
Returns the total pickup load of this route per dimension.
Returns the prizes collected on this route.
Returns the schedule of this route as a list of ScheduledVisit tuples.
Returns the service duration of this route.
Returns the slack time of this route.
Returns the start depot of this route.
Returns the start time of this route.
Returns the time warp of this route.
Returns the travel duration of this route.
Returns the vehicle type of this route.
Returns the visits (client indices) of this route.
Returns the wait duration of this route.
Types
@type t() :: %ExVrp.Route{ end_depot: non_neg_integer(), route_idx: non_neg_integer() | nil, solution_ref: reference() | nil, start_depot: non_neg_integer(), trips: [ExVrp.Trip.t()], vehicle_type: non_neg_integer(), visits: [non_neg_integer()] }
Functions
Returns the centroid of this route as {x, y}.
@spec delivery(t()) :: [non_neg_integer()]
Returns the total delivery load of this route per dimension.
@spec distance(t()) :: non_neg_integer()
Returns the distance of this route.
@spec distance_cost(t()) :: non_neg_integer()
Returns the distance cost of this route.
@spec duration(t()) :: non_neg_integer()
Returns the duration of this route.
@spec duration_cost(t()) :: non_neg_integer()
Returns the duration cost of this route.
@spec end_depot(t()) :: non_neg_integer()
Returns the end depot of this route.
@spec end_time(t()) :: non_neg_integer()
Returns the end time of this route.
@spec excess_distance(t()) :: non_neg_integer()
Returns the excess distance of this route.
@spec excess_load(t()) :: [non_neg_integer()]
Returns the excess load of this route per dimension.
Checks if this route is feasible.
Checks if this route has excess distance.
Checks if this route has excess load in any dimension.
Checks if this route has time warp.
@spec num_clients(t()) :: non_neg_integer()
Returns the number of clients visited in this route.
This uses the local visits field and doesn't require a solution reference.
@spec num_trips(t()) :: non_neg_integer()
Returns the number of trips in this route.
@spec overtime(t()) :: non_neg_integer()
Returns the overtime of this route.
@spec pickup(t()) :: [non_neg_integer()]
Returns the total pickup load of this route per dimension.
@spec prizes(t()) :: non_neg_integer()
Returns the prizes collected on this route.
@spec schedule(t()) :: [ {non_neg_integer(), non_neg_integer(), non_neg_integer(), non_neg_integer(), non_neg_integer(), non_neg_integer()} ]
Returns the schedule of this route as a list of ScheduledVisit tuples.
Each tuple contains: {location, trip, start_service, end_service, wait_duration, time_warp}
@spec service_duration(t()) :: non_neg_integer()
Returns the service duration of this route.
@spec slack(t()) :: non_neg_integer()
Returns the slack time of this route.
@spec start_depot(t()) :: non_neg_integer()
Returns the start depot of this route.
@spec start_time(t()) :: non_neg_integer()
Returns the start time of this route.
@spec time_warp(t()) :: non_neg_integer()
Returns the time warp of this route.
@spec travel_duration(t()) :: non_neg_integer()
Returns the travel duration of this route.
@spec vehicle_type(t()) :: non_neg_integer()
Returns the vehicle type of this route.
@spec visits(t()) :: [non_neg_integer()]
Returns the visits (client indices) of this route.
@spec wait_duration(t()) :: non_neg_integer()
Returns the wait duration of this route.