TSP and VRP: rename getDistance() to getDistanceTo() to make it clear…

… which way an asymmetric distance it's going.

optaplanner-examples/src/main/java/org/optaplanner/examples/tsp/domain/Domicile.java

@@ -42,7 +42,7 @@ public void setLocation(Location location) {
      * @return a positive number, the distance multiplied by 1000 to avoid floating point arithmetic rounding errors
      */
     public long getDistanceTo(Standstill standstill) {
-        return location.getDistance(standstill.getLocation());
+        return location.getDistanceTo(standstill.getLocation());
     }
 
     @Override

optaplanner-examples/src/main/java/org/optaplanner/examples/tsp/domain/Visit.java

@@ -23,7 +23,6 @@
 import org.optaplanner.examples.common.domain.AbstractPersistable;
 import org.optaplanner.examples.tsp.domain.location.Location;
 import org.optaplanner.examples.tsp.domain.solver.DomicileAngleVisitDifficultyWeightFactory;
-import org.optaplanner.examples.tsp.domain.solver.LatitudeVisitDifficultyComparator;
 
 @PlanningEntity(difficultyWeightFactoryClass = DomicileAngleVisitDifficultyWeightFactory.class)
 @XStreamAlias("Visit")
@@ -71,15 +70,15 @@ public long getDistanceFromPreviousStandstill() {
      * @return a positive number, the distance multiplied by 1000 to avoid floating point arithmetic rounding errors
      */
     public long getDistanceFrom(Standstill standstill) {
-        return standstill.getLocation().getDistance(location);
+        return standstill.getLocation().getDistanceTo(location);
     }
 
     /**
      * @param standstill never null
      * @return a positive number, the distance multiplied by 1000 to avoid floating point arithmetic rounding errors
      */
     public long getDistanceTo(Standstill standstill) {
-        return location.getDistance(standstill.getLocation());
+        return location.getDistanceTo(standstill.getLocation());
     }
 
     @Override

optaplanner-examples/src/main/java/org/optaplanner/examples/tsp/domain/location/AirLocation.java

@@ -33,8 +33,8 @@ public AirLocation(long id, double latitude, double longitude) {
     }
 
     @Override
-    public long getDistance(Location location) {
-        double distance = getAirDistanceDouble(location);
+    public long getDistanceTo(Location location) {
+        double distance = getAirDistanceDoubleTo(location);
         // Multiplied by 1000 to avoid floating point arithmetic rounding errors
         return (long) (distance * 1000.0 + 0.5);
     }

optaplanner-examples/src/main/java/org/optaplanner/examples/tsp/domain/location/Location.java

@@ -75,9 +75,9 @@ public void setLongitude(double longitude) {
      * @param location never null
      * @return a positive number, the distance multiplied by 1000 to avoid floating point arithmetic rounding errors
      */
-    public abstract long getDistance(Location location);
+    public abstract long getDistanceTo(Location location);
 
-    public double getAirDistanceDouble(Location location) {
+    public double getAirDistanceDoubleTo(Location location) {
         // Implementation specified by TSPLIB http://www2.iwr.uni-heidelberg.de/groups/comopt/software/TSPLIB95/
         // Euclidean distance (Pythagorean theorem) - not correct when the surface is a sphere
         double latitudeDifference = location.latitude - latitude;

optaplanner-examples/src/main/java/org/optaplanner/examples/tsp/domain/location/RoadLocation.java

@@ -47,7 +47,7 @@ public void setTravelDistanceMap(Map<RoadLocation, Double> travelDistanceMap) {
     }
 
     @Override
-    public long getDistance(Location location) {
+    public long getDistanceTo(Location location) {
         if (this == location) {
             return 0L;
         }

optaplanner-examples/src/main/java/org/optaplanner/examples/tsp/domain/solver/DomicileAngleVisitDifficultyWeightFactory.java

@@ -32,8 +32,8 @@ public Comparable createSorterWeight(TravelingSalesmanTour vehicleRoutingSolutio
         Domicile domicile = vehicleRoutingSolution.getDomicile();
         return new DomicileAngleVisitDifficultyWeight(visit,
                 visit.getLocation().getAngle(domicile.getLocation()),
-                visit.getLocation().getDistance(domicile.getLocation())
-                        + domicile.getLocation().getDistance(visit.getLocation()));
+                visit.getLocation().getDistanceTo(domicile.getLocation())
+                        + domicile.getLocation().getDistanceTo(visit.getLocation()));
     }
 
     public static class DomicileAngleVisitDifficultyWeight

optaplanner-examples/src/main/java/org/optaplanner/examples/vehiclerouting/domain/Customer.java

@@ -106,15 +106,15 @@ public int getDistanceFromPreviousStandstill() {
      * @return a positive number, the distance multiplied by 1000 to avoid floating point arithmetic rounding errors
      */
     public int getDistanceFrom(Standstill standstill) {
-        return standstill.getLocation().getDistance(location);
+        return standstill.getLocation().getDistanceTo(location);
     }
 
     /**
      * @param standstill never null
      * @return a positive number, the distance multiplied by 1000 to avoid floating point arithmetic rounding errors
      */
     public int getDistanceTo(Standstill standstill) {
-        return location.getDistance(standstill.getLocation());
+        return location.getDistanceTo(standstill.getLocation());
     }
 
     @Override

optaplanner-examples/src/main/java/org/optaplanner/examples/vehiclerouting/domain/Depot.java

@@ -47,7 +47,7 @@ public void setLocation(Location location) {
      * @return a positive number, the distance multiplied by 1000 to avoid floating point arithmetic rounding errors
      */
     public int getDistanceTo(Standstill standstill) {
-        return location.getDistance(standstill.getLocation());
+        return location.getDistanceTo(standstill.getLocation());
     }
 
 }

optaplanner-examples/src/main/java/org/optaplanner/examples/vehiclerouting/domain/location/AirLocation.java

@@ -33,8 +33,8 @@ public AirLocation(long id, double latitude, double longitude) {
     }
 
     @Override
-    public int getDistance(Location location) {
-        double distance = getAirDistanceDouble(location);
+    public int getDistanceTo(Location location) {
+        double distance = getAirDistanceDoubleTo(location);
         // Multiplied by 1000 to avoid floating point arithmetic rounding errors
         return (int) (distance * 1000.0 + 0.5);
     }

optaplanner-examples/src/main/java/org/optaplanner/examples/vehiclerouting/domain/location/Location.java

@@ -75,9 +75,9 @@ public void setLongitude(double longitude) {
      * @param location never null
      * @return a positive number, the distance multiplied by 1000 to avoid floating point arithmetic rounding errors
      */
-    public abstract int getDistance(Location location);
+    public abstract int getDistanceTo(Location location);
 
-    public double getAirDistanceDouble(Location location) {
+    public double getAirDistanceDoubleTo(Location location) {
         // Implementation specified by TSPLIB http://www2.iwr.uni-heidelberg.de/groups/comopt/software/TSPLIB95/
         // Euclidean distance (Pythagorean theorem) - not correct when the surface is a sphere
         double latitudeDifference = location.latitude - latitude;

optaplanner-examples/src/main/java/org/optaplanner/examples/vehiclerouting/domain/location/RoadLocation.java

@@ -47,7 +47,7 @@ public void setTravelDistanceMap(Map<RoadLocation, Double> travelDistanceMap) {
     }
 
     @Override
-    public int getDistance(Location location) {
+    public int getDistanceTo(Location location) {
         if (this == location) {
             return 0;
         }

optaplanner-examples/src/main/java/org/optaplanner/examples/vehiclerouting/domain/location/segmented/HubSegmentLocation.java

@@ -57,7 +57,7 @@ public void setHubTravelDistanceMap(Map<HubSegmentLocation, Double> hubTravelDis
     }
 
     @Override
-    public int getDistance(Location location) {
+    public int getDistanceTo(Location location) {
         double distance;
         if (location instanceof RoadSegmentLocation) {
             distance = getDistanceDouble((RoadSegmentLocation) location);

optaplanner-examples/src/main/java/org/optaplanner/examples/vehiclerouting/domain/location/segmented/RoadSegmentLocation.java

@@ -59,7 +59,7 @@ public void setHubTravelDistanceMap(Map<HubSegmentLocation, Double> hubTravelDis
     }
 
     @Override
-    public int getDistance(Location location) {
+    public int getDistanceTo(Location location) {
         Double distance = getDistanceDouble((RoadSegmentLocation) location);
         // Multiplied by 1000 to avoid floating point arithmetic rounding errors
         return (int) (distance * 1000.0 + 0.5);

optaplanner-examples/src/main/java/org/optaplanner/examples/vehiclerouting/domain/solver/DepotAngleCustomerDifficultyWeightFactory.java

@@ -32,8 +32,8 @@ public Comparable createSorterWeight(VehicleRoutingSolution vehicleRoutingSoluti
         Depot depot = vehicleRoutingSolution.getDepotList().get(0);
         return new DepotAngleCustomerDifficultyWeight(customer,
                 customer.getLocation().getAngle(depot.getLocation()),
-                customer.getLocation().getDistance(depot.getLocation())
-                        + depot.getLocation().getDistance(customer.getLocation()));
+                customer.getLocation().getDistanceTo(depot.getLocation())
+                        + depot.getLocation().getDistanceTo(customer.getLocation()));
     }
 
     public static class DepotAngleCustomerDifficultyWeight

optaplanner-examples/src/main/java/org/optaplanner/examples/vehiclerouting/domain/solver/DepotDistanceCustomerDifficultyWeightFactory.java

@@ -31,8 +31,8 @@ public class DepotDistanceCustomerDifficultyWeightFactory
     public Comparable createSorterWeight(VehicleRoutingSolution vehicleRoutingSolution, Customer customer) {
         Depot depot = vehicleRoutingSolution.getDepotList().get(0);
         return new DepotDistanceCustomerDifficultyWeight(customer,
-                customer.getLocation().getDistance(depot.getLocation())
-                        + depot.getLocation().getDistance(customer.getLocation()));
+                customer.getLocation().getDistanceTo(depot.getLocation())
+                        + depot.getLocation().getDistanceTo(customer.getLocation()));
     }
 
     public static class DepotDistanceCustomerDifficultyWeight

optaplanner-examples/src/main/java/org/optaplanner/examples/vehiclerouting/persistence/VehicleRoutingImporter.java

@@ -468,7 +468,7 @@ private void readTimeWindowedDepotAndCustomers() throws IOException {
                     customer.setReadyTime(readyTime);
                     // Score constraint arrivalAfterDueTimeAtDepot is a build-in hard constraint in VehicleRoutingImporter
                     int maximumDueTime = depot.getDueTime()
-                            - serviceDuration - location.getDistance(depot.getLocation());
+                            - serviceDuration - location.getDistanceTo(depot.getLocation());
                     if (dueTime > maximumDueTime) {
                         logger.warn("The customer ({})'s dueTime ({}) was automatically reduced" +
                                 " to maximumDueTime ({}) because of the depot's dueTime ({}).",

optaplanner-examples/src/main/java/org/optaplanner/examples/vehiclerouting/solver/score/VehicleRoutingEasyScoreCalculator.java

@@ -50,7 +50,7 @@ public HardSoftScore calculateScore(VehicleRoutingSolution solution) {
                 softScore -= customer.getDistanceFromPreviousStandstill();
                 if (customer.getNextCustomer() == null) {
                     // Score constraint distanceFromLastCustomerToDepot
-                    softScore -= customer.getLocation().getDistance(vehicle.getLocation());
+                    softScore -= customer.getLocation().getDistanceTo(vehicle.getLocation());
                 }
                 if (timeWindowed) {
                     TimeWindowedCustomer timeWindowedCustomer = (TimeWindowedCustomer) customer;

optaplanner-examples/src/main/java/org/optaplanner/examples/vehiclerouting/solver/score/VehicleRoutingIncrementalScoreCalculator.java

@@ -149,7 +149,7 @@ private void insertVehicle(Customer customer) {
             vehicleDemandMap.put(vehicle, newDemand);
             if (customer.getNextCustomer() == null) {
                 // Score constraint distanceFromLastCustomerToDepot
-                softScore -= customer.getLocation().getDistance(vehicle.getLocation());
+                softScore -= customer.getLocation().getDistanceTo(vehicle.getLocation());
             }
         }
     }
@@ -165,7 +165,7 @@ private void retractVehicle(Customer customer) {
             vehicleDemandMap.put(vehicle, newDemand);
             if (customer.getNextCustomer() == null) {
                 // Score constraint distanceFromLastCustomerToDepot
-                softScore += customer.getLocation().getDistance(vehicle.getLocation());
+                softScore += customer.getLocation().getDistanceTo(vehicle.getLocation());
             }
         }
     }
@@ -175,7 +175,7 @@ private void insertNextCustomer(Customer customer) {
         if (vehicle != null) {
             if (customer.getNextCustomer() == null) {
                 // Score constraint distanceFromLastCustomerToDepot
-                softScore -= customer.getLocation().getDistance(vehicle.getLocation());
+                softScore -= customer.getLocation().getDistanceTo(vehicle.getLocation());
             }
         }
     }
@@ -185,7 +185,7 @@ private void retractNextCustomer(Customer customer) {
         if (vehicle != null) {
             if (customer.getNextCustomer() == null) {
                 // Score constraint distanceFromLastCustomerToDepot
-                softScore += customer.getLocation().getDistance(vehicle.getLocation());
+                softScore += customer.getLocation().getDistanceTo(vehicle.getLocation());
             }
         }
     }

optaplanner-examples/src/test/java/org/optaplanner/examples/vehiclerouting/domain/location/segmented/RoadSegmentLocationTest.java

@@ -51,25 +51,25 @@ public void getDistance() {
         z.setNearbyTravelDistanceMap(createNearbyTravelDistanceMap(z, d));
         z.setHubTravelDistanceMap(createHubTravelDistanceMap(z, x, y));
 
-        assertEquals(sumOfArcs(a, b), a.getDistance(b));
-        assertEquals(sumOfArcs(a, c), a.getDistance(c));
-        assertEquals(sumOfArcs(a, x, z, d), a.getDistance(d));
-        assertEquals(sumOfArcs(b, a), b.getDistance(a));
-        assertEquals(sumOfArcs(b, y, c), b.getDistance(c));
-        assertEquals(sumOfArcs(b, y, z, d), b.getDistance(d));
-        assertEquals(sumOfArcs(c, a), c.getDistance(a));
-        assertEquals(sumOfArcs(c, y, b), c.getDistance(b));
-        assertEquals(sumOfArcs(c, x, z, d), c.getDistance(d));
-        assertEquals(sumOfArcs(d, z, x, a), d.getDistance(a));
-        assertEquals(sumOfArcs(d, z, y, b), d.getDistance(b));
-        assertEquals(sumOfArcs(d, z, x, c), d.getDistance(c));
+        assertEquals(sumOfArcs(a, b), a.getDistanceTo(b));
+        assertEquals(sumOfArcs(a, c), a.getDistanceTo(c));
+        assertEquals(sumOfArcs(a, x, z, d), a.getDistanceTo(d));
+        assertEquals(sumOfArcs(b, a), b.getDistanceTo(a));
+        assertEquals(sumOfArcs(b, y, c), b.getDistanceTo(c));
+        assertEquals(sumOfArcs(b, y, z, d), b.getDistanceTo(d));
+        assertEquals(sumOfArcs(c, a), c.getDistanceTo(a));
+        assertEquals(sumOfArcs(c, y, b), c.getDistanceTo(b));
+        assertEquals(sumOfArcs(c, x, z, d), c.getDistanceTo(d));
+        assertEquals(sumOfArcs(d, z, x, a), d.getDistanceTo(a));
+        assertEquals(sumOfArcs(d, z, y, b), d.getDistanceTo(b));
+        assertEquals(sumOfArcs(d, z, x, c), d.getDistanceTo(c));
     }
 
     protected int sumOfArcs(Location fromLocation, Location... stopLocations) {
         Location previousLocation = fromLocation;
         int distance = 0;
         for (Location stopLocation : stopLocations) {
-            distance += (int) (previousLocation.getAirDistanceDouble(stopLocation) * 1000.0 + 0.5);
+            distance += (int) (previousLocation.getAirDistanceDoubleTo(stopLocation) * 1000.0 + 0.5);
             previousLocation = stopLocation;
         }
         return distance;
@@ -78,7 +78,7 @@ protected int sumOfArcs(Location fromLocation, Location... stopLocations) {
     private Map<HubSegmentLocation, Double> createHubTravelDistanceMap(Location fromLocation, HubSegmentLocation... toLocations) {
         Map<HubSegmentLocation, Double> map = new LinkedHashMap<HubSegmentLocation, Double>(toLocations.length);
         for (HubSegmentLocation toLocation : toLocations) {
-            map.put(toLocation, fromLocation.getAirDistanceDouble(toLocation));
+            map.put(toLocation, fromLocation.getAirDistanceDoubleTo(toLocation));
         }
         return map;
     }
@@ -87,7 +87,7 @@ protected Map<RoadSegmentLocation, Double> createNearbyTravelDistanceMap(Locatio
             RoadSegmentLocation... toLocations) {
         Map<RoadSegmentLocation, Double> map = new LinkedHashMap<RoadSegmentLocation, Double>(toLocations.length);
         for (RoadSegmentLocation toLocation : toLocations) {
-            map.put(toLocation, fromLocation.getAirDistanceDouble(toLocation));
+            map.put(toLocation, fromLocation.getAirDistanceDoubleTo(toLocation));
         }
         return map;
     }