Package pulse.tasks.processing

Class Buffer

java.lang.Object

pulse.util.UpwardsNavigable

pulse.util.Group

pulse.util.Accessible

pulse.util.PropertyHolder

pulse.tasks.processing.Buffer

All Implemented Interfaces:

Serializable, Descriptive

public class Buffer
extends PropertyHolder

A Buffer is used to estimate the convergence of the reverse problem solution, by comparing the variance of the properties to a pre-specified error tolerance.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Buffer()	Creates a Buffer with a default size.

Method Summary

Modifier and Type	Method	Description
double	average(NumericPropertyKeyword index)	Calculates the average for the index -- if the respective NumericProperty is contained in the IndexedVector data of this Buffer.
double	averageStatistic()	Calculates the average statistic value
void	fill(GeneralTask t, int bufferElement)	(Over)writes a buffer cell corresponding to the bufferElement with the current set of parameters of SearchTask and the search statistic.
ParameterVector[]	getData()	Retrieves the contents of this Buffer.
static NumericProperty	getSize()	Gets the buffer size (a NumericProperty derived from BUFFER_SIZE.
void	init()
boolean	isErrorTooHigh(double errorTolerance)	Determines whether the relative error (variance divided by mean) for any of the properties in this buffer is higher than the expect errorTolerance.
List<Property>	listedTypes()	The BUFFER_SIZE is the single listed parameter for this class.
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.
static void	setSize(NumericProperty newSize)	Sets a new size for this Buffer.
double	variance(NumericPropertyKeyword index)	Calculates the variance for the index -- if the respective NumericProperty is contained in the IndexedVector data of this Buffer.

Methods inherited from class pulse.util.PropertyHolder

addListener, areDetailsHidden, data, describe, firePropertyChanged, getDescriptor, getListeners, getPrefix, ignoreSiblings, initListeners, isListedNumericType, isListedParameter, listedKeywords, 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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Buffer

public Buffer()

Creates a Buffer with a default size.

Method Detail

getData

public ParameterVector[] getData()

Retrieves the contents of this Buffer.

Returns:

the data

init

public final void init()

fill

public final void fill(GeneralTask t,
                       int bufferElement)

(Over)writes a buffer cell corresponding to the bufferElement with the current set of parameters of SearchTask and the search statistic.

Parameters:

t - the SearchTask

bufferElement - the bufferElement which will be written over

isErrorTooHigh

public boolean isErrorTooHigh(double errorTolerance)

Determines whether the relative error (variance divided by mean) for any of the properties in this buffer is higher than the expect errorTolerance.

Parameters:

errorTolerance - the maximum tolerated relative error.

Returns:

true if convergence has not been reached.

average

public double average(NumericPropertyKeyword index)

Calculates the average for the index -- if the respective NumericProperty is contained in the IndexedVector data of this Buffer.

Parameters:

index - a symbolic index (keyword)

Returns:

the mean of the data sample for the specific type of NumericProperties

averageStatistic

public double averageStatistic()

Calculates the average statistic value

Returns:

the mean statistic value.

variance

public double variance(NumericPropertyKeyword index)

Calculates the variance for the index -- if the respective NumericProperty is contained in the IndexedVector data of this Buffer.

Parameters:

index - a symbolic index (keyword).

Returns:

the variance of the data sample for the specific type of NumericProperties.

getSize

public static NumericProperty getSize()

Gets the buffer size (a NumericProperty derived from BUFFER_SIZE.

Returns:

the buffer size property

See Also:

NumericPropertyKeyword

setSize

public static void setSize(NumericProperty newSize)

Sets a new size for this Buffer.

Parameters:

newSize - a NumericProperty of the type BUFFER_SIZE.

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.

listedTypes

public List<Property> listedTypes()

The BUFFER_SIZE is the single listed parameter for this class.

Overrides:

listedTypes in class PropertyHolder

Returns:

a list of Property instances, which have been explicitly marked as a listed parameter for this PropertyHolder.

See Also:

NumericPropertyKeyword