cusack.hcg.games.pebble.algorithms.twopebblingproperty

Class TwoPebblingGeneric

java.lang.Object

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

cusack.hcg.games.pebble.algorithms.PebbleAlgorithm

cusack.hcg.games.pebble.algorithms.twopebblingproperty.TwoPebblingGeneric

All Implemented Interfaces:

AlgorithmInterface<PebbleInstance>

Direct Known Subclasses:

TwoPebblingAllViolators, TwoPebblingBottomUp, TwoPebblingProperty

public abstract class TwoPebblingGeneric
extends PebbleAlgorithm

A superclass for all of the 2PP algorithms. The only thing subclasses have to do is tell what algorithm to use for the individual q values. NOTE: The puzzle passed to this should be a regular graph and NOT one that already has extension vertices added.

Author:

ferzle

Constructor Summary

Constructors

Constructor and Description
TwoPebblingGeneric()

Method Summary

Modifier and Type	Method and Description
void	addAllViolators(java.util.ArrayList<int[]> violator)
void	addViolator(int[] violator)
java.lang.String	argumentFormat() Describe how the argument(s) to the algorithm should be formatted, if applicable.
boolean	countsOperations()
java.lang.String	getCurrentProblemData()
int	getPebblingNumber()
java.lang.String	getResult() Get the result 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	runAlgorithm() Run the algorithm.
void	setPebblingNumber(int pebNum) If the pebbling number is being set by an outside source, it can set it using this method.
void	setUseThreads(boolean useThreads)

Methods inherited from class cusack.hcg.games.pebble.algorithms.PebbleAlgorithm

getPebbleState, getProblemType, getProgressReport, initializeData, initializeMoreData, quit, setPebbleState

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

TwoPebblingGeneric

public TwoPebblingGeneric()

Method Detail

setUseThreads

public void setUseThreads(boolean useThreads)

addViolator

public void addViolator(int[] violator)

addAllViolators

public void addAllViolators(java.util.ArrayList<int[]> violator)

runAlgorithm

public void runAlgorithm()

Run the algorithm.

setPebblingNumber

public void setPebblingNumber(int pebNum)

If the pebbling number is being set by an outside source, it can set it using this method.

Parameters:

pebNum - The pebbling number for this algorithm to use.

getPebblingNumber

public int getPebblingNumber()

getResult

public java.lang.String getResult()

Get the result of the algorithm.

Specified by:

getResult in interface AlgorithmInterface<PebbleInstance>

Overrides:

getResult in class PebbleAlgorithm

Returns:

the result

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.

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: