Module net.finmath.lib
Package net.finmath.montecarlo.interestrate.models.covariance

Class LIBORVolatilityModelMaturityDependentFourParameterExponentialForm

java.lang.Object
net.finmath.montecarlo.interestrate.models.covariance.LIBORVolatilityModel
net.finmath.montecarlo.interestrate.models.covariance.LIBORVolatilityModelMaturityDependentFourParameterExponentialForm
All Implemented Interfaces:
Serializable
public class LIBORVolatilityModelMaturityDependentFourParameterExponentialForm extends LIBORVolatilityModel
Version:
1.0
Author:
Christian Fries
See Also:
Serialized Form

  • Constructor Details

    • LIBORVolatilityModelMaturityDependentFourParameterExponentialForm

      public LIBORVolatilityModelMaturityDependentFourParameterExponentialForm​(TimeDiscretization timeDiscretization, TimeDiscretization liborPeriodDiscretization, RandomVariable[] parameterA, RandomVariable[] parameterB, RandomVariable[] parameterC, RandomVariable[] parameterD)

    • LIBORVolatilityModelMaturityDependentFourParameterExponentialForm

      public LIBORVolatilityModelMaturityDependentFourParameterExponentialForm​(RandomVariableFactory randomVariableFactory, TimeDiscretization timeDiscretization, TimeDiscretization liborPeriodDiscretization, double[] a, double[] b, double[] c, double[] d)
      Parameters:
      randomVariableFactory - The random variable factor used to construct random variables from the parameters.
      timeDiscretization - The simulation time discretization tj.
      liborPeriodDiscretization - The period time discretization Ti.
      a - The parameter a: an initial volatility level.
      b - The parameter b: the slope at the short end (shortly before maturity).
      c - The parameter c: exponential decay of the volatility in time-to-maturity.
      d - The parameter d: if c > 0 this is the very long term volatility level.

    • LIBORVolatilityModelMaturityDependentFourParameterExponentialForm

      public LIBORVolatilityModelMaturityDependentFourParameterExponentialForm​(RandomVariableFactory randomVariableFactory, TimeDiscretization timeDiscretization, TimeDiscretization liborPeriodDiscretization, double a, double b, double c, double d)
      Parameters:
      randomVariableFactory - The random variable factor used to construct random variables from the parameters.
      timeDiscretization - The simulation time discretization tj.
      liborPeriodDiscretization - The period time discretization Ti.
      a - The parameter a: an initial volatility level.
      b - The parameter b: the slope at the short end (shortly before maturity).
      c - The parameter c: exponential decay of the volatility in time-to-maturity.
      d - The parameter d: if c > 0 this is the very long term volatility level.

    • LIBORVolatilityModelMaturityDependentFourParameterExponentialForm

      public LIBORVolatilityModelMaturityDependentFourParameterExponentialForm​(TimeDiscretization timeDiscretization, TimeDiscretization liborPeriodDiscretization, double a, double b, double c, double d)
      Parameters:
      timeDiscretization - The simulation time discretization tj.
      liborPeriodDiscretization - The period time discretization Ti.
      a - The parameter a: an initial volatility level.
      b - The parameter b: the slope at the short end (shortly before maturity).
      c - The parameter c: exponential decay of the volatility in time-to-maturity.
      d - The parameter d: if c > 0 this is the very long term volatility level.

    • LIBORVolatilityModelMaturityDependentFourParameterExponentialForm

      public LIBORVolatilityModelMaturityDependentFourParameterExponentialForm​(TimeDiscretization timeDiscretization, TimeDiscretization liborPeriodDiscretization, double[] a, double[] b, double[] c, double[] d)
      Parameters:
      timeDiscretization - The simulation time discretization tj.
      liborPeriodDiscretization - The period time discretization Ti.
      a - The parameter a: an initial volatility level.
      b - The parameter b: the slope at the short end (shortly before maturity).
      c - The parameter c: exponential decay of the volatility in time-to-maturity.
      d - The parameter d: if c > 0 this is the very long term volatility level.

  • Method Details

    • getParameter

      public RandomVariable[] getParameter()
      Specified by:
      getParameter in class LIBORVolatilityModel

    • getCloneWithModifiedParameter

      public LIBORVolatilityModelMaturityDependentFourParameterExponentialForm getCloneWithModifiedParameter​(RandomVariable[] parameter)
      Specified by:
      getCloneWithModifiedParameter in class LIBORVolatilityModel

    • getVolatility

      public RandomVariable getVolatility​(int timeIndex, int liborIndex)
      Description copied from class: LIBORVolatilityModel
      Implement this method to complete the implementation.
      Specified by:
      getVolatility in class LIBORVolatilityModel
      Parameters:
      timeIndex - The time index (for timeDiscretizationFromArray)
      liborIndex - The libor index (for liborPeriodDiscretization)
      Returns:
      A random variable (e.g. as a vector of doubles) representing the volatility for each path.

    • clone

      public Object clone()
      Specified by:
      clone in class LIBORVolatilityModel

    • getCloneWithModifiedData

      public LIBORVolatilityModel getCloneWithModifiedData​(Map<String,​Object> dataModified)
      Description copied from class: LIBORVolatilityModel
      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 correlation 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 class LIBORVolatilityModel
      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).