add example 'ConfigureAlgorithInCodeInsteadOfPerXml' - issue #52

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

@@ -0,0 +1,140 @@
+/*******************************************************************************
+ * 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 examples;
+
+import java.io.File;
+import java.util.Collection;
+
+import org.apache.commons.configuration.XMLConfiguration;
+
+import util.Coordinate;
+import util.Solutions;
+import algorithms.VehicleRoutingAlgorithms;
+import analysis.SolutionPlotter;
+import analysis.SolutionPrinter;
+import analysis.SolutionPrinter.Print;
+import basics.Service;
+import basics.VehicleRoutingAlgorithm;
+import basics.VehicleRoutingProblem;
+import basics.VehicleRoutingProblemSolution;
+import basics.io.AlgorithmConfig;
+import basics.io.VrpXMLWriter;
+import basics.route.Vehicle;
+import basics.route.VehicleImpl;
+import basics.route.VehicleImpl.Builder;
+import basics.route.VehicleType;
+import basics.route.VehicleTypeImpl;
+
+public class ConfigureAlgorithmInCodeInsteadOfPerXml {
+	
+	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);
+		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.addService(service1).addService(service2).addService(service3).addService(service4);
+		
+		VehicleRoutingProblem problem = vrpBuilder.build();
+		
+		/*
+		 * get the algorithm out-of-the-box. 
+		 */
+		AlgorithmConfig algorithmConfig = getAlgorithmConfig();
+		VehicleRoutingAlgorithm algorithm = VehicleRoutingAlgorithms.createAlgorithm(problem,algorithmConfig);
+		
+		/*
+		 * and search a solution
+		 */
+		Collection<VehicleRoutingProblemSolution> solutions = algorithm.searchSolutions();
+		
+		/*
+		 * get the best 
+		 */
+		VehicleRoutingProblemSolution bestSolution = Solutions.getBest(solutions);
+		
+		new VrpXMLWriter(problem, solutions).write("output/problem-with-solution.xml");
+		
+		SolutionPrinter.print(bestSolution,Print.VERBOSE);
+		
+		/*
+		 * plot
+		 */
+		SolutionPlotter.plotSolutionAsPNG(problem, bestSolution, "output/solution.png", "solution");
+	}
+
+	private static AlgorithmConfig getAlgorithmConfig() {
+		AlgorithmConfig config = new AlgorithmConfig();
+		XMLConfiguration xmlConfig = config.getXMLConfiguration();
+		xmlConfig.setProperty("iterations", 2000);
+		xmlConfig.setProperty("construction.insertion[@name]","bestInsertion");
+		
+		xmlConfig.setProperty("strategy.memory", 1);
+		String searchStrategy = "strategy.searchStrategies.searchStrategy";
+		
+		xmlConfig.setProperty(searchStrategy + "(0).selector[@name]","selectBest");
+		xmlConfig.setProperty(searchStrategy + "(0).acceptor[@name]","acceptNewRemoveWorst");
+		xmlConfig.setProperty(searchStrategy + "(0).modules.module(0)[@name]","ruin_and_recreate");
+		xmlConfig.setProperty(searchStrategy + "(0).modules.module(0).ruin[@name]","randomRuin");
+		xmlConfig.setProperty(searchStrategy + "(0).modules.module(0).ruin.share","0.3");
+		xmlConfig.setProperty(searchStrategy + "(0).modules.module(0).insertion[@name]","bestInsertion");
+		xmlConfig.setProperty(searchStrategy + "(0).probability","0.5");
+		
+		xmlConfig.setProperty(searchStrategy + "(1).selector[@name]","selectBest");
+		xmlConfig.setProperty(searchStrategy + "(1).acceptor[@name]","acceptNewRemoveWorst");
+		xmlConfig.setProperty(searchStrategy + "(1).modules.module(0)[@name]","ruin_and_recreate");
+		xmlConfig.setProperty(searchStrategy + "(1).modules.module(0).ruin[@name]","radialRuin");
+		xmlConfig.setProperty(searchStrategy + "(1).modules.module(0).ruin.share","0.15");
+		xmlConfig.setProperty(searchStrategy + "(1).modules.module(0).insertion[@name]","bestInsertion");
+		xmlConfig.setProperty(searchStrategy + "(1).probability","0.5");
+		
+		return config;
+	}
+
+}