QuantLib: a free/open-source library for quantitative finance
fully annotated source code - version 1.34
Loading...
Searching...
No Matches
Public Member Functions | List of all members
ArithmeticOISRateHelper Class Reference

Rate helper for bootstrapping over Overnight Indexed Swap rates. More...

#include <arithmeticoisratehelper.hpp>

+ Inheritance diagram for ArithmeticOISRateHelper:
+ Collaboration diagram for ArithmeticOISRateHelper:

Public Member Functions

 ArithmeticOISRateHelper (Natural settlementDays, const Period &tenor, Frequency fixedLegPaymentFrequency, const Handle< Quote > &fixedRate, ext::shared_ptr< OvernightIndex > overnightIndex, Frequency overnightLegPaymentFrequency, Handle< Quote > spread, Real meanReversionSpeed=0.03, Real volatility=0.00, bool byApprox=false, Handle< YieldTermStructure > discountingCurve=Handle< YieldTermStructure >())
 
RateHelper interface
Real impliedQuote () const override
 
void setTermStructure (YieldTermStructure *) override
 
inspectors
ext::shared_ptr< ArithmeticAverageOISswap () const
 
- Public Member Functions inherited from RelativeDateBootstrapHelper< TS >
 RelativeDateBootstrapHelper (const Handle< Quote > &quote)
 
 RelativeDateBootstrapHelper (Real quote)
 
void update () override
 
- 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...
 
- Public Member Functions inherited from Observer
 Observer ()=default
 
 Observer (const Observer &)
 
Observeroperator= (const Observer &)
 
virtual ~Observer ()
 
std::pair< iterator, boolregisterWith (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 &)
 
Observableoperator= (const Observable &)
 
 Observable (Observable &&)=delete
 
Observableoperator= (Observable &&)=delete
 
virtual ~Observable ()=default
 
void notifyObservers ()
 

Visitability

Natural settlementDays_
 
Period tenor_
 
ext::shared_ptr< OvernightIndexovernightIndex_
 
ext::shared_ptr< ArithmeticAverageOISswap_
 
RelinkableHandle< YieldTermStructuretermStructureHandle_
 
Handle< YieldTermStructurediscountHandle_
 
RelinkableHandle< YieldTermStructurediscountRelinkableHandle_
 
Frequency fixedLegPaymentFrequency_
 
Frequency overnightLegPaymentFrequency_
 
Handle< Quotespread_
 
Real mrs_
 
Real vol_
 
bool byApprox_
 
void accept (AcyclicVisitor &) override
 
void initializeDates () override
 

Additional Inherited Members

- Public Types inherited from Observer
typedef set_type::iterator iterator
 
- Protected Member Functions inherited from RelativeDateBootstrapHelper< TS >
- Protected Attributes inherited from RelativeDateBootstrapHelper< TS >
Date evaluationDate_
 
- Protected Attributes inherited from BootstrapHelper< TS >
Handle< Quotequote_
 
TS * termStructure_
 
Date earliestDate_
 
Date latestDate_
 
Date maturityDate_
 
Date latestRelevantDate_
 
Date pillarDate_
 

Detailed Description

Rate helper for bootstrapping over Overnight Indexed Swap rates.

Definition at line 33 of file arithmeticoisratehelper.hpp.

Constructor & Destructor Documentation

◆ ArithmeticOISRateHelper()

ArithmeticOISRateHelper ( Natural  settlementDays,
const Period tenor,
Frequency  fixedLegPaymentFrequency,
const Handle< Quote > &  fixedRate,
ext::shared_ptr< OvernightIndex overnightIndex,
Frequency  overnightLegPaymentFrequency,
Handle< Quote spread,
Real  meanReversionSpeed = 0.03,
Real  volatility = 0.00,
bool  byApprox = false,
Handle< YieldTermStructure discountingCurve = Handle<YieldTermStructure>() 
)

Definition at line 28 of file arithmeticoisratehelper.cpp.

+ Here is the call graph for this function:

Member Function Documentation

◆ impliedQuote()

Real impliedQuote ( ) const
overridevirtual

Implements BootstrapHelper< TS >.

Definition at line 86 of file arithmeticoisratehelper.cpp.

◆ setTermStructure()

void setTermStructure ( YieldTermStructure t)
override

Definition at line 70 of file arithmeticoisratehelper.cpp.

+ Here is the call graph for this function:

◆ swap()

ext::shared_ptr< ArithmeticAverageOIS > swap ( ) const

Definition at line 56 of file arithmeticoisratehelper.hpp.

◆ accept()

void accept ( AcyclicVisitor v)
overridevirtual

Reimplemented from BootstrapHelper< TS >.

Definition at line 101 of file arithmeticoisratehelper.cpp.

+ Here is the call graph for this function:

◆ initializeDates()

void initializeDates ( )
overrideprotectedvirtual

Implements RelativeDateBootstrapHelper< TS >.

Definition at line 50 of file arithmeticoisratehelper.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ settlementDays_

Natural settlementDays_
protected

Definition at line 65 of file arithmeticoisratehelper.hpp.

◆ tenor_

Period tenor_
protected

Definition at line 66 of file arithmeticoisratehelper.hpp.

◆ overnightIndex_

ext::shared_ptr<OvernightIndex> overnightIndex_
protected

Definition at line 67 of file arithmeticoisratehelper.hpp.

◆ swap_

ext::shared_ptr<ArithmeticAverageOIS> swap_
protected

Definition at line 69 of file arithmeticoisratehelper.hpp.

◆ termStructureHandle_

RelinkableHandle<YieldTermStructure> termStructureHandle_
protected

Definition at line 70 of file arithmeticoisratehelper.hpp.

◆ discountHandle_

Handle<YieldTermStructure> discountHandle_
protected

Definition at line 72 of file arithmeticoisratehelper.hpp.

◆ discountRelinkableHandle_

RelinkableHandle<YieldTermStructure> discountRelinkableHandle_
protected

Definition at line 73 of file arithmeticoisratehelper.hpp.

◆ fixedLegPaymentFrequency_

Frequency fixedLegPaymentFrequency_
protected

Definition at line 75 of file arithmeticoisratehelper.hpp.

◆ overnightLegPaymentFrequency_

Frequency overnightLegPaymentFrequency_
protected

Definition at line 76 of file arithmeticoisratehelper.hpp.

◆ spread_

Handle<Quote> spread_
protected

Definition at line 77 of file arithmeticoisratehelper.hpp.

◆ mrs_

Real mrs_
protected

Definition at line 79 of file arithmeticoisratehelper.hpp.

◆ vol_

Real vol_
protected

Definition at line 80 of file arithmeticoisratehelper.hpp.

◆ byApprox_

bool byApprox_
protected

Definition at line 81 of file arithmeticoisratehelper.hpp.