From f8f063773a4b5af37e9f6ede7f1fb1e944571068 Mon Sep 17 00:00:00 2001
From: oblonski <jsprit.vehicle.routing@gmail.com>
Date: Thu, 12 Feb 2015 20:33:08 +0100
Subject: [PATCH] add factory methods to Location to simplify location building

---
 .../toolbox/ComputationalLaboratory.java      | 60 +++++++++++++++----
 .../java/jsprit/core/problem/Location.java    | 31 ++++++++++
 .../jsprit/core/problem/LocationTest.java     | 23 +++++++
 3 files changed, 101 insertions(+), 13 deletions(-)

diff --git a/jsprit-analysis/src/main/java/jsprit/analysis/toolbox/ComputationalLaboratory.java b/jsprit-analysis/src/main/java/jsprit/analysis/toolbox/ComputationalLaboratory.java
index eb050838..0d3563a2 100644
--- a/jsprit-analysis/src/main/java/jsprit/analysis/toolbox/ComputationalLaboratory.java
+++ b/jsprit-analysis/src/main/java/jsprit/analysis/toolbox/ComputationalLaboratory.java
@@ -32,7 +32,11 @@ import java.util.concurrent.TimeUnit;
 
 
 public class ComputationalLaboratory {
-	
+
+	public static interface LabListener {
+
+	}
+
 	/**
 	 * Listener-interface to listen to calculation.
 	 * 
@@ -42,13 +46,20 @@ public class ComputationalLaboratory {
 	 * @author schroeder
 	 *
 	 */
-	public static interface CalculationListener {
+	public static interface CalculationListener extends LabListener{
 		
 		public void calculationStarts(final BenchmarkInstance p, final String algorithmName, final VehicleRoutingAlgorithm algorithm, final int run);
 		
 		public void calculationEnds(final BenchmarkInstance p, final String algorithmName, final VehicleRoutingAlgorithm algorithm, final int run, final Collection<VehicleRoutingProblemSolution> solutions);
 		
 	}
+
+	public static interface LabStartsAndEndsListener extends LabListener {
+
+		public void labStarts(List<BenchmarkInstance> instances, int noAlgorithms, int runs);
+
+		public void labEnds();
+	}
 	
 	/**
 	 * Collects whatever indicators you require by algorithmName, instanceName, run and indicator.
@@ -251,6 +262,8 @@ public class ComputationalLaboratory {
 	private int runs = 1;
 	
 	private Collection<CalculationListener> listeners = new ArrayList<ComputationalLaboratory.CalculationListener>();
+
+	private Collection<LabStartsAndEndsListener> startsAndEndslisteners = new ArrayList<LabStartsAndEndsListener>();
 	
 	private List<Algorithm> algorithms = new ArrayList<ComputationalLaboratory.Algorithm>();
 	
@@ -258,7 +271,7 @@ public class ComputationalLaboratory {
 	
 	private Set<String> instanceNames = new HashSet<String>();
 	
-	private int threads = Runtime.getRuntime().availableProcessors()+1;
+	private int threads = 1;
 	
 	public ComputationalLaboratory() {
 
@@ -335,11 +348,16 @@ public class ComputationalLaboratory {
 	
 	/**
 	 * Adds listener to listen computational experiments.
-	 * 
+	 *
 	 * @param listener
 	 */
-	public void addListener(CalculationListener listener){
-		listeners.add(listener);
+	public void addListener(LabListener listener){
+		if(listener instanceof CalculationListener) {
+			listeners.add((CalculationListener) listener);
+		}
+		if(listener instanceof LabStartsAndEndsListener){
+			startsAndEndslisteners.add((LabStartsAndEndsListener) listener);
+		}
 	}
 	
 	/**
@@ -372,6 +390,7 @@ public class ComputationalLaboratory {
 		if(benchmarkInstances.isEmpty()){
 			throw new IllegalStateException("no instance specified. at least one instance needs to be specified.");
 		}
+		informStart();
 		System.out.println("start benchmarking [nuAlgorithms="+algorithms.size()+"][nuInstances=" + benchmarkInstances.size() + "][runsPerInstance=" + runs + "]");
 		double startTime = System.currentTimeMillis();
 		ExecutorService executor = Executors.newFixedThreadPool(threads);
@@ -379,14 +398,16 @@ public class ComputationalLaboratory {
 			for(final BenchmarkInstance p : benchmarkInstances){
 				for(int run=0;run<runs;run++){
 					final int r = run;
-					executor.submit(new Runnable(){
+					runAlgorithm(p, algorithm, r+1);
 
-						@Override
-						public void run() {
-							runAlgorithm(p, algorithm, r+1);
-						}
-						
-					});
+//					executor.submit(new Runnable(){
+//
+//						@Override
+//						public void run() {
+//							;
+//						}
+//
+//					});
 				}
 			}
 		}
@@ -398,6 +419,19 @@ public class ComputationalLaboratory {
 			e.printStackTrace();
 		}
 		System.out.println("benchmarking done [time="+(System.currentTimeMillis()-startTime)/1000 + "sec]");
+		informEnd();
+	}
+
+	private void informEnd() {
+		for(LabStartsAndEndsListener l : startsAndEndslisteners){
+			l.labEnds();
+		}
+	}
+
+	private void informStart() {
+		for(LabStartsAndEndsListener l : startsAndEndslisteners){
+			l.labStarts(benchmarkInstances, algorithms.size(),runs);
+		}
 	}
 
 	/**
diff --git a/jsprit-core/src/main/java/jsprit/core/problem/Location.java b/jsprit-core/src/main/java/jsprit/core/problem/Location.java
index ac87ed14..2009e6da 100644
--- a/jsprit-core/src/main/java/jsprit/core/problem/Location.java
+++ b/jsprit-core/src/main/java/jsprit/core/problem/Location.java
@@ -24,6 +24,37 @@ import jsprit.core.util.Coordinate;
  */
 public final class Location implements HasIndex, HasId{
 
+    /**
+     * Factory method (and shortcut) for creating a location object just with x and y coordinates.
+     *
+     * @param x coordinate
+     * @param y coordinate
+     * @return location
+     */
+    public static Location newInstance(double x, double y){
+        return Location.Builder.newInstance().setCoordinate(Coordinate.newInstance(x,y)).build();
+    }
+
+    /**
+     * Factory method (and shortcut) for creating location object just with id
+     *
+     * @param id location id
+     * @return location
+     */
+    public static Location newInstance(String id){
+        return Location.Builder.newInstance().setId(id).build();
+    }
+
+    /**
+     * Factory method (and shortcut) for creating location object just with location index
+     *
+     * @param index
+     * @return
+     */
+    public static Location newInstance(int index){
+        return Location.Builder.newInstance().setIndex(index).build();
+    }
+
     public static class Builder {
 
         private String id;
diff --git a/jsprit-core/src/test/java/jsprit/core/problem/LocationTest.java b/jsprit-core/src/test/java/jsprit/core/problem/LocationTest.java
index dff29663..e6fdabb7 100644
--- a/jsprit-core/src/test/java/jsprit/core/problem/LocationTest.java
+++ b/jsprit-core/src/test/java/jsprit/core/problem/LocationTest.java
@@ -33,6 +33,13 @@ public class LocationTest {
         Assert.assertTrue(true);
     }
 
+    @Test
+    public void whenIndexSetWitFactory_returnCorrectLocation(){
+        Location l = Location.newInstance(1);
+        Assert.assertEquals(1,l.getIndex());
+        Assert.assertTrue(true);
+    }
+
     @Test(expected = IllegalArgumentException.class)
     public void whenIndexSmallerZero_throwException(){
         Location l = Location.Builder.newInstance().setIndex(-1).build();
@@ -50,6 +57,13 @@ public class LocationTest {
         Assert.assertTrue(true);
     }
 
+    @Test
+    public void whenIdSetWithFactory_returnCorrectLocation(){
+        Location l = Location.newInstance("id");
+        Assert.assertEquals("id",l.getId());
+        Assert.assertTrue(true);
+    }
+
     @Test
     public void whenCoordinateSet_build(){
         Location l = Location.Builder.newInstance().setCoordinate(Coordinate.newInstance(10,20)).build();
@@ -58,5 +72,14 @@ public class LocationTest {
         Assert.assertTrue(true);
     }
 
+    @Test
+    public void whenCoordinateSetWithFactory_returnCorrectLocation(){
+//        Location l = Location.Builder.newInstance().setCoordinate(Coordinate.newInstance(10,20)).build();
+        Location l = Location.newInstance(10,20);
+        Assert.assertEquals(10.,l.getCoordinate().getX());
+        Assert.assertEquals(20.,l.getCoordinate().getY());
+        Assert.assertTrue(true);
+    }
+
 
 }