org.jamesframework.ext.permutation.neigh.moves

Class SingleSwapMove

java.lang.Object

org.jamesframework.ext.permutation.neigh.moves.SingleSwapMove

All Implemented Interfaces:

Move<PermutationSolution>

public class SingleSwapMove
extends Object
implements Move<PermutationSolution>

A move that swaps two items at given positions in a permutation solution.

Author:

Herman De Beukelaer

Constructor Summary

Constructors

Constructor and Description
SingleSwapMove(int i, int j) Create a single swap move given the two positions in the permutation at which items are to be swapped.

Method Summary

Modifier and Type	Method and Description
void	apply(PermutationSolution solution) Apply the move by swapping the items at the positions specified at construction.
boolean	equals(Object obj) Two single swap moves are considered equal if they swap the same pair of items.
int	getI() Get the position of the first swapped item.
int	getJ() Get the position of the second swapped item.
int	hashCode() Hash code computation corresponding to the implementation of equals(Object).
String	toString() Get string indicating move type and positions of swapped items.
void	undo(PermutationSolution solution) Undo a previously applied swap move.

Methods inherited from class java.lang.Object

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

Constructor Detail

SingleSwapMove

public SingleSwapMove(int i,
                      int j)

Create a single swap move given the two positions in the permutation at which items are to be swapped.

Parameters:

i - position of first item to be swapped

j - position of second item to be swapped

Method Detail

getI

public int getI()

Get the position of the first swapped item.

Returns:

first position

getJ

public int getJ()

Get the position of the second swapped item.

Returns:

second position

apply

public void apply(PermutationSolution solution)

Apply the move by swapping the items at the positions specified at construction.

Specified by:

apply in interface Move<PermutationSolution>

Parameters:

solution - permutation solution to which the move is applied

undo

public void undo(PermutationSolution solution)

Undo a previously applied swap move.

Specified by:

undo in interface Move<PermutationSolution>

Parameters:

solution - permutation solution to which the move had been applied

equals

public boolean equals(Object obj)

Two single swap moves are considered equal if they swap the same pair of items. The order of i and j is arbitrary.

Overrides:

equals in class Object

Parameters:

obj - object to compare for equality

Returns:

true if the given object is also a single swap move that swaps the same pair of items

hashCode

public int hashCode()

Hash code computation corresponding to the implementation of equals(Object).

Overrides:

hashCode in class Object

Returns:

hash code

toString

public String toString()

Get string indicating move type and positions of swapped items.

Overrides:

toString in class Object

Returns:

string representation