From 7011ad8c8e9c4b0d6c197347967217d28e32f660 Mon Sep 17 00:00:00 2001 From: oblonski <4sschroeder@gmail.com> Date: Wed, 17 Jul 2013 11:56:39 +0200 Subject: [PATCH] Add VehicleRoutingTransportCostsMatrix to allow considering pre-compiled time and/or distance matrices. The CostMatrixExample illustrates its use. --- .../VehicleRoutingTransportCostsMatrix.java | 56 ++++++++++++++++++- .../main/java/examples/CostMatrixExample.java | 12 +++- 2 files changed, 65 insertions(+), 3 deletions(-) diff --git a/jsprit-core/src/main/java/util/VehicleRoutingTransportCostsMatrix.java b/jsprit-core/src/main/java/util/VehicleRoutingTransportCostsMatrix.java index 2832d66c..4410e18f 100644 --- a/jsprit-core/src/main/java/util/VehicleRoutingTransportCostsMatrix.java +++ b/jsprit-core/src/main/java/util/VehicleRoutingTransportCostsMatrix.java @@ -10,7 +10,16 @@ import basics.route.Driver; import basics.route.Vehicle; import basics.route.VehicleTypeImpl.VehicleCostParams; - +/** + * CostMatrix that allows pre-compiled time and distance-matrices to be considered as {@link VehicleRoutingRoutingCosts} + * in the {@link VehicleRoutingProblem}. + *

Note that you can also use it with distance matrix only (or time matrix). But ones + * you set a particular distance, this expects distance-entries for all relations. This counts also + * for a particular time. If the method getTransportCosts(...) is then invoked for a relation, where no distance can be found, an + * IllegalStateException will be thrown. Thus if you want to only use distances only, do not use addTransportTime(...). + * @author schroeder + * + */ public class VehicleRoutingTransportCostsMatrix implements VehicleRoutingTransportCosts { static class RelationKey { @@ -74,7 +83,12 @@ public class VehicleRoutingTransportCostsMatrix implements VehicleRoutingTranspo } - + /** + * Builder that builds the matrix. + * + * @author schroeder + * + */ public static class Builder { private static Logger log = Logger.getLogger(Builder.class); @@ -84,6 +98,16 @@ public class VehicleRoutingTransportCostsMatrix implements VehicleRoutingTranspo private Map times = new HashMap(); + private boolean distancesSet = false; + + private boolean timesSet = false; + + /** + * Creates a new builder returning the matrix-builder. + *

If you want to consider symmetric matrices, set isSymmetric to true. + * @param isSymmetric + * @return + */ public static Builder newInstance(boolean isSymmetric){ return new Builder(isSymmetric); } @@ -92,8 +116,16 @@ public class VehicleRoutingTransportCostsMatrix implements VehicleRoutingTranspo this.isSymmetric = isSymmetric; } + /** + * Adds a transport-distance for a particular relation. + * @param from + * @param to + * @param distance + * @return + */ public Builder addTransportDistance(String from, String to, double distance){ RelationKey key = RelationKey.newKey(from, to); + if(!distancesSet) distancesSet = true; if(distances.containsKey(key)){ log.warn("distance from " + from + " to " + to + " already exists. This overrides distance."); } @@ -101,8 +133,16 @@ public class VehicleRoutingTransportCostsMatrix implements VehicleRoutingTranspo return this; } + /** + * Adds transport-time for a particular relation. + * @param from + * @param to + * @param time + * @return + */ public Builder addTransportTime(String from, String to, double time){ RelationKey key = RelationKey.newKey(from, to); + if(!timesSet) timesSet = true; if(times.containsKey(key)){ log.warn("transport-time from " + from + " to " + to + " already exists. This overrides distance."); } @@ -110,6 +150,10 @@ public class VehicleRoutingTransportCostsMatrix implements VehicleRoutingTranspo return this; } + /** + * Builds the matrix. + * @return + */ public VehicleRoutingTransportCostsMatrix build(){ return new VehicleRoutingTransportCostsMatrix(this); } @@ -121,10 +165,16 @@ public class VehicleRoutingTransportCostsMatrix implements VehicleRoutingTranspo private boolean isSymmetric; + private boolean timesSet; + + private boolean distancesSet; + private VehicleRoutingTransportCostsMatrix(Builder builder){ this.isSymmetric = builder.isSymmetric; distances.putAll(builder.distances); times.putAll(builder.times); + timesSet = builder.timesSet; + distancesSet = builder.distancesSet; } @@ -136,6 +186,7 @@ public class VehicleRoutingTransportCostsMatrix implements VehicleRoutingTranspo private double getTime(String fromId, String toId) { if(fromId.equals(toId)) return 0.0; + if(!timesSet) return 0.0; RelationKey key = RelationKey.newKey(fromId, toId); if(!isSymmetric){ if(times.containsKey(key)) return times.get(key); @@ -153,6 +204,7 @@ public class VehicleRoutingTransportCostsMatrix implements VehicleRoutingTranspo private double getDistance(String fromId, String toId) { if(fromId.equals(toId)) return 0.0; + if(!distancesSet) return 0.0; RelationKey key = RelationKey.newKey(fromId, toId); if(!isSymmetric){ if(distances.containsKey(key)) return distances.get(key); diff --git a/jsprit-examples/src/main/java/examples/CostMatrixExample.java b/jsprit-examples/src/main/java/examples/CostMatrixExample.java index 85959b98..0ab81b4e 100644 --- a/jsprit-examples/src/main/java/examples/CostMatrixExample.java +++ b/jsprit-examples/src/main/java/examples/CostMatrixExample.java @@ -1,5 +1,6 @@ package examples; +import java.io.File; import java.util.Collection; import util.Solutions; @@ -32,7 +33,16 @@ public class CostMatrixExample { * @param args */ 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"); + } VehicleType type = VehicleTypeImpl.Builder.newInstance("type", 2).setCostPerDistance(1).setCostPerTime(2).build(); Vehicle vehicle = VehicleImpl.Builder.newInstance("vehicle").setLocationId("0").setType(type).build();