java.lang.Object
- pulse.util.UpwardsNavigable
- - pulse.util.Group
  - - pulse.util.Accessible
    - - pulse.search.GeneralTask<I,R>

All Implemented Interfaces:

Serializable, Runnable, Descriptive

Direct Known Subclasses:

SearchTask, SimpleOptimisationTask
```
public abstract class GeneralTask<I extends DiscreteInput,R extends Response>
extends Accessible
implements Runnable
```
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

GeneralTask()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract List<NumericPropertyKeyword>`	`activeParameters()`
`abstract void`	`assign(ParameterVector pv)`	Tries to assign a selected set of parameters to the search vector used in optimisation.
`IterativeState`	`getBestState()`
`Buffer`	`getBuffer()`
`abstract I`	`getInput()`
`IterativeState`	`getIterativeState()`
`abstract R`	`getResponse()`
`void`	`intermediateProcessing()`	Override this to add intermediate processing of results e.g.
`abstract boolean`	`isInProgress()`
`double`	`objectiveFunction()`
`void`	`onSolverException(SolverException e1)`	Specifies what should be done when a solver exception is encountered.
`void`	`postProcessing()`	Override this to add post-processing checks e.g.
`void`	`run()`	Runs this task if is either `READY` or `QUEUED`.
`abstract ParameterVector`	`searchVector()`	Creates a search vector populated by parameters that are included in the optimisation routine.
`void`	`setDefaultOptimiser()`
`void`	`setIterativeState(IterativeState state)`
`void`	`setOptimiser(PathOptimiser optimiser)`
`void`	`storeState()`	Update the best state.

Methods inherited from class pulse.util.Accessible
accessibleChildren, genericProperties, genericProperty, numericProperties, numericProperty, property, set, update, update

Methods inherited from class pulse.util.Group
access, children, contents, getDescriptor, getSimpleName, subgroups

Methods inherited from class pulse.util.UpwardsNavigable
addHierarchyListener, describe, getHierarchyListeners, getParent, identify, initListeners, removeHierarchyListener, removeHierarchyListeners, setParent, specificAncestor, tellParent

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GeneralTask
```
public GeneralTask()
```
- Method Detail
  - activeParameters
```
public abstract List<NumericPropertyKeyword> activeParameters()
```
  - searchVector
```
public abstract ParameterVector searchVector()
```
    Creates a search vector populated by parameters that are included in the optimisation routine.
    
    Returns:
    
    the parameter vector with optimisation parameters
  - assign
```
public abstract void assign(ParameterVector pv)
                     throws SolverException
```
    Tries to assign a selected set of parameters to the search vector used in optimisation.
    
    Parameters:
    
    pv - a parameter vector containing all of the optimisation parameters whose values will be assigned to this task
    
    Throws:
    
    SolverException
  - run
```
public void run()
```
    Runs this task if is either READY or QUEUED. Otherwise, will do nothing. After making some preparatory steps, will initiate a loop with successive calls to PathSolver.iteration(this), filling the buffer and notifying any data change listeners in parallel. This loop will go on until either converging results are obtained, or a timeout is reached, or if an execution error happens. Whether the run has been successful will be determined by comparing the associated R² value with the SUCCESS_CUTOFF.
    
    Specified by:
    
    run in interface Runnable
  - isInProgress
```
public abstract boolean isInProgress()
```
  - intermediateProcessing
```
public void intermediateProcessing()
```
    Override this to add intermediate processing of results e.g. with a correlation test.
  - onSolverException
```
public void onSolverException(SolverException e1)
```
    Specifies what should be done when a solver exception is encountered. Empty by default
    
    Parameters:
    
    e1 - a solver exception
  - postProcessing
```
public void postProcessing()
```
    Override this to add post-processing checks e.g. normality tests or range checking.
  - getBuffer
```
public final Buffer getBuffer()
```
  - setIterativeState
```
public void setIterativeState(IterativeState state)
```
  - getIterativeState
```
public IterativeState getIterativeState()
```
  - getBestState
```
public IterativeState getBestState()
```
  - storeState
```
public void storeState()
```
    Update the best state. The instance of this class stores two objects of the type IterativeState: the current state of the optimiser and the global best state. Calling this method will check if a new global best is found, and if so, this will store its parameters in the corresponding variable. This will then be used at the final stage of running the search task, comparing the converged result to the global best, and selecting whichever has the lowest cost. Such routine is required due to the possibility of some optimisers going uphill.
  - setOptimiser
```
public final void setOptimiser(PathOptimiser optimiser)
```
  - setDefaultOptimiser
```
public void setDefaultOptimiser()
```
  - objectiveFunction
```
public double objectiveFunction()
                         throws SolverException
```
    Throws:
    
    SolverException
  - getInput
```
public abstract I getInput()
```
  - getResponse
```
public abstract R getResponse()
```

Class GeneralTask<I extends DiscreteInput,​R extends Response>

Constructor Summary

Method Summary

Methods inherited from class pulse.util.Accessible

Methods inherited from class pulse.util.Group

Methods inherited from class pulse.util.UpwardsNavigable

Methods inherited from class java.lang.Object

Constructor Detail

GeneralTask

Method Detail

activeParameters

searchVector

assign

run

isInProgress

intermediateProcessing

onSolverException

postProcessing

getBuffer

setIterativeState

getIterativeState

getBestState

storeState

setOptimiser

setDefaultOptimiser

objectiveFunction

getInput

getResponse

Class GeneralTask<I extends DiscreteInput,R extends Response>