CapFloor Class Reference

Base class for cap-like instruments. More...

#include <ql/instruments/capfloor.hpp>

Inheritance diagram for CapFloor:

Classes
class	arguments
	Arguments for cap/floor calculation More...
class	engine
	base class for cap/floor engines More...

Public Types
enum	Type { Cap , Floor , Collar }
Public Types inherited from Observer
typedef set_type::iterator	iterator

Public Member Functions
	CapFloor (Type type, Leg floatingLeg, std::vector< Rate > capRates, std::vector< Rate > floorRates)
	CapFloor (Type type, Leg floatingLeg, const std::vector< Rate > &strikes)
Observable interface
void	deepUpdate () override
Instrument interface
bool	isExpired () const override
	returns whether the instrument might have value greater than zero.
void	setupArguments (PricingEngine::arguments *) const override
Public Member Functions inherited from Instrument
Real	NPV () const
	returns the net present value of the instrument.
Real	errorEstimate () const
	returns the error estimate on the NPV when available.
const Date &	valuationDate () const
	returns the date the net present value refers to.
template<typename T>
T	result (const std::string &tag) const
	returns any additional result returned by the pricing engine.
const std::map< std::string, ext::any > &	additionalResults () const
	returns all additional result returned by the pricing engine.
void	setPricingEngine (const ext::shared_ptr< PricingEngine > &)
	set the pricing engine to be used.
virtual void	fetchResults (const PricingEngine::results *) const
Public Member Functions inherited from LazyObject
void	update () override
bool	isCalculated () const
void	forwardFirstNotificationOnly ()
void	alwaysForwardNotifications ()
void	recalculate ()
void	freeze ()
void	unfreeze ()
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 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 ()

Inspectors
Type	type () const
const std::vector< Rate > &	capRates () const
const std::vector< Rate > &	floorRates () const
const Leg &	floatingLeg () const
Date	startDate () const
Date	maturityDate () const
ext::shared_ptr< FloatingRateCoupon >	lastFloatingRateCoupon () const
ext::shared_ptr< CapFloor >	optionlet (Size n) const
	Returns the n-th optionlet as a new CapFloor with only one cash flow.
Rate	atmRate (const YieldTermStructure &discountCurve) const
Volatility	impliedVolatility (Real price, const Handle< YieldTermStructure > &disc, Volatility guess, Real accuracy=1.0e-4, Natural maxEvaluations=100, Volatility minVol=1.0e-7, Volatility maxVol=4.0, VolatilityType type=ShiftedLognormal, Real displacement=0.0) const
	implied term volatility

Additional Inherited Members
Protected Member Functions inherited from Instrument
void	calculate () const override
virtual void	setupExpired () const
void	performCalculations () const override
Protected Attributes inherited from Instrument
Real	NPV_
Real	errorEstimate_
Date	valuationDate_
std::map< std::string, ext::any >	additionalResults_
ext::shared_ptr< PricingEngine >	engine_
bool	calculated_ = false
bool	frozen_ = false
bool	alwaysForward_

Detailed Description

Base class for cap-like instruments.

Tests

• the correctness of the returned value is tested by checking that the price of a cap (resp. floor) decreases (resp. increases) with the strike rate.
• the relationship between the values of caps, floors and the resulting collars is checked.
• the put-call parity between the values of caps, floors and swaps is checked.
• the correctness of the returned implied volatility is tested by using it for reproducing the target value.
• the correctness of the returned value is tested by checking it against a known good value.

Member Function Documentation

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.

isExpired()

bool isExpired ( ) const

overridevirtual

returns whether the instrument might have value greater than zero.

Implements Instrument.

setupArguments()

void setupArguments ( PricingEngine::arguments * ) const

overridevirtual

When a derived argument structure is defined for an instrument, this method should be overridden to fill it. This is mandatory in case a pricing engine is used.

Reimplemented from Instrument.