Package pulse.math.filters

Class OptimisablePolyline

java.lang.Object

pulse.util.UpwardsNavigable

pulse.util.Group

pulse.util.Accessible

pulse.util.PropertyHolder

pulse.math.filters.OptimisablePolyline

All Implemented Interfaces:

Serializable, Optimisable, Descriptive

public class OptimisablePolyline
extends PropertyHolder
implements Optimisable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
OptimisablePolyline(List<Point2D> data)

Method Summary

Modifier and Type	Method	Description
void	addAssignmentListener(AssignmentListener listener)
void	assign(ParameterVector input)	Assigns parameter values of this Optimisable using the optimisation vector params.
double[]	getX()
double[]	getY()
void	optimisationVector(ParameterVector output)	Calculates the vector argument defined on $$Rn to the scalar objective function for this Optimisable.
List<Point2D>	points()
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.

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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OptimisablePolyline

public OptimisablePolyline(List<Point2D> data)

Method Detail

assign

public void assign(ParameterVector input)
            throws SolverException

Description copied from interface: Optimisable

Assigns parameter values of this Optimisable using the optimisation vector params. Only those parameters will be updated, the types of which are listed as indices in the params vector.

Specified by:

assign in interface Optimisable

Parameters:

input - the optimisation vector, containing a similar set of parameters to this Problem

Throws:

SolverException - if params contains invalid parameter values

optimisationVector

public void optimisationVector(ParameterVector output)

Description copied from interface: Optimisable

Calculates the vector argument defined on $$Rⁿ to the scalar objective function for this Optimisable.

Specified by:

optimisationVector in interface Optimisable

Parameters:

output - the output vector where the result will be stored

points

public List<Point2D> points()

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.

getX

public double[] getX()

getY

public double[] getY()

addAssignmentListener

public void addAssignmentListener(AssignmentListener listener)