ai.libs.jaicore.basic.algorithm

Class AOptimizer<I,O extends ScoredItem<V>,V extends java.lang.Comparable<V>>

java.lang.Object

ai.libs.jaicore.basic.algorithm.AAlgorithm<I,O>

ai.libs.jaicore.basic.algorithm.ASolutionCandidateIterator<I,O>

ai.libs.jaicore.basic.algorithm.AOptimizer<I,O,V>

Type Parameters:

I - The type of input instances (problems) to be solved by the algorithm.

O - The type of output that is obtained by running the algorithm on the input.

V - The type performance values will have to compare different solutions.

All Implemented Interfaces:

IAlgorithm<I,O>, IOptimizationAlgorithm<I,O,V>, ISolutionCandidateIterator<I,O>, Cancelable, ILoggingCustomizable, java.lang.Iterable<AlgorithmEvent>, java.util.concurrent.Callable<O>, java.util.Iterator<AlgorithmEvent>

public abstract class AOptimizer<I,O extends ScoredItem<V>,V extends java.lang.Comparable<V>>
extends ASolutionCandidateIterator<I,O>
implements IOptimizationAlgorithm<I,O,V>

The AOptimizer represents an algorithm that is meant to optimize for a single best solution. While it may observe multiple candidates for the best solution and report them via events when running, eventually it will return only the single best observed one.

Constructor Summary

Constructors

Modifier	Constructor and Description
	AOptimizer(I input) C'tor taking only an input as a parameter.
protected	AOptimizer(IAlgorithmConfig config, I input) C'tor taking a configuration of the algorithm and an input for the algorithm as arguments.

Method Summary

Modifier and Type	Method and Description
O	call() Overrides the call of Callable to restrict the set of allowed exceptions
O	getBestSeenSolution()
java.lang.String	getLoggerName()
O	nextSolutionCandidate()
SolutionCandidateFoundEvent<O>	nextSolutionCandidateEvent()
protected boolean	setBestSeenSolution(O candidate) Sets the best seen solution regardless the currently best solution.
void	setLoggerName(java.lang.String name)
protected boolean	updateBestSeenSolution(O candidate) Updates the best seen solution if the new solution is better.

Methods inherited from class ai.libs.jaicore.basic.algorithm.ASolutionCandidateIterator

collectAllSolutions

Methods inherited from class ai.libs.jaicore.basic.algorithm.AAlgorithm

activate, announceTimeoutDetected, avoidReinterruptionOnShutdownOnCurrentThread, cancel, checkAndConductTermination, checkTermination, computeTimeoutAware, getActivationTime, getConfig, getId, getInput, getNumCPUs, getRemainingTimeToDeadline, getState, getTimeout, getTimeoutPrecautionOffset, hasNext, hasThreadBeenInterruptedDuringShutdown, interruptThreadAsPartOfShutdown, isCanceled, isShutdownInitialized, isStopCriterionSatisfied, isTimeouted, iterator, next, post, registerActiveThread, registerListener, resolveShutdownInterruptOnCurrentThread, setConfig, setMaxNumThreads, setNumCPUs, setState, setTimeout, setTimeout, setTimeoutPrecautionOffset, shutdown, terminate, unregisterActiveThread, unregisterThreadAndShutdown

Methods inherited from class java.lang.Object

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

Methods inherited from interface ai.libs.jaicore.basic.algorithm.IAlgorithm

getConfig, getId, getInput, getNumCPUs, getTimeout, nextWithException, registerListener, setMaxNumThreads, setNumCPUs, setTimeout, setTimeout

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next, remove

Methods inherited from interface ai.libs.jaicore.basic.Cancelable

cancel

Constructor Detail

AOptimizer

public AOptimizer(I input)

C'tor taking only an input as a parameter.

Parameters:

input - The input of the algorithm.

AOptimizer

protected AOptimizer(IAlgorithmConfig config,
                     I input)

C'tor taking a configuration of the algorithm and an input for the algorithm as arguments.

Parameters:

config - The parameterization of the algorithm.

input - The input to the algorithm (the problem to solve).

Method Detail

updateBestSeenSolution

protected boolean updateBestSeenSolution(O candidate)

Updates the best seen solution if the new solution is better. Returns true iff the best seen solution has been updated.

Parameters:

candidate - A candidate for a new best seen solution. It is only updated iff the candidate performs better than the bestSeenSolution observed so far.

Returns:

Returns true iff the candidate is the best seen solution.

setBestSeenSolution

protected boolean setBestSeenSolution(O candidate)

Sets the best seen solution regardless the currently best solution.

Parameters:

candidate -

Returns:

true iff the new solution has a higher score than the existing one

nextSolutionCandidate

public O nextSolutionCandidate()
                        throws java.lang.InterruptedException,
                               AlgorithmExecutionCanceledException,
                               AlgorithmTimeoutedException,
                               AlgorithmException

Specified by:

nextSolutionCandidate in interface ISolutionCandidateIterator<I,O extends ScoredItem<V>>

Overrides:

nextSolutionCandidate in class ASolutionCandidateIterator<I,O extends ScoredItem<V>>

Throws:

java.lang.InterruptedException

AlgorithmExecutionCanceledException

AlgorithmTimeoutedException

AlgorithmException

nextSolutionCandidateEvent

public SolutionCandidateFoundEvent<O> nextSolutionCandidateEvent()
                                                          throws java.lang.InterruptedException,
                                                                 AlgorithmExecutionCanceledException,
                                                                 AlgorithmTimeoutedException,
                                                                 AlgorithmException

Specified by:

nextSolutionCandidateEvent in interface ISolutionCandidateIterator<I,O extends ScoredItem<V>>

Overrides:

nextSolutionCandidateEvent in class ASolutionCandidateIterator<I,O extends ScoredItem<V>>

Throws:

java.lang.InterruptedException

AlgorithmExecutionCanceledException

AlgorithmTimeoutedException

AlgorithmException

getBestSeenSolution

public O getBestSeenSolution()

Returns:

The best seen solution, yet.

call

public O call()
       throws java.lang.InterruptedException,
              AlgorithmExecutionCanceledException,
              AlgorithmTimeoutedException,
              AlgorithmException

Description copied from interface: IAlgorithm

Overrides the call of Callable to restrict the set of allowed exceptions

Specified by:

call in interface IAlgorithm<I,O extends ScoredItem<V>>

Specified by:

call in interface java.util.concurrent.Callable<O extends ScoredItem<V>>

Overrides:

call in class ASolutionCandidateIterator<I,O extends ScoredItem<V>>

Throws:

java.lang.InterruptedException

AlgorithmExecutionCanceledException

AlgorithmTimeoutedException

AlgorithmException

getLoggerName

public java.lang.String getLoggerName()

Specified by:

getLoggerName in interface ILoggingCustomizable

Overrides:

getLoggerName in class AAlgorithm<I,O extends ScoredItem<V>>

setLoggerName

public void setLoggerName(java.lang.String name)

Specified by:

setLoggerName in interface ILoggingCustomizable

Overrides:

setLoggerName in class AAlgorithm<I,O extends ScoredItem<V>>