cusack.hcg.games.multidesigns.algorithms

Class MultiCoveringAlgorithm

java.lang.Object

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

cusack.hcg.games.multidesigns.algorithms.MultiDesignAlgorithm

cusack.hcg.games.multidesigns.algorithms.MultiCoveringAlgorithm

All Implemented Interfaces:

AlgorithmInterface<MultiDesignsInstance>

public class MultiCoveringAlgorithm
extends MultiDesignAlgorithm

Find MultiPackings of graphs.

Author:

Charles Cusack, May 2012

Constructor Summary

Constructors

Constructor and Description
MultiCoveringAlgorithm()

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.
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	initializeData() setProblemData is already implemented for you, but you might need to initialize other data related to your algorithm.
void	parseArguments(java.lang.String args) Sends a string that the user can enter to the algorithm.
void	runAlgorithm() Runs the Algorithm.

Methods inherited from class cusack.hcg.games.multidesigns.algorithms.MultiDesignAlgorithm

countsOperations, getCurrentProblemData, getNumberOfOperations, getProblemType, quit

Methods inherited from class cusack.hcg.graph.algorithm.AbstractAlgorithm

getState, isDone, isNotDone, isQuit, setProblemData, setState

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MultiCoveringAlgorithm

public MultiCoveringAlgorithm()

Method Detail

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

Returns:

the result

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.

Specified by:

getProgressReport in interface AlgorithmInterface<MultiDesignsInstance>

Overrides:

getProgressReport in class MultiDesignAlgorithm

Returns:

initializeData

public void initializeData()

Description copied from class: AbstractAlgorithm

setProblemData is already implemented for you, but you might need to initialize other data related to your algorithm. This method is called in setProblemData.

Overrides:

initializeData in class MultiDesignAlgorithm

runAlgorithm

public void runAlgorithm()

Description copied from interface: AlgorithmInterface

Runs the Algorithm. This is the most important method.

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:

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: