finMath lib documentation
net.finmath.montecarlo.interestrate.models.covariance

## Class DisplacedLocalVolatilityModel

• All Implemented Interfaces:
Serializable, LIBORCovarianceModel, LIBORCovarianceModelCalibrateable

public class DisplacedLocalVolatilityModel
extends AbstractLIBORCovarianceModelParametric
Displaced model build on top of a standard covariance model. The model constructed for the i-th factor loading is
(Li(t) + d) Fi(t)
where d is the displacement and Li is the realization of the i-th component of the stochastic process and Fi is the factor loading from the given covariance model. The parameter of this model is a joint parameter vector, consisting of the parameter vector of the given base covariance model and appending the displacement parameter at the end. If this model is not calibrateable, its parameter vector is that of the covariance model, i.e., only the displacement parameter will be not part of the calibration.
Version:
1.0
Author:
Christian Fries
Serialized Form
• ### Constructor Summary

Constructors
Constructor and Description
DisplacedLocalVolatilityModel(AbstractLIBORCovarianceModelParametric covarianceModel, double displacement, boolean isCalibrateable)
Displaced model build on top of a standard covariance model.
DisplacedLocalVolatilityModel(AbstractLIBORCovarianceModelParametric covarianceModel, RandomVariable displacement, boolean isCalibrateable)
Displaced model build on top of a standard covariance model.
• ### Method Summary

All Methods
Modifier and Type Method and Description
Object clone()
AbstractLIBORCovarianceModelParametric getBaseCovarianceModel()
Returns the base covariance model, i.e., the model providing the factor loading F such that this model's i-th factor loading is (a Li,0 + (1-a)Li(t)) Fi(t) where a is the displacement and Li is the realization of the i-th component of the stochastic process and Fi is the factor loading loading from the given covariance model.
AbstractLIBORCovarianceModelParametric getCloneWithModifiedData(Map<String,Object> dataModified)
Returns a clone of this model where the specified properties have been modified.
AbstractLIBORCovarianceModelParametric getCloneWithModifiedParameters(double[] parameters)
Return an instance of this model using a new set of parameters.
AbstractLIBORCovarianceModelParametric getCloneWithModifiedParameters(RandomVariable[] parameters)
Return an instance of this model using a new set of parameters.
RandomVariable getDisplacement()
RandomVariable[] getFactorLoading(int timeIndex, int component, RandomVariable[] realizationAtTimeIndex)
Return the factor loading for a given time index and component index.
RandomVariable getFactorLoadingPseudoInverse(int timeIndex, int component, int factor, RandomVariable[] realizationAtTimeIndex)
Returns the pseudo inverse of the factor matrix.
RandomVariable[] getParameter()
Get the parameters of determining this parametric covariance model.
double[] getParameterAsDouble()
Get the parameters of determining this parametric covariance model.
• ### Methods inherited from class net.finmath.montecarlo.interestrate.models.covariance.AbstractLIBORCovarianceModelParametric

getCloneCalibrated, getCloneCalibrated, getCloneCalibratedLegazy, toString
• ### Methods inherited from class net.finmath.montecarlo.interestrate.models.covariance.AbstractLIBORCovarianceModel

getCovariance, getCovariance, getFactorLoading, getFactorLoading, getLiborPeriodDiscretization, getNumberOfFactors, getTimeDiscretization
• ### Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
• ### Methods inherited from interface net.finmath.montecarlo.interestrate.models.covariance.LIBORCovarianceModel

getCovariance, getCovariance, getFactorLoading, getFactorLoading, getLiborPeriodDiscretization, getNumberOfFactors, getTimeDiscretization
• ### Constructor Detail

• #### DisplacedLocalVolatilityModel

public DisplacedLocalVolatilityModel(AbstractLIBORCovarianceModelParametric covarianceModel,
RandomVariable displacement,
boolean isCalibrateable)
Displaced model build on top of a standard covariance model. The model constructed for the i-th factor loading is
(Li(t) + d) Fi(t)
where d is the displacement and Li is the realization of the i-th component of the stochastic process and Fi is the factor loading from the given covariance model. The parameter of this model is a joint parameter vector, consisting of the parameter vector of the given base covariance model and appending the displacement parameter at the end. If this model is not calibrateable, its parameter vector is that of the covariance model, i.e., only the displacement parameter will be not part of the calibration.
Parameters:
covarianceModel - The given covariance model specifying the factor loadings F.
displacement - The displacement a.
isCalibrateable - If true, the parameter a is a free parameter. Note that the covariance model may have its own parameter calibration settings.
• #### DisplacedLocalVolatilityModel

public DisplacedLocalVolatilityModel(AbstractLIBORCovarianceModelParametric covarianceModel,
double displacement,
boolean isCalibrateable)
Displaced model build on top of a standard covariance model. The model constructed for the i-th factor loading is
(Li(t) + d) Fi(t)
where d is the displacement and Li is the realization of the i-th component of the stochastic process and Fi is the factor loading from the given covariance model. The parameter of this model is a joint parameter vector, consisting of the parameter vector of the given base covariance model and appending the displacement parameter at the end. If this model is not calibrateable, its parameter vector is that of the covariance model, i.e., only the displacement parameter will be not part of the calibration.
Parameters:
covarianceModel - The given covariance model specifying the factor loadings F.
displacement - The displacement a.
isCalibrateable - If true, the parameter a is a free parameter. Note that the covariance model may have its own parameter calibration settings.
• ### Method Detail

• #### clone

public Object clone()
Specified by:
clone in class AbstractLIBORCovarianceModelParametric
• #### getBaseCovarianceModel

public AbstractLIBORCovarianceModelParametric getBaseCovarianceModel()
(a Li,0 + (1-a)Li(t)) Fi(t)
where a is the displacement and Li is the realization of the i-th component of the stochastic process and Fi is the factor loading loading from the given covariance model.
Returns:
The base covariance model.
• #### getParameter

public RandomVariable[] getParameter()
Description copied from class: AbstractLIBORCovarianceModelParametric
Get the parameters of determining this parametric covariance model. The parameters are usually free parameters which may be used in calibration.
Overrides:
getParameter in class AbstractLIBORCovarianceModelParametric
Returns:
Parameter vector.
• #### getParameterAsDouble

public double[] getParameterAsDouble()
Description copied from class: AbstractLIBORCovarianceModelParametric
Get the parameters of determining this parametric covariance model. The parameters are usually free parameters which may be used in calibration.
Specified by:
getParameterAsDouble in class AbstractLIBORCovarianceModelParametric
Returns:
Parameter vector.
• #### getCloneWithModifiedParameters

public AbstractLIBORCovarianceModelParametric getCloneWithModifiedParameters(RandomVariable[] parameters)
Description copied from class: AbstractLIBORCovarianceModelParametric
Return an instance of this model using a new set of parameters. Note: To improve performance it is admissible to return the same instance of the object given that the parameters have not changed. Models should be immutable.
Overrides:
getCloneWithModifiedParameters in class AbstractLIBORCovarianceModelParametric
Parameters:
parameters - The new set of parameters.
Returns:
An instance of AbstractLIBORCovarianceModelParametric with modified parameters.
• #### getCloneWithModifiedParameters

public AbstractLIBORCovarianceModelParametric getCloneWithModifiedParameters(double[] parameters)
Description copied from class: AbstractLIBORCovarianceModelParametric
Return an instance of this model using a new set of parameters. Note: To improve performance it is admissible to return the same instance of the object given that the parameters have not changed. Models should be immutable.
Specified by:
getCloneWithModifiedParameters in class AbstractLIBORCovarianceModelParametric
Parameters:
parameters - The new set of parameters.
Returns:
An instance of AbstractLIBORCovarianceModelParametric with modified parameters.

public RandomVariable[] getFactorLoading(int timeIndex,
int component,
RandomVariable[] realizationAtTimeIndex)
Description copied from interface: LIBORCovarianceModel
Return the factor loading for a given time index and component index. The factor loading is the vector fi such that the scalar product
fjfk = fj,1fk,1 + ... + fj,mfk,m
is the instantaneous covariance of the component j and k.
Specified by:
getFactorLoading in interface LIBORCovarianceModel
Specified by:
getFactorLoading in class AbstractLIBORCovarianceModel
Parameters:
timeIndex - The time index at which factor loading is requested.
component - The index of the component i.
realizationAtTimeIndex - The realization of the stochastic process (may be used to implement local volatility/covariance/correlation models).
Returns:

public RandomVariable getFactorLoadingPseudoInverse(int timeIndex,
int component,
int factor,
RandomVariable[] realizationAtTimeIndex)
Description copied from interface: LIBORCovarianceModel
Returns the pseudo inverse of the factor matrix.
Specified by:
getFactorLoadingPseudoInverse in interface LIBORCovarianceModel
Specified by:
getFactorLoadingPseudoInverse in class AbstractLIBORCovarianceModel
Parameters:
timeIndex - The time index at which factor loading inverse is requested.
component - The index of the component i.
factor - The index of the factor j.
realizationAtTimeIndex - The realization of the stochastic process (may be used to implement local volatility/covariance/correlation models).
Returns:
• #### getDisplacement

public RandomVariable getDisplacement()
• #### getCloneWithModifiedData

public AbstractLIBORCovarianceModelParametric getCloneWithModifiedData(Map<String,Object> dataModified)
throws CalculationException
Description copied from interface: LIBORCovarianceModel
Returns a clone of this model where the specified properties have been modified. Note that there is no guarantee that a model reacts on a specification of a properties in the parameter map dataModified. If data is provided which is ignored by the model no exception may be thrown. Furthermore the structure of the covariance model has to match changed data. A change of the time discretizations may requires a change in the parameters but this function will just insert the new time discretization without changing the parameters. An exception may not be thrown.
Specified by:
getCloneWithModifiedData in interface LIBORCovarianceModel
Specified by:
getCloneWithModifiedData in class AbstractLIBORCovarianceModel
Parameters:
dataModified - Key-value-map of parameters to modify.
Returns:
A clone of this model (or a new instance of this model if no parameter was modified).
Throws:
CalculationException - Thrown when the model could not be created.