Module net.finmath.lib

Package net.finmath.fouriermethod.calibration

Class ScalarParameterInformationImplementation

java.lang.Object

net.finmath.fouriermethod.calibration.ScalarParameterInformationImplementation

All Implemented Interfaces:

ParameterInformation, ScalarParameterInformation

public class ScalarParameterInformationImplementation
extends Object
implements ScalarParameterInformation

This class tells us if a parameter has to be calibrated and if it is constrained.

Author:

Alessandro Gnoatto

Constructor Summary

Constructors

Constructor	Description
ScalarParameterInformationImplementation(boolean isParameterToCalibrate)	Constructs an unconstrained parameter.
ScalarParameterInformationImplementation(boolean isParameterToCalibrate, ScalarConstraint constraint)	Constructs a parameter.
ScalarParameterInformationImplementation(ScalarConstraint constraint)	Constructs a parameter that needs to be calibrated.

Method Summary

Modifier and Type	Method	Description
ScalarConstraint	getConstraint()	Returns the constraint.
boolean	getIsParameterToCalibrate()	Boolean flag for parameters that need to be calibrated.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScalarParameterInformationImplementation

public ScalarParameterInformationImplementation(boolean isParameterToCalibrate,
                                                ScalarConstraint constraint)

Constructs a parameter.

Parameters:

isParameterToCalibrate - If true, the parameter will be varied during calibration.

constraint - A constraint for the parameter.

ScalarParameterInformationImplementation

public ScalarParameterInformationImplementation(boolean isParameterToCalibrate)

Constructs an unconstrained parameter.

Parameters:

isParameterToCalibrate - If true, the parameter will be varied during calibration.

ScalarParameterInformationImplementation

public ScalarParameterInformationImplementation(ScalarConstraint constraint)

Constructs a parameter that needs to be calibrated.

Parameters:

constraint - A constraint for the parameter.

Method Detail

getIsParameterToCalibrate

public boolean getIsParameterToCalibrate()

Description copied from interface: ScalarParameterInformation

Boolean flag for parameters that need to be calibrated.

Specified by:

getIsParameterToCalibrate in interface ScalarParameterInformation

Returns:

true if the parameter must be calibrated.

getConstraint

public ScalarConstraint getConstraint()

Description copied from interface: ScalarParameterInformation

Returns the constraint.

Specified by:

getConstraint in interface ScalarParameterInformation

Returns:

the constraint.