cusack.hcg.games.pebble.algorithms

Class PebbleAlgorithm

java.lang.Object

cusack.hcg.graph.algorithm.AbstractAlgorithm<PebbleInstance>

cusack.hcg.games.pebble.algorithms.PebbleAlgorithm

All Implemented Interfaces:

AlgorithmInterface<PebbleInstance>

Direct Known Subclasses:

Check2PebblingLemkeP3, Check2PebblingLemkeP3OnlyVertex0, Check2PebblingProperty, Check2PebblingSingleQValue, EfficientPebbleAlgorithm, FindAllUnsolvableConfigs, IsSolvableBest, IsSolvableIslands, IsSolvableIslandsRecursive, IsSolvableSomewhatExhaustive, PebblingNumberBacktrackingRecursiveWithoutSomeNonDeterministics, PebblingNumberBottomUp, PebblingNumberExhaustiveGeneric, PebblingNumberForkJoin, TwoPebblingGeneric

public abstract class PebbleAlgorithm
extends AbstractAlgorithm<PebbleInstance>

The basis for all algorithms involving Graph Pebbling

Author:

Charles Cusack, April 2010.

Constructor Summary

Constructors

Constructor and Description
PebbleAlgorithm()

Method Summary

Modifier and Type	Method and Description
PebbleAlgorithmStates	getPebbleState() Returns the PebbleState without allowing it to be changed
java.lang.Class<PebbleInstance>	getProblemType()
java.lang.String	getProgressReport() The Default implementation for a pebble algorithm.
java.lang.String	getResult() Return the result of the algorithm in the context of the problem.
void	initializeData() setProblemData is already implemented for you, but you might need to initialize other data related to your algorithm.
abstract void	initializeMoreData() Called by initializeData which is called by setPuzzleData.
void	quit() (Hopefully) gracefully stop the computation.
void	setPebbleState(PebbleAlgorithmStates pebblingAlgorithmState) Sets the state of the pebbling algorithm, and also updates the state of the algorithm in general.

Methods inherited from class cusack.hcg.graph.algorithm.AbstractAlgorithm

getNumberOfOperations, getState, isDone, isNotDone, isQuit, setProblemData, setState

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface cusack.hcg.graph.algorithm.AlgorithmInterface

argumentFormat, countsOperations, getCurrentProblemData, getVersion, parseArguments, runAlgorithm

Constructor Detail

PebbleAlgorithm

public PebbleAlgorithm()

Method Detail

initializeData

public final void initializeData()

Description copied from class: AbstractAlgorithm

setProblemData is already implemented for you, but you might need to initialize other data related to your algorithm. This method is called in setProblemData.

Specified by:

initializeData in class AbstractAlgorithm<PebbleInstance>

initializeMoreData

public abstract void initializeMoreData()

Called by initializeData which is called by setPuzzleData. It should initialize data in the subclass that needs it.

getResult

public java.lang.String getResult()

Description copied from interface: AlgorithmInterface

Return the result of the algorithm in the context of the problem. i.e. Solvable, Unsolvable, Unknown. This tells more than "Done" or "Not_Done" that is given in the more general sense. This might just be "true" or "false", it might be the encoding of a series of moves, etc.

Returns:

the result

getProgressReport

public java.lang.String getProgressReport()

The Default implementation for a pebble algorithm. This should be overridden if there is anything other information besides covering vertices

Returns:

setPebbleState

public void setPebbleState(PebbleAlgorithmStates pebblingAlgorithmState)

Sets the state of the pebbling algorithm, and also updates the state of the algorithm in general.

Parameters:

pebblingAlgorithmState - The Algorithm State in terms of Pebbling Algorithms

getPebbleState

public PebbleAlgorithmStates getPebbleState()

Returns the PebbleState without allowing it to be changed

Returns:

the PebbleState

getProblemType

public java.lang.Class<PebbleInstance> getProblemType()

Returns:

The class object representing the subclass of PuzzleInstance that this algorithm runs on. The implementation should probably be something like "return Blah.class;", where Blah is the subclass of PuzzleInstance used in place of T.

quit

public void quit()

Description copied from interface: AlgorithmInterface

(Hopefully) gracefully stop the computation.