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
CPIBondHelper Class Reference

CPI bond helper for curve bootstrap. More...

#include <bondhelpers.hpp>

+ Inheritance diagram for CPIBondHelper:
+ Collaboration diagram for CPIBondHelper:

Public Member Functions

QL_DEPRECATED_DISABLE_WARNING ~CPIBondHelper () override=default
 
QL_DEPRECATED_ENABLE_WARNING CPIBondHelper (const Handle< Quote > &price, Natural settlementDays, Real faceAmount, bool growthOnly, Real baseCPI, const Period &observationLag, const ext::shared_ptr< ZeroInflationIndex > &cpiIndex, CPI::InterpolationType observationInterpolation, Schedule schedule, const std::vector< Rate > &fixedRate, const DayCounter &accrualDayCounter, BusinessDayConvention paymentConvention=Following, const Date &issueDate=Date(), const Calendar &paymentCalendar=Calendar(), const Period &exCouponPeriod=Period(), const Calendar &exCouponCalendar=Calendar(), BusinessDayConvention exCouponConvention=Unadjusted, bool exCouponEndOfMonth=false, Bond::Price::Type priceType=Bond::Price::Clean)
 
ext::shared_ptr< CPIBondcpiBond () const
 
- Public Member Functions inherited from BondHelper
 BondHelper (const Handle< Quote > &price, const ext::shared_ptr< Bond > &bond, Bond::Price::Type priceType=Bond::Price::Clean)
 
Real impliedQuote () const override
 
void setTermStructure (YieldTermStructure *) override
 
ext::shared_ptr< Bondbond () const
 
Bond::Price::Type priceType () 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 &)
 
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

ext::shared_ptr< CPIBondcpiBond_
 
void accept (AcyclicVisitor &) override
 

Additional Inherited Members

- Public Types inherited from Observer
typedef set_type::iterator iterator
 
- Protected Attributes inherited from BondHelper
ext::shared_ptr< Bondbond_
 
RelinkableHandle< YieldTermStructuretermStructureHandle_
 
Bond::Price::Type priceType_
 
- Protected Attributes inherited from BootstrapHelper< TS >
Handle< Quotequote_
 
TS * termStructure_
 
Date earliestDate_
 
Date latestDate_
 
Date maturityDate_
 
Date latestRelevantDate_
 
Date pillarDate_
 

Detailed Description

CPI bond helper for curve bootstrap.

Definition at line 123 of file bondhelpers.hpp.

Constructor & Destructor Documentation

◆ ~CPIBondHelper()

◆ CPIBondHelper()

QL_DEPRECATED_DISABLE_WARNING CPIBondHelper ( const Handle< Quote > &  price,
Natural  settlementDays,
Real  faceAmount,
bool  growthOnly,
Real  baseCPI,
const Period observationLag,
const ext::shared_ptr< ZeroInflationIndex > &  cpiIndex,
CPI::InterpolationType  observationInterpolation,
Schedule  schedule,
const std::vector< Rate > &  fixedRate,
const DayCounter accrualDayCounter,
BusinessDayConvention  paymentConvention = Following,
const Date issueDate = Date(),
const Calendar paymentCalendar = Calendar(),
const Period exCouponPeriod = Period(),
const Calendar exCouponCalendar = Calendar(),
BusinessDayConvention  exCouponConvention = Unadjusted,
bool  exCouponEndOfMonth = false,
Bond::Price::Type  priceType = Bond::Price::Clean 
)

Definition at line 120 of file bondhelpers.cpp.

Member Function Documentation

◆ cpiBond()

ext::shared_ptr< CPIBond > cpiBond ( ) const
Deprecated:
Do not use; this method is broken and will be removed. Deprecated in version 1.34.

Definition at line 155 of file bondhelpers.hpp.

◆ accept()

QL_DEPRECATED_ENABLE_WARNING void accept ( AcyclicVisitor v)
overridevirtual

Reimplemented from BondHelper.

Definition at line 150 of file bondhelpers.cpp.

+ Here is the call graph for this function:

Member Data Documentation

◆ cpiBond_

ext::shared_ptr<CPIBond> cpiBond_
protected
Deprecated:
Do not use; this pointer is always null. Deprecated in version 1.34.

Definition at line 170 of file bondhelpers.hpp.