QuantLib: InflationTermStructure Class Reference

Interface for inflation term structures. More...

#include <inflationtermstructure.hpp>

Inheritance diagram for InflationTermStructure:

Collaboration diagram for InflationTermStructure:

Public Member Functions
Constructors
	InflationTermStructure (Date baseDate, Frequency frequency, const DayCounter &dayCounter=DayCounter(), ext::shared_ptr< Seasonality > seasonality={}, Rate baseRate=Null< Rate >())

	InflationTermStructure (const Date &referenceDate, Date baseDate, Frequency frequency, const DayCounter &dayCounter=DayCounter(), ext::shared_ptr< Seasonality > seasonality={}, Rate baseRate=Null< Rate >())

	InflationTermStructure (Natural settlementDays, const Calendar &calendar, Date baseDate, Frequency frequency, const DayCounter &dayCounter=DayCounter(), ext::shared_ptr< Seasonality > seasonality={}, Rate baseRate=Null< Rate >())

QL_DEPRECATED_DISABLE_WARNING	~InflationTermStructure () override=default

Inflation interface
virtual Period	observationLag () const

virtual Frequency	frequency () const

virtual Rate	baseRate () const

virtual Date	baseDate () const
	minimum (base) date More...

bool	hasExplicitBaseDate () const

Public Member Functions inherited from TermStructure
	TermStructure (DayCounter dc=DayCounter())
	default constructor More...

	TermStructure (const Date &referenceDate, Calendar calendar=Calendar(), DayCounter dc=DayCounter())
	initialize with a fixed reference date More...

	TermStructure (Natural settlementDays, Calendar, DayCounter dc=DayCounter())
	calculate the reference date based on the global evaluation date More...

	~TermStructure () override=default

virtual DayCounter	dayCounter () const
	the day counter used for date/time conversion More...

Time	timeFromReference (const Date &date) const
	date/time conversion More...

virtual Date	maxDate () const =0
	the latest date for which the curve can return values More...

virtual Time	maxTime () const
	the latest time for which the curve can return values More...

virtual const Date &	referenceDate () const
	the date at which discount = 1.0 and/or variance = 0.0 More...

virtual Calendar	calendar () const
	the calendar used for reference and/or option date calculation More...

virtual Natural	settlementDays () const
	the settlementDays used for reference date calculation More...

void	update () override

Public Member Functions inherited from Observer
	Observer ()=default

	Observer (const Observer &)

Observer &	operator= (const Observer &)

virtual	~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	update ()=0

virtual void	deepUpdate ()

Public Member Functions inherited from Observable
	Observable ()=default

	Observable (const Observable &)

Observable &	operator= (const Observable &)

	Observable (Observable &&)=delete

Observable &	operator= (Observable &&)=delete

virtual	~Observable ()=default

void	notifyObservers ()

Public Member Functions inherited from Extrapolator
	Extrapolator ()=default

virtual	~Extrapolator ()=default

void	enableExtrapolation (bool b=true)
	enable extrapolation in subsequent calls More...

void	disableExtrapolation (bool b=true)
	disable extrapolation in subsequent calls More...

bool	allowsExtrapolation () const
	tells whether extrapolation is enabled More...

Seasonality
ext::shared_ptr< Seasonality >	seasonality_

Period	observationLag_

Frequency	frequency_

Rate	baseRate_

Date	baseDate_

void	setSeasonality (const ext::shared_ptr< Seasonality > &seasonality)

ext::shared_ptr< Seasonality >	seasonality () const

bool	hasSeasonality () const

void	checkRange (const Date &, bool extrapolate) const

void	checkRange (Time t, bool extrapolate) const

Additional Inherited Members
Public Types inherited from Observer
typedef set_type::iterator	iterator

Protected Member Functions inherited from TermStructure
void	checkRange (const Date &d, bool extrapolate) const
	date-range check More...

void	checkRange (Time t, bool extrapolate) const
	time-range check More...

Protected Attributes inherited from TermStructure
bool	moving_ = false

bool	updated_ = true

Calendar	calendar_

Detailed Description

Interface for inflation term structures.

Definition at line 36 of file inflationtermstructure.hpp.

Constructor & Destructor Documentation

◆ InflationTermStructure() [1/3]

QL_DEPRECATED_DISABLE_WARNING InflationTermStructure	(	Date	baseDate,
		Frequency	frequency,
		const DayCounter &	dayCounter = `DayCounter()`,
		ext::shared_ptr< Seasonality >	seasonality = `{}`,
		Rate	baseRate = `Null<Rate>()`
	)

Definition at line 28 of file inflationtermstructure.cpp.

◆ InflationTermStructure() [2/3]

InflationTermStructure	(	const Date &	referenceDate,
		Date	baseDate,
		Frequency	frequency,
		const DayCounter &	dayCounter = `DayCounter()`,
		ext::shared_ptr< Seasonality >	seasonality = `{}`,
		Rate	baseRate = `Null<Rate>()`
	)

Definition at line 42 of file inflationtermstructure.cpp.

◆ InflationTermStructure() [3/3]

InflationTermStructure	(	Natural	settlementDays,
		const Calendar &	calendar,
		Date	baseDate,
		Frequency	frequency,
		const DayCounter &	dayCounter = `DayCounter()`,
		ext::shared_ptr< Seasonality >	seasonality = `{}`,
		Rate	baseRate = `Null<Rate>()`
	)