QuantLib_InflationTermStructure man page

InflationTermStructure — Interface for inflation term structures.

Synopsis

#include <ql/termstructures/inflationtermstructure.hpp>

Inherits TermStructure.

Inherited by CPICapFloorTermPriceSurface, YoYCapFloorTermPriceSurface, YoYInflationTermStructure, and ZeroInflationTermStructure.

Public Member Functions

void setSeasonality (const boost::shared_ptr< Seasonality > &seasonality=boost::shared_ptr< Seasonality >())
Functions to set and get seasonality.
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

Protected Member Functions

virtual void setBaseRate (const Rate &r)

void checkRange (const Date &, bool extrapolate) const

void checkRange (Time t, bool extrapolate) const

Protected Attributes

boost::shared_ptr< Seasonality > seasonality_

Period observationLag_

Frequency frequency_

bool indexIsInterpolated_

Rate baseRate_

Handle< YieldTermStructure > nominalTermStructure_

Additional Inherited Members

Detailed Description

Interface for inflation term structures.

Member Function Documentation

Period observationLag () const [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.

virtual Date baseDate () const [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.

Author

Generated automatically by Doxygen for QuantLib from the source code.

Referenced By

baseRate(3), baseRate_(3), hasSeasonality(3), InflationTermStructure(3), nominalTermStructure(3), nominalTermStructure_(3), seasonality(3), seasonality_(3), setBaseRate(3) and setSeasonality(3) are aliases of QuantLib_InflationTermStructure(3).

Fri Sep 23 2016 Version 1.8.1 QuantLib