Module net.finmath.lib
Class SABRVolatilityCube
java.lang.Object
net.finmath.singleswaprate.model.volatilities.SABRVolatilityCube
- All Implemented Interfaces:
Serializable
,VolatilityCube
A volatility cube that uses a grid of SABR models for the calculation of the volatility with different strikes. The SABR parameters \( \beta \) and displacement are globally set for the entire cube.
For the other SABR parameters the cube stores a grid of maturity x termination and a set of parameters for each node of this grid. Between the nodes of this grid, the SABR parameters are interpolated.
- Author:
- Christian Fries, Roland Bachl
- See Also:
-
Constructor Summary
ConstructorDescriptionSABRVolatilityCube
(String name, LocalDate referenceDate, DataTable swapRateTable, double sabrDisplacement, double sabrBeta, DataTable rhoTable, DataTable baseVolTable, DataTable volvolTable, double correlationDecay) Create the cube.SABRVolatilityCube
(String name, LocalDate referenceDate, DataTable swapRateTable, double sabrDisplacement, double sabrBeta, DataTable rhoTable, DataTable baseVolTable, DataTable volvolTable, double correlationDecay, double iborOisDecorrelation) Create the cube. -
Method Summary
Modifier and TypeMethodDescriptiondouble
Return the correlation decay parameter of the cube.double
Return the IBOR vs OIS decorrelation parameter.double
Returns the lowest possible value of strike that can be evaluated by this cube.getName()
Returns the name of the volatility cube.Returns a map with all implementation dependent parameters of this volatility cube.Return the reference date of this cube, i.e.double
getValue
(double termination, double maturity, double strike, VolatilitySurface.QuotingConvention quotingConvention) Return the volatility at the specified coordinates in the desired quotation.double
getValue
(VolatilityCubeModel model, double termination, double maturity, double strike, VolatilitySurface.QuotingConvention quotingConvention) Return the volatility at the specified coordinates in the desired quotation.
-
Constructor Details
-
SABRVolatilityCube
public SABRVolatilityCube(String name, LocalDate referenceDate, DataTable swapRateTable, double sabrDisplacement, double sabrBeta, DataTable rhoTable, DataTable baseVolTable, DataTable volvolTable, double correlationDecay) Create the cube. With ibor ois decorrelation set to 1.0.- Parameters:
name
- The name of the cube.referenceDate
- The reference date of the cube.swapRateTable
- Table containing base swap rates.sabrDisplacement
- Displacement for the entire cube.sabrBeta
- Beta for the entire cube.rhoTable
- Table containing rhos.baseVolTable
- Table containing initial volatilities.volvolTable
- Table containing volvols.correlationDecay
- The correlation decay parameters of this cube.
-
SABRVolatilityCube
public SABRVolatilityCube(String name, LocalDate referenceDate, DataTable swapRateTable, double sabrDisplacement, double sabrBeta, DataTable rhoTable, DataTable baseVolTable, DataTable volvolTable, double correlationDecay, double iborOisDecorrelation) Create the cube.- Parameters:
name
- The name of the cube.referenceDate
- The reference date of the cube.swapRateTable
- Table containing base swap rates.sabrDisplacement
- Displacement for the entire cube.sabrBeta
- Beta for the entire cube.rhoTable
- Table containing rhos.baseVolTable
- Table containing initial volatilities.volvolTable
- Table containing volvols.correlationDecay
- The correlation decay parameters of this cube.iborOisDecorrelation
- The ibor ois decorrelation parameter of this cube.
-
-
Method Details
-
getValue
public double getValue(VolatilityCubeModel model, double termination, double maturity, double strike, VolatilitySurface.QuotingConvention quotingConvention) Description copied from interface:VolatilityCube
Return the volatility at the specified coordinates in the desired quotation.- Specified by:
getValue
in interfaceVolatilityCube
- Parameters:
model
- A model providing context.termination
- End date of the underlying.maturity
- Maturity date of the option.strike
- Strike rate of the option.quotingConvention
- Desired quoting convention.- Returns:
- The volatility.
-
getValue
public double getValue(double termination, double maturity, double strike, VolatilitySurface.QuotingConvention quotingConvention) Description copied from interface:VolatilityCube
Return the volatility at the specified coordinates in the desired quotation.- Specified by:
getValue
in interfaceVolatilityCube
- Parameters:
termination
- End date of the underlying.maturity
- Maturity date of the option.strike
- Strike rate of the option.quotingConvention
- Desired quoting convention.- Returns:
- The volatility.
-
getName
Description copied from interface:VolatilityCube
Returns the name of the volatility cube.- Specified by:
getName
in interfaceVolatilityCube
- Returns:
- The name of the volatility cube.
-
getReferenceDate
Description copied from interface:VolatilityCube
Return the reference date of this cube, i.e. the date associated with t=0.- Specified by:
getReferenceDate
in interfaceVolatilityCube
- Returns:
- The date identified as t=0.
-
getCorrelationDecay
public double getCorrelationDecay()Description copied from interface:VolatilityCube
Return the correlation decay parameter of the cube. This is used to determine the correlation between tenors in a derived volvol cube.- Specified by:
getCorrelationDecay
in interfaceVolatilityCube
- Returns:
- The correlation decay parameter.
-
getParameters
Description copied from interface:VolatilityCube
Returns a map with all implementation dependent parameters of this volatility cube.- Specified by:
getParameters
in interfaceVolatilityCube
- Returns:
- A map of all parameters.
-
getLowestStrike
Description copied from interface:VolatilityCube
Returns the lowest possible value of strike that can be evaluated by this cube. This is relevant for instance when an implementation uses a SABR model with displacement.- Specified by:
getLowestStrike
in interfaceVolatilityCube
- Parameters:
model
- A model for context.- Returns:
- Lowest possible strike this volatility cube supports.
-
getIborOisDecorrelation
public double getIborOisDecorrelation()Description copied from interface:VolatilityCube
Return the IBOR vs OIS decorrelation parameter. This parameter scales the convexity adjustment in a multi curve model, using different curves for forward rates and discounting.- Specified by:
getIborOisDecorrelation
in interfaceVolatilityCube
- Returns:
- The IBOR vs OIS decorrelation parameter.
-
getUnderlyingTable
- Returns:
- The table of swap rates.
-
getRhoTable
- Returns:
- The table of rhos.
-
getBaseVolTable
- Returns:
- The table containing initial volatilities.
-
getVolvolTable
- Returns:
- The table containing volvols.
-