org.jamesframework.core.search.neigh

Interface Move<SolutionType extends Solution>

Type Parameters:

SolutionType - the solution type to which move can be applied, required to extend Solution

All Known Subinterfaces:

SubsetMove

All Known Implementing Classes:

AbstractSubsetMove, AdditionMove, DeletionMove, GeneralSubsetMove, SwapMove

public interface Move<SolutionType extends Solution>

Interface of a move that can be applied to a generic solution type. Contains methods to apply the move to a given solution and to undo the move after it has been applied.

Author:

Herman De Beukelaer

Method Summary

Modifier and Type	Method and Description
void	apply(SolutionType solution) Apply this move to the given solution.
void	undo(SolutionType solution) Undo this move after it has been applied to the given solution.

Method Detail

apply

void apply(SolutionType solution)

Apply this move to the given solution.

Parameters:

solution - solution to which the move is applied

Throws:

SolutionModificationException - if the solution can not be modified according to the applied move

undo

void undo(SolutionType solution)

Undo this move after it has been applied to the given solution. It is assumed that the solution has not been modified in any way since the move was applied; if so, the behaviour of this method is undefined.

Parameters:

solution - solution to which the move has been applied