Module net.finmath.lib

Package net.finmath.singleswaprate.products

Class AnnuityDummyProduct

java.lang.Object

net.finmath.singleswaprate.products.AbstractAnalyticVolatilityCubeProduct

net.finmath.singleswaprate.products.AbstractSingleSwapRateProduct

net.finmath.singleswaprate.products.AnnuityDummyProduct

All Implemented Interfaces:

AnalyticProduct, Product, AnalyticVolatilityCubeProduct

public class AnnuityDummyProduct
extends AbstractSingleSwapRateProduct

A dummy product that only evaluates the value of a AnnuityMapping. This can be used to find the expectation correction factor in Piterbarg annuity mapping.

Author:

Christian Fries, Roland Bachl

Constructor Summary

Constructors

Constructor	Description
AnnuityDummyProduct(Schedule fixSchedule, Schedule floatSchedule, String discountCurveName, String forwardCurveName, String volatilityCubeName, AnnuityMapping annuityMapping)	Create the dummy product for the given annuity mapping.
AnnuityDummyProduct(Schedule fixSchedule, Schedule floatSchedule, String discountCurveName, String forwardCurveName, String volatilityCubeName, AnnuityMapping.AnnuityMappingType annuityMappingType)	Create the dummy product with the annuity mapping specified by type.

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

AnnuityDummyProduct

public AnnuityDummyProduct(Schedule fixSchedule,
                           Schedule floatSchedule,
                           String discountCurveName,
                           String forwardCurveName,
                           String volatilityCubeName,
                           AnnuityMapping.AnnuityMappingType annuityMappingType)

Create the dummy product with the annuity mapping specified by type. The mapping will be generated at execution of getValue.

Parameters:

fixSchedule - The fix schedule of the swap.

floatSchedule - The float schedule of the swap.

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 the annuity mapping.

AnnuityDummyProduct

public AnnuityDummyProduct(Schedule fixSchedule,
                           Schedule floatSchedule,
                           String discountCurveName,
                           String forwardCurveName,
                           String volatilityCubeName,
                           AnnuityMapping annuityMapping)

Create the dummy product for the given annuity mapping.

Parameters:

fixSchedule - The fix schedule of the swap.

floatSchedule - The float schedule of the swap.

discountCurveName - The name of the discount curve.

forwardCurveName - The name of the forward curve.

volatilityCubeName - The name of the volatility cube.

annuityMapping - The annuity mapping.

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.