Class AdjacentSwapMutation
 java.lang.Object

 org.cicirello.search.operators.permutations.AdjacentSwapMutation

 All Implemented Interfaces:
Splittable<MutationOperator<Permutation>>
,IterableMutationOperator<Permutation>
,MutationOperator<Permutation>
,UndoableMutationOperator<Permutation>
public final class AdjacentSwapMutation extends Object implements UndoableMutationOperator<Permutation>, IterableMutationOperator<Permutation>
This class implements an adjacent swap mutation on permutations, where one mutation consists in randomly swapping a pair of adjacent elements. The random choice of elements is performed uniformly at random from among all adjacent pairs. If the length of the permutation is n, there are n1 such adjacent pairs. The runtime of both themutate
andundo
methods is O(1).


Constructor Summary
Constructors Constructor Description AdjacentSwapMutation()
Constructs an AdjacentSwapMutation mutation operator.

Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MutationIterator
iterator(Permutation p)
Creates and returns aMutationIterator
that can be used to systematically iterate over all of the direct neighbors (i.e., a single mutation step away) of a candidate solution, as one might do in a hill climber.void
mutate(Permutation c)
Mutates a candidate solution to a problem, by randomly modifying its state.AdjacentSwapMutation
split()
Generates a functionally identical copy of this object, for use in multithreaded implementations of search algorithms.void
undo(Permutation c)
Returns a candidate solution to its previous state prior to the most recent mutation performed.



Method Detail

mutate
public void mutate(Permutation c)
Description copied from interface:MutationOperator
Mutates a candidate solution to a problem, by randomly modifying its state. The mutant that is produced is in the local neighborhood of the original candidate solution. Specified by:
mutate
in interfaceMutationOperator<Permutation>
 Parameters:
c
 The candidate solution subject to the mutation. This method changes the state of c.

undo
public void undo(Permutation c)
Description copied from interface:UndoableMutationOperator
Returns a candidate solution to its previous state prior to the most recent mutation performed.
For example, consider the following. Let c' be the current state of c. Let c'' be the state of c after mutate(c); If we then call undo(c), the state of c should revert back to c'.
The behavior of undo is undefined if c is altered by some other process between the calls to mutate and undo. The behavior is also undefined if a different candidate is given to undo then the last given to mutate. For example, if the following two statements are executed, mutate(c); undo(d);, the effect on d is undefined as it wasn't the most recently mutated candidate solution.
 Specified by:
undo
in interfaceUndoableMutationOperator<Permutation>
 Parameters:
c
 The candidate solution to revert.

split
public AdjacentSwapMutation split()
Description copied from interface:Splittable
Generates a functionally identical copy of this object, for use in multithreaded implementations of search algorithms. The state of the object that is returned may or may not be identical to that of the original. Thus, this is a distinct concept from the functionality of theCopyable
interface. Classes that implement this interface must ensure that the object returned performs the same functionality, and that it does not share any state data that would be either unsafe or inefficient for concurrent access by multiple threads. The split method is allowed to simply return the this reference, provided that it is both safe and efficient for multiple threads to share a single copy of the Splittable object. The intention is to provide a multithreaded search with the capability to provide spawned threads with their own distinct search operators. Such multithreaded algorithms can call the split method for each thread it spawns to generate a functionally identical copy of the operator, but with independent state. Specified by:
split
in interfaceIterableMutationOperator<Permutation>
 Specified by:
split
in interfaceSplittable<MutationOperator<Permutation>>
 Specified by:
split
in interfaceUndoableMutationOperator<Permutation>
 Returns:
 A functionally identical copy of the object, or a reference to this if it is both safe and efficient for multiple threads to share a single instance of this Splittable object.

iterator
public MutationIterator iterator(Permutation p)
Creates and returns aMutationIterator
that can be used to systematically iterate over all of the direct neighbors (i.e., a single mutation step away) of a candidate solution, as one might do in a hill climber.The worst case runtime of the
MutationIterator.hasNext()
,MutationIterator.nextMutant()
,MutationIterator.setSavepoint()
, andMutationIterator.rollback()
methods of theMutationIterator
created by this method is O(1). Specified by:
iterator
in interfaceIterableMutationOperator<Permutation>
 Parameters:
p
 The candidate solution subject to the mutation. Calling methods of theMutationIterator
that is returned changes the state of that candidate solution. See the documentation of those methods for details of how such changes may occur. Returns:
 A MutationIterator for iterating over the direct neighbors of a candidate solution.

