1
0
Fork 0
mirror of https://github.com/graphhopper/jsprit.git synced 2020-01-24 07:45:05 +01:00

add javadoc and tests

This commit is contained in:
oblonski 2013-12-29 23:53:06 +01:00
parent 5842bd73a4
commit b6d97d6688
4 changed files with 73 additions and 7 deletions

View file

@ -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);
}

View file

@ -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);

View file

@ -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;
}