Merge branch 'open-vehicle-routes'

jsprit-examples/src/main/java/jsprit/examples/PickupAndDeliveryExample.java

@@ -57,7 +57,7 @@ public class PickupAndDeliveryExample {
 		/*
 		 * A solomonReader reads solomon-instance files, and stores the required information in the builder.
 		 */
-		new VrpXMLReader(vrpBuilder).read("input/pickups_and_deliveries_solomon_r101.xml");
+		new VrpXMLReader(vrpBuilder).read("input/pickups_and_deliveries_solomon_r101_withoutTWs.xml");
 		
 		/*
 		 * Finally, the problem can be built. By default, transportCosts are crowFlyDistances (as usually used for vrp-instances).

jsprit-examples/src/main/java/jsprit/examples/PickupAndDeliveryOpenExample.java

@@ -0,0 +1,108 @@
+/*******************************************************************************
+ * Copyright (C) 2013  Stefan Schroeder
+ * 
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either 
+ * version 3.0 of the License, or (at your option) any later version.
+ * 
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ * 
+ * You should have received a copy of the GNU Lesser General Public 
+ * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
+ ******************************************************************************/
+package jsprit.examples;
+
+import java.io.File;
+import java.util.Collection;
+
+import jsprit.analysis.toolbox.AlgorithmSearchProgressChartListener;
+import jsprit.analysis.toolbox.Plotter;
+import jsprit.analysis.toolbox.Plotter.Label;
+import jsprit.analysis.toolbox.SolutionPlotter;
+import jsprit.analysis.toolbox.SolutionPrinter;
+import jsprit.core.algorithm.VehicleRoutingAlgorithm;
+import jsprit.core.algorithm.io.VehicleRoutingAlgorithms;
+import jsprit.core.algorithm.selector.SelectBest;
+import jsprit.core.problem.VehicleRoutingProblem;
+import jsprit.core.problem.io.VrpXMLReader;
+import jsprit.core.problem.solution.VehicleRoutingProblemSolution;
+
+
+public class PickupAndDeliveryOpenExample {
+	
+	public static void main(String[] args) {
+		
+		/*
+		 * some preparation - create output folder
+		 */
+		File dir = new File("output");
+		// if the directory does not exist, create it
+		if (!dir.exists()){
+			System.out.println("creating directory ./output");
+			boolean result = dir.mkdir();  
+			if(result) System.out.println("./output created");  
+		}
+		
+		/*
+		 * Build the problem.
+		 * 
+		 * But define a problem-builder first.
+		 */
+		VehicleRoutingProblem.Builder vrpBuilder = VehicleRoutingProblem.Builder.newInstance();
+		
+		/*
+		 * A solomonReader reads solomon-instance files, and stores the required information in the builder.
+		 */
+		new VrpXMLReader(vrpBuilder).read("input/pickups_and_deliveries_solomon_r101_withoutTWs_open.xml");
+		
+		/*
+		 * Finally, the problem can be built. By default, transportCosts are crowFlyDistances (as usually used for vrp-instances).
+		 */
+		
+		VehicleRoutingProblem vrp = vrpBuilder.build();
+		
+//		SolutionPlotter.plotVrpAsPNG(vrp, "output/pd_solomon_r101_o.png", "pd_r101");
+		
+		/*
+		 * Define the required vehicle-routing algorithms to solve the above problem.
+		 * 
+		 * The algorithm can be defined and configured in an xml-file.
+		 */
+//		VehicleRoutingAlgorithm vra = new SchrimpfFactory().createAlgorithm(vrp);
+		VehicleRoutingAlgorithm vra = VehicleRoutingAlgorithms.readAndCreateAlgorithm(vrp, "input/algorithmConfig_open.xml");
+		vra.getAlgorithmListeners().addListener(new AlgorithmSearchProgressChartListener("output/sol_progress.png"));
+		/*
+		 * Solve the problem.
+		 * 
+		 *
+		 */
+		Collection<VehicleRoutingProblemSolution> solutions = vra.searchSolutions();
+		
+		/*
+		 * Retrieve best solution.
+		 */
+		VehicleRoutingProblemSolution solution = new SelectBest().selectSolution(solutions);
+		
+		/*
+		 * print solution
+		 */
+		SolutionPrinter.print(solution);
+		
+		/*
+		 * Plot solution. 
+		 */
+//		SolutionPlotter.plotSolutionAsPNG(vrp, solution, "output/pd_solomon_r101_solution.png","pd_r101");
+		Plotter plotter = new Plotter(vrp, solution);
+		plotter.setLabel(Label.SIZE);
+		plotter.setShowFirstActivity(true);
+		plotter.plot("output/pd_solomon_r101_solution_open.png","pd_r101");
+	
+		
+		
+	}
+
+}

jsprit-examples/src/main/java/jsprit/examples/SimpleEnRoutePickupAndDeliveryOpenRoutesExample.java

@@ -0,0 +1,132 @@
+/*******************************************************************************
+ * Copyright (C) 2013  Stefan Schroeder
+ * 
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either 
+ * version 3.0 of the License, or (at your option) any later version.
+ * 
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ * 
+ * You should have received a copy of the GNU Lesser General Public 
+ * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
+ ******************************************************************************/
+package jsprit.examples;
+
+import java.io.File;
+import java.util.Arrays;
+import java.util.Collection;
+
+import jsprit.analysis.toolbox.Plotter;
+import jsprit.analysis.toolbox.SolutionPrinter;
+import jsprit.core.algorithm.VehicleRoutingAlgorithm;
+import jsprit.core.algorithm.box.SchrimpfFactory;
+import jsprit.core.problem.VehicleRoutingProblem;
+import jsprit.core.problem.io.VrpXMLWriter;
+import jsprit.core.problem.job.Shipment;
+import jsprit.core.problem.solution.VehicleRoutingProblemSolution;
+import jsprit.core.problem.vehicle.Vehicle;
+import jsprit.core.problem.vehicle.VehicleImpl;
+import jsprit.core.problem.vehicle.VehicleImpl.Builder;
+import jsprit.core.problem.vehicle.VehicleType;
+import jsprit.core.problem.vehicle.VehicleTypeImpl;
+import jsprit.core.util.Coordinate;
+import jsprit.core.util.Solutions;
+
+
+public class SimpleEnRoutePickupAndDeliveryOpenRoutesExample {
+	
+	public static void main(String[] args) {
+		/*
+		 * some preparation - create output folder
+		 */
+		File dir = new File("output");
+		// if the directory does not exist, create it
+		if (!dir.exists()){
+			System.out.println("creating directory ./output");
+			boolean result = dir.mkdir();  
+			if(result) System.out.println("./output created");  
+		}
+		
+		/*
+		 * get a vehicle type-builder and build a type with the typeId "vehicleType" and a capacity of 2
+		 */
+		VehicleTypeImpl.Builder vehicleTypeBuilder = VehicleTypeImpl.Builder.newInstance("vehicleType", 2);
+		VehicleType vehicleType = vehicleTypeBuilder.build();
+		
+		/*
+		 * get a vehicle-builder and build a vehicle located at (10,10) with type "vehicleType"
+		 */
+		Builder vehicleBuilder = VehicleImpl.Builder.newInstance("vehicle");
+		vehicleBuilder.setLocationCoord(Coordinate.newInstance(10, 10));
+		vehicleBuilder.setType(vehicleType);
+		vehicleBuilder.setReturnToDepot(false);
+		Vehicle vehicle = vehicleBuilder.build();
+		
+		/*
+		 * build shipments at the required locations, each with a capacity-demand of 1.
+		 * 4 shipments
+		 * 1: (5,7)->(6,9)
+		 * 2: (5,13)->(6,11)
+		 * 3: (15,7)->(14,9)
+		 * 4: (15,13)->(14,11)
+		 */
+		
+		Shipment shipment1 = Shipment.Builder.newInstance("1", 1).setPickupCoord(Coordinate.newInstance(5, 7)).setDeliveryCoord(Coordinate.newInstance(6, 9)).build();
+		Shipment shipment2 = Shipment.Builder.newInstance("2", 1).setPickupCoord(Coordinate.newInstance(5, 13)).setDeliveryCoord(Coordinate.newInstance(6, 11)).build();
+		
+		Shipment shipment3 = Shipment.Builder.newInstance("3", 1).setPickupCoord(Coordinate.newInstance(15, 7)).setDeliveryCoord(Coordinate.newInstance(14, 9)).build();
+		Shipment shipment4 = Shipment.Builder.newInstance("4", 1).setPickupCoord(Coordinate.newInstance(15, 13)).setDeliveryCoord(Coordinate.newInstance(14, 11)).build();
+		
+		
+		VehicleRoutingProblem.Builder vrpBuilder = VehicleRoutingProblem.Builder.newInstance();
+		vrpBuilder.addVehicle(vehicle);
+		vrpBuilder.addJob(shipment1).addJob(shipment2).addJob(shipment3).addJob(shipment4);
+		
+		VehicleRoutingProblem problem = vrpBuilder.build();
+		
+		/*
+		 * get the algorithm out-of-the-box. 
+		 */
+		VehicleRoutingAlgorithm algorithm = new SchrimpfFactory().createAlgorithm(problem);
+		
+		/*
+		 * and search a solution
+		 */
+		Collection<VehicleRoutingProblemSolution> solutions = algorithm.searchSolutions();
+		
+		/*
+		 * get the best 
+		 */
+		VehicleRoutingProblemSolution bestSolution = Solutions.bestOf(solutions);
+		
+		/*
+		 * write out problem and solution to xml-file
+		 */
+		new VrpXMLWriter(problem, solutions).write("output/shipment-problem-with-solution.xml");
+		
+		/*
+		 * print nRoutes and totalCosts of bestSolution
+		 */
+		SolutionPrinter.print(bestSolution);
+		
+		/*
+		 * plot problem without solution
+		 */
+		Plotter problemPlotter = new Plotter(problem);
+		problemPlotter.plotShipments(true);
+		problemPlotter.plot("output/simpleEnRoutePickupAndDeliveryExample_problem.png", "en-route pickup and delivery");
+		
+		/*
+		 * plot problem with solution
+		 */
+		Plotter solutionPlotter = new Plotter(problem,Solutions.bestOf(solutions).getRoutes());
+		solutionPlotter.plotShipments(true);
+		solutionPlotter.plot("output/simpleEnRoutePickupAndDeliveryExample_solution.png", "en-route pickup and delivery");
+		
+	}
+
+}

jsprit-examples/src/main/java/jsprit/examples/SimpleExampleOpenRoutes.java

@@ -0,0 +1,112 @@
+/*******************************************************************************
+ * Copyright (C) 2013  Stefan Schroeder
+ * 
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either 
+ * version 3.0 of the License, or (at your option) any later version.
+ * 
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ * 
+ * You should have received a copy of the GNU Lesser General Public 
+ * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
+ ******************************************************************************/
+package jsprit.examples;
+
+import java.io.File;
+import java.util.Collection;
+
+import jsprit.analysis.toolbox.SolutionPlotter;
+import jsprit.analysis.toolbox.SolutionPrinter;
+import jsprit.core.algorithm.VehicleRoutingAlgorithm;
+import jsprit.core.algorithm.box.SchrimpfFactory;
+import jsprit.core.algorithm.io.VehicleRoutingAlgorithms;
+import jsprit.core.problem.VehicleRoutingProblem;
+import jsprit.core.problem.io.VrpXMLWriter;
+import jsprit.core.problem.job.Service;
+import jsprit.core.problem.solution.VehicleRoutingProblemSolution;
+import jsprit.core.problem.vehicle.Vehicle;
+import jsprit.core.problem.vehicle.VehicleImpl;
+import jsprit.core.problem.vehicle.VehicleImpl.Builder;
+import jsprit.core.problem.vehicle.VehicleType;
+import jsprit.core.problem.vehicle.VehicleTypeImpl;
+import jsprit.core.util.Coordinate;
+import jsprit.core.util.Solutions;
+
+
+public class SimpleExampleOpenRoutes {
+	
+	public static void main(String[] args) {
+		/*
+		 * some preparation - create output folder
+		 */
+		File dir = new File("output");
+		// if the directory does not exist, create it
+		if (!dir.exists()){
+			System.out.println("creating directory ./output");
+			boolean result = dir.mkdir();  
+			if(result) System.out.println("./output created");  
+		}
+		
+		/*
+		 * get a vehicle type-builder and build a type with the typeId "vehicleType" and a capacity of 2
+		 */
+		VehicleTypeImpl.Builder vehicleTypeBuilder = VehicleTypeImpl.Builder.newInstance("vehicleType", 2);
+		vehicleTypeBuilder.setFixedCost(100);
+		VehicleType vehicleType = vehicleTypeBuilder.build();
+		
+		/*
+		 * get a vehicle-builder and build a vehicle located at (10,10) with type "vehicleType"
+		 */
+		Builder vehicleBuilder = VehicleImpl.Builder.newInstance("vehicle");
+		vehicleBuilder.setLocationCoord(Coordinate.newInstance(10, 10));
+		vehicleBuilder.setType(vehicleType);
+		vehicleBuilder.setReturnToDepot(false);
+		
+		Vehicle vehicle = vehicleBuilder.build();
+		
+		/*
+		 * build services at the required locations, each with a capacity-demand of 1.
+		 */
+		Service service1 = Service.Builder.newInstance("1", 1).setCoord(Coordinate.newInstance(5, 7)).build();
+		Service service2 = Service.Builder.newInstance("2", 1).setCoord(Coordinate.newInstance(5, 13)).build();
+		
+		Service service3 = Service.Builder.newInstance("3", 1).setCoord(Coordinate.newInstance(15, 7)).build();
+		Service service4 = Service.Builder.newInstance("4", 1).setCoord(Coordinate.newInstance(15, 13)).build();
+		
+		
+		VehicleRoutingProblem.Builder vrpBuilder = VehicleRoutingProblem.Builder.newInstance();
+		vrpBuilder.addVehicle(vehicle);
+		vrpBuilder.addJob(service1).addJob(service2).addJob(service3).addJob(service4);
+		
+		VehicleRoutingProblem problem = vrpBuilder.build();
+		
+		/*
+		 * get the algorithm out-of-the-box. 
+		 */
+		VehicleRoutingAlgorithm algorithm = VehicleRoutingAlgorithms.readAndCreateAlgorithm(problem, "input/algorithmConfig_fix.xml");
+		
+		/*
+		 * and search a solution
+		 */
+		Collection<VehicleRoutingProblemSolution> solutions = algorithm.searchSolutions();
+		
+		/*
+		 * get the best 
+		 */
+		VehicleRoutingProblemSolution bestSolution = Solutions.bestOf(solutions);
+		
+		new VrpXMLWriter(problem, solutions).write("output/problem-with-solution.xml");
+		
+		SolutionPrinter.print(bestSolution);
+		
+		/*
+		 * plot
+		 */
+		SolutionPlotter.plotSolutionAsPNG(problem, bestSolution, "output/solution.png", "solution");
+	}
+
+}

jsprit-examples/src/main/java/jsprit/examples/SolomonOpenExample.java

@@ -0,0 +1,101 @@
+/*******************************************************************************
+ * Copyright (C) 2013  Stefan Schroeder
+ * 
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either 
+ * version 3.0 of the License, or (at your option) any later version.
+ * 
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ * 
+ * You should have received a copy of the GNU Lesser General Public 
+ * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
+ ******************************************************************************/
+package jsprit.examples;
+
+import java.io.File;
+import java.util.Collection;
+
+import jsprit.analysis.toolbox.SolutionPlotter;
+import jsprit.analysis.toolbox.SolutionPrinter;
+import jsprit.core.algorithm.VehicleRoutingAlgorithm;
+import jsprit.core.algorithm.io.VehicleRoutingAlgorithms;
+import jsprit.core.algorithm.selector.SelectBest;
+import jsprit.core.problem.VehicleRoutingProblem;
+import jsprit.core.problem.io.VrpXMLReader;
+import jsprit.core.problem.solution.VehicleRoutingProblemSolution;
+import jsprit.instance.reader.SolomonReader;
+
+
+public class SolomonOpenExample {
+	
+	public static void main(String[] args) {
+		/*
+		 * some preparation - create output folder
+		 */
+		File dir = new File("output");
+		// if the directory does not exist, create it
+		if (!dir.exists()){
+			System.out.println("creating directory ./output");
+			boolean result = dir.mkdir();  
+			if(result) System.out.println("./output created");  
+		}
+		
+		/*
+		 * Build the problem.
+		 * 
+		 * But define a problem-builder first.
+		 */
+		VehicleRoutingProblem.Builder vrpBuilder = VehicleRoutingProblem.Builder.newInstance();
+		
+		/*
+		 * A solomonReader reads solomon-instance files, and stores the required information in the builder.
+		 */
+		new VrpXMLReader(vrpBuilder).read("input/deliveries_solomon_open_c101.xml");
+		
+		/*
+		 * Finally, the problem can be built. By default, transportCosts are crowFlyDistances (as usually used for vrp-instances).
+		 */
+		VehicleRoutingProblem vrp = vrpBuilder.build();
+		
+		SolutionPlotter.plotVrpAsPNG(vrp, "output/solomon_C101_open.png", "C101");
+		
+		/*
+		 * Define the required vehicle-routing algorithms to solve the above problem.
+		 * 
+		 * The algorithm can be defined and configured in an xml-file.
+		 */
+//		VehicleRoutingAlgorithm vra = new SchrimpfFactory().createAlgorithm(vrp);
+		VehicleRoutingAlgorithm vra = VehicleRoutingAlgorithms.readAndCreateAlgorithm(vrp, "input/algorithmConfig_fix.xml");
+//		vra.setPrematureBreak(100);
+//		vra.getAlgorithmListeners().addListener(new AlgorithmSearchProgressChartListener("output/sol_progress.png"));
+		/*
+		 * Solve the problem.
+		 * 
+		 *
+		 */
+		Collection<VehicleRoutingProblemSolution> solutions = vra.searchSolutions();
+		
+		/*
+		 * Retrieve best solution.
+		 */
+		VehicleRoutingProblemSolution solution = new SelectBest().selectSolution(solutions);
+		
+		/*
+		 * print solution
+		 */
+		SolutionPrinter.print(solution);
+		
+		/*
+		 * Plot solution. 
+		 */
+		SolutionPlotter.plotSolutionAsPNG(vrp, solution, "output/solomon_C101_open_solution.png","C101");
+		
+	
+		
+	}
+
+}