cusack.hcg.graph.algorithm

Interface AlgorithmInterface<T extends PuzzleInstance>

All Known Implementing Classes:

AbstractAlgorithm, BacktrackingSolvabilitySomewhatEfficient, BreadthFirstSearchSkeletonAlgorithm, Check2PebblingLemkeP3, Check2PebblingLemkeP3OnlyVertex0, Check2PebblingProperty, Check2PebblingSingleQValue, CheckReachabilityAllVertices, CheckReachabilityByConvertingToDirectedGraphs, ContainsCycle, ContainsTriangle, CountShortestPathsAlgorithm, DepthFirstSearchSkeletonAlgorithm, EfficientPebbleAlgorithm, EfficientPebblingNumberExhaustive, EfficientPebblingNumberNoEvens, EliminateDegree2Vertices, FindAllUnsolvableConfigs, GeneralizedMultiCoveringAlgorithm, HowellAlgorithm, IsAntipodal, IsBipartite, IsReachableShortestPebblePathAaronModified, IsReachableShortestPebblePathAaronOriginal, IsSolvableBest, IsSolvableIslands, IsSolvableIslandsRecursive, IsSolvableMergePebblesOriginal, IsSolvablePurePebbles, IsSolvableShortestPath, IsSolvableShortestPebblePath, IsSolvableShortestPebblePathAaron, IsSolvableSomewhatExhaustive, IsSolvableSomewhatExhaustiveEfficient, MergePebbles, MultiCoveringAlgorithm, MultiDecompositionAlgorithm, MultiDesignAlgorithm, MultiPackingAlgorithm, PebbleAlgorithm, PebblingNumberBacktrackingRecursiveWithoutSomeNonDeterministics, PebblingNumberBottomUp, PebblingNumberExhaustive, PebblingNumberExhaustiveGeneric, PebblingNumberForkJoin, PebblingNumberRootedAllVertices, PebblingNumberRootedBottomUp, PebblingNumberRootedForkJoin, PebblingNumberSuperSkip, PebblingNumberSuperSkipNoEvens, Prim, ShortestPathAlgorithm, TwoPebblingAllViolators, TwoPebblingBottomUp, TwoPebblingGeneric, TwoPebblingProperty, WeightFunctionCheck

public interface AlgorithmInterface<T extends PuzzleInstance>

An interface for algorithms

Author:

Charles Cusack, 6/2013

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()
long	getNumberOfOperations() Assuming the subclasses keep track, get the number of operations performed so far, where "operation" is defined however the algorithm would like.
java.lang.Class<T>	getProblemType()
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.
AlgorithmStates	getState() Get the current state of the algorithm.
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	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.
void	setProblemData(T puzzle)
void	setState(AlgorithmStates state) Sets the state of the algorithm to state.

Method Detail

setProblemData

void setProblemData(T puzzle)

Parameters:

puzzle - the puzzle to run the algorithm on. The algorithm may or may not use this directly, so there should be no expectation that either the puzzle you pass in will be updated/changed by the algorithm or that it won't.

getProblemType

java.lang.Class<T> 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.

getProgressReport

java.lang.String getProgressReport()

HTML text that will be displayed in the Algorithm Runner that explains what the algorithm is doing.

Returns:

getResult

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. This might just be "true" or "false", it might be the encoding of a series of moves, etc.

Returns:

the result

runAlgorithm

void runAlgorithm()

Runs the Algorithm. This is the most important method.

getCurrentProblemData

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

setState

void setState(AlgorithmStates state)

Sets the state of the algorithm to state. The choices are DONE, NOT_DONE, PAUSED, and QUIT. Currently anything related to PAUSED is not implemented fully.

Parameters:

state - What state the algorithm should be set to.

quit

void quit()

(Hopefully) gracefully stop the computation.

getState

AlgorithmStates getState()

Get the current state of the algorithm.

Returns:

countsOperations

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.

getNumberOfOperations

long getNumberOfOperations()

Assuming the subclasses keep track, get the number of operations performed so far, where "operation" is defined however the algorithm would like.

Returns:

getVersion

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:

parseArguments

void parseArguments(java.lang.String args)
             throws java.lang.RuntimeException

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.

Parameters:

args -

Throws:

java.lang.RuntimeException

argumentFormat

java.lang.String argumentFormat()

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

Returns: