cusack.hcg.graph.algorithm

Class AbstractAlgorithm<T extends PuzzleInstance>

java.lang.Object

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

Type Parameters:

T - a subclass of PuzzleInstance

All Implemented Interfaces:

AlgorithmInterface<T>

Direct Known Subclasses:

BreadthFirstSearchSkeletonAlgorithm, DepthFirstSearchSkeletonAlgorithm, IsAntipodal, MultiDesignAlgorithm, PebbleAlgorithm, Prim

public abstract class AbstractAlgorithm<T extends PuzzleInstance>
extends java.lang.Object
implements AlgorithmInterface<T>

An abstract implementation of AlgorithmInterface with of the more peripheral/annoying methods filled in. This is a possible starting point for user-contributed algorithms.

Author:

CAC

Constructor Summary

Constructors

Constructor and Description
AbstractAlgorithm()

Method Summary

Modifier and Type	Method and Description
long	getNumberOfOperations() Assuming the subclasses keep track, get the number of operations performed so far, where "operation" is defined however the algorithm would like.
AlgorithmStates	getState() Get the current state of the algorithm.
abstract void	initializeData() setProblemData is already implemented for you, but you might need to initialize other data related to your algorithm.
boolean	isDone() Check if the current state is DONE.
boolean	isNotDone() Check if the current state is NOT_DONE
boolean	isQuit() Check if the current state is QUIT.
void	setProblemData(T puzzle)
void	setState(AlgorithmStates state) Sets the state of the algorithm to state.

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, countsOperations, getCurrentProblemData, getProblemType, getProgressReport, getResult, getVersion, parseArguments, quit, runAlgorithm

Constructor Detail

AbstractAlgorithm

public AbstractAlgorithm()

Method Detail

initializeData

public abstract void initializeData()

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

setProblemData

public void setProblemData(T puzzle)

Specified by:

setProblemData in interface AlgorithmInterface<T extends PuzzleInstance>

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.

getState

public AlgorithmStates getState()

Description copied from interface: AlgorithmInterface

Get the current state of the algorithm.

Specified by:

getState in interface AlgorithmInterface<T extends PuzzleInstance>

Returns:

setState

public void setState(AlgorithmStates state)

Description copied from interface: AlgorithmInterface

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.

Specified by:

setState in interface AlgorithmInterface<T extends PuzzleInstance>

Parameters:

state - What state the algorithm should be set to.

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<T extends PuzzleInstance>

Returns:

isDone

public boolean isDone()

Check if the current state is DONE.

Returns:

true if the current state is equal to AlgorithmStates.DONE

See Also:

AlgorithmStates

isQuit

public boolean isQuit()

Check if the current state is QUIT.

Returns:

true if the current state is equal to AlgorithmStates.QUIT

See Also:

AlgorithmStates

isNotDone

public boolean isNotDone()

Check if the current state is NOT_DONE

Returns:

true if the current state is equal to AlgorithmStates.NOT_DONE

See Also:

AlgorithmStates