FuturesRateHelper Class Reference

Rate helper for bootstrapping over IborIndex futures prices. More...

#include <ql/termstructures/yield/ratehelpers.hpp>

Inheritance diagram for FuturesRateHelper:

Collaboration diagram for FuturesRateHelper:

Public Member Functions
	FuturesRateHelper (const Handle< Quote > &price, const Date &iborStartDate, Natural lengthInMonths, const Calendar &calendar, BusinessDayConvention convention, bool endOfMonth, const DayCounter &dayCounter, Handle< Quote > convexityAdjustment={}, Futures::Type type=Futures::IMM)
	FuturesRateHelper (Real price, const Date &iborStartDate, Natural lengthInMonths, const Calendar &calendar, BusinessDayConvention convention, bool endOfMonth, const DayCounter &dayCounter, Rate convexityAdjustment=0.0, Futures::Type type=Futures::IMM)
	FuturesRateHelper (const Handle< Quote > &price, const Date &iborStartDate, const Date &iborEndDate, const DayCounter &dayCounter, Handle< Quote > convexityAdjustment={}, Futures::Type type=Futures::IMM)
	FuturesRateHelper (Real price, const Date &iborStartDate, const Date &endDate, const DayCounter &dayCounter, Rate convexityAdjustment=0.0, Futures::Type type=Futures::IMM)
	FuturesRateHelper (const Handle< Quote > &price, const Date &iborStartDate, const ext::shared_ptr< IborIndex > &iborIndex, const Handle< Quote > &convexityAdjustment={}, Futures::Type type=Futures::IMM)
	FuturesRateHelper (Real price, const Date &iborStartDate, const ext::shared_ptr< IborIndex > &iborIndex, Rate convexityAdjustment=0.0, Futures::Type type=Futures::IMM)
RateHelper interface
Real	impliedQuote () const override
FuturesRateHelper inspectors
Real	convexityAdjustment () const
Public Member Functions inherited from BootstrapHelper< TS >
	BootstrapHelper (Handle< Quote > quote)
	BootstrapHelper (Real quote)
	~BootstrapHelper () override=default
const Handle< Quote > &	quote () const
Real	quoteError () const
virtual void	setTermStructure (TS *)
	sets the term structure to be used for pricing More...
virtual Date	earliestDate () const
	earliest relevant date More...
virtual Date	maturityDate () const
	instrument's maturity date More...
virtual Date	latestRelevantDate () const
	latest relevant date More...
virtual Date	pillarDate () const
	pillar date More...
virtual Date	latestDate () const
	latest date More...
void	update () override
Public Member Functions inherited from Observer
	Observer ()=default
	Observer (const Observer &)
Observer &	operator= (const Observer &)
virtual	~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	update ()=0
virtual void	deepUpdate ()
Public Member Functions inherited from Observable
	Observable ()
	Observable (const Observable &)
Observable &	operator= (const Observable &)
	Observable (Observable &&)=delete
Observable &	operator= (Observable &&)=delete
virtual	~Observable ()=default
void	notifyObservers ()

Visitability
Time	yearFraction_
Handle< Quote >	convAdj_
void	accept (AcyclicVisitor &) override

Additional Inherited Members
Public Types inherited from Observer
typedef set_type::iterator	iterator
Protected Attributes inherited from BootstrapHelper< TS >
Handle< Quote >	quote_
TS *	termStructure_
Date	earliestDate_
Date	latestDate_
Date	maturityDate_
Date	latestRelevantDate_
Date	pillarDate_

Detailed Description

Rate helper for bootstrapping over IborIndex futures prices.

Definition at line 52 of file ratehelpers.hpp.

Constructor & Destructor Documentation

FuturesRateHelper() [1/6]

FuturesRateHelper	(	const Handle< Quote > &	price,
		const Date &	iborStartDate,
		Natural	lengthInMonths,
		const Calendar &	calendar,
		BusinessDayConvention	convention,
		bool	endOfMonth,
		const DayCounter &	dayCounter,
		Handle< Quote >	convexityAdjustment = {},
		Futures::Type	type = Futures::IMM
	)

Definition at line 44 of file ratehelpers.cpp.

Here is the call graph for this function:

FuturesRateHelper() [2/6]

FuturesRateHelper	(	Real	price,
		const Date &	iborStartDate,
		Natural	lengthInMonths,
		const Calendar &	calendar,
		BusinessDayConvention	convention,
		bool	endOfMonth,
		const DayCounter &	dayCounter,
		Rate	convexityAdjustment = 0.0,
		Futures::Type	type = Futures::IMM
	)

Definition at line 75 of file ratehelpers.cpp.

Here is the call graph for this function:

FuturesRateHelper() [3/6]

FuturesRateHelper	(	const Handle< Quote > &	price,
		const Date &	iborStartDate,
		const Date &	iborEndDate,
		const DayCounter &	dayCounter,
		Handle< Quote >	convexityAdjustment = {},
		Futures::Type	type = Futures::IMM
	)

Definition at line 106 of file ratehelpers.cpp.

Here is the call graph for this function:

FuturesRateHelper() [4/6]

FuturesRateHelper	(	Real	price,
		const Date &	iborStartDate,
		const Date &	endDate,
		const DayCounter &	dayCounter,
		Rate	convexityAdjustment = 0.0,
		Futures::Type	type = Futures::IMM
	)

Definition at line 158 of file ratehelpers.cpp.

Here is the call graph for this function:

FuturesRateHelper() [5/6]

FuturesRateHelper	(	const Handle< Quote > &	price,
		const Date &	iborStartDate,
		const ext::shared_ptr< IborIndex > &	iborIndex,
		const Handle< Quote > &	convexityAdjustment = {},
		Futures::Type	type = Futures::IMM
	)

Definition at line 210 of file ratehelpers.cpp.

Here is the call graph for this function:

FuturesRateHelper() [6/6]

FuturesRateHelper	(	Real	price,
		const Date &	iborStartDate,
		const ext::shared_ptr< IborIndex > &	iborIndex,
		Rate	convexityAdjustment = 0.0,
		Futures::Type	type = Futures::IMM
	)

Definition at line 239 of file ratehelpers.cpp.

Here is the call graph for this function:

Member Function Documentation

impliedQuote()

Real impliedQuote ( ) const

overridevirtual

Implements BootstrapHelper< TS >.

Definition at line 268 of file ratehelpers.cpp.

convexityAdjustment()

Real convexityAdjustment

(

)

const

Definition at line 280 of file ratehelpers.cpp.

accept()

void accept ( AcyclicVisitor &  v )

overridevirtual

Reimplemented from BootstrapHelper< TS >.

Definition at line 284 of file ratehelpers.cpp.

Here is the call graph for this function:

Member Data Documentation

yearFraction_

Time yearFraction_

private

Definition at line 107 of file ratehelpers.hpp.

convAdj_

Handle<Quote> convAdj_

private

Definition at line 108 of file ratehelpers.hpp.