org.jamesframework.core.subset.neigh.moves

Class SwapMove

java.lang.Object

org.jamesframework.core.subset.neigh.moves.AbstractSubsetMove

org.jamesframework.core.subset.neigh.moves.SwapMove

All Implemented Interfaces:

Move<SubsetSolution>, SubsetMove

public class SwapMove
extends AbstractSubsetMove

Simple subset move that removes a single ID from the current selection and replaces it with a new ID which was previously not selected.

Author:

Herman De Beukelaer

Constructor Summary

Constructors

Constructor and Description
SwapMove(int add, int delete) Creates a new swap move with specified IDs to add to and remove from the current selection when being applied to a given subset solution.

Method Summary

Modifier and Type	Method and Description
void	apply(SubsetSolution solution) Apply this swap move to a given subset solution.
int	getAddedID() Returns the added ID.
Set<Integer>	getAddedIDs() Returns an unmodifiable singleton containing the only added ID.
int	getDeletedID() Returns the deleted ID.
Set<Integer>	getDeletedIDs() Returns an unmodifiable singleton containing the only deleted ID.
int	getNumAdded() Always returns 1.
int	getNumDeleted() Always return 1.
void	undo(SubsetSolution solution) Undo this swap move after it has been successfully applied to the given subset solution, by removing the newly added ID and re-adding the deleted ID.

Methods inherited from class org.jamesframework.core.subset.neigh.moves.AbstractSubsetMove

equals, hashCode

Methods inherited from class java.lang.Object

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

Constructor Detail

SwapMove

public SwapMove(int add,
                int delete)

Creates a new swap move with specified IDs to add to and remove from the current selection when being applied to a given subset solution. Both IDs can not be equal.

Parameters:

add - ID to add

delete - ID to delete

Throws:

IllegalArgumentException - if add == delete

Method Detail

apply

public void apply(SubsetSolution solution)

Apply this swap move to a given subset solution. The move can only be applied to a solution for which the added ID is currently not selected and the deleted ID is currently selected. This guarantees that calling undo(SubsetSolution) will correctly undo the move.

Parameters:

solution - solution to which to move will be applied

Throws:

SolutionModificationException - if the added ID is already selected, the deleted ID is already unselected, or any of both IDs does not correspond to an underlying entity

undo

public void undo(SubsetSolution solution)

Undo this swap move after it has been successfully applied to the given subset solution, by removing the newly added ID and re-adding the deleted ID.

Parameters:

solution - solution to which the move has been applied

getAddedIDs

public Set<Integer> getAddedIDs()

Returns an unmodifiable singleton containing the only added ID.

Returns:

unmodifiable singleton containing added ID

getAddedID

public int getAddedID()

Returns the added ID.

Returns:

added ID

getDeletedIDs

public Set<Integer> getDeletedIDs()

Returns an unmodifiable singleton containing the only deleted ID.

Returns:

unmodifiable singleton containing deleted ID

getDeletedID

public int getDeletedID()

Returns the deleted ID.

Returns:

deleted ID

getNumAdded

public int getNumAdded()

Always returns 1.

Returns:

1

getNumDeleted

public int getNumDeleted()

Always return 1.

Returns:

1