QuantLib
A free/open-source library for quantitative finance
Reference manual - version 1.20
Public Member Functions | List of all members
OptionletStripper1 Class Reference

#include <ql/termstructures/volatility/optionlet/optionletstripper1.hpp>

+ Inheritance diagram for OptionletStripper1:

Public Member Functions

 OptionletStripper1 (const ext::shared_ptr< CapFloorTermVolSurface > &, const ext::shared_ptr< IborIndex > &index, Rate switchStrikes=Null< Rate >(), Real accuracy=1.0e-6, Natural maxIter=100, const Handle< YieldTermStructure > &discount=Handle< YieldTermStructure >(), VolatilityType type=ShiftedLognormal, Real displacement=0.0, bool dontThrow=false)
 
const MatrixcapFloorPrices () const
 
const MatrixcapletVols () const
 
const MatrixcapFloorVolatilities () const
 
const MatrixoptionletPrices () const
 
Rate switchStrike () const
 
- Public Member Functions inherited from OptionletStripper
const std::vector< Rate > & optionletStrikes (Size i) const
 
const std::vector< Volatility > & optionletVolatilities (Size i) const
 
const std::vector< Date > & optionletFixingDates () const
 
const std::vector< Time > & optionletFixingTimes () const
 
Size optionletMaturities () const
 
const std::vector< Rate > & atmOptionletRates () const
 
DayCounter dayCounter () const
 
Calendar calendar () const
 
Natural settlementDays () const
 
BusinessDayConvention businessDayConvention () const
 
const std::vector< Period > & optionletFixingTenors () const
 
const std::vector< Date > & optionletPaymentDates () const
 
const std::vector< Time > & optionletAccrualPeriods () const
 
ext::shared_ptr< CapFloorTermVolSurfacetermVolSurface () const
 
ext::shared_ptr< IborIndexiborIndex () const
 
Real displacement () const
 
VolatilityType volatilityType () const
 
- Public Member Functions inherited from LazyObject
void update ()
 
void recalculate ()
 
void freeze ()
 
void unfreeze ()
 
void alwaysForwardNotifications ()
 
- Public Member Functions inherited from Observable
 Observable (const Observable &)
 
Observableoperator= (const Observable &)
 
void notifyObservers ()
 
- Public Member Functions inherited from Observer
 Observer (const Observer &)
 
Observeroperator= (const Observer &)
 
std::pair< iterator, bool > registerWith (const ext::shared_ptr< Observable > &)
 
void registerWithObservables (const ext::shared_ptr< Observer > &)
 
Size unregisterWith (const ext::shared_ptr< Observable > &)
 
void unregisterWithAll ()
 
virtual void deepUpdate ()
 

LazyObject interface

void performCalculations () const
 

Additional Inherited Members

- Public Types inherited from Observer
typedef boost::unordered_set< ext::shared_ptr< Observable > > set_type
 
typedef set_type::iterator iterator
 
- Protected Member Functions inherited from OptionletStripper
 OptionletStripper (const ext::shared_ptr< CapFloorTermVolSurface > &, const ext::shared_ptr< IborIndex > &iborIndex_, const Handle< YieldTermStructure > &discount=Handle< YieldTermStructure >(), VolatilityType type=ShiftedLognormal, Real displacement=0.0)
 
- Protected Member Functions inherited from LazyObject
virtual void calculate () const
 
- Protected Attributes inherited from OptionletStripper
ext::shared_ptr< CapFloorTermVolSurfacetermVolSurface_
 
ext::shared_ptr< IborIndexiborIndex_
 
Handle< YieldTermStructurediscount_
 
Size nStrikes_
 
Size nOptionletTenors_
 
std::vector< std::vector< Rate > > optionletStrikes_
 
std::vector< std::vector< Volatility > > optionletVolatilities_
 
std::vector< TimeoptionletTimes_
 
std::vector< DateoptionletDates_
 
std::vector< PeriodoptionletTenors_
 
std::vector< RateatmOptionletRate_
 
std::vector< DateoptionletPaymentDates_
 
std::vector< TimeoptionletAccrualPeriods_
 
std::vector< PeriodcapFloorLengths_
 
const VolatilityType volatilityType_
 
const Real displacement_
 
- Protected Attributes inherited from LazyObject
bool calculated_
 
bool frozen_
 
bool alwaysForward_
 

Detailed Description

Helper class to strip optionlet (i.e. caplet/floorlet) volatilities (a.k.a. forward-forward volatilities) from the (cap/floor) term volatilities of a CapFloorTermVolSurface.

Member Function Documentation

◆ performCalculations()

void performCalculations ( ) const
virtual

This method must implement any calculations which must be (re)done in order to calculate the desired results.

Implements LazyObject.