A C D E F G N O R S T U W

A

addEngineFinishedListener(TSEngineFinishedListener) - Method in class net.usa.rharder.tabusearch22.TSEngine
Registers listener to receive tabu events when the engine finishes.
addEngineStartedListener(TSEngineStartedListener) - Method in class net.usa.rharder.tabusearch22.TSEngine
Registers listener to receive tabu events when the engine starts.
addNewBestSolutionListener(TSNewBestSolutionListener) - Method in class net.usa.rharder.tabusearch22.TSEngine
Registers listener to receive tabu events when a new best solution is found.
addNewCurrentSolutionListener(TSNewCurrentSolutionListener) - Method in class net.usa.rharder.tabusearch22.TSEngine
Registers listener to receive tabu events when a new current solution is found.
addUnimprovingMoveListener(TSUnimprovingMoveListener) - Method in class net.usa.rharder.tabusearch22.TSEngine
Registers listener to receive tabu events when an unimproving move is made.
allowMove(TSMove, TSSolution) - Method in interface net.usa.rharder.tabusearch22.TSTabuList
This function should be able to determine if a given move is on the tabu list.

C

clone() - Method in class net.usa.rharder.tabusearch22.TSSolution
A common Java method that returns of copy of the object.
conflictsWith(TSMove) - Method in interface net.usa.rharder.tabusearch22.TSMove
If a number of moves have improving solutions and do not affect each other, the TSEngine will execute all of these moves at that iteration.

D

DEBUGGING - Static variable in class net.usa.rharder.tabusearch22.TSEngine
When set to true, information will be printed to System.out and System.err at various points in the code.

E

engineFinished(TSTabuEvent) - Method in interface net.usa.rharder.tabusearch22.TSEngineFinishedListener
Called when the engine is done.
engineStarted(TSTabuEvent) - Method in interface net.usa.rharder.tabusearch22.TSEngineStartedListener
Called when the engine has started.
evaluate(TSSolution) - Method in interface net.usa.rharder.tabusearch22.TSFunction
The Tabu Search TSEngine expects an objective function and constraint penalties function to be able to evaluate its own worth.

F

fireEngineFinished() - Method in class net.usa.rharder.tabusearch22.TSEngine
This quick method is called when the engine finishes.
fireEngineStarted() - Method in class net.usa.rharder.tabusearch22.TSEngine
This quick method is called when the engine starts.
fireNewBestSolution() - Method in class net.usa.rharder.tabusearch22.TSEngine
This quick method is called when a new best solution is found.
fireNewCurrentSolution() - Method in class net.usa.rharder.tabusearch22.TSEngine
This quick method is called when a new current solution is found.
fireUnimprovingMoveMade() - Method in class net.usa.rharder.tabusearch22.TSEngine
This quick method is called when an unimproving move is made.

G

getAllMoves(TSSolution) - Method in interface net.usa.rharder.tabusearch22.TSMoveManager
This method should return an array of all possible moves to try at an iteration based on the passed current solution.
getBestSolution() - Method in class net.usa.rharder.tabusearch22.TSEngine
Returns the best solution found so far.
getCurrentIteration() - Method in class net.usa.rharder.tabusearch22.TSEngine
Returns the current iteration of the engine.
getCurrentSolution() - Method in class net.usa.rharder.tabusearch22.TSEngine
Returns the current solution.
getIterationOfBestSolution() - Method in class net.usa.rharder.tabusearch22.TSEngine
Returns the iteration number when the best solution was found.
getIterationsToGo() - Method in class net.usa.rharder.tabusearch22.TSEngine
Returns the iterations left in the engine.
getLastSolveMillis() - Method in class net.usa.rharder.tabusearch22.TSEngine
Returns the number of milliseconds it took to solve the last set of iterations.
getMoveManager() - Method in class net.usa.rharder.tabusearch22.TSEngine
Returns the move manager being used by the engine.
getMovesUsedOnLastIteration() - Method in class net.usa.rharder.tabusearch22.TSEngine
Returns the moves that were used on the last iteration.
getObjectiveFunction() - Method in class net.usa.rharder.tabusearch22.TSEngine
Returns the objective function being used by the engine.
getObjectiveValue() - Method in class net.usa.rharder.tabusearch22.TSSolution
This is the value without the penalties.
getPenaltyFunction() - Method in class net.usa.rharder.tabusearch22.TSEngine
Returns the penalty function being used by the engine.
getPenaltyValue() - Method in class net.usa.rharder.tabusearch22.TSSolution
Gets the value of the penalties for the solution.
getSource() - Method in class net.usa.rharder.tabusearch22.TSTabuEvent
Returns the source of the event.
getTabuList() - Method in class net.usa.rharder.tabusearch22.TSEngine
Returns the tabu list that is being used by the engine.
getTSEngine() - Method in class net.usa.rharder.tabusearch22.TSTabuEvent
Casts the source as a TSEngine prior to returning.
getValue() - Method in class net.usa.rharder.tabusearch22.TSSolution
If the value has been set for this solution, then the value will be returned.

N

newBestSolutionFound(TSTabuEvent) - Method in interface net.usa.rharder.tabusearch22.TSNewBestSolutionListener
Called when a new best solution is found.
newCurrentSolutionFound(TSTabuEvent) - Method in interface net.usa.rharder.tabusearch22.TSNewCurrentSolutionListener
Called when a new best solution is found.
NoMovesGeneratedException - exception net.usa.rharder.tabusearch22.NoMovesGeneratedException.
This exception is thrown when getAllMoves (in the TSMoveManager)returns no moves.
NoMovesGeneratedException() - Constructor for class net.usa.rharder.tabusearch22.NoMovesGeneratedException
Constructs generic NoMovesGeneratedException.
NoMovesGeneratedException(int) - Constructor for class net.usa.rharder.tabusearch22.NoMovesGeneratedException
Constructs a NoMovesGeneratedException and specifies the iteration when the exception occurred.
NoMovesGeneratedException(String) - Constructor for class net.usa.rharder.tabusearch22.NoMovesGeneratedException
Constructs a NoMovesGeneratedException with the specified string.

O

operateOn(TSSolution) - Method in interface net.usa.rharder.tabusearch22.TSMove
The required method operateOn accepts a solution to modify and does so.

R

registerMoves(TSMove[], TSSolution) - Method in interface net.usa.rharder.tabusearch22.TSTabuList
This method accepts an array of TSMoves as an argument and updates the tabu list as necessary.
removeEngineFinishedListener(TSEngineFinishedListener) - Method in class net.usa.rharder.tabusearch22.TSEngine
Removes listener from list of objects to notify when the engine finished its appointed iterations.
removeEngineStartedListener(TSEngineStartedListener) - Method in class net.usa.rharder.tabusearch22.TSEngine
Removes listener from list of objects to notify when the engine starts its appointed iterations.
removeNewBestSolutionListener(TSNewBestSolutionListener) - Method in class net.usa.rharder.tabusearch22.TSEngine
Removes listener from list of objects to notify when a new best solution is found.
removeNewCurrentSolutionListener(TSNewCurrentSolutionListener) - Method in class net.usa.rharder.tabusearch22.TSEngine
Removes listener from list of objects to notify when a new current solution is found.
removeUnimprovingMoveListener(TSUnimprovingMoveListener) - Method in class net.usa.rharder.tabusearch22.TSEngine
Removes listener from list of objects to notify when an unimproving move is made.

S

setBestSolutionToCopyOf(TSSolution) - Method in class net.usa.rharder.tabusearch22.TSEngine
Sets the best solution to a copy of the passed solution.
setCurrentSolutionToCopyOf(TSSolution) - Method in class net.usa.rharder.tabusearch22.TSEngine
Sets the current solution to a copy of the passed solution.
setObjectiveValue(double[]) - Method in class net.usa.rharder.tabusearch22.TSSolution
Generally used by the TSEngine to set the value of the objective function (without penalties).
setPenaltyValue(double[]) - Method in class net.usa.rharder.tabusearch22.TSSolution
Generally used by the TSEngine to set the penalties for the solution.
startSolving(int) - Method in class net.usa.rharder.tabusearch22.TSEngine
Starts the engine solving for the given number of iterations.
stopSolving() - Method in class net.usa.rharder.tabusearch22.TSEngine
Stop the engine after the current iteration.

T

toString() - Method in class net.usa.rharder.tabusearch22.NoMovesGeneratedException
Returns a String representation of the exception, specifiying the iteration of the exception, if known.
trySettingBestSolutionToCopyOf(TSSolution) - Method in class net.usa.rharder.tabusearch22.TSEngine
Sets the best solution to a copy of the passed solution but only if the new solution is better than the existing best solution.
TSEngine - class net.usa.rharder.tabusearch22.TSEngine.
The TSEngine is the main source of control for the programmer.
TSEngine(TSSolution, TSTabuList, TSFunction, TSFunction, TSMoveManager) - Constructor for class net.usa.rharder.tabusearch22.TSEngine
This most basic constructor assumes a maximization problem and uses just one thread for searching.
TSEngine(TSSolution, TSTabuList, TSFunction, TSFunction, TSMoveManager, boolean) - Constructor for class net.usa.rharder.tabusearch22.TSEngine
This constructor lets you specify if you are maximizing or minimizing.
TSEngine(TSSolution, TSTabuList, TSFunction, TSFunction, TSMoveManager, boolean, int) - Constructor for class net.usa.rharder.tabusearch22.TSEngine
This constructor lets you specify if you are maximizing or minimizing.
TSEngineFinishedListener - interface net.usa.rharder.tabusearch22.TSEngineFinishedListener.
An object that will listen for the engine to finish.
TSEngineStartedListener - interface net.usa.rharder.tabusearch22.TSEngineStartedListener.
An object that will listen for the engine to start.
TSFunction - interface net.usa.rharder.tabusearch22.TSFunction.
This generic function can be used for anything that evaluates a TSSolution.
TSMove - interface net.usa.rharder.tabusearch22.TSMove.
There is a great deal of flexibility in defining these moves.
TSMoveManager - interface net.usa.rharder.tabusearch22.TSMoveManager.
The TSMoveManager determines which moves are available at any given time (or given solution).
TSNewBestSolutionListener - interface net.usa.rharder.tabusearch22.TSNewBestSolutionListener.
An object that will listen for new best solutions to be found.
TSNewCurrentSolutionListener - interface net.usa.rharder.tabusearch22.TSNewCurrentSolutionListener.
An object that will listen for new current solutions to be found.
TSSolution - class net.usa.rharder.tabusearch22.TSSolution.
The user has complete flexibility in describing a solution.
TSSolution() - Constructor for class net.usa.rharder.tabusearch22.TSSolution
Empty constructor
TSSolution(TSSolution) - Constructor for class net.usa.rharder.tabusearch22.TSSolution
Aids in cloning.
TSTabuEvent - class net.usa.rharder.tabusearch22.TSTabuEvent.
These events are fired off by the TSEngine and are useful for extending the engine to include such things as long term memory and other tabu extras.
TSTabuEvent(Object) - Constructor for class net.usa.rharder.tabusearch22.TSTabuEvent
Constructor that accepts the source of the event.
TSTabuList - interface net.usa.rharder.tabusearch22.TSTabuList.
The TSTabuList tracks which moves are tabu and for how long.
TSUnimprovingMoveListener - interface net.usa.rharder.tabusearch22.TSUnimprovingMoveListener.
An object that will listen for the engine to make unimproving moves.

U

undoOperation(TSSolution) - Method in interface net.usa.rharder.tabusearch22.TSMove
A move needs to be able to undo itself.
unimprovingMoveMade(TSTabuEvent) - Method in interface net.usa.rharder.tabusearch22.TSUnimprovingMoveListener
Called when the engine is done.

W

waitToFinish() - Method in class net.usa.rharder.tabusearch22.TSEngine
Returns control when the engine has stopped.

A C D E F G N O R S T U W