org.jamesframework.core.search

Class SingleNeighbourhoodSearch<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.SingleNeighbourhoodSearch<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:

MetropolisSearch, ParallelTempering, RandomDescent, SteepestDescent, TabuSearch

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

Abstract neighbourhood search that uses a single neighbourhood to modify the current solution. Most local search metaheuristics use a single neighbourhood, including random descent, steepest descent, tabu search, Metropolis search, parallel tempering, etc.

Author:

Herman De Beukelaer

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Neighbourhood<? super SolutionType>	getNeighbourhood() Get the neighbourhood used to modify the current solution.
void	setNeighbourhood(Neighbourhood<? super SolutionType> neighbourhood) Sets the neighbourhood 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

SingleNeighbourhoodSearch

public SingleNeighbourhoodSearch(Problem<SolutionType> problem,
                                 Neighbourhood<? super SolutionType> neighbourhood)

Create a new single neighbourhood search, specifying the problem to be solved and the neighbourhood used to modify the current solution. None of both arguments may be null, else, an exception is thrown. The search name is set to the default name "SingleNeighbourhoodSearch".

Parameters:

problem - problem to be solved

neighbourhood - neighbourhood used to modify the current solution

Throws:

NullPointerException - if problem or neighbourhood are null

SingleNeighbourhoodSearch

public SingleNeighbourhoodSearch(String name,
                                 Problem<SolutionType> problem,
                                 Neighbourhood<? super SolutionType> neighbourhood)

Create a new single neighbourhood search, specifying the problem to be solved, the neighbourhood used to modify the current solution, and a custom search name. The problem and neighbourhood may not be null, else, an exception is thrown. The search name may be null in which case it is set to the default name "SingleNeighbourhoodSearch".

Parameters:

name - custom search name

problem - problem to be solved

neighbourhood - neighbourhood used to modify the current solution

Throws:

NullPointerException - if problem or neighbourhood are null

Method Detail

getNeighbourhood

public Neighbourhood<? super SolutionType> getNeighbourhood()

Get the neighbourhood used to modify the current solution.

Returns:

neighbourhood used to modify the current solution

setNeighbourhood

public void setNeighbourhood(Neighbourhood<? super SolutionType> neighbourhood)

Sets the neighbourhood used to modify the current solution. Note that neighbourhood can not be null and that this method may only be called when the search is idle.

Parameters:

neighbourhood - neighbourhood used to modify the current solution

Throws:

NullPointerException - if neighbourhood is null

SearchException - if the search is currently not idle