Package com.graphhopper.jsprit.core.problem

Class VehicleRoutingProblem.Builder

java.lang.Object

com.graphhopper.jsprit.core.problem.VehicleRoutingProblem.Builder

Enclosing class:

VehicleRoutingProblem

public static class VehicleRoutingProblem.Builder
extends Object

Builder to build the routing-problem.

Author:

stefan schroeder

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
VehicleRoutingProblem.Builder	addAllJobs(Collection<? extends Job> jobs)	Adds a collection of jobs.
VehicleRoutingProblem.Builder	addAllVehicles(Collection<? extends Vehicle> vehicles)	Adds a collection of vehicles.
VehicleRoutingProblem.Builder	addInitialRouteSpec(RouteSpec spec)	Adds a single route specification.
VehicleRoutingProblem.Builder	addInitialVehicleRoute(VehicleRoute route)	Adds an initial vehicle route.
VehicleRoutingProblem.Builder	addInitialVehicleRoutes(Collection<VehicleRoute> routes)	Adds a collection of initial vehicle routes.
VehicleRoutingProblem.Builder	addJob(AbstractJob job)	Adds a job which is either a service or a shipment.
VehicleRoutingProblem.Builder	addJob(Job job)	Adds a job which is either a service or a shipment.
VehicleRoutingProblem.Builder	addLocation(String locationId, Coordinate coordinate)	Deprecated.
VehicleRoutingProblem.Builder	addNonJobActivities(Collection<? extends AbstractActivity> nonJobActivities)
VehicleRoutingProblem.Builder	addVehicle(AbstractVehicle vehicle)	Adds a vehicle.
VehicleRoutingProblem.Builder	addVehicle(Vehicle vehicle)	Adds a vehicle.
VehicleRoutingProblem	build()	Builds the VehicleRoutingProblem.
Collection<Job>	getAddedJobs()	Returns an unmodifiable collection of already added jobs.
Collection<Vehicle>	getAddedVehicles()	Gets an unmodifiable collection of already added vehicles.
Collection<VehicleType>	getAddedVehicleTypes()	Gets an unmodifiable collection of already added vehicle-types.
Map<String,Coordinate>	getLocationMap()	Returns the unmodifiable map of collected locations (mapped by their location-id).
Locations	getLocations()	Returns the locations collected SO FAR by this builder.
static VehicleRoutingProblem.Builder	newInstance()	Returns a new instance of this builder.
VehicleRoutingProblem.Builder	setActivityCosts(VehicleRoutingActivityCosts activityCosts)	Sets the activity-costs.
VehicleRoutingProblem.Builder	setFleetSize(VehicleRoutingProblem.FleetSize fleetSize)	Sets the type of fleetSize.
VehicleRoutingProblem.Builder	setInitialRouteSpecs(List<RouteSpec> specs)	Sets the initial route specifications, replacing any previously added specs.
VehicleRoutingProblem.Builder	setJobActivityFactory(JobActivityFactory jobActivityFactory)
VehicleRoutingProblem.Builder	setRoutingCost(VehicleRoutingTransportCosts costs)	Sets routing costs.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

newInstance

public static VehicleRoutingProblem.Builder newInstance()

Returns a new instance of this builder.

Returns:

builder

getLocationMap

public Map<String,Coordinate> getLocationMap()

Returns the unmodifiable map of collected locations (mapped by their location-id).

Returns:

map with locations

getLocations

public Locations getLocations()

Returns the locations collected SO FAR by this builder.

Locations are cached when adding a shipment, service, depot, vehicle.

Returns:

locations

setRoutingCost

public VehicleRoutingProblem.Builder setRoutingCost(VehicleRoutingTransportCosts costs)

Sets routing costs.

Parameters:

costs - the routingCosts

Returns:

builder

See Also:

• VehicleRoutingTransportCosts

setJobActivityFactory

public VehicleRoutingProblem.Builder setJobActivityFactory(JobActivityFactory jobActivityFactory)

setFleetSize

public VehicleRoutingProblem.Builder setFleetSize(VehicleRoutingProblem.FleetSize fleetSize)

Sets the type of fleetSize.

FleetSize is either FleetSize.INFINITE or FleetSize.FINITE. By default it is FleetSize.INFINITE.

Parameters:

fleetSize - the fleet size used in this problem. it can either be FleetSize.INFINITE or FleetSize.FINITE

Returns:

this builder

addJob

public VehicleRoutingProblem.Builder addJob(Job job)

Adds a job which is either a service or a shipment.

Note that job.getId() must be unique, i.e. no job (either it is a shipment or a service) is allowed to have an already allocated id.

Parameters:

job - job to be added

Returns:

this builder

Throws:

IllegalStateException - if job is neither a shipment nor a service, or jobId has already been added.

addJob

public VehicleRoutingProblem.Builder addJob(AbstractJob job)

Adds a job which is either a service or a shipment.

Note that job.getId() must be unique, i.e. no job (either it is a shipment or a service) is allowed to have an already allocated id.

Parameters:

job - job to be added

Returns:

this builder

Throws:

IllegalStateException - if job is neither a shipment nor a service, or jobId has already been added.

addInitialVehicleRoute

public VehicleRoutingProblem.Builder addInitialVehicleRoute(VehicleRoute route)

Adds an initial vehicle route.

Parameters:

route - initial route

Returns:

the builder

addInitialVehicleRoutes

public VehicleRoutingProblem.Builder addInitialVehicleRoutes(Collection<VehicleRoute> routes)

Adds a collection of initial vehicle routes.

Parameters:

routes - initial routes

Returns:

the builder

setInitialRouteSpecs

public VehicleRoutingProblem.Builder setInitialRouteSpecs(List<RouteSpec> specs)

Sets the initial route specifications, replacing any previously added specs.

The specs will be materialized into actual routes during build(). This is the preferred way to define initial (locked) routes as it avoids the chicken-and-egg problem of needing a VRP to create routes.

Note: Jobs in these routes will be locked and cannot be removed by the algorithm. If you want a starting solution that can be fully optimized, use algorithm.addInitialSolution() instead.

Parameters:

specs - the route specifications

Returns:

the builder

addInitialRouteSpec

public VehicleRoutingProblem.Builder addInitialRouteSpec(RouteSpec spec)

Adds a single route specification.

The spec will be materialized into an actual route during build().

Parameters:

spec - the route specification

Returns:

the builder

addVehicle

public VehicleRoutingProblem.Builder addVehicle(Vehicle vehicle)

Adds a vehicle.

Parameters:

vehicle - vehicle to be added

Returns:

this builder

addVehicle

public VehicleRoutingProblem.Builder addVehicle(AbstractVehicle vehicle)

Adds a vehicle.

Parameters:

vehicle - vehicle to be added

Returns:

this builder

setActivityCosts

public VehicleRoutingProblem.Builder setActivityCosts(VehicleRoutingActivityCosts activityCosts)

Sets the activity-costs.

By default it is set to zero.

Parameters:

activityCosts - activity costs of the problem

Returns:

this builder

See Also:

• VehicleRoutingActivityCosts

addNonJobActivities

public VehicleRoutingProblem.Builder addNonJobActivities(Collection<? extends AbstractActivity> nonJobActivities)

build

public VehicleRoutingProblem build()

Builds the VehicleRoutingProblem.

If VehicleRoutingTransportCosts are not set, CrowFlyCosts is used.

Returns:

VehicleRoutingProblem

addLocation

@Deprecated
public VehicleRoutingProblem.Builder addLocation(String locationId,
 Coordinate coordinate)

Deprecated.

addAllJobs

public VehicleRoutingProblem.Builder addAllJobs(Collection<? extends Job> jobs)

Adds a collection of jobs.

Parameters:

jobs - which is a collection of jobs that subclasses Job

Returns:

this builder

addAllVehicles

public VehicleRoutingProblem.Builder addAllVehicles(Collection<? extends Vehicle> vehicles)

Adds a collection of vehicles.

Parameters:

vehicles - vehicles to be added

Returns:

this builder

getAddedVehicles

public Collection<Vehicle> getAddedVehicles()

Gets an unmodifiable collection of already added vehicles.

Returns:

collection of vehicles

getAddedVehicleTypes

public Collection<VehicleType> getAddedVehicleTypes()

Gets an unmodifiable collection of already added vehicle-types.

Returns:

collection of vehicle-types

getAddedJobs

public Collection<Job> getAddedJobs()

Returns an unmodifiable collection of already added jobs.

Returns:

collection of jobs