StrippedOptionletAdapter Class Reference

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

Inheritance diagram for StrippedOptionletAdapter:

Public Member Functions
	StrippedOptionletAdapter (const ext::shared_ptr< StrippedOptionletBase > &)
TermStructure interface
Date	maxDate () const override
	the latest date for which the curve can return values
VolatilityTermStructure interface
Rate	minStrike () const override
	the minimum strike for which the term structure can return vols
Rate	maxStrike () const override
	the maximum strike for which the term structure can return vols
LazyObject interface
void	update () override
void	performCalculations () const override
ext::shared_ptr< OptionletStripper >	optionletStripper () const
Observer interface
void	deepUpdate () override
VolatilityType	volatilityType () const override
Real	displacement () const override
Public Member Functions inherited from OptionletVolatilityStructure
	OptionletVolatilityStructure (BusinessDayConvention bdc=Following, const DayCounter &dc=DayCounter())
	default constructor
	OptionletVolatilityStructure (const Date &referenceDate, const Calendar &cal, BusinessDayConvention bdc, const DayCounter &dc=DayCounter())
	initialize with a fixed reference date
	OptionletVolatilityStructure (Natural settlementDays, const Calendar &, BusinessDayConvention bdc, const DayCounter &dc=DayCounter())
	calculate the reference date based on the global evaluation date
Volatility	volatility (const Period &optionTenor, Rate strike, bool extrapolate=false) const
	returns the volatility for a given option tenor and strike rate
Volatility	volatility (const Date &optionDate, Rate strike, bool extrapolate=false) const
	returns the volatility for a given option date and strike rate
Volatility	volatility (Time optionTime, Rate strike, bool extrapolate=false) const
	returns the volatility for a given option time and strike rate
Real	blackVariance (const Period &optionTenor, Rate strike, bool extrapolate=false) const
	returns the Black variance for a given option tenor and strike rate
Real	blackVariance (const Date &optionDate, Rate strike, bool extrapolate=false) const
	returns the Black variance for a given option date and strike rate
Real	blackVariance (Time optionTime, Rate strike, bool extrapolate=false) const
	returns the Black variance for a given option time and strike rate
ext::shared_ptr< SmileSection >	smileSection (const Period &optionTenor, bool extr=false) const
	returns the smile for a given option tenor
ext::shared_ptr< SmileSection >	smileSection (const Date &optionDate, bool extr=false) const
	returns the smile for a given option date
ext::shared_ptr< SmileSection >	smileSection (Time optionTime, bool extr=false) const
	returns the smile for a given option time
	VolatilityTermStructure (BusinessDayConvention bdc, const DayCounter &dc=DayCounter())
	VolatilityTermStructure (const Date &referenceDate, const Calendar &cal, BusinessDayConvention bdc, const DayCounter &dc=DayCounter())
	initialize with a fixed reference date
	VolatilityTermStructure (Natural settlementDays, const Calendar &cal, BusinessDayConvention bdc, const DayCounter &dc=DayCounter())
	calculate the reference date based on the global evaluation date
virtual BusinessDayConvention	businessDayConvention () const
	the business day convention used in tenor to date conversion
Date	optionDateFromTenor (const Period &) const
	period/date conversion
Public Member Functions inherited from TermStructure
	TermStructure (DayCounter dc=DayCounter())
	default constructor
	TermStructure (const Date &referenceDate, Calendar calendar=Calendar(), DayCounter dc=DayCounter())
	initialize with a fixed reference date
	TermStructure (Natural settlementDays, Calendar, DayCounter dc=DayCounter())
	calculate the reference date based on the global evaluation date
virtual DayCounter	dayCounter () const
	the day counter used for date/time conversion
Time	timeFromReference (const Date &date) const
	date/time conversion
virtual Time	maxTime () const
	the latest time for which the curve can return values
virtual const Date &	referenceDate () const
	the date at which discount = 1.0 and/or variance = 0.0
virtual Calendar	calendar () const
	the calendar used for reference and/or option date calculation
virtual Natural	settlementDays () const
	the settlementDays used for reference date calculation
void	update () override
Public Member Functions inherited from Observer
	Observer (const Observer &)
Observer &	operator= (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 ()
Public Member Functions inherited from Observable
	Observable (const Observable &)
Observable &	operator= (const Observable &)
	Observable (Observable &&)=delete
Observable &	operator= (Observable &&)=delete
void	notifyObservers ()
Public Member Functions inherited from Extrapolator
void	enableExtrapolation (bool b=true)
	enable extrapolation in subsequent calls
void	disableExtrapolation (bool b=true)
	disable extrapolation in subsequent calls
bool	allowsExtrapolation () const
	tells whether extrapolation is enabled
Public Member Functions inherited from LazyObject
bool	isCalculated () const
void	forwardFirstNotificationOnly ()
void	alwaysForwardNotifications ()
void	recalculate ()
void	freeze ()
void	unfreeze ()

OptionletVolatilityStructure interface
ext::shared_ptr< SmileSection >	smileSectionImpl (Time optionTime) const override
	implements the actual smile calculation in derived classes
Volatility	volatilityImpl (Time length, Rate strike) const override
	implements the actual volatility calculation in derived classes

Additional Inherited Members
Public Types inherited from Observer
typedef set_type::iterator	iterator
virtual ext::shared_ptr< SmileSection >	smileSectionImpl (const Date &optionDate) const
virtual Volatility	volatilityImpl (const Date &optionDate, Rate strike) const
void	checkStrike (Rate strike, bool extrapolate) const
	strike-range check
void	checkRange (const Date &d, bool extrapolate) const
	date-range check
void	checkRange (Time t, bool extrapolate) const
	time-range check
virtual void	calculate () const
bool	moving_ = false
bool	updated_ = true
Calendar	calendar_
bool	calculated_ = false
bool	frozen_ = false
bool	alwaysForward_

Detailed Description

Adapter class for turning a StrippedOptionletBase object into an OptionletVolatilityStructure.

Member Function Documentation

maxDate()

Date maxDate ( ) const

overridevirtual

the latest date for which the curve can return values

Implements TermStructure.

minStrike()

Rate minStrike ( ) const

overridevirtual

the minimum strike for which the term structure can return vols

Implements VolatilityTermStructure.

maxStrike()

Rate maxStrike ( ) const

overridevirtual

the maximum strike for which the term structure can return vols

Implements VolatilityTermStructure.

update()

void update ( )

overridevirtual

This method must be implemented in derived classes. An instance of Observer does not call this method directly: instead, it will be called by the observables the instance registered with when they need to notify any changes.

Implements Observer.

performCalculations()

void performCalculations ( ) const

overridevirtual

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

Implements LazyObject.

deepUpdate()

void deepUpdate ( )

overridevirtual

This method allows to explicitly update the instance itself and nested observers. If notifications are disabled a call to this method ensures an update of such nested observers. It should be implemented in derived classes whenever applicable

Reimplemented from Observer.

volatilityType()

VolatilityType volatilityType ( ) const

overridevirtual

Reimplemented from OptionletVolatilityStructure.

displacement()

Real displacement ( ) const

overridevirtual

Reimplemented from OptionletVolatilityStructure.

smileSectionImpl()

ext::shared_ptr< SmileSection > smileSectionImpl ( Time optionTime ) const

overrideprotectedvirtual

implements the actual smile calculation in derived classes

Implements OptionletVolatilityStructure.

volatilityImpl()

Volatility volatilityImpl ( Time optionTime, Rate strike ) const

overrideprotectedvirtual

implements the actual volatility calculation in derived classes

Implements OptionletVolatilityStructure.