cusack.hcg.games.pebble.algorithms.solvability

Class IsSolvableSomewhatExhaustiveEfficient

java.lang.Object

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

cusack.hcg.games.pebble.algorithms.PebbleAlgorithm

cusack.hcg.games.pebble.algorithms.EfficientPebbleAlgorithm

cusack.hcg.games.pebble.algorithms.solvability.IsSolvableSomewhatExhaustiveEfficient

All Implemented Interfaces:

AlgorithmInterface<PebbleInstance>, java.io.Serializable, java.util.Iterator<AlgorithmStates>

public class IsSolvableSomewhatExhaustiveEfficient
extends EfficientPebbleAlgorithm
implements java.util.Iterator<AlgorithmStates>, java.io.Serializable

This is the class that uses the brute force algorithm to determine whether a particular pebbling puzzle is solvable or not.

Author:

Charles Cusack, April 2010.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IsSolvableSomewhatExhaustiveEfficient()

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.
boolean	countsOperations()
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.
boolean	hasNext() Checks to see if the next method needs to be called (if the state of the algorithm is unknown)
void	initializeMoreData() Called by initializeData which is called by setPuzzleData.
AlgorithmStates	next() This is the method that uses the algorithm.
void	parseArguments(java.lang.String args) Sends a string that the user can enter to the algorithm.
void	reinitializeMoreData() If resetWithThesePebbles is called, what else needs to be reinitialized before the algorithm can be run? This is supposed to be much more efficient than calling initializeMoreData.
void	remove() From Iterator interface.
void	runAlgorithm() Runs the Algorithm.

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

getCovered, getCurrentProblemData, resetWithThesePebbles, resetWithThesePebbles

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

getPebbleState, getProblemType, getProgressReport, getResult, initializeData, 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

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

IsSolvableSomewhatExhaustiveEfficient

public IsSolvableSomewhatExhaustiveEfficient()

Method Detail

runAlgorithm

public void runAlgorithm()

Description copied from interface: AlgorithmInterface

Runs the Algorithm. This is the most important method.

Specified by:

runAlgorithm in interface AlgorithmInterface<PebbleInstance>

hasNext

public boolean hasNext()

Checks to see if the next method needs to be called (if the state of the algorithm is unknown)

Specified by:

hasNext in interface java.util.Iterator<AlgorithmStates>

Returns:

true if the algorithm state is unknown

next

public AlgorithmStates next()

This is the method that uses the algorithm.

Specified by:

next in interface java.util.Iterator<AlgorithmStates>

Returns:

The state the problem is in. If still unknown, the method will be executed again.

remove

public void remove()

From Iterator interface. Not implemented.

Specified by:

remove in interface java.util.Iterator<AlgorithmStates>

initializeMoreData

public void initializeMoreData()

Description copied from class: PebbleAlgorithm

Called by initializeData which is called by setPuzzleData. It should initialize data in the subclass that needs it.

Overrides:

initializeMoreData in class EfficientPebbleAlgorithm

reinitializeMoreData

public void reinitializeMoreData()

Description copied from class: EfficientPebbleAlgorithm

If resetWithThesePebbles is called, what else needs to be reinitialized before the algorithm can be run? This is supposed to be much more efficient than calling initializeMoreData. The idea is that the graph didn't change, but the data did, so we only need to reinitialize some things.

Specified by:

reinitializeMoreData in class EfficientPebbleAlgorithm

countsOperations

public boolean countsOperations()

Specified by:

countsOperations in interface AlgorithmInterface<PebbleInstance>

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.)

Specified by:

getVersion in interface AlgorithmInterface<PebbleInstance>

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.

Specified by:

parseArguments in interface AlgorithmInterface<PebbleInstance>

argumentFormat

public java.lang.String argumentFormat()

Description copied from interface: AlgorithmInterface

Describe how the argument(s) to the algorithm should be formatted, if applicable.

Specified by:

argumentFormat in interface AlgorithmInterface<PebbleInstance>

Returns: