Module net.finmath.lib

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

Class LIBORVolatilityModelPiecewiseConstant

java.lang.Object

net.finmath.montecarlo.interestrate.models.covariance.LIBORVolatilityModel

net.finmath.montecarlo.interestrate.models.covariance.LIBORVolatilityModelPiecewiseConstant

All Implemented Interfaces:

Serializable

public class LIBORVolatilityModelPiecewiseConstant
extends LIBORVolatilityModel

Version:

1.0

Author:

Christian Fries

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
LIBORVolatilityModelPiecewiseConstant(RandomVariableFactory abstractRandomVariableFactory, TimeDiscretization timeDiscretization, TimeDiscretization liborPeriodDiscretization, TimeDiscretization simulationTimeDiscretization, TimeDiscretization timeToMaturityDiscretization, double[][] volatility, boolean isCalibrateable)
LIBORVolatilityModelPiecewiseConstant(RandomVariableFactory abstractRandomVariableFactory, TimeDiscretization timeDiscretization, TimeDiscretization liborPeriodDiscretization, TimeDiscretization simulationTimeDiscretization, TimeDiscretization timeToMaturityDiscretization, double[] volatility, boolean isCalibrateable)
LIBORVolatilityModelPiecewiseConstant(TimeDiscretization timeDiscretization, TimeDiscretization liborPeriodDiscretization, TimeDiscretization simulationTimeDiscretization, TimeDiscretization timeToMaturityDiscretization, double volatility)
LIBORVolatilityModelPiecewiseConstant(TimeDiscretization timeDiscretization, TimeDiscretization liborPeriodDiscretization, TimeDiscretization simulationTimeDiscretization, TimeDiscretization timeToMaturityDiscretization, double[] volatility)
LIBORVolatilityModelPiecewiseConstant(TimeDiscretization timeDiscretization, TimeDiscretization liborPeriodDiscretization, TimeDiscretization simulationTimeDiscretization, TimeDiscretization timeToMaturityDiscretization, double[] volatility, boolean isCalibrateable)
LIBORVolatilityModelPiecewiseConstant(TimeDiscretization timeDiscretization, TimeDiscretization liborPeriodDiscretization, TimeDiscretization simulationTimeDiscretization, TimeDiscretization timeToMaturityDiscretization, double volatility, boolean isCalibrateable)
LIBORVolatilityModelPiecewiseConstant(TimeDiscretization timeDiscretization, TimeDiscretization liborPeriodDiscretization, TimeDiscretization simulationTimeDiscretization, TimeDiscretization timeToMaturityDiscretization, RandomVariable[] volatility, boolean isCalibrateable)

Method Summary

Modifier and Type	Method	Description
Object	clone()
LIBORVolatilityModel	getCloneWithModifiedData(Map<String,Object> dataModified)	Returns a clone of this model where the specified properties have been modified.
LIBORVolatilityModel	getCloneWithModifiedParameter(RandomVariable[] parameter)
RandomVariable[]	getParameter()
TimeDiscretization	getSimulationTimeDiscretization()
TimeDiscretization	getTimeToMaturityDiscretization()
RandomVariable	getVolatility(int timeIndex, int liborIndex)	Implement this method to complete the implementation.

Methods inherited from class net.finmath.montecarlo.interestrate.models.covariance.LIBORVolatilityModel

getLiborPeriodDiscretization, getParameterAsDouble, getTimeDiscretization

Methods inherited from class java.lang.Object

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

Constructor Detail

LIBORVolatilityModelPiecewiseConstant

public LIBORVolatilityModelPiecewiseConstant(TimeDiscretization timeDiscretization,
                                             TimeDiscretization liborPeriodDiscretization,
                                             TimeDiscretization simulationTimeDiscretization,
                                             TimeDiscretization timeToMaturityDiscretization,
                                             RandomVariable[] volatility,
                                             boolean isCalibrateable)

LIBORVolatilityModelPiecewiseConstant

public LIBORVolatilityModelPiecewiseConstant(RandomVariableFactory abstractRandomVariableFactory,
                                             TimeDiscretization timeDiscretization,
                                             TimeDiscretization liborPeriodDiscretization,
                                             TimeDiscretization simulationTimeDiscretization,
                                             TimeDiscretization timeToMaturityDiscretization,
                                             double[][] volatility,
                                             boolean isCalibrateable)

LIBORVolatilityModelPiecewiseConstant

public LIBORVolatilityModelPiecewiseConstant(RandomVariableFactory abstractRandomVariableFactory,
                                             TimeDiscretization timeDiscretization,
                                             TimeDiscretization liborPeriodDiscretization,
                                             TimeDiscretization simulationTimeDiscretization,
                                             TimeDiscretization timeToMaturityDiscretization,
                                             double[] volatility,
                                             boolean isCalibrateable)

LIBORVolatilityModelPiecewiseConstant

public LIBORVolatilityModelPiecewiseConstant(TimeDiscretization timeDiscretization,
                                             TimeDiscretization liborPeriodDiscretization,
                                             TimeDiscretization simulationTimeDiscretization,
                                             TimeDiscretization timeToMaturityDiscretization,
                                             double[] volatility,
                                             boolean isCalibrateable)

LIBORVolatilityModelPiecewiseConstant

public LIBORVolatilityModelPiecewiseConstant(TimeDiscretization timeDiscretization,
                                             TimeDiscretization liborPeriodDiscretization,
                                             TimeDiscretization simulationTimeDiscretization,
                                             TimeDiscretization timeToMaturityDiscretization,
                                             double volatility,
                                             boolean isCalibrateable)

LIBORVolatilityModelPiecewiseConstant

public LIBORVolatilityModelPiecewiseConstant(TimeDiscretization timeDiscretization,
                                             TimeDiscretization liborPeriodDiscretization,
                                             TimeDiscretization simulationTimeDiscretization,
                                             TimeDiscretization timeToMaturityDiscretization,
                                             double[] volatility)

LIBORVolatilityModelPiecewiseConstant

public LIBORVolatilityModelPiecewiseConstant(TimeDiscretization timeDiscretization,
                                             TimeDiscretization liborPeriodDiscretization,
                                             TimeDiscretization simulationTimeDiscretization,
                                             TimeDiscretization timeToMaturityDiscretization,
                                             double volatility)

Method Detail

getParameter

public RandomVariable[] getParameter()

Specified by:

getParameter in class LIBORVolatilityModel

getCloneWithModifiedParameter

public LIBORVolatilityModel 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

getSimulationTimeDiscretization

public TimeDiscretization getSimulationTimeDiscretization()

Returns:

the simulationTimeDiscretization

getTimeToMaturityDiscretization

public TimeDiscretization getTimeToMaturityDiscretization()

Returns:

the timeToMaturityDiscretization

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).