From b6d97d6688cc6b65c4b95fff5de26ea84b9833fe Mon Sep 17 00:00:00 2001
From: oblonski <4sschroeder@gmail.com>
Date: Sun, 29 Dec 2013 23:53:06 +0100
Subject: [PATCH] add javadoc and tests

---
 .../solution/InitialSolutionFactory.java      | 14 ++++++--
 .../solution/SolutionCostCalculator.java      | 11 ++++--
 .../VehicleRoutingProblemSolution.java        | 19 ++++++++--
 .../VehicleRoutingProblemSolutionTest.java    | 36 +++++++++++++++++++
 4 files changed, 73 insertions(+), 7 deletions(-)
 create mode 100644 jsprit-core/src/test/java/jsprit/core/problem/solution/VehicleRoutingProblemSolutionTest.java

diff --git a/jsprit-core/src/main/java/jsprit/core/problem/solution/InitialSolutionFactory.java b/jsprit-core/src/main/java/jsprit/core/problem/solution/InitialSolutionFactory.java
index 96fa7f82..6670745e 100644
--- a/jsprit-core/src/main/java/jsprit/core/problem/solution/InitialSolutionFactory.java
+++ b/jsprit-core/src/main/java/jsprit/core/problem/solution/InitialSolutionFactory.java
@@ -18,10 +18,20 @@ package jsprit.core.problem.solution;
 
 import jsprit.core.problem.VehicleRoutingProblem;
 
-
-
+/**
+ * Interface for all factories that create initial solutions for the specified {@link VehicleRoutingProblem}.
+ * 
+ * @author schroeder
+ *
+ */
 public interface InitialSolutionFactory {
 
+	/**
+	 * Creates an initial solution for the specified {@link VehicleRoutingProblem}.
+	 * 
+	 * @param vrp
+	 * @return
+	 */
 	public VehicleRoutingProblemSolution createSolution(VehicleRoutingProblem vrp);
 
 }
diff --git a/jsprit-core/src/main/java/jsprit/core/problem/solution/SolutionCostCalculator.java b/jsprit-core/src/main/java/jsprit/core/problem/solution/SolutionCostCalculator.java
index 92c226cf..f82656fc 100644
--- a/jsprit-core/src/main/java/jsprit/core/problem/solution/SolutionCostCalculator.java
+++ b/jsprit-core/src/main/java/jsprit/core/problem/solution/SolutionCostCalculator.java
@@ -16,14 +16,21 @@
  ******************************************************************************/
 package jsprit.core.problem.solution;
 
-
+/**
+ * Interface for all solutionCostCalculators which should be the objective-functions of the problem.
+ * 
+ * <p>It evaluates VehicleRoutingProblemSolution and returns its costs.
+ * 
+ * @author schroeder
+ *
+ */
 public interface SolutionCostCalculator {
 	
 	/**
 	 * Returns costs of solution.
 	 * 
 	 * @param solution
-	 * @return TODO
+	 * @return costs
 	 */
 	public double getCosts(VehicleRoutingProblemSolution solution);
 
diff --git a/jsprit-core/src/main/java/jsprit/core/problem/solution/VehicleRoutingProblemSolution.java b/jsprit-core/src/main/java/jsprit/core/problem/solution/VehicleRoutingProblemSolution.java
index c5c9ed86..63302c94 100644
--- a/jsprit-core/src/main/java/jsprit/core/problem/solution/VehicleRoutingProblemSolution.java
+++ b/jsprit-core/src/main/java/jsprit/core/problem/solution/VehicleRoutingProblemSolution.java
@@ -25,7 +25,7 @@ import jsprit.core.problem.solution.route.VehicleRoute;
 /**
  * Contains the solution of a vehicle routing problem and its corresponding costs.
  * 
- * @author stefan schröder
+ * @author stefan schroeder
  *
  */
 public class VehicleRoutingProblemSolution {
@@ -67,16 +67,29 @@ public class VehicleRoutingProblemSolution {
 		this.cost = cost;
 	}
 
-	
+	/**
+	 * Returns a collection of vehicle-routes.
+	 * 
+	 * @return collection of vehicle-routes
+	 */
 	public Collection<VehicleRoute> getRoutes() {
 		return routes;
 	}
 
-
+	/**
+	 * Returns cost of this solution.
+	 * 
+	 * @return costs
+	 */
 	public double getCost() {
 		return cost;
 	}
 	
+	/**
+	 * Sets the costs of this solution.
+	 * 
+	 * @param cost
+	 */
 	public void setCost(double cost){
 		this.cost = cost;
 	}
diff --git a/jsprit-core/src/test/java/jsprit/core/problem/solution/VehicleRoutingProblemSolutionTest.java b/jsprit-core/src/test/java/jsprit/core/problem/solution/VehicleRoutingProblemSolutionTest.java
new file mode 100644
index 00000000..b08f03c8
--- /dev/null
+++ b/jsprit-core/src/test/java/jsprit/core/problem/solution/VehicleRoutingProblemSolutionTest.java
@@ -0,0 +1,36 @@
+package jsprit.core.problem.solution;
+
+import java.util.Arrays;
+import java.util.Collections;
+
+import jsprit.core.problem.solution.route.VehicleRoute;
+
+import static org.junit.Assert.*;
+import static org.mockito.Mockito.mock;
+import org.junit.Test;
+
+public class VehicleRoutingProblemSolutionTest {
+	
+	@Test
+	public void whenCreatingSolutionWithTwoRoutes_solutionShouldContainTheseRoutes(){
+		VehicleRoute r1 = mock(VehicleRoute.class);
+		VehicleRoute r2 = mock(VehicleRoute.class);
+		
+		VehicleRoutingProblemSolution sol = new VehicleRoutingProblemSolution(Arrays.asList(r1,r2), 0.0);
+		assertEquals(2,sol.getRoutes().size());
+	}
+	
+	@Test
+	public void whenSettingSolutionCostsTo10_solutionCostsShouldBe10(){
+		VehicleRoutingProblemSolution sol = new VehicleRoutingProblemSolution(Collections.<VehicleRoute>emptyList(), 10.0);
+		assertEquals(10.0,sol.getCost(),0.01);
+	}
+	
+	@Test
+	public void whenCreatingSolWithCostsOf10AndSettingCostsAfterwardsTo20_solutionCostsShouldBe20(){
+		VehicleRoutingProblemSolution sol = new VehicleRoutingProblemSolution(Collections.<VehicleRoute>emptyList(), 10.0);
+		sol.setCost(20.0);
+		assertEquals(20.0,sol.getCost(),0.01);
+	}
+
+}