FraRateHelper Class Reference

Rate helper for bootstrapping over FRA rates. More...

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

Inheritance diagram for FraRateHelper:

Public Member Functions
	FraRateHelper (const std::variant< Rate, Handle< Quote > > &rate, Natural monthsToStart, Natural monthsToEnd, Natural fixingDays, const Calendar &calendar, BusinessDayConvention convention, bool endOfMonth, const DayCounter &dayCounter, Pillar::Choice pillar=Pillar::LastRelevantDate, Date customPillarDate=Date(), bool useIndexedCoupon=true)
	FraRateHelper (const std::variant< Rate, Handle< Quote > > &rate, Natural monthsToStart, const ext::shared_ptr< IborIndex > &iborIndex, Pillar::Choice pillar=Pillar::LastRelevantDate, Date customPillarDate=Date(), bool useIndexedCoupon=true)
	FraRateHelper (const std::variant< Rate, Handle< Quote > > &rate, Period periodToStart, Natural lengthInMonths, Natural fixingDays, const Calendar &calendar, BusinessDayConvention convention, bool endOfMonth, const DayCounter &dayCounter, Pillar::Choice pillar=Pillar::LastRelevantDate, Date customPillarDate=Date(), bool useIndexedCoupon=true)
	FraRateHelper (const std::variant< Rate, Handle< Quote > > &rate, Period periodToStart, const ext::shared_ptr< IborIndex > &iborIndex, Pillar::Choice pillar=Pillar::LastRelevantDate, Date customPillarDate=Date(), bool useIndexedCoupon=true)
	FraRateHelper (const std::variant< Rate, Handle< Quote > > &rate, Natural immOffsetStart, Natural immOffsetEnd, const ext::shared_ptr< IborIndex > &iborIndex, Pillar::Choice pillar=Pillar::LastRelevantDate, Date customPillarDate=Date(), bool useIndexedCoupon=true)
	FraRateHelper (const std::variant< Rate, Handle< Quote > > &rate, Date startDate, Date endDate, const ext::shared_ptr< IborIndex > &iborIndex, Pillar::Choice pillar=Pillar::LastRelevantDate, Date customPillarDate=Date(), bool useIndexedCoupon=true)
RateHelper interface
Real	impliedQuote () const override
void	setTermStructure (YieldTermStructure *) override
	sets the term structure to be used for pricing
Public Member Functions inherited from RelativeDateBootstrapHelper< YieldTermStructure >
	RelativeDateBootstrapHelper (const std::variant< Spread, Handle< Quote > > &quote, bool updateDates=true)
void	update () override
Public Member Functions inherited from BootstrapHelper< YieldTermStructure >
	BootstrapHelper (const std::variant< Spread, Handle< Quote > > &quote)
const Handle< Quote > &	quote () const
Real	quoteError () const
virtual Date	earliestDate () const
	earliest relevant date
virtual Date	maturityDate () const
	instrument's maturity date
virtual Date	latestRelevantDate () const
	latest relevant date
virtual Date	pillarDate () const
	pillar date
virtual Date	latestDate () const
	latest date
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 ()
virtual void	deepUpdate ()
Public Member Functions inherited from Observable
	Observable (const Observable &)
Observable &	operator= (const Observable &)
	Observable (Observable &&)=delete
Observable &	operator= (Observable &&)=delete
void	notifyObservers ()

Visitability
void	accept (AcyclicVisitor &) override

Additional Inherited Members
Public Types inherited from Observer
typedef set_type::iterator	iterator
Date	evaluationDate_
bool	updateDates_
Handle< Quote >	quote_
YieldTermStructure *	termStructure_
Date	earliestDate_
Date	latestDate_
Date	maturityDate_
Date	latestRelevantDate_
Date	pillarDate_

Detailed Description

Rate helper for bootstrapping over FRA rates.

Member Function Documentation

impliedQuote()

Real impliedQuote ( ) const

overridevirtual

Implements BootstrapHelper< YieldTermStructure >.

setTermStructure()

void setTermStructure ( YieldTermStructure * )

overridevirtual

sets the term structure to be used for pricing

Warning

Being a pointer and not a shared_ptr, the term structure is not guaranteed to remain allocated for the whole life of the rate helper. It is responsibility of the programmer to ensure that the pointer remains valid. It is advised that this method is called only inside the term structure being bootstrapped, setting the pointer to this, i.e., the term structure itself.

Reimplemented from BootstrapHelper< YieldTermStructure >.

accept()

void accept ( AcyclicVisitor & )

overridevirtual

Reimplemented from BootstrapHelper< YieldTermStructure >.