org.licas.ai_solver.mediator.problem

Class GridProblemMediator

java.lang.Object

org.licas.service.spec.ServiceSpec

org.licas.ai_solver.mediator.problem.ProblemMediator

org.licas.ai_solver.mediator.problem.ProblemMediatorCentral

org.licas.ai_solver.mediator.problem.IterateMediatorCentral

org.licas.ai_solver.mediator.problem.IterateMediatorEvolve

org.licas.ai_solver.mediator.problem.GridProblemMediator

All Implemented Interfaces:

EvolveMediatorDef, IterateMediatorDef, ProblemMediatorDef

Direct Known Subclasses:

GeneticGridProblemMediator, SingleGridProblemMediator

public abstract class GridProblemMediator
extends IterateMediatorEvolve

This is the abstract base class for modelling the grid problem. A grid framework will try to combine the solutions to find the optimal one, and in this case, it is setup for the new hyper-heuristic type of grid.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Object	bestOptValue The best optimal value
protected java.lang.Object	currentOptValue The current optimal value
protected EvalBounds	intermediateBounds Intermediate solution results
protected MatchResult	lastGridSolution The previous grid solution, before this one
protected int	maxSolutionsNumber Maximum allowed number of solutions
protected int	partProblemNumber The maximum number of problem parts if required
protected int	partProblemSize The maximum size for part of a problem if required
protected int	wholeProblemSize The maximum size for a whole problem if required

Fields inherited from class org.licas.ai_solver.mediator.problem.IterateMediatorCentral

resultsBetter

Fields inherited from class org.licas.ai_solver.mediator.problem.ProblemMediatorCentral

dataHash, serviceNames, solutionHierarc

Fields inherited from class org.licas.ai_solver.mediator.problem.ProblemMediator

bestResult, fullTrace, problem, result, solutionOrder, solutionSet, solutionsNumber, solverType, testEnded

Fields inherited from class org.licas.service.spec.ServiceSpec

constructorParams, createServices, dataConditions, datasetType, dirPath, externalScript, heuristicOptions, heuristicType, inputVariables, linkSpec, metricType, serverSpec, serviceClasses, serviceJarFiles, servicesNum, serviceType, tokenizer

Constructor Summary

Constructors

Constructor and Description
GridProblemMediator(org.licas.PasswordHandler thePasswordHandler) Create a new instance of GridProblemMediator.

Method Summary

Modifier and Type	Method and Description
protected boolean	calcResultsBetter(MatchResult solutionSet) This method checks for conditions that indicate that the current set of results are better than the previous set.
protected void	calcTestEnded(MatchResult solutionSet) Check for conditions that indicate that the test runs have or should be terminated.
void	copyToConfig(TestSpec testSpec) Copy any values specific to the problem solver classes to the related specific structures, from the more general list of variables from the Problem Spec itself.
int	getMaxSolutionsNumber() Get the maximum number of allowed solutions.
int	getPartProblemNumber() Get the maximum number of problem parts.
int	getPartProblemSize() Get the maximum size for part of a problem.
boolean	getResultsBetter() Return true if the current set of results are better than the previous set of results.
org.licas_xml.abs.Element	getResultXml() Get the results of the test.
int	getWholeProblemSize() Get the maximum size for a whole problem.
java.util.HashMap<java.lang.String,?>	randomiseHashtableOrder(java.util.HashMap toRandomise) Randomise the order of the entries in the hashtable.
boolean	resetForNextRun(java.util.HashMap varList) Reset the problem-solving structures for the next run.
void	resetValues() Reset to starting values
void	restorePreviousSolutionSet(boolean randomise) Rollback to the previous solution set.
void	setMaxSolutionsNumber(int thisMaxSolutionsNumber) Set the maximum allowed number of solutions.
void	setPartProblemNumber(int thisPartProblemNumber) Set the maximum number of problem parts.
void	setPartProblemSize(int thisPartProblemSize) Set the maximum size for part of a problem.
void	setWholeProblemSize(int thisWholeProblemSize) Set the maximum size for a whole problem.
protected void	sortProblems(TestSpec testSpec, boolean reOrder) Try to (re)sort the problem list after making appropriate changes.

Methods inherited from class org.licas.ai_solver.mediator.problem.IterateMediatorEvolve

firstSolutionsAndProblems

Methods inherited from class org.licas.ai_solver.mediator.problem.IterateMediatorCentral

solutionsToProcess

Methods inherited from class org.licas.ai_solver.mediator.problem.ProblemMediatorCentral

createStoreData, getProblemsList, getSolutionHierarchy, hasSolutions, readData

Methods inherited from class org.licas.ai_solver.mediator.problem.ProblemMediator

addHeuristicOption, clearHeuristicOptions, getFullTrace, getHeuristicOptions, getHeuristicType, getProblem, getProblemNames, getSolutionSet, getSolutionsNumber, getTestEnded, processResult, setDatasetType, setFullTrace, setHeuristicOptions, setHeuristicType, setProblem, setSolutionSet, setSolutionsNumber

Methods inherited from class org.licas.service.spec.ServiceSpec

getDatasetType, getDirFolder, getTokenizer, parseProblemDataset, setDirFolder, setTokenizer, validateScript, validateVariable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.licas.ai_solver.def.EvolveMediatorDef

createNewSolution

Methods inherited from interface org.licas.ai_solver.def.IterateMediatorDef

updateSolutions

Methods inherited from interface org.licas.ai_solver.def.ProblemMediatorDef

solve

Field Detail

intermediateBounds

protected EvalBounds intermediateBounds

Intermediate solution results

currentOptValue

protected java.lang.Object currentOptValue

The current optimal value

bestOptValue

protected java.lang.Object bestOptValue

The best optimal value

maxSolutionsNumber

protected int maxSolutionsNumber

Maximum allowed number of solutions

wholeProblemSize

protected int wholeProblemSize

The maximum size for a whole problem if required

partProblemSize

protected int partProblemSize

The maximum size for part of a problem if required

partProblemNumber

protected int partProblemNumber

The maximum number of problem parts if required

lastGridSolution

protected MatchResult lastGridSolution

The previous grid solution, before this one

Constructor Detail

GridProblemMediator

public GridProblemMediator(org.licas.PasswordHandler thePasswordHandler)

Create a new instance of GridProblemMediator.

Parameters:

thePasswordHandler - for storing passwords.

Method Detail

resetValues

public void resetValues()

Reset to starting values

Overrides:

resetValues in class IterateMediatorCentral

copyToConfig

public void copyToConfig(TestSpec testSpec)
                  throws java.lang.Exception

Copy any values specific to the problem solver classes to the related specific structures, from the more general list of variables from the Problem Spec itself.

Specified by:

copyToConfig in interface ProblemMediatorDef

Overrides:

copyToConfig in class ProblemMediator

Parameters:

testSpec - the model of the tests to perform.

Throws:

java.lang.Exception - any error.

sortProblems

protected void sortProblems(TestSpec testSpec,
                            boolean reOrder)
                     throws java.lang.Exception

Try to (re)sort the problem list after making appropriate changes.

Parameters:

testSpec - the test specification describing the test run.

reOrder - true if randomise the ordering for the next test iteration.

Throws:

java.lang.Exception - any error.

resetForNextRun

public boolean resetForNextRun(java.util.HashMap varList)
                        throws java.lang.Exception

Reset the problem-solving structures for the next run. In this case, remove the named solutions from the list of current ones.

Specified by:

resetForNextRun in class ProblemMediator

Parameters:

varList - a list of variables as key-value pairs. Needs to include the test spec.

Returns:

true if all are removed, false otherwise.

Throws:

java.lang.Exception - any error.

restorePreviousSolutionSet

public void restorePreviousSolutionSet(boolean randomise)
                                throws java.lang.Exception

Rollback to the previous solution set. This sets testEnded to true if the rollback was unsuccessful.

Parameters:

randomise - if true also randomise the new solutions in the previous solution set with regard to their positions.

Throws:

java.lang.Exception - any error.

calcResultsBetter

protected boolean calcResultsBetter(MatchResult solutionSet)
                             throws java.lang.Exception

This method checks for conditions that indicate that the current set of results are better than the previous set.

Parameters:

solutionSet - the solution set to evaluate.

Returns:

true if the current result set is better, false otherwise.

Throws:

java.lang.Exception - any error.

calcTestEnded

protected void calcTestEnded(MatchResult solutionSet)
                      throws java.lang.Exception

Check for conditions that indicate that the test runs have or should be terminated. This also resets the previous solution results that are stored.

Overrides:

calcTestEnded in class IterateMediatorCentral

Parameters:

solutionSet - the last solution set to evaluate.

Throws:

java.lang.Exception - any error.

getResultXml

public org.licas_xml.abs.Element getResultXml()
                                       throws java.lang.Exception

Get the results of the test.

Returns:

the test results in XML format.

Throws:

java.lang.Exception - any error.

randomiseHashtableOrder

public java.util.HashMap<java.lang.String,?> randomiseHashtableOrder(java.util.HashMap toRandomise)

Randomise the order of the entries in the hashtable.

Parameters:

toRandomise - the hashtable to randomise.

Returns:

the same values but in a different order.

setMaxSolutionsNumber

public void setMaxSolutionsNumber(int thisMaxSolutionsNumber)

Set the maximum allowed number of solutions. This can be optional.

Parameters:

thisMaxSolutionsNumber - the maximum number of solutions.

getMaxSolutionsNumber

public int getMaxSolutionsNumber()

Get the maximum number of allowed solutions. This can be optional.

Returns:

the value of maxSolutionsNumber.

setWholeProblemSize

public void setWholeProblemSize(int thisWholeProblemSize)

Set the maximum size for a whole problem.

Parameters:

thisWholeProblemSize - the maximum size for a whole problem.

getWholeProblemSize

public int getWholeProblemSize()

Get the maximum size for a whole problem.

Returns:

the totalValue of wholeProblemSize.

setPartProblemSize

public void setPartProblemSize(int thisPartProblemSize)

Set the maximum size for part of a problem.

Parameters:

thisPartProblemSize - the maximum size for a problem part.

getPartProblemSize

public int getPartProblemSize()

Get the maximum size for part of a problem.

Returns:

the totalValue of partProblemSize.

setPartProblemNumber

public void setPartProblemNumber(int thisPartProblemNumber)

Set the maximum number of problem parts.

Parameters:

thisPartProblemNumber - the maximum number of problem parts.

getPartProblemNumber

public int getPartProblemNumber()

Get the maximum number of problem parts.

Returns:

the totalValue of partProblemNumber.

getResultsBetter

public boolean getResultsBetter()

Return true if the current set of results are better than the previous set of results. This is not set automatically and needs to be implemented by any derived class.

Specified by:

getResultsBetter in interface IterateMediatorDef

Overrides:

getResultsBetter in class IterateMediatorCentral

Returns:

the value of resultsNotBetter.