cusack.hcg.games.pebble.algorithms.pebblingNumber

Class PebblingNumberForkJoin

java.lang.Object

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

cusack.hcg.games.pebble.algorithms.PebbleAlgorithm

cusack.hcg.games.pebble.algorithms.pebblingNumber.PebblingNumberForkJoin

All Implemented Interfaces:

AlgorithmInterface<PebbleInstance>

Direct Known Subclasses:

PebblingNumberRootedForkJoin

public class PebblingNumberForkJoin
extends PebbleAlgorithm

The wrapper for the PebblingAlgorithmBottomUpForJoinTask.

Author:

CAC, Summer 2016.

Constructor Summary

Constructors

Constructor and Description
PebblingNumberForkJoin()

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()
int	getPebblingNumber()
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.
int	getRoot()
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.
void	parseArguments(java.lang.String args) Sends a string that the user can enter to the algorithm.
void	runAlgorithm() Runs the Algorithm.
void	setLogging(boolean state)
void	setRoot(int root)

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

getPebbleState, getProblemType, initializeData, quit, 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

PebblingNumberForkJoin

public PebblingNumberForkJoin()

Method Detail

getRoot

public int getRoot()

setRoot

public void setRoot(int root)

setLogging

public void setLogging(boolean state)

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

runAlgorithm

public void runAlgorithm()

Description copied from interface: AlgorithmInterface

Runs the Algorithm. This is the most important method.

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

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).

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:

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:

getPebblingNumber

public int getPebblingNumber()

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: