Interface for inflation term structures. More...
#include <ql/termstructures/inflationtermstructure.hpp>
Public Member Functions | |
void | setSeasonality (const boost::shared_ptr< Seasonality > &seasonality=boost::shared_ptr< Seasonality >()) |
Functions to set and get seasonality. More... | |
boost::shared_ptr< Seasonality > | seasonality () const |
bool | hasSeasonality () const |
Constructors | |
InflationTermStructure (Rate baseRate, const Period &observationLag, Frequency frequency, bool indexIsInterpolated, const Handle< YieldTermStructure > &yTS, const DayCounter &dayCounter=DayCounter(), const boost::shared_ptr< Seasonality > &seasonality=boost::shared_ptr< Seasonality >()) | |
InflationTermStructure (const Date &referenceDate, Rate baseRate, const Period &observationLag, Frequency frequency, bool indexIsInterpolated, const Handle< YieldTermStructure > &yTS, const Calendar &calendar=Calendar(), const DayCounter &dayCounter=DayCounter(), const boost::shared_ptr< Seasonality > &seasonality=boost::shared_ptr< Seasonality >()) | |
InflationTermStructure (Natural settlementDays, const Calendar &calendar, Rate baseRate, const Period &observationLag, Frequency frequency, bool indexIsInterpolated, const Handle< YieldTermStructure > &yTS, const DayCounter &dayCounter=DayCounter(), const boost::shared_ptr< Seasonality > &seasonality=boost::shared_ptr< Seasonality >()) | |
Inflation interface | |
virtual Period | observationLag () const |
virtual Frequency | frequency () const |
virtual bool | indexIsInterpolated () const |
virtual Rate | baseRate () const |
virtual Handle< YieldTermStructure > | nominalTermStructure () const |
virtual Date | baseDate () const =0 |
minimum (base) date More... | |
![]() | |
TermStructure (const DayCounter &dc=DayCounter()) | |
default constructor More... | |
TermStructure (const Date &referenceDate, const Calendar &calendar=Calendar(), const DayCounter &dc=DayCounter()) | |
initialize with a fixed reference date | |
TermStructure (Natural settlementDays, const Calendar &, const DayCounter &dc=DayCounter()) | |
calculate the reference date based on the global evaluation date | |
virtual DayCounter | dayCounter () const |
the day counter used for date/time conversion | |
Time | timeFromReference (const Date &date) const |
date/time conversion | |
virtual Date | maxDate () const =0 |
the latest date for which the curve can return values | |
virtual Time | maxTime () const |
the latest time for which the curve can return values | |
virtual const Date & | referenceDate () const |
the date at which discount = 1.0 and/or variance = 0.0 | |
virtual Calendar | calendar () const |
the calendar used for reference and/or option date calculation | |
virtual Natural | settlementDays () const |
the settlementDays used for reference date calculation | |
void | update () |
![]() | |
Observer (const Observer &) | |
Observer & | operator= (const Observer &) |
std::pair< iterator, bool > | registerWith (const boost::shared_ptr< Observable > &) |
void | registerWithObservables (const boost::shared_ptr< Observer > &) |
Size | unregisterWith (const boost::shared_ptr< Observable > &) |
void | unregisterWithAll () |
![]() | |
Observable (const Observable &) | |
Observable & | operator= (const Observable &) |
void | notifyObservers () |
![]() | |
void | enableExtrapolation (bool b=true) |
enable extrapolation in subsequent calls | |
void | disableExtrapolation (bool b=true) |
disable extrapolation in subsequent calls | |
bool | allowsExtrapolation () const |
tells whether extrapolation is enabled | |
Protected Member Functions | |
virtual void | setBaseRate (const Rate &r) |
void | checkRange (const Date &, bool extrapolate) const |
void | checkRange (Time t, bool extrapolate) const |
![]() | |
void | checkRange (const Date &d, bool extrapolate) const |
date-range check | |
void | checkRange (Time t, bool extrapolate) const |
time-range check | |
Protected Attributes | |
boost::shared_ptr< Seasonality > | seasonality_ |
Period | observationLag_ |
Frequency | frequency_ |
bool | indexIsInterpolated_ |
Rate | baseRate_ |
Handle< YieldTermStructure > | nominalTermStructure_ |
![]() | |
bool | moving_ |
bool | updated_ |
Calendar | calendar_ |
Additional Inherited Members | |
![]() | |
typedef std::set< boost::shared_ptr< Observable > > | set_type |
typedef set_type::iterator | iterator |
Interface for inflation term structures.
|
virtual |
The TS observes with a lag that is usually different from the availability lag of the index. An inflation rate is given, by default, for the maturity requested assuming this lag.
Reimplemented in CPICapFloorTermPriceSurface.
|
pure virtual |
minimum (base) date
Important in inflation since it starts before nominal reference date. Changes depending whether index is interpolated or not. When interpolated the base date is just observation lag before nominal. When not interpolated it is the beginning of the relevant period (hence it is easy to create interpolated fixings from a not-interpolated curve because interpolation, usually, of fixings is forward looking).
Implemented in CPICapFloorTermPriceSurface, PiecewiseYoYInflationCurve< Interpolator, Bootstrap, Traits >, PiecewiseZeroInflationCurve< Interpolator, Bootstrap, Traits >, InterpolatedYoYInflationCurve< Interpolator >, and InterpolatedZeroInflationCurve< Interpolator >.
void setSeasonality | ( | const boost::shared_ptr< Seasonality > & | seasonality = boost::shared_ptr< Seasonality >() | ) |
Functions to set and get seasonality.
Calling setSeasonality with no arguments means unsetting as the default is used to choose unsetting.