https://docs.icepack.ai/isr/ Recent content in The Icepack Street Router on API Documentation Hugo -- gohugo.io en Tue, 19 Dec 2023 00:00:00 +0000 https://docs.icepack.ai/isr/configuration/ Thu, 13 Jun 2019 00:00:00 +0000 https://docs.icepack.ai/isr/configuration/ Overview The configuration for a Icepack Street Routing (ISR) model is designed to encapsulate the high-level features that are present in street-level routing problems. Often such street routing problems hinge on multiple collections along the same street segment (defined by the section of a road between two other roads). It would be unusual to split up such collections along a street and are rather required to make decisions between streets that are visited. https://docs.icepack.ai/isr/geocode/ Thu, 13 Jun 2019 00:00:00 +0000 https://docs.icepack.ai/isr/geocode/ Overview The term geocode is used to describe a pair of coordinates. In general, we mostly handle routing requests which are on the face of planet earth so we’ve biased the terminology used here in that direction. In the context of the ISR model, we only currently support road network queries which means that the geocode here must be a longitude/latitude pair on the face of planet earth. Applicable models ISR isr-z4foi53qznrv Geocode A longitude/latitude pair for routing on the face of planet earth which are used to determine entry and exit points on the road network. https://docs.icepack.ai/isr/offloadsite/ Thu, 13 Jun 2019 00:00:00 +0000 https://docs.icepack.ai/isr/offloadsite/ Overview An offload site in the context of the ISR model is a location where the collections accrued on a trip are delivered. It’s common that an offload site corresponds to a dump site or similar location. Applicable models ISR isr-z4foi53qznrv Offload Site Schema definition message OffloadSite { required string id = 1; required Geocode location = 2; required float fixedOffloadTime = 3 [default = 0.0]; required float offloadTimePerQuantity = 4 [default = 0. https://docs.icepack.ai/isr/collection/ Thu, 13 Jun 2019 00:00:00 +0000 https://docs.icepack.ai/isr/collection/ Overview A collection is a particular location on the street which requires a collection to be performed. A collection has both a time and quantity which contribute to the constraints in the time dimension and vehicle capacity dimension, respectively. A model will typically consist of many collections which are destined for a common offload site. We include the offload site in this current specification for future potential decompositions which may be required. https://docs.icepack.ai/isr/vehicle/ Thu, 13 Jun 2019 00:00:00 +0000 https://docs.icepack.ai/isr/vehicle/ Overview The vehicle component of the ISR model describes important features of the vehicle such as its start and end locations for the day, its available working time and the maximum number it may load before the vehicle is required to visit an offload site. Applicable models ISR isr-z4foi53qznrv Vehicle A model may contain multiple allowable vehicles for a particular solution. Each vehicle may have a different start/end location, available working time and capacity. https://docs.icepack.ai/isr/collectionsequence/ Thu, 13 Jun 2019 00:00:00 +0000 https://docs.icepack.ai/isr/collectionsequence/ Overview A collection sequence is used to provide a fixed sequence to the solver, either to be used as a starting incumbent in a reoptimise procedure or as a fixed sequence to be evaluated for infeasibilities. Applicable models ISR isr-z4foi53qznrv Collection Sequence The collection sequence is a list of task id’s, which are mostly collection identifiers with the dropoff site id’s where applicable. In other words, its the sequence that the vehicle should follow through collection, offloading and then potentially collecting again. https://docs.icepack.ai/isr/model/ Thu, 13 Jun 2019 00:00:00 +0000 https://docs.icepack.ai/isr/model/ Overview The model is a container for all the components that should be combined to describe a problem instance. In the case of the ISR model we’ll be required to provide all of the fields except for the collection sequence (which is optional). Applicable models ISR isr-z4foi53qznrv Model The model defines an instance of the desired problem to be solved. Schema definition message Model { required Configuration configuration = 1; repeated Collection collections = 2; repeated OffloadSite offloadSites = 3; repeated Vehicle vehicles = 4; repeated CollectionSequence collectionSequence = 5; } Fields configuration The configuration defining the costs, travel factors, units of measurement and collection policies for this model. https://docs.icepack.ai/isr/solverequest/ Thu, 13 Jun 2019 00:00:00 +0000 https://docs.icepack.ai/isr/solverequest/ Overview Different actions can be performed against a model and the solve request object provides a mechanism to communicate the action to the solver. Applicable models ISR isr-z4foi53qznrv Endpoint POST: https://api.icepack.ai/vehicle-router/solve/ Solve Request The solve request indicates what type of solve should be performed against a specified model. Schema definition message SolveRequest { optional Model model = 1; optional string modelID = 2; repeated VisitSequence routes = 3; optional SolveType solveType = 4 [default = Optimise]; } Fields model The target model which should be solved (commonly specified). https://docs.icepack.ai/isr/solutionresponse/ Thu, 13 Jun 2019 00:00:00 +0000 https://docs.icepack.ai/isr/solutionresponse/ Overview The solution response is produced by the API as an output object for a given solve request. This is considered the primary output from the Icepack engine. The solution response contains all the evaluation information for each vehicle, i.e. travel durations and distances between collections as well as the streets and matching information in the schedule. Applicable models ISR isr-z4foi53qznrv Solution Response The solution response contains five core elements. The first is the objective cost of the schedule which is the total cost as evaluated by the engine given the input model parameters (such as the cost coefficient parameters by the configuration).