net.finmath.analytic.calibration

Interface ParameterObjectInterface

All Known Subinterfaces:

CurveInterface, DiscountCurveInterface, ForwardCurveInterface

All Known Implementing Classes:

AbstractCurve, AbstractForwardCurve, Curve, DiscountCurve, DiscountCurveFromForwardCurve, ForwardCurve, ForwardCurveFromDiscountCurve, ParameterAggregation

public interface ParameterObjectInterface

An objects having a dependence on a parameter (double[]). The state of the objects is encoded in the parameter. It can be read or set. Note that the parameter may alter the state of multiple depending objects (e.g. referenced members).

Version:

1.0

Author:

Christian Fries

Method Summary

Modifier and Type	Method and Description
ParameterObjectInterface	getCloneForParameter(RandomVariableInterface[] value) Create a clone with a modified parameter.
RandomVariableInterface[]	getParameter() Get the current parameter associated with the state of the objects.
void	setParameter(RandomVariableInterface[] parameter) Deprecated.

Method Detail

getParameter

RandomVariableInterface[] getParameter()

Get the current parameter associated with the state of the objects.

Returns:

The parameter.

getCloneForParameter

ParameterObjectInterface getCloneForParameter(RandomVariableInterface[] value)
                                       throws CloneNotSupportedException

Create a clone with a modified parameter.

Parameters:

value - The new parameter.

Returns:

A clone with an otherwise modified parameter.

Throws:

CloneNotSupportedException - Thrown, when the curve could not be cloned.

setParameter

@Deprecated
void setParameter(RandomVariableInterface[] parameter)

Deprecated.

Set the current parameter and change the state of the objects.

Parameters:

parameter - The parameter associated with the new state of the objects.