org.optaweb.vehiclerouting.plugin.planner

Class SolutionUtil

java.lang.Object

org.optaweb.vehiclerouting.plugin.planner.SolutionUtil

public class SolutionUtil
extends Object

Provides common operations on solution that are not part of its API.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_CUSTOMER_DEMAND
(package private) static int	DEFAULT_VEHICLE_CAPACITY

Method Summary

Modifier and Type	Method and Description
(package private) static org.optaplanner.examples.vehiclerouting.domain.Customer	addCustomer(org.optaplanner.examples.vehiclerouting.domain.VehicleRoutingSolution solution, org.optaplanner.examples.vehiclerouting.domain.location.Location location) Add customer with zero demand.
(package private) static org.optaplanner.examples.vehiclerouting.domain.Customer	addCustomer(org.optaplanner.examples.vehiclerouting.domain.VehicleRoutingSolution solution, org.optaplanner.examples.vehiclerouting.domain.location.Location location, int demand) Add customer with demand.
(package private) static org.optaplanner.examples.vehiclerouting.domain.Depot	addDepot(org.optaplanner.examples.vehiclerouting.domain.VehicleRoutingSolution solution, org.optaplanner.examples.vehiclerouting.domain.location.Location location) Add depot.
(package private) static org.optaplanner.examples.vehiclerouting.domain.Vehicle	addVehicle(org.optaplanner.examples.vehiclerouting.domain.VehicleRoutingSolution solution, long id) Add vehicle with zero capacity.
(package private) static Long	depot(org.optaplanner.examples.vehiclerouting.domain.VehicleRoutingSolution solution) Get solution's depot ID.
static org.optaplanner.examples.vehiclerouting.domain.VehicleRoutingSolution	emptySolution() Create an empty solution.
(package private) static org.optaplanner.examples.vehiclerouting.domain.VehicleRoutingSolution	initialSolution() Create an initial solution with no locations and some vehicles.
(package private) static void	moveAllVehiclesTo(org.optaplanner.examples.vehiclerouting.domain.VehicleRoutingSolution solution, org.optaplanner.examples.vehiclerouting.domain.Depot depot) Move all vehicles to the specified depot.
(package private) static org.optaplanner.examples.vehiclerouting.domain.location.RoadLocation	planningLocation(Location location) Translate domain location to a planning location.
(package private) static List<ShallowRoute>	routes(org.optaplanner.examples.vehiclerouting.domain.VehicleRoutingSolution solution) Extract routes from the solution.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CUSTOMER_DEMAND

public static final int DEFAULT_CUSTOMER_DEMAND

See Also:

Constant Field Values

DEFAULT_VEHICLE_CAPACITY

static final int DEFAULT_VEHICLE_CAPACITY

See Also:

Constant Field Values

Method Detail

emptySolution

public static org.optaplanner.examples.vehiclerouting.domain.VehicleRoutingSolution emptySolution()

Create an empty solution. Empty solution has zero locations, depots, customers and vehicles and a zero score.

Returns:

empty solution

initialSolution

static org.optaplanner.examples.vehiclerouting.domain.VehicleRoutingSolution initialSolution()

Create an initial solution with no locations and some vehicles.

Returns:

initial solution

addVehicle

static org.optaplanner.examples.vehiclerouting.domain.Vehicle addVehicle(org.optaplanner.examples.vehiclerouting.domain.VehicleRoutingSolution solution,
                                                                         long id)

Add vehicle with zero capacity.

Parameters:

solution - solution

id - vehicle id

Returns:

the new vehicle

routes

static List<ShallowRoute> routes(org.optaplanner.examples.vehiclerouting.domain.VehicleRoutingSolution solution)

Extract routes from the solution. Includes empty routes of vehicles that stay in the depot.

Parameters:

solution - solution

Returns:

one route per vehicle

planningLocation

static org.optaplanner.examples.vehiclerouting.domain.location.RoadLocation planningLocation(Location location)

Translate domain location to a planning location.

Parameters:

location - domain location

Returns:

planning location

depot

static Long depot(org.optaplanner.examples.vehiclerouting.domain.VehicleRoutingSolution solution)

Get solution's depot ID.

Parameters:

solution - the solution in which to look for the depot

Returns:

first depot ID from the solution or null if there are no depots

addDepot

static org.optaplanner.examples.vehiclerouting.domain.Depot addDepot(org.optaplanner.examples.vehiclerouting.domain.VehicleRoutingSolution solution,
                                                                     org.optaplanner.examples.vehiclerouting.domain.location.Location location)

Add depot.

Parameters:

solution - solution

location - depot's location

Returns:

the new depot

addCustomer

static org.optaplanner.examples.vehiclerouting.domain.Customer addCustomer(org.optaplanner.examples.vehiclerouting.domain.VehicleRoutingSolution solution,
                                                                           org.optaplanner.examples.vehiclerouting.domain.location.Location location)

Add customer with zero demand.

Parameters:

solution - solution

location - customer's location

Returns:

the new customer

addCustomer

static org.optaplanner.examples.vehiclerouting.domain.Customer addCustomer(org.optaplanner.examples.vehiclerouting.domain.VehicleRoutingSolution solution,
                                                                           org.optaplanner.examples.vehiclerouting.domain.location.Location location,
                                                                           int demand)

Add customer with demand.

Parameters:

solution - solution

location - customer's location

demand - customer's demand

Returns:

the new customer

moveAllVehiclesTo

static void moveAllVehiclesTo(org.optaplanner.examples.vehiclerouting.domain.VehicleRoutingSolution solution,
                              org.optaplanner.examples.vehiclerouting.domain.Depot depot)

Move all vehicles to the specified depot.

Parameters:

solution - solution

depot - new vehicles' depot. May be null.