cusack.hcg.games.pebble.algorithms.mergePebbles

Class MergePebbles

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.mergePebbles.MergePebbles

All Implemented Interfaces:

AlgorithmInterface<PebbleInstance>

public class MergePebbles
extends EfficientPebbleAlgorithm

This is based on IsSolvableMergePebbles. This version is just slightly different and this one is (hopefully) optimized better.

Author:

Modified by Chuck Cusack, June 2016.

Constructor Summary

Constructors

Constructor and Description
MergePebbles()

Method Summary

Modifier and Type	Method and Description
void	addPebbleAndUnprocessCompositePebbles(int indexToAddPebble) In an attempt to speed up pebblingNumberBottomUp, this method is created.
java.lang.String	argumentFormat() Describe how the argument(s) to the algorithm should be formatted, if applicable.
boolean	countsOperations()
void	doMergers()
java.lang.String	getProgressReport() The Default implementation for a pebble algorithm.
int	getRootIndex()
int	getTotalPebbles()
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	initializeMoreData() Called by initializeData which is called by setPuzzleData.
void	isSolvable()
void	parseArguments(java.lang.String args) Sends a string that the user can enter to the algorithm.
void	printLists()
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	removePebbleAndUpdatePebbleLists(int indexToRemovePebble) To be used when the method above (addPebbleAndUnprocessCompositePebbles) is used.
void	runAlgorithm() Runs the Algorithm.
void	setRootIndex(int rootIndex) Set this to the appropriate index before running the algorithm to do reachable instead of solvable.

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, 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

Constructor Detail

MergePebbles

public MergePebbles()

Method Detail

getRootIndex

public int getRootIndex()

setRootIndex

public void setRootIndex(int rootIndex)

Set this to the appropriate index before running the algorithm to do reachable instead of solvable.

Parameters:

rootIndex -

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

getTotalPebbles

public int getTotalPebbles()

runAlgorithm

public void runAlgorithm()

Description copied from interface: AlgorithmInterface

Runs the Algorithm. This is the most important method.

isSolvable

public void isSolvable()

doMergers

public void doMergers()

addPebbleAndUnprocessCompositePebbles

public void addPebbleAndUnprocessCompositePebbles(int indexToAddPebble)

In an attempt to speed up pebblingNumberBottomUp, this method is created. The point of this method is that each time IsSolvableMergePebbles is run in the pebblingNumberBottomUp algorithm, the configuration of pebbles only differs from the previous run by one pebble. Because the configurations are so similar, it might be unnecessary to compute all the composite pebbles again. Hopefully it is possible to just add the one pebble, figure out which composite pebbles could potentially do more mergers because of the addition, and run doMergers(). There are two unknowns before starting to write this feature: 1. Is the naive version of this algorithm correct? 2. Is it more efficient in general than rerunning the whole algorithm? by Aaron Green, Fall 2016

Parameters:

indexToAddPebble - The index representing the vertex on the graph upon which a single additional pebble is to be placed.

removePebbleAndUpdatePebbleLists

public void removePebbleAndUpdatePebbleLists(int indexToRemovePebble)

To be used when the method above (addPebbleAndUnprocessCompositePebbles) is used. Simply remove one pebble from the specified vertex and then change all composite pebbles that contain a pure pebble from the specified vertex so that the pure pebble has one less starting mass.

Parameters:

indexToRemovePebble - The vertex that loses a pebble. by Aaron Green, October 2016

getProgressReport

public java.lang.String getProgressReport()

Description copied from class: PebbleAlgorithm

The Default implementation for a pebble algorithm. This should be overridden if there is anything other information besides covering vertices

Specified by:

getProgressReport in interface AlgorithmInterface<PebbleInstance>

Overrides:

getProgressReport in class PebbleAlgorithm

Returns:

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:

printLists

public void printLists()

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: