cusack.hcg.games.multidesigns.algorithms

Class MultiDesignAlgorithm

java.lang.Object

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

cusack.hcg.games.multidesigns.algorithms.MultiDesignAlgorithm

All Implemented Interfaces:

AlgorithmInterface<MultiDesignsInstance>

Direct Known Subclasses:

GeneralizedMultiCoveringAlgorithm, MultiCoveringAlgorithm, MultiDecompositionAlgorithm, MultiPackingAlgorithm

public abstract class MultiDesignAlgorithm
extends AbstractAlgorithm<MultiDesignsInstance>

Find MultiDesigns of graphs.

Author:

Charles Cusack, May 2012

Constructor Summary

Constructors

Constructor and Description
MultiDesignAlgorithm()

Method Summary

Modifier and Type	Method and Description
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<MultiDesignsInstance>	getProblemType()
java.lang.String	getProgressReport() HTML text that will be displayed in the Algorithm Runner that explains what the algorithm is doing.
void	initializeData() setProblemData is already implemented for you, but you might need to initialize other data related to your algorithm.
void	quit() (Hopefully) gracefully stop the computation.

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

Methods inherited from interface cusack.hcg.graph.algorithm.AlgorithmInterface

argumentFormat, getResult, getVersion, parseArguments, runAlgorithm

Constructor Detail

MultiDesignAlgorithm

public MultiDesignAlgorithm()

Method Detail

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.

Specified by:

initializeData in class AbstractAlgorithm<MultiDesignsInstance>

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:

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.

getNumberOfOperations

public long getNumberOfOperations()

Description copied from interface: AlgorithmInterface

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

Specified by:

getNumberOfOperations in interface AlgorithmInterface<MultiDesignsInstance>

Overrides:

getNumberOfOperations in class AbstractAlgorithm<MultiDesignsInstance>

Returns:

getProblemType

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

quit

public void quit()

Description copied from interface: AlgorithmInterface

(Hopefully) gracefully stop the computation.