cusack.hcg.games.pebble.algorithms.islands

Class IsSolvableIslands

java.lang.Object

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

cusack.hcg.games.pebble.algorithms.PebbleAlgorithm

cusack.hcg.games.pebble.algorithms.islands.IsSolvableIslands

All Implemented Interfaces:

AlgorithmInterface<PebbleInstance>

public class IsSolvableIslands
extends PebbleAlgorithm

This class is based off of the IsSolvableDiam2Iterable class from the previous version of PebbleIt, and implements the Islands Algorithm as explained in Pebbling Algorithms in Diameter Two Graphs.

Author:

Daniel Simpson

Constructor Summary

Constructors

Constructor and Description
IsSolvableIslands()

Method Summary

Modifier and Type	Method and Description
java.lang.String	argumentFormat() Describe how the argument(s) to the algorithm should be formatted, if applicable.
boolean	countsOperations()
java.lang.String	getCurrentProblemData()
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.
double	getVersion() Mostly for use in comparing results from previous versions of algorithms, and/or so we can know whether or not data in the database is based on an older version of the algorithm.
void	initializeMoreData() Called by initializeData which is called by setPuzzleData.
AlgorithmStates	next() Next Step in the Islands Algorithm
void	parseArguments(java.lang.String args) Sends a string that the user can enter to the algorithm.
void	quit() (Hopefully) gracefully stop the computation.
void	runAlgorithm() Runs the Algorithm.

Methods inherited from class cusack.hcg.games.pebble.algorithms.PebbleAlgorithm

getPebbleState, getProblemType, initializeData, setPebbleState

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

Constructor Detail

IsSolvableIslands

public IsSolvableIslands()

Method Detail

getCurrentProblemData

public java.lang.String getCurrentProblemData()

Returns:

A string representation of the current state of the problem data. This should be in the same format as it was passed in to setProblemData, but updated to give the current state based on the algorithm progress so far. The idea is that this can be used to show the progress of the algorithm by some GUI (or in text form, I suppose).

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.

Specified by:

getResult in interface AlgorithmInterface<PebbleInstance>

Overrides:

getResult in class PebbleAlgorithm

Returns:

the result

getProgressReport

public java.lang.String getProgressReport()

Description copied from class: PebbleAlgorithm

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

Specified by:

getProgressReport in interface AlgorithmInterface<PebbleInstance>

Overrides:

getProgressReport in class PebbleAlgorithm

Returns:

next

public AlgorithmStates next()

Next Step in the Islands Algorithm

Returns:

the algorithm states

runAlgorithm

public void runAlgorithm()

Description copied from interface: AlgorithmInterface

Runs the Algorithm. This is the most important method.

initializeMoreData

public void initializeMoreData()

Description copied from class: PebbleAlgorithm

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

Specified by:

initializeMoreData in class PebbleAlgorithm

countsOperations

public boolean countsOperations()

Returns:

True if and only if the algorithm intends to keep track of the number of operations it is performing. Each algorithm is free to decide what it considers an "operation" to be.

getVersion

public double getVersion()

Description copied from interface: AlgorithmInterface

Mostly for use in comparing results from previous versions of algorithms, and/or so we can know whether or not data in the database is based on an older version of the algorithm. Start with "return 1.0". Go up by whatever increments you like (e.g. 1.1, 1.2, etc. or 1, 2, 3, etc.)

Returns:

quit

public void quit()

Description copied from interface: AlgorithmInterface

(Hopefully) gracefully stop the computation.

Specified by:

quit in interface AlgorithmInterface<PebbleInstance>

Overrides:

quit in class PebbleAlgorithm

parseArguments

public void parseArguments(java.lang.String args)

Description copied from interface: AlgorithmInterface

Sends a string that the user can enter to the algorithm. The string will be in whatever format the user enters. Implementation can assume this method is called after the problem data has been set. Throw an exception if different arguments are required.

argumentFormat

public java.lang.String argumentFormat()

Description copied from interface: AlgorithmInterface

Describe how the argument(s) to the algorithm should be formatted, if applicable.

Returns: