add VehicleRoutingTransportCostMatrix to easily consider time and

distance matrices, and add an example that illustrates the matrix

jsprit-core/src/main/java/util/VehicleRoutingTransportCostsMatrix.java

@@ -0,0 +1,192 @@
+package util;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import org.apache.log4j.Logger;
+
+import basics.costs.VehicleRoutingTransportCosts;
+import basics.route.Driver;
+import basics.route.Vehicle;
+import basics.route.VehicleTypeImpl.VehicleCostParams;
+
+
+public class VehicleRoutingTransportCostsMatrix implements VehicleRoutingTransportCosts {
+
+	static class RelationKey {
+		
+		static RelationKey newKey(String from, String to){
+			int fromInt = Integer.parseInt(from);
+			int toInt = Integer.parseInt(to);
+			if(fromInt < toInt){
+				return new RelationKey(from, to);
+			}
+			else {
+				return new RelationKey(to, from);
+			}
+		}
+		
+		final String from;
+		final String to;
+		
+		public RelationKey(String from, String to) {
+			super();
+			this.from = from;
+			this.to = to;
+		}
+
+		/* (non-Javadoc)
+		 * @see java.lang.Object#hashCode()
+		 */
+		@Override
+		public int hashCode() {
+			final int prime = 31;
+			int result = 1;
+			result = prime * result + ((from == null) ? 0 : from.hashCode());
+			result = prime * result + ((to == null) ? 0 : to.hashCode());
+			return result;
+		}
+
+		/* (non-Javadoc)
+		 * @see java.lang.Object#equals(java.lang.Object)
+		 */
+		@Override
+		public boolean equals(Object obj) {
+			if (this == obj)
+				return true;
+			if (obj == null)
+				return false;
+			if (getClass() != obj.getClass())
+				return false;
+			RelationKey other = (RelationKey) obj;
+			if (from == null) {
+				if (other.from != null)
+					return false;
+			} else if (!from.equals(other.from))
+				return false;
+			if (to == null) {
+				if (other.to != null)
+					return false;
+			} else if (!to.equals(other.to))
+				return false;
+			return true;
+		}
+	}
+
+	
+	
+	public static class Builder {
+		private static Logger log = Logger.getLogger(Builder.class);
+		
+		private boolean isSymmetric;
+		
+		private Map<RelationKey,Double> distances = new HashMap<RelationKey, Double>();
+		
+		private Map<RelationKey,Double> times = new HashMap<RelationKey, Double>();
+		
+		public static Builder newInstance(boolean isSymmetric){
+			return new Builder(isSymmetric);
+		}
+		
+		private Builder(boolean isSymmetric){
+			this.isSymmetric = isSymmetric;
+		}
+		
+		public Builder addTransportDistance(String from, String to, double distance){
+			RelationKey key = RelationKey.newKey(from, to);
+			if(distances.containsKey(key)){
+				log.warn("distance from " + from + " to " + to + " already exists. This overrides distance.");
+			}
+			distances.put(key, distance);
+			return this;
+		}
+		
+		public Builder addTransportTime(String from, String to, double time){
+			RelationKey key = RelationKey.newKey(from, to);
+			if(times.containsKey(key)){
+				log.warn("transport-time from " + from + " to " + to + " already exists. This overrides distance.");
+			}
+			times.put(key, time);
+			return this;
+		}
+		
+		public VehicleRoutingTransportCostsMatrix build(){
+			return new VehicleRoutingTransportCostsMatrix(this);
+		}
+	}
+	
+	private Map<RelationKey,Double> distances = new HashMap<RelationKey, Double>();
+	
+	private Map<RelationKey,Double> times = new HashMap<RelationKey, Double>();
+	
+	private boolean isSymmetric;
+	
+	private VehicleRoutingTransportCostsMatrix(Builder builder){
+		this.isSymmetric = builder.isSymmetric;
+		distances.putAll(builder.distances);
+		times.putAll(builder.times);
+	}
+
+
+	@Override
+	public double getTransportTime(String fromId, String toId, double departureTime, Driver driver, Vehicle vehicle) {
+		return getTime(fromId, toId);
+	}
+
+
+	private double getTime(String fromId, String toId) {
+		if(fromId.equals(toId)) return 0.0;
+		RelationKey key = RelationKey.newKey(fromId, toId);
+		if(!isSymmetric){
+			if(times.containsKey(key)) return times.get(key);
+			else throw new IllegalStateException("time value for relation from " + fromId + " to " + toId + " does not exist");
+		}
+		else{
+			Double time = times.get(key);
+			if(time == null){
+				time = times.get(RelationKey.newKey(toId, fromId));
+			}
+			if(time != null) return time;
+			else throw new IllegalStateException("time value for relation from " + fromId + " to " + toId + " does not exist");
+		}
+	}
+
+	private double getDistance(String fromId, String toId) {
+		if(fromId.equals(toId)) return 0.0;
+		RelationKey key = RelationKey.newKey(fromId, toId);
+		if(!isSymmetric){
+			if(distances.containsKey(key)) return distances.get(key);
+			else throw new IllegalStateException("distance value for relation from " + fromId + " to " + toId + " does not exist");
+		}
+		else{
+			Double time = distances.get(key);
+			if(time == null){
+				time = distances.get(RelationKey.newKey(toId, fromId));
+			}
+			if(time != null) return time;
+			else throw new IllegalStateException("distance value for relation from " + fromId + " to " + toId + " does not exist");
+		}
+	}
+
+	@Override
+	public double getBackwardTransportTime(String fromId, String toId, double arrivalTime, Driver driver, Vehicle vehicle) {
+		return getTransportTime(fromId, toId, arrivalTime, driver, vehicle);
+	}
+
+
+	@Override
+	public double getTransportCost(String fromId, String toId, double departureTime, Driver driver, Vehicle vehicle) {
+		if(vehicle == null) return getDistance(fromId, toId);
+		VehicleCostParams costParams = vehicle.getType().getVehicleCostParams();
+		return costParams.perDistanceUnit*getDistance(fromId, toId) + costParams.perTimeUnit*getTime(fromId, toId);
+	}
+
+
+	@Override
+	public double getBackwardTransportCost(String fromId, String toId, double arrivalTime, Driver driver, Vehicle vehicle) {
+		return getTransportCost(fromId, toId, arrivalTime, driver, vehicle);
+	}
+	
+	
+	
+}

jsprit-examples/input/fastAlgo.xml

@@ -0,0 +1,74 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  Copyright (C) 2013  Stefan Schroeder
+  
+  This program is free software; you can redistribute it and/or
+  modify it under the terms of the GNU General Public License
+  as published by the Free Software Foundation; either version 2
+  of the License, or (at your option) any later version.
+  
+  This program 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 General Public License for more details.
+  
+  You should have received a copy of the GNU General Public License
+  along with this program; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+  
+  Contributors:
+      Stefan Schroeder - initial API and implementation
+-->
+<algorithm xmlns="http://www.w3schools.com"
+     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.w3schools.com algorithm_schema.xsd">
+	
+	<iterations>2000</iterations>
+	<prematureBreak basedOn="variationCoefficient">
+		<threshold>0.01</threshold>
+		<iterations>50</iterations>
+	</prematureBreak>
+
+	<construction>
+		<insertion name="bestInsertion"/>
+	</construction>
+	
+	<strategy>
+		<memory>1</memory>
+		<searchStrategies>
+			<searchStrategy name="radialRuinAndRecreate">
+				<selector name="selectBest"/>
+				<acceptor name="acceptNewRemoveWorst"/>
+				<modules>
+					<module name="ruin_and_recreate">
+						<ruin name="randomRuin">
+							<share>0.3</share>
+						</ruin>
+						<insertion name="bestInsertion"/>					
+					</module>
+					
+				</modules>
+				<probability>0.5</probability>
+			</searchStrategy>
+			
+			<searchStrategy name="radialRuinAndRecreate">
+				<selector name="selectBest"/>
+				<acceptor name="acceptNewRemoveWorst"/>
+					
+				<modules>
+					<module name="ruin_and_recreate">
+						<ruin name="radialRuin">
+							<share>0.15</share>
+						</ruin>
+						<insertion name="bestInsertion"/>					
+					</module>
+					
+				</modules>
+				<probability>0.5</probability>
+			</searchStrategy>
+			
+			
+		</searchStrategies>		
+	</strategy>
+	
+
+</algorithm>

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

@@ -0,0 +1,93 @@
+package examples;
+
+import java.util.Collection;
+
+import util.Solutions;
+import util.VehicleRoutingTransportCostsMatrix;
+import algorithms.GreedySchrimpfFactory;
+import algorithms.VehicleRoutingAlgorithms;
+import analysis.SolutionPlotter;
+import analysis.SolutionPrinter;
+import analysis.SolutionPrinter.Print;
+import basics.Service;
+import basics.VehicleRoutingAlgorithm;
+import basics.VehicleRoutingProblem;
+import basics.VehicleRoutingProblem.FleetSize;
+import basics.VehicleRoutingProblemSolution;
+import basics.costs.VehicleRoutingTransportCosts;
+import basics.route.Vehicle;
+import basics.route.VehicleImpl;
+import basics.route.VehicleType;
+import basics.route.VehicleTypeImpl;
+
+/**
+ * Illustrates how you can use jsprit with an already compiled distance and time matrix.
+ * 
+ * @author schroeder
+ *
+ */
+public class CostMatrixExample {
+
+	/**
+	 * @param args
+	 */
+	public static void main(String[] args) {
+		
+		VehicleType type = VehicleTypeImpl.Builder.newInstance("type", 2).setCostPerDistance(1).setCostPerTime(2).build();
+		Vehicle vehicle = VehicleImpl.Builder.newInstance("vehicle").setLocationId("0").setType(type).build();
+		
+		Service s1 = Service.Builder.newInstance("1", 1).setLocationId("1").build();
+		Service s2 = Service.Builder.newInstance("2", 1).setLocationId("2").build();
+		Service s3 = Service.Builder.newInstance("3", 1).setLocationId("3").build();
+		
+		
+		/*
+		 * Assume the following symmetric distance-matrix
+		 * from,to,distance
+		 * 0,1,10.0
+		 * 0,2,20.0
+		 * 0,3,5.0
+		 * 1,2,4.0
+		 * 1,3,1.0
+		 * 2,3,2.0
+		 * 
+		 * and this time-matrix
+		 * 0,1,5.0
+		 * 0,2,10.0
+		 * 0,3,2.5
+		 * 1,2,2.0
+		 * 1,3,0.5
+		 * 2,3,1.0
+		 */
+		//define a matrix-builder building a symmetric matrix
+		VehicleRoutingTransportCostsMatrix.Builder costMatrixBuilder = VehicleRoutingTransportCostsMatrix.Builder.newInstance(true);
+		costMatrixBuilder.addTransportDistance("0", "1", 10.0);
+		costMatrixBuilder.addTransportDistance("0", "2", 20.0);
+		costMatrixBuilder.addTransportDistance("0", "3", 5.0);
+		costMatrixBuilder.addTransportDistance("1", "2", 4.0);
+		costMatrixBuilder.addTransportDistance("1", "3", 1.0);
+		costMatrixBuilder.addTransportDistance("2", "3", 2.0);
+		
+		costMatrixBuilder.addTransportTime("0", "1", 10.0);
+		costMatrixBuilder.addTransportTime("0", "2", 20.0);
+		costMatrixBuilder.addTransportTime("0", "3", 5.0);
+		costMatrixBuilder.addTransportTime("1", "2", 4.0);
+		costMatrixBuilder.addTransportTime("1", "3", 1.0);
+		costMatrixBuilder.addTransportTime("2", "3", 2.0);
+		
+		VehicleRoutingTransportCosts costMatrix = costMatrixBuilder.build();
+		
+		VehicleRoutingProblem vrp = VehicleRoutingProblem.Builder.newInstance().setFleetSize(FleetSize.INFINITE).setRoutingCost(costMatrix)
+				.addVehicle(vehicle).addService(s1).addService(s2).addService(s3).build();
+		
+		VehicleRoutingAlgorithm vra = VehicleRoutingAlgorithms.readAndCreateAlgorithm(vrp, "input/fastAlgo.xml");
+		
+		Collection<VehicleRoutingProblemSolution> solutions = vra.searchSolutions();
+		
+		SolutionPrinter.print(Solutions.getBest(solutions), Print.VERBOSE);
+				
+		SolutionPlotter.plotSolutionAsPNG(vrp, Solutions.getBest(solutions), "output/yo.png", "po");
+
+	}
+
+}

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

@@ -30,6 +30,8 @@ import java.util.HashMap;
 import java.util.Map;
 
 import util.Solutions;
+import util.VehicleRoutingTransportCostsMatrix;
+import util.VehicleRoutingTransportCostsMatrix.Builder;
 import algorithms.GreedySchrimpfFactory;
 import analysis.SolutionPrinter;
 import analysis.SolutionPrinter.Print;
@@ -179,13 +181,12 @@ public class RefuseCollectionExample {
 		readDemandQuantities(vrpBuilder);
 		
 		/*
-		 * read distances
+		 * create cost-matrix
 		 */
-		Map<RelationKey,Integer> distances = new HashMap<RelationKey, Integer>();
-		readDistances(distances);
+		VehicleRoutingTransportCostsMatrix.Builder matrixBuilder = VehicleRoutingTransportCostsMatrix.Builder.newInstance(true);
+		readDistances(matrixBuilder);
 
-		VehicleRoutingTransportCosts routingCosts = new RoutingCosts(distances);
-		vrpBuilder.setRoutingCost(routingCosts);
+		vrpBuilder.setRoutingCost(matrixBuilder.build());
 		
 		VehicleRoutingProblem vrp = vrpBuilder.build();
 		
@@ -199,6 +200,7 @@ public class RefuseCollectionExample {
 		
 	}
 
+
 	private static void readDemandQuantities(VehicleRoutingProblem.Builder vrpBuilder) throws FileNotFoundException, IOException {
 		BufferedReader reader = new BufferedReader(new FileReader(new File("input/RefuseCollectionExample_Quantities")));
 		String line = null;
@@ -221,7 +223,8 @@ public class RefuseCollectionExample {
 		reader.close();
 	}
 	
-	private static void readDistances(Map<RelationKey, Integer> distances) throws IOException {
+
+	private static void readDistances(Builder matrixBuilder) throws IOException {
 		BufferedReader reader = new BufferedReader(new FileReader(new File("input/RefuseCollectionExample_Distances")));
 		String line = null;
 		boolean firstLine = true;
@@ -231,8 +234,7 @@ public class RefuseCollectionExample {
 				continue;
 			}
 			String[] lineTokens = line.split(",");
-			RelationKey key = RelationKey.newKey(lineTokens[0],lineTokens[1]);
-			distances.put(key, Integer.parseInt(lineTokens[2]));
+			matrixBuilder.addTransportDistance(lineTokens[0],lineTokens[1], Integer.parseInt(lineTokens[2]));
 		}
 		reader.close();