cusack.hcg.graph.algorithm.standard

Class ShortestPathAlgorithm

java.lang.Object

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

cusack.hcg.graph.algorithm.standard.BreadthFirstSearchSkeletonAlgorithm

cusack.hcg.graph.algorithm.standard.ShortestPathAlgorithm

All Implemented Interfaces:

AlgorithmInterface<PuzzleInstance>

public class ShortestPathAlgorithm
extends BreadthFirstSearchSkeletonAlgorithm

Constructor Summary

Constructors

Constructor and Description
ShortestPathAlgorithm()

Method Summary

Modifier and Type	Method and Description
java.lang.Class<PuzzleInstance>	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.
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.

Methods inherited from class cusack.hcg.graph.algorithm.standard.BreadthFirstSearchSkeletonAlgorithm

argumentFormat, countsOperations, getCurrentProblemData, getDistance, getParent, getSource, initializeData, parseArguments, quit, runAlgorithm

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

ShortestPathAlgorithm

public ShortestPathAlgorithm()

Method Detail

getProblemType

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

Specified by:

getProblemType in interface AlgorithmInterface<PuzzleInstance>

Overrides:

getProblemType in class BreadthFirstSearchSkeletonAlgorithm

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

public java.lang.String getProgressReport()

Description copied from interface: AlgorithmInterface

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

Returns:

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

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: