ai.libs.jaicore.basic.algorithm

Class ASolutionCandidateIterator<I,O>

java.lang.Object

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

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

Type Parameters:

I -

O -

All Implemented Interfaces:

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

Direct Known Subclasses:

AOptimizer

public abstract class ASolutionCandidateIterator<I,O>
extends AAlgorithm<I,O>
implements ISolutionCandidateIterator<I,O>

A template for algorithms that iterate over solution candidates. By default, if this algorithm is called, it returns the first solution it finds.

Constructor Summary

Constructors

Modifier	Constructor and Description
	ASolutionCandidateIterator(I input)
protected	ASolutionCandidateIterator(IAlgorithmConfig config, I input)

Method Summary

Modifier and Type	Method and Description
O	call() Overrides the call of Callable to restrict the set of allowed exceptions
java.util.List<O>	collectAllSolutions() Gathers all solutions that exist
O	nextSolutionCandidate()
SolutionCandidateFoundEvent<O>	nextSolutionCandidateEvent()

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

activate, announceTimeoutDetected, avoidReinterruptionOnShutdownOnCurrentThread, cancel, checkAndConductTermination, checkTermination, computeTimeoutAware, getActivationTime, getConfig, getId, getInput, getLoggerName, getNumCPUs, getRemainingTimeToDeadline, getState, getTimeout, getTimeoutPrecautionOffset, hasNext, hasThreadBeenInterruptedDuringShutdown, interruptThreadAsPartOfShutdown, isCanceled, isShutdownInitialized, isStopCriterionSatisfied, isTimeouted, iterator, next, post, registerActiveThread, registerListener, resolveShutdownInterruptOnCurrentThread, setConfig, setLoggerName, 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

ASolutionCandidateIterator

public ASolutionCandidateIterator(I input)

ASolutionCandidateIterator

protected ASolutionCandidateIterator(IAlgorithmConfig config,
                                     I input)

Method Detail

nextSolutionCandidate

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

Specified by:

nextSolutionCandidate in interface ISolutionCandidateIterator<I,O>

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>

Throws:

java.lang.InterruptedException

AlgorithmExecutionCanceledException

AlgorithmTimeoutedException

AlgorithmException

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>

Specified by:

call in interface java.util.concurrent.Callable<O>

Throws:

java.lang.InterruptedException

AlgorithmExecutionCanceledException

AlgorithmTimeoutedException

AlgorithmException

collectAllSolutions

public java.util.List<O> collectAllSolutions()
                                      throws java.lang.InterruptedException,
                                             AlgorithmExecutionCanceledException,
                                             java.util.concurrent.TimeoutException,
                                             AlgorithmException

Gathers all solutions that exist

Returns:

Throws:

java.lang.InterruptedException

AlgorithmExecutionCanceledException

java.util.concurrent.TimeoutException

AlgorithmException