Package pulse.tasks

Class Calculation

java.lang.Object

pulse.util.UpwardsNavigable

pulse.util.Group

pulse.util.Accessible

pulse.util.PropertyHolder

pulse.tasks.Calculation

All Implemented Interfaces:

Serializable, Comparable<Calculation>, Response, Descriptive

public class Calculation
extends PropertyHolder
implements Comparable<Calculation>, Response

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static double	RELATIVE_TIME_MARGIN

Constructor Summary

Constructors

Constructor	Description
Calculation(Calculation c)	Creates an orphan Calculation, retaining some properties of the argument
Calculation(SearchTask t)

Method Summary

Modifier and Type	Method	Description
Segment	accessibleRange()
void	clear()
int	compareTo(Calculation arg0)	Compares two calculations based on their model selection criteria.
void	conformTo(UpwardsNavigable owner)
boolean	equals(Object obj)
double	evaluate(double t)
ModelSelectionCriterion	getModelSelectionCriterion()
static InstanceDescriptor<? extends ModelSelectionCriterion>	getModelSelectionDescriptor()
OptimiserStatistic	getOptimiserStatistic()
Problem	getProblem()
Result	getResult()
DifferenceScheme	getScheme()
Status	getStatus()
int	hashCode()
protected void	initModelCriterion(Statistic res)
void	initOptimiser()
boolean	isBetterThan(Calculation a)	Checks if this Calculation is better than a.
double	objectiveFunction(GeneralTask task)	This will use the current DifferenceScheme to solve the Problem for this SearchTask and calculate the SSR value showing how well (or bad) the calculated solution describes the ExperimentalData.
void	process()	This will use the current DifferenceScheme to solve the Problem for this Calculation.
void	set(NumericPropertyKeyword type, NumericProperty property)	An abstract method, which must be overriden to gain access over setting the values of all relevant (selected by the programmer) NumericProperties in subclasses of Accessible.
void	setModelSelectionCriterion(ModelSelectionCriterion rs)
void	setOptimiserStatistic(OptimiserStatistic os)
void	setProblem(Problem problem, ExperimentalData curve)	After setting and adopting the problem by this SearchTask, this will attempt to change the parameters of that problem in accordance with the loaded ExperimentalData for this SearchTask (if not null).Later, if any changes to the properties of that Problem occur and if the source of that event is either the Metadata or the PropertyHolderTable, they will be accounted for by altering the parameters of the problem accordingly -- immediately after the former take place.
void	setResult(Result result)
void	setScheme(DifferenceScheme scheme, ExperimentalData curve)	Adopts the scheme by this SearchTask and updates the time limit of scheme to match ExperimentalData.
boolean	setStatus(Status status)	Attempts to set the status of this calculation to status.
NumericProperty	weight(List<Calculation> all)

Methods inherited from class pulse.util.PropertyHolder

addListener, areDetailsHidden, data, describe, firePropertyChanged, getDescriptor, getListeners, getPrefix, ignoreSiblings, initListeners, isListedNumericType, isListedParameter, listedKeywords, listedTypes, numericData, parameterListChanged, removeListeners, setPrefix, updateProperties, updateProperty

Methods inherited from class pulse.util.Accessible

accessibleChildren, genericProperties, genericProperty, numericProperties, numericProperty, property, update, update

Methods inherited from class pulse.util.Group

access, children, contents, getSimpleName, subgroups

Methods inherited from class pulse.util.UpwardsNavigable

addHierarchyListener, getHierarchyListeners, getParent, identify, removeHierarchyListener, removeHierarchyListeners, setParent, specificAncestor, tellParent

Methods inherited from class java.lang.Object

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

Field Detail

RELATIVE_TIME_MARGIN

public static final double RELATIVE_TIME_MARGIN

See Also:

Constant Field Values

Constructor Detail

Calculation

public Calculation(SearchTask t)

Calculation

public Calculation(Calculation c)

Creates an orphan Calculation, retaining some properties of the argument

Parameters:

c - another calculation to be archived.

Method Detail

conformTo

public void conformTo(UpwardsNavigable owner)

clear

public void clear()

setProblem

public void setProblem(Problem problem,
                       ExperimentalData curve)

After setting and adopting the problem by this SearchTask, this will attempt to change the parameters of that problem in accordance with the loaded ExperimentalData for this SearchTask (if not null).Later, if any changes to the properties of that Problem occur and if the source of that event is either the Metadata or the PropertyHolderTable, they will be accounted for by altering the parameters of the problem accordingly -- immediately after the former take place.

Parameters:

problem - a Problem

curve -

setScheme

public void setScheme(DifferenceScheme scheme,
                      ExperimentalData curve)

Adopts the scheme by this SearchTask and updates the time limit of scheme to match ExperimentalData.

Parameters:

scheme - the DiffenceScheme.

curve -

process

public void process()
             throws SolverException

This will use the current DifferenceScheme to solve the Problem for this Calculation.

Throws:

SolverException

getStatus

public Status getStatus()

setStatus

public boolean setStatus(Status status)

Attempts to set the status of this calculation to status.

Parameters:

status - a status

Returns:

true if this attempt is successful, including the case when the status being set is equal to the current status. false if the current status is one of the following: DONE, EXECUTION_ERROR, INCOMPLETE, IN_PROGRES, AND the status being set is QUEUED.

weight

public NumericProperty weight(List<Calculation> all)

setModelSelectionCriterion

public void setModelSelectionCriterion(ModelSelectionCriterion rs)

getModelSelectionCriterion

public ModelSelectionCriterion getModelSelectionCriterion()

setOptimiserStatistic

public void setOptimiserStatistic(OptimiserStatistic os)

getOptimiserStatistic

public OptimiserStatistic getOptimiserStatistic()

Specified by:

getOptimiserStatistic in interface Response

getProblem

public Problem getProblem()

initOptimiser

public void initOptimiser()

initModelCriterion

protected void initModelCriterion(Statistic res)

getScheme

public DifferenceScheme getScheme()

set

public void set(NumericPropertyKeyword type,
                NumericProperty property)

Description copied from class: Accessible

An abstract method, which must be overriden to gain access over setting the values of all relevant (selected by the programmer) NumericProperties in subclasses of Accessible. Typically this involves a switch statement that goes through the different options for the type and invokes different set(...) methods to update the matching NumericProperty with property.

Specified by:

set in class Accessible

Parameters:

type - the type, which must be equal by definition to property.getType().

property - the property, which contains new information.

isBetterThan

public boolean isBetterThan(Calculation a)

Checks if this Calculation is better than a.

Parameters:

a - another completed calculation

Returns:

true if another calculation hasn't been completed or if this calculation's statistic is lower than statistic of a.

compareTo

public int compareTo(Calculation arg0)

Compares two calculations based on their model selection criteria.

Specified by:

compareTo in interface Comparable<Calculation>

Parameters:

arg0 - another calculation

Returns:

the result of comparing the model selection statistics of this and arg0.

getModelSelectionDescriptor

public static InstanceDescriptor<? extends ModelSelectionCriterion> getModelSelectionDescriptor()

getResult

public Result getResult()

setResult

public void setResult(Result result)

evaluate

public double evaluate(double t)

Specified by:

evaluate in interface Response

accessibleRange

public Segment accessibleRange()

Specified by:

accessibleRange in interface Response

objectiveFunction

public double objectiveFunction(GeneralTask task)
                         throws SolverException

This will use the current DifferenceScheme to solve the Problem for this SearchTask and calculate the SSR value showing how well (or bad) the calculated solution describes the ExperimentalData.

Specified by:

objectiveFunction in interface Response

Parameters:

task -

Returns:

the value of SSR (sum of squared residuals).

Throws:

SolverException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object