org.jamesframework.core.search

Class MultiNeighbourhoodSearch<SolutionType extends Solution>

java.lang.Object

org.jamesframework.core.search.Search<SolutionType>

org.jamesframework.core.search.LocalSearch<SolutionType>

org.jamesframework.core.search.NeighbourhoodSearch<SolutionType>

org.jamesframework.core.search.MultiNeighbourhoodSearch<SolutionType>

Type Parameters:

SolutionType - solution type of the problems that may be solved using this search, required to extend Solution

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

ReducedVariableNeighbourhoodSearch, VariableNeighbourhoodDescent, VariableNeighbourhoodSearch

public abstract class MultiNeighbourhoodSearch<SolutionType extends Solution>
extends NeighbourhoodSearch<SolutionType>

Abstract neighbourhood search that uses multiple neighbourhoods to modify the current solution. This includes variable neighbourhood descent and variable neighbourhood search.

Author:

Herman De Beukelaer

Constructor Summary

Constructors

Constructor and Description
MultiNeighbourhoodSearch(Problem<SolutionType> problem, List<? extends Neighbourhood<? super SolutionType>> neighs) Create a new multi neighbourhood search, specifying the problem to be solved and the neighbourhoods used to modify the current solution.
MultiNeighbourhoodSearch(String name, Problem<SolutionType> problem, List<? extends Neighbourhood<? super SolutionType>> neighs) Create a new multi neighbourhood search, specifying the problem to be solved, the neighbourhoods used to modify the current solution, and a custom search name.

Method Summary

Modifier and Type	Method and Description
List<? extends Neighbourhood<? super SolutionType>>	getNeighbourhoods() Get list of applied neighbourhoods (unmodifiable).
void	setNeighbourhoods(List<? extends Neighbourhood<? super SolutionType>> neighs) Sets the list of neighbourhoods used to modify the current solution.

Methods inherited from class org.jamesframework.core.search.NeighbourhoodSearch

accept, evaluate, getBestMove, getNumAcceptedMoves, getNumRejectedMoves, incNumAcceptedMoves, incNumRejectedMoves, init, isImprovement, reject, setEvaluatedMoveCache, updateCurrentSolution, validate

Methods inherited from class org.jamesframework.core.search.LocalSearch

generateRandomInitialSolution, getCurrentSolution, getCurrentSolutionEvaluation, getCurrentSolutionValidation, setCurrentSolution, setCurrentSolution, updateCurrentAndBestSolution, updateCurrentAndBestSolution, updateCurrentSolution

Methods inherited from class org.jamesframework.core.search.Search

addSearchListener, addStopCriterion, assertIdle, clearSearchListeners, clearStopCriteria, computeDelta, dispose, getBestSolution, getBestSolutionEvaluation, getBestSolutionValidation, getID, getMinDelta, getName, getProblem, getRandom, getRuntime, getSearchListeners, getStatus, getStatusLock, getSteps, getStepsWithoutImprovement, getTimeWithoutImprovement, removeSearchListener, removeStopCriterion, run, searchDisposed, searchStarted, searchStep, searchStopped, setRandom, setStopCriterionCheckPeriod, start, stop, toString, updateBestSolution, updateBestSolution

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiNeighbourhoodSearch

public MultiNeighbourhoodSearch(Problem<SolutionType> problem,
                                List<? extends Neighbourhood<? super SolutionType>> neighs)

Create a new multi neighbourhood search, specifying the problem to be solved and the neighbourhoods used to modify the current solution. None of both arguments may be null and the list of neighbourhoods may not be empty and may not contain any null elements The default search name "MultiNeighbourhoodSearch" is assigned.

The search stores an unmodifiable view of the given neighbourhood list.

Parameters:

problem - problem to be solved

neighs - neighbourhoods used to modify the current solution

Throws:

NullPointerException - if problem or neighs are null, or if neighs contains a null element

IllegalArgumentException - if neighs is empty

MultiNeighbourhoodSearch

public MultiNeighbourhoodSearch(String name,
                                Problem<SolutionType> problem,
                                List<? extends Neighbourhood<? super SolutionType>> neighs)

Create a new multi neighbourhood search, specifying the problem to be solved, the neighbourhoods used to modify the current solution, and a custom search name. The problem and neighbourhood list may not be null and the neighbourhood list may not be empty and may not contain any null elements. The search name may be null in which case the default name "MultiNeighbourhoodSearch" is assigned.

The search stores an unmodifiable view of the given neighbourhood list.

Parameters:

name - custom search name

problem - problem to be solved

neighs - neighbourhoods used to modify the current solution

Throws:

NullPointerException - if problem or neighs are null, or if neighs contains a null element

IllegalArgumentException - if neighs is empty

Method Detail

getNeighbourhoods

public List<? extends Neighbourhood<? super SolutionType>> getNeighbourhoods()

Get list of applied neighbourhoods (unmodifiable).

Returns:

neighbourhood list (unmodifiable)

setNeighbourhoods

public void setNeighbourhoods(List<? extends Neighbourhood<? super SolutionType>> neighs)

Sets the list of neighbourhoods used to modify the current solution. Note that neighs can not be null nor empty and can not contain any null elements. This method may only be called when the search is idle. It should be used with care for searches that have already been run, as updating the neighbourhoods might break the execution of a restarted search that tries to continue from where it had arrived.

An unmodifiable view of the given list is stored.

Parameters:

neighs - list of neighbourhoods used to modify the current solution

Throws:

NullPointerException - if neighs is null or contains any null elements

IllegalArgumentException - if neighs is empty

SearchException - if the search is currently not idle