com.graphhopper.jsprit.core.algorithm

Class VehicleRoutingAlgorithm

java.lang.Object

com.graphhopper.jsprit.core.algorithm.VehicleRoutingAlgorithm

public class VehicleRoutingAlgorithm
extends Object

Algorithm that solves a VehicleRoutingProblem.

Author:

stefan schroeder

Constructor Summary

Constructors

Constructor and Description
VehicleRoutingAlgorithm(VehicleRoutingProblem problem, Collection<VehicleRoutingProblemSolution> initialSolutions, SearchStrategyManager searchStrategyManager)
VehicleRoutingAlgorithm(VehicleRoutingProblem problem, SearchStrategyManager searchStrategyManager)
VehicleRoutingAlgorithm(VehicleRoutingProblem problem, SearchStrategyManager searchStrategyManager, SolutionCostCalculator objectiveFunction)

Method Summary

Modifier and Type	Method and Description
void	addInitialSolution(VehicleRoutingProblemSolution solution) Adds solution to the collection of initial solutions.
void	addListener(VehicleRoutingAlgorithmListener l)
void	addTerminationCriterion(PrematureAlgorithmTermination terminationCriterion) Adds a termination criterion to the collection of already specified termination criteria.
VehicleRoutingAlgorithmListeners	getAlgorithmListeners()
int	getMaxIterations() Gets max number of iterations.
SolutionCostCalculator	getObjectiveFunction()
SearchStrategyManager	getSearchStrategyManager() Gets the SearchStrategyManager.
Collection<VehicleRoutingProblemSolution>	searchSolutions() Runs the vehicle routing algorithm and returns a number of generated solutions.
void	setMaxIterations(int maxIterations) Sets max number of iterations.
void	setPrematureAlgorithmTermination(PrematureAlgorithmTermination prematureAlgorithmTermination) Sets premature termination and overrides existing termination criteria.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VehicleRoutingAlgorithm

public VehicleRoutingAlgorithm(VehicleRoutingProblem problem,
                               SearchStrategyManager searchStrategyManager)

VehicleRoutingAlgorithm

public VehicleRoutingAlgorithm(VehicleRoutingProblem problem,
                               Collection<VehicleRoutingProblemSolution> initialSolutions,
                               SearchStrategyManager searchStrategyManager)

VehicleRoutingAlgorithm

public VehicleRoutingAlgorithm(VehicleRoutingProblem problem,
                               SearchStrategyManager searchStrategyManager,
                               SolutionCostCalculator objectiveFunction)

Method Detail

addInitialSolution

public void addInitialSolution(VehicleRoutingProblemSolution solution)

Adds solution to the collection of initial solutions.

Parameters:

solution - the solution to be added

setPrematureAlgorithmTermination

public void setPrematureAlgorithmTermination(PrematureAlgorithmTermination prematureAlgorithmTermination)

Sets premature termination and overrides existing termination criteria. If existing ones should not be overridden use .addTerminationCriterion(...).

Parameters:

prematureAlgorithmTermination - the termination criterion

addTerminationCriterion

public void addTerminationCriterion(PrematureAlgorithmTermination terminationCriterion)

Adds a termination criterion to the collection of already specified termination criteria. If one of the termination criteria is fulfilled, the algorithm terminates prematurely.

Parameters:

terminationCriterion - the termination criterion

getSearchStrategyManager

public SearchStrategyManager getSearchStrategyManager()

Gets the SearchStrategyManager.

Returns:

SearchStrategyManager

searchSolutions

public Collection<VehicleRoutingProblemSolution> searchSolutions()

Runs the vehicle routing algorithm and returns a number of generated solutions.

The algorithm runs as long as it is specified in nuOfIterations and prematureBreak. In each iteration it selects a searchStrategy according to searchStrategyManager and runs the strategy to improve solutions.

Note that clients are allowed to observe/listen the algorithm. See VehicleRoutingAlgorithmListener and its according listeners.

Returns:

Collection the solutions

See Also:

SearchStrategyManager}, {@link com.graphhopper.jsprit.core.algorithm.listener.VehicleRoutingAlgorithmListener}, {@link com.graphhopper.jsprit.core.algorithm.listener.AlgorithmStartsListener}, {@link com.graphhopper.jsprit.core.algorithm.listener.AlgorithmEndsListener}, {@link com.graphhopper.jsprit.core.algorithm.listener.IterationStartsListener}, {@link com.graphhopper.jsprit.core.algorithm.listener.IterationEndsListener}

getAlgorithmListeners

public VehicleRoutingAlgorithmListeners getAlgorithmListeners()

addListener

public void addListener(VehicleRoutingAlgorithmListener l)

setMaxIterations

public void setMaxIterations(int maxIterations)

Sets max number of iterations.

Parameters:

maxIterations - max number of iteration the algorithm runs

getMaxIterations

public int getMaxIterations()

Gets max number of iterations.

Returns:

max number of iterations

getObjectiveFunction

public SolutionCostCalculator getObjectiveFunction()