relax API

jsprit-core/src/main/java/algorithms/ActivityInsertionCostCalculator.java

@@ -22,7 +22,7 @@ package algorithms;
 
 import basics.route.TourActivity;
 
-interface MarginalsCalculus {
+interface ActivityInsertionCostCalculator {
 	
 	class Marginals {
 		
@@ -52,4 +52,6 @@ interface MarginalsCalculus {
 	
 	Marginals calculate(InsertionContext iContext, TourActivity prevAct, TourActivity nextAct, TourActivity newAct, double depTimeAtPrevAct);
 	
+	
+
 }

jsprit-core/src/main/java/algorithms/BestInsertionBuilder.java

@@ -0,0 +1,34 @@
+package algorithms;
+
+import basics.VehicleRoutingProblem;
+import algorithms.HardConstraints.HardActivityLevelConstraint;
+import algorithms.HardConstraints.HardRouteLevelConstraint;
+
+public class BestInsertionBuilder implements InsertionStrategyBuilder{
+
+	private VehicleRoutingProblem vrp;
+	
+	private StateManager stateManager;
+	
+	public BestInsertionBuilder(VehicleRoutingProblem vrp, StateManager stateManager) {
+		super();
+		this.vrp = vrp;
+		this.stateManager = stateManager;
+	}
+
+	public void addConstraint(HardActivityLevelConstraint hardActvitiyLevelConstraint){};
+	
+	public void addConstraint(HardRouteLevelConstraint hardRouteLevelConstraint){};
+	
+	public void setRouteLevel(int forwardLooking, int memory){};
+	
+	public void setLocalLevel(){};
+	
+	public void setActivityInsertionCostCalculator(ActivityInsertionCostCalculator costCalc){};
+	
+	@Override
+	public InsertionStrategy build() {
+		return null;
+	}
+
+}

jsprit-core/src/main/java/algorithms/CalculatesServiceInsertion.java

@@ -16,7 +16,7 @@ import org.apache.log4j.Logger;
 
 import util.Neighborhood;
 import algorithms.HardConstraints.HardRouteLevelConstraint;
-import algorithms.MarginalsCalculus.Marginals;
+import algorithms.ActivityInsertionCostCalculator.Marginals;
 import basics.Job;
 import basics.Service;
 import basics.costs.VehicleRoutingTransportCosts;
@@ -47,7 +47,7 @@ final class CalculatesServiceInsertion implements JobInsertionCalculator{
 		}
 	};
 	
-	private MarginalsCalculus marginalCalculus;
+	private ActivityInsertionCostCalculator marginalCalculus;
 	
 	private VehicleRoutingTransportCosts transportCosts;
 	
@@ -58,7 +58,7 @@ final class CalculatesServiceInsertion implements JobInsertionCalculator{
 		logger.info("initialise neighborhood " + neighborhood);
 	}
 	
-	public CalculatesServiceInsertion(VehicleRoutingTransportCosts routingCosts, MarginalsCalculus marginalsCalculus, HardRouteLevelConstraint hardRouteLevelConstraint) {
+	public CalculatesServiceInsertion(VehicleRoutingTransportCosts routingCosts, ActivityInsertionCostCalculator marginalsCalculus, HardRouteLevelConstraint hardRouteLevelConstraint) {
 		super();
 		this.marginalCalculus = marginalsCalculus;
 		this.hardRouteLevelConstraint = hardRouteLevelConstraint;

jsprit-core/src/main/java/algorithms/CalculatorBuilder.java

@@ -219,7 +219,7 @@ class CalculatorBuilder {
 	private CalculatorPlusListeners createStandardLocal(VehicleRoutingProblem vrp, StateManager statesManager){
 		if(constraintManager == null) throw new IllegalStateException("constraint-manager is null");
  		
-		MarginalsCalculus defaultCalc = new MarginalsCalculusTriangleInequality(vrp.getTransportCosts(), vrp.getActivityCosts(), constraintManager);
+		ActivityInsertionCostCalculator defaultCalc = new MarginalsCalculusTriangleInequality(vrp.getTransportCosts(), vrp.getActivityCosts(), constraintManager);
 		JobInsertionCalculator standardServiceInsertion = new CalculatesServiceInsertion(vrp.getTransportCosts(), defaultCalc, constraintManager);
 		
 		((CalculatesServiceInsertion) standardServiceInsertion).setNeighborhood(vrp.getNeighborhood());

jsprit-core/src/main/java/algorithms/EuclideanServiceDistance.java

@@ -23,7 +23,7 @@ class EuclideanServiceDistance implements JobDistance {
 	}
 
 	@Override
-	public double calculateDistance(Job i, Job j) {
+	public double getDistance(Job i, Job j) {
 		double avgCost = 0.0;
 		if (i instanceof Service && j instanceof Service) {
 			if (i.equals(j)) {

jsprit-core/src/main/java/algorithms/InsertionStrategy.java

@@ -27,7 +27,7 @@ import basics.route.VehicleRoute;
  * 
  */
 
-interface InsertionStrategy {
+public interface InsertionStrategy {
 
 	class Insertion {
 		

jsprit-core/src/main/java/algorithms/InsertionStrategyBuilder.java

@@ -0,0 +1,7 @@
+package algorithms;
+
+public interface InsertionStrategyBuilder {
+	
+	public InsertionStrategy build();
+
+}

jsprit-core/src/main/java/algorithms/JobDistance.java

@@ -16,8 +16,8 @@ import basics.Job;
 
 
 
-interface JobDistance {
+public interface JobDistance {
 
-	public double calculateDistance(Job i, Job j);
+	public double getDistance(Job i, Job j);
 
 }

jsprit-core/src/main/java/algorithms/JobDistanceAvgCosts.java

@@ -45,7 +45,7 @@ class JobDistanceAvgCosts implements JobDistance {
 	 * <p>If the distance between two jobs cannot be calculated with input-transport costs, it tries the euclidean distance between these jobs.
 	 */ 
 	@Override
-	public double calculateDistance(Job i, Job j) {
+	public double getDistance(Job i, Job j) {
 		double avgCost = 0.0;
 		if (i instanceof Service && j instanceof Service) {
 			if (i.equals(j)) {
@@ -72,7 +72,7 @@ class JobDistanceAvgCosts implements JobDistance {
 			// now try the euclidean distance between these two services
 		}
 		EuclideanServiceDistance euclidean = new EuclideanServiceDistance();
-		distance = euclidean.calculateDistance(s_i, s_j);
+		distance = euclidean.getDistance(s_i, s_j);
 		return distance;
 	}
 

jsprit-core/src/main/java/algorithms/JobDistanceBeeline.java

@@ -29,7 +29,7 @@ class JobDistanceBeeline implements JobDistance {
 	}
 
 	@Override
-	public double calculateDistance(Job i, Job j) {
+	public double getDistance(Job i, Job j) {
 		double avgCost = 0.0;
 		if (i instanceof Service && j instanceof Service) {
 			if (i.equals(j)) {

jsprit-core/src/main/java/algorithms/MarginalsCalculusTriangleInequality.java

@@ -25,7 +25,7 @@ import basics.costs.VehicleRoutingActivityCosts;
 import basics.costs.VehicleRoutingTransportCosts;
 import basics.route.TourActivity;
 
-class MarginalsCalculusTriangleInequality implements MarginalsCalculus{
+class MarginalsCalculusTriangleInequality implements ActivityInsertionCostCalculator{
 
 	private HardActivityLevelConstraint hardConstraint;
 

jsprit-core/src/main/java/algorithms/RadialRuinStrategyFactory.java

@@ -0,0 +1,22 @@
+package algorithms;
+
+import basics.VehicleRoutingProblem;
+
+public class RadialRuinStrategyFactory implements RuinStrategyFactory{
+
+	private double fraction;
+	
+	private JobDistance jobDistance;
+	
+	public RadialRuinStrategyFactory(double fraction, JobDistance jobDistance) {
+		super();
+		this.fraction = fraction;
+		this.jobDistance = jobDistance;
+	}
+
+	@Override
+	public RuinStrategy createStrategy(VehicleRoutingProblem vrp) {
+		return new RuinRadial(vrp,fraction,jobDistance);
+	}
+
+}

jsprit-core/src/main/java/algorithms/RandomRuinStrategyFactory.java

@@ -0,0 +1,19 @@
+package algorithms;
+
+import basics.VehicleRoutingProblem;
+
+public class RandomRuinStrategyFactory implements RuinStrategyFactory{
+
+	private double fraction;
+	
+	public RandomRuinStrategyFactory(double fraction) {
+		super();
+		this.fraction = fraction;
+	}
+
+	@Override
+	public RuinStrategy createStrategy(VehicleRoutingProblem vrp) {
+		return new RuinRandom(vrp, fraction);
+	}
+
+}

jsprit-core/src/main/java/algorithms/RuinAndRecreateModule.java

@@ -30,7 +30,7 @@ import basics.algo.InsertionListener;
 import basics.algo.SearchStrategyModule;
 import basics.algo.SearchStrategyModuleListener;
 
-class RuinAndRecreateModule implements SearchStrategyModule{
+public class RuinAndRecreateModule implements SearchStrategyModule{
 
 	private InsertionStrategy insertion;
 	
@@ -49,9 +49,13 @@ class RuinAndRecreateModule implements SearchStrategyModule{
 	public VehicleRoutingProblemSolution runAndGetSolution(VehicleRoutingProblemSolution vrpSolution) {
 		Collection<Job> ruinedJobs = ruin.ruin(vrpSolution.getRoutes());
 		insertion.insertJobs(vrpSolution.getRoutes(), ruinedJobs);
+		scoreSolution(vrpSolution);
+		return vrpSolution;
+	}
+
+	private void scoreSolution(VehicleRoutingProblemSolution vrpSolution) {
 		double totalCost = RouteUtils.getTotalCost(vrpSolution.getRoutes());
 		vrpSolution.setCost(totalCost);
-		return vrpSolution;
 	}
 
 	@Override

jsprit-core/src/main/java/algorithms/RuinRadial.java

@@ -106,7 +106,7 @@ final class RuinRadial implements RuinStrategy {
 					});
 			distanceNodeTree.put(i.getId(), treeSet);
 			for (Job j : vrp.getJobs().values()) {
-				double distance = jobDistance.calculateDistance(i, j);
+				double distance = jobDistance.getDistance(i, j);
 				ReferencedJob refNode = new ReferencedJob(j, distance);
 				treeSet.add(refNode);
 				nuOfDistancesStored++;

jsprit-core/src/main/java/algorithms/RuinStrategy.java

@@ -26,7 +26,7 @@ import basics.route.VehicleRoute;
  * 
  */
 
-interface RuinStrategy {
+public interface RuinStrategy {
 	
 	/**
 	 * Listener that listens to the ruin-process. It informs whoever is interested about start, end and about a removal of a job.

jsprit-core/src/main/java/algorithms/RuinStrategyFactory.java

@@ -22,7 +22,7 @@ package algorithms;
 
 import basics.VehicleRoutingProblem;
 
-interface RuinStrategyFactory {
+public interface RuinStrategyFactory {
 	
 	public RuinStrategy createStrategy(VehicleRoutingProblem vrp);
 

jsprit-core/src/main/java/algorithms/StateManager.java

@@ -23,7 +23,7 @@ package algorithms;
 import basics.route.TourActivity;
 import basics.route.VehicleRoute;
 
-interface StateManager {
+public interface StateManager {
 	
 	interface State {
 		double toDouble();

jsprit-core/src/test/java/algorithms/BuildCVRPAlgoFromScratchTest.java

@@ -62,7 +62,7 @@ public class BuildCVRPAlgoFromScratchTest {
 				return true;
 			}
 		};
-		MarginalsCalculus marginalCalculus = new MarginalsCalculusTriangleInequality(vrp.getTransportCosts(), vrp.getActivityCosts(), hardActLevelConstraint);
+		ActivityInsertionCostCalculator marginalCalculus = new MarginalsCalculusTriangleInequality(vrp.getTransportCosts(), vrp.getActivityCosts(), hardActLevelConstraint);
 		CalculatesServiceInsertion serviceInsertion = new CalculatesServiceInsertion(vrp.getTransportCosts(), marginalCalculus, new HardConstraints.HardLoadConstraint(stateManager));
 		
 		VehicleFleetManager fleetManager = new InfiniteVehicles(vrp.getVehicles());

jsprit-core/src/test/java/algorithms/BuildPDVRPAlgoFromScratchTest.java

@@ -78,7 +78,7 @@ public class BuildPDVRPAlgoFromScratchTest {
 			actLevelConstraintAccumulator.addConstraint(new HardConstraints.HardPickupAndDeliveryActivityLevelConstraint(stateManager));
 			actLevelConstraintAccumulator.addConstraint(new HardConstraints.HardTimeWindowActivityLevelConstraint(stateManager, vrp.getTransportCosts()));
 			
-			MarginalsCalculus marginalCalculus = new MarginalsCalculusTriangleInequality(vrp.getTransportCosts(), vrp.getActivityCosts(), actLevelConstraintAccumulator);
+			ActivityInsertionCostCalculator marginalCalculus = new MarginalsCalculusTriangleInequality(vrp.getTransportCosts(), vrp.getActivityCosts(), actLevelConstraintAccumulator);
 
 			CalculatesServiceInsertion serviceInsertion = new CalculatesServiceInsertion(vrp.getTransportCosts(), marginalCalculus, new HardConstraints.HardPickupAndDeliveryLoadConstraint(stateManager));
 //			CalculatesServiceInsertion serviceInsertion = new CalculatesServiceInsertion(vrp.getTransportCosts(), marginalCalculus, new HardConstraints.HardLoadConstraint(stateManager));
@@ -105,7 +105,6 @@ public class BuildPDVRPAlgoFromScratchTest {
 			
 			vra = new VehicleRoutingAlgorithm(vrp, strategyManager);
 	
-			
 			vra.getAlgorithmListeners().addListener(new StateUpdates.ResetStateManager(stateManager));
 			
 			final IterateRouteForwardInTime iterateForward = new IterateRouteForwardInTime(vrp.getTransportCosts());

jsprit-core/src/test/java/algorithms/TestJobDistanceAvgCosts.java

@@ -60,7 +60,7 @@ public class TestJobDistanceAvgCosts {
 			}
 		};
 		JobDistanceAvgCosts c = new JobDistanceAvgCosts(costs);
-		c.calculateDistance(Service.Builder.newInstance("1", 1).setLocationId("foo").build(), Service.Builder.newInstance("2", 2).setLocationId("foo").build());
+		c.getDistance(Service.Builder.newInstance("1", 1).setLocationId("foo").build(), Service.Builder.newInstance("2", 2).setLocationId("foo").build());
 	}
 	
 	@Test(expected=NullPointerException.class)
@@ -96,7 +96,7 @@ public class TestJobDistanceAvgCosts {
 			}
 		};
 		JobDistanceAvgCosts c = new JobDistanceAvgCosts(costs);
-		c.calculateDistance(Service.Builder.newInstance("1", 1).setLocationId("loc").build(), Service.Builder.newInstance("2", 2).setLocationId("loc").build());
+		c.getDistance(Service.Builder.newInstance("1", 1).setLocationId("loc").build(), Service.Builder.newInstance("2", 2).setLocationId("loc").build());
 	}
 
 }