From c31949f53869a0bb965ca6eeea5e7c7d8e1bf95a Mon Sep 17 00:00:00 2001
From: Stefan Schroeder <4sschroeder@gmail.com>
Date: Thu, 7 Nov 2013 16:47:27 +0100
Subject: [PATCH] some internals

---
 .../algo/VariationCoefficientBreaker.java     | 20 +++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/jsprit-core/src/main/java/basics/algo/VariationCoefficientBreaker.java b/jsprit-core/src/main/java/basics/algo/VariationCoefficientBreaker.java
index e3f271fc..f3c75691 100644
--- a/jsprit-core/src/main/java/basics/algo/VariationCoefficientBreaker.java
+++ b/jsprit-core/src/main/java/basics/algo/VariationCoefficientBreaker.java
@@ -28,6 +28,16 @@ import basics.VehicleRoutingProblem;
 import basics.VehicleRoutingProblemSolution;
 import basics.algo.SearchStrategy.DiscoveredSolution;
 
+/**
+ * Breaks algorithm prematurely based on variationCoefficient.
+ * 
+ * <p>Note that this must be registered in algorithm<br>
+ * <code>algorithm.getAlgorithmListeners().addListener(this);</code>
+ * 
+ * 
+ * @author stefan
+ *
+ */
 public class VariationCoefficientBreaker implements PrematureAlgorithmBreaker, IterationStartsListener, AlgorithmStartsListener, IterationEndsListener{
 
 	private static Logger logger = Logger.getLogger(VariationCoefficientBreaker.class);
@@ -42,6 +52,16 @@ public class VariationCoefficientBreaker implements PrematureAlgorithmBreaker, I
 	
 	private VehicleRoutingProblemSolution lastAccepted = null;
 	
+	/**
+	 * Breaks algorithm prematurely based on variationCoefficient.
+	 * 
+	 * <p>Note that this must be registered in algorithm<br>
+	 * <code>algorithm.getAlgorithmListeners().addListener(this);</code>
+	 * 
+	 * 
+	 * @author stefan
+	 *
+	 */
 	public VariationCoefficientBreaker(int nuOfIterations, double variationCoefficientThreshold) {
 		super();
 		this.nuOfIterations = nuOfIterations;