Module net.finmath.lib

Package net.finmath.singleswaprate.products

Class CashSettledReceiverSwaption

java.lang.Object

net.finmath.singleswaprate.products.AbstractAnalyticVolatilityCubeProduct

net.finmath.singleswaprate.products.AbstractSingleSwapRateProduct

net.finmath.singleswaprate.products.CashSettledReceiverSwaption

All Implemented Interfaces:

AnalyticProduct, Product, AnalyticVolatilityCubeProduct

public class CashSettledReceiverSwaption
extends AbstractSingleSwapRateProduct

A European cash settled receiver swaption.

Author:

Christian Fries, Roland Bachl

Constructor Summary

Constructors

Constructor	Description
CashSettledReceiverSwaption(Schedule fixSchedule, Schedule floatSchedule, double strike, String discountCurveName, String forwardCurveName, String volatilityCubeName, AnnuityMapping.AnnuityMappingType annuityMappingType)	Create the product.
CashSettledReceiverSwaption(Schedule fixSchedule, Schedule floatSchedule, double strike, String discountCurveName, String forwardCurveName, String volatilityCubeName, AnnuityMapping.AnnuityMappingType annuityMappingType, double replicationLowerBound, double replicationUpperBound, int replicationNumberOfEvaluationPoints)	Create the product with custom replication settings.

Method Summary

Modifier and Type	Method	Description
protected AnnuityMapping	buildAnnuityMapping(VolatilityCubeModel model)	Since most annuity mappings require data from models to be created, but models are only provided at execution of getValue, the product needs to dynamically be able to build its annuity mapping.
protected double	hedgeWeight(double swapRate, AnnuityMapping annuityMapping, VolatilityCubeModel model)	Essentially the second derivative of the payoff function.
protected double	payoffFunction(double swapRate, AnnuityMapping annuityMapping, VolatilityCubeModel model)	Payoff function of the product.
protected double	singularAddon(double swapRate, AnnuityMapping annuityMapping, VolatilityCubeModel model)	As some products have a portion of their weight in a singular point, this is portion is split off from the hedgeweight and added after the integration.

Methods inherited from class net.finmath.singleswaprate.products.AbstractSingleSwapRateProduct

getDiscountCurveName, getFixSchedule, getFloatSchedule, getForwardCurveName, getIntegrationLowerBound, getIntegrationNumberOfEvaluationPoints, getIntegrationUpperBound, getValue, getValue, getVolatilityCubeName, setIntegrationParameters, valueCall, valuePut

Methods inherited from class net.finmath.singleswaprate.products.AbstractAnalyticVolatilityCubeProduct

getValue, getValue, getValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.finmath.modelling.Product

getValues

Constructor Detail

CashSettledReceiverSwaption

public CashSettledReceiverSwaption(Schedule fixSchedule,
                                   Schedule floatSchedule,
                                   double strike,
                                   String discountCurveName,
                                   String forwardCurveName,
                                   String volatilityCubeName,
                                   AnnuityMapping.AnnuityMappingType annuityMappingType)

Create the product.

Parameters:

fixSchedule - The fix schedule of the swap.

floatSchedule - The float schedule of the swap.

strike - The strike of the option.

discountCurveName - The name of the discount curve.

forwardCurveName - The name of the forward curve.

volatilityCubeName - The name of the volatility cube.

annuityMappingType - The type of annuity mapping to be used for evaluation.

CashSettledReceiverSwaption

public CashSettledReceiverSwaption(Schedule fixSchedule,
                                   Schedule floatSchedule,
                                   double strike,
                                   String discountCurveName,
                                   String forwardCurveName,
                                   String volatilityCubeName,
                                   AnnuityMapping.AnnuityMappingType annuityMappingType,
                                   double replicationLowerBound,
                                   double replicationUpperBound,
                                   int replicationNumberOfEvaluationPoints)

Create the product with custom replication settings.

Parameters:

fixSchedule - The fix schedule of the swap.

floatSchedule - The float schedule of the swap.

strike - The strike of the option.

discountCurveName - The name of the discount curve.

forwardCurveName - The name of the forward curve.

volatilityCubeName - The name of the volatility cube.

annuityMappingType - The type of annuity mapping to be used for evaluation.

replicationLowerBound - The lowest strike the replication may use.

replicationUpperBound - The largest strike the replication may use.

replicationNumberOfEvaluationPoints - The number of points the replication may evaluate.

Method Detail

payoffFunction

protected double payoffFunction(double swapRate,
                                AnnuityMapping annuityMapping,
                                VolatilityCubeModel model)

Description copied from class: AbstractSingleSwapRateProduct

Payoff function of the product. Dependent only on the swap rate.

Specified by:

payoffFunction in class AbstractSingleSwapRateProduct

Parameters:

swapRate - The swap rate.

annuityMapping - The annuity mapping to use.

model - The model for context.

Returns:

The payoff of the product.

hedgeWeight

protected double hedgeWeight(double swapRate,
                             AnnuityMapping annuityMapping,
                             VolatilityCubeModel model)

Description copied from class: AbstractSingleSwapRateProduct

Essentially the second derivative of the payoff function. The hedgeweight determines the weight of the puts and calls under the integral when replicating.

Specified by:

hedgeWeight in class AbstractSingleSwapRateProduct

Parameters:

swapRate - The swap rate.

annuityMapping - The annuity mapping to use.

model - The model for context.

Returns:

The weight during replication.

singularAddon

protected double singularAddon(double swapRate,
                               AnnuityMapping annuityMapping,
                               VolatilityCubeModel model)

Description copied from class: AbstractSingleSwapRateProduct

As some products have a portion of their weight in a singular point, this is portion is split off from the hedgeweight and added after the integration.

Specified by:

singularAddon in class AbstractSingleSwapRateProduct

Parameters:

swapRate - The swap rate.

annuityMapping - The annuity mapping to use.

model - The model for context.

Returns:

The singular addon.

buildAnnuityMapping

protected AnnuityMapping buildAnnuityMapping(VolatilityCubeModel model)

Description copied from class: AbstractSingleSwapRateProduct

Since most annuity mappings require data from models to be created, but models are only provided at execution of getValue, the product needs to dynamically be able to build its annuity mapping. This method may be left to return null, if the product requires no annuity mapping or is intended to always receive an annuity mapping for evaluation.

Specified by:

buildAnnuityMapping in class AbstractSingleSwapRateProduct

Parameters:

model - The model for context.

Returns:

The annuity mapping.