cusack.hcg.games.pebble.algorithms.solvability

Class BacktrackingSolvabilitySomewhatEfficient

java.lang.Object

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

cusack.hcg.games.pebble.algorithms.PebbleAlgorithm

cusack.hcg.games.pebble.algorithms.EfficientPebbleAlgorithm

cusack.hcg.games.pebble.algorithms.solvability.BacktrackingSolvabilitySomewhatEfficient

All Implemented Interfaces:

AlgorithmInterface<PebbleInstance>

public class BacktrackingSolvabilitySomewhatEfficient
extends EfficientPebbleAlgorithm

Insert comment here about what your algorithm does.

Author:

Mostly Dane Linksey and Mark Powers 7/2017

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BacktrackingSolvabilitySomewhatEfficient.Move

Constructor Summary

Constructors

Constructor and Description
BacktrackingSolvabilitySomewhatEfficient()

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	backTrackingSolvability()
boolean	countsOperations()
java.lang.String	getCurrentProblemData()
int	getDistance(Vertex v) Returns the length of the shortest path from this vertex to any other vertex on the graph (counting each edge as 1)
int	getPebbleCount(Vertex v)
java.lang.String	getProgressReport() HTML text that will be displayed in the Algorithm Runner that explains what the algorithm is doing.
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.
boolean	isSolved()
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	reinitializeMoreData() If resetWithThesePebbles is called, what else needs to be reinitialized before the algorithm can be run? This is supposed to be much more efficient than calling initializeMoreData.
void	runAlgorithm() Runs the Algorithm.
void	setPebbleCount(Vertex v, int numberOfPebbles)

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

getCovered, resetWithThesePebbles, resetWithThesePebbles

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

BacktrackingSolvabilitySomewhatEfficient

public BacktrackingSolvabilitySomewhatEfficient()

Method Detail

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.

Overrides:

initializeMoreData in class EfficientPebbleAlgorithm

reinitializeMoreData

public void reinitializeMoreData()

Description copied from class: EfficientPebbleAlgorithm

If resetWithThesePebbles is called, what else needs to be reinitialized before the algorithm can be run? This is supposed to be much more efficient than calling initializeMoreData. The idea is that the graph didn't change, but the data did, so we only need to reinitialize some things.

Specified by:

reinitializeMoreData in class EfficientPebbleAlgorithm

runAlgorithm

public void runAlgorithm()

Runs the Algorithm. This is the most important method.

backTrackingSolvability

public boolean backTrackingSolvability()

getProgressReport

public java.lang.String getProgressReport()

HTML text that will be displayed in the Algorithm Runner that explains what the algorithm is doing. Think of the status as a progress report.

Specified by:

getProgressReport in interface AlgorithmInterface<PebbleInstance>

Overrides:

getProgressReport in class PebbleAlgorithm

Returns:

getResult

public java.lang.String getResult()

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

Specified by:

getResult in interface AlgorithmInterface<PebbleInstance>

Overrides:

getResult in class PebbleAlgorithm

Returns:

the result

getCurrentProblemData

public java.lang.String getCurrentProblemData()

Specified by:

getCurrentProblemData in interface AlgorithmInterface<PebbleInstance>

Overrides:

getCurrentProblemData in class EfficientPebbleAlgorithm

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, only updated to give the current state based on the algorithm. 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 operations.

getVersion

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

(Hopefully) gracefully stop the computation.

Specified by:

quit in interface AlgorithmInterface<PebbleInstance>

Overrides:

quit in class PebbleAlgorithm

isSolved

public boolean isSolved()

getPebbleCount

public int getPebbleCount(Vertex v)

setPebbleCount

public void setPebbleCount(Vertex v,
                           int numberOfPebbles)

getDistance

public int getDistance(Vertex v)

Returns the length of the shortest path from this vertex to any other vertex on the graph (counting each edge as 1)

Returns:

the length of the shortest path from this vertex to any other vertex on the graph

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: