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

Multiplicative seasonality in the price index (CPI/RPI/HICP/etc). More...

#include <seasonality.hpp>

+ Inheritance diagram for MultiplicativePriceSeasonality:
+ Collaboration diagram for MultiplicativePriceSeasonality:

Public Member Functions

 MultiplicativePriceSeasonality ()=default
 
 MultiplicativePriceSeasonality (const Date &seasonalityBaseDate, Frequency frequency, const std::vector< Rate > &seasonalityFactors)
 
virtual void set (const Date &seasonalityBaseDate, Frequency frequency, const std::vector< Rate > &seasonalityFactors)
 
virtual Date seasonalityBaseDate () const
 inspectors More...
 
virtual Frequency frequency () const
 
virtual std::vector< RateseasonalityFactors () const
 
virtual Rate seasonalityFactor (const Date &d) const
 The factor returned is NOT normalized relative to ANYTHING. More...
 
- Public Member Functions inherited from Seasonality
virtual ~Seasonality ()=default
 

Private Attributes

Date seasonalityBaseDate_
 
Frequency frequency_
 
std::vector< RateseasonalityFactors_
 

Seasonality interface

Rate correctZeroRate (const Date &d, Rate r, const InflationTermStructure &iTS) const override
 
Rate correctYoYRate (const Date &d, Rate r, const InflationTermStructure &iTS) const override
 
bool isConsistent (const InflationTermStructure &iTS) const override
 
 ~MultiplicativePriceSeasonality () override=default
 
virtual void validate () const
 
virtual Rate seasonalityCorrection (Rate r, const Date &d, const DayCounter &dc, const Date &curveBaseDate, bool isZeroRate) const
 

Detailed Description

Multiplicative seasonality in the price index (CPI/RPI/HICP/etc).

Stationary multiplicative seasonality in CPI/RPI/HICP (i.e. in price) implies that zero inflation swap rates are affected, but that year-on-year inflation swap rates show no effect. Of course, if the seasonality in CPI/RPI/HICP is non-stationary then both swap rates will be affected.

Factors must be in multiples of the minimum required for one year, e.g. 12 for monthly, and these factors are reused for as long as is required, i.e. they wrap around. So, for example, if 24 factors are given this repeats every two years. True stationary seasonality can be obtained by giving the same number of factors as the frequency dictates e.g. 12 for monthly seasonality.

Warning:
Multi-year seasonality (i.e. non-stationary) is fragile: the user must ensure that corrections at whole years before and after the inflation term structure base date are the same. Otherwise there can be an inconsistency with quoted rates. This is enforced if the frequency is lower than daily. This is not enforced for daily seasonality because this will always be inconsistent due to weekends, holidays, leap years, etc. If you use multi-year daily seasonality it is up to you to check.
Note
Factors are normalized relative to their appropriate reference dates. For zero inflation this is the inflation curve true base date: since you have a fixing for that date the seasonality factor must be one. For YoY inflation the reference is always one year earlier.

Seasonality is treated as piecewise constant, hence it works correctly with uninterpolated indices if the seasonality correction factor frequency is the same as the index frequency (or less).

Definition at line 119 of file seasonality.hpp.

Constructor & Destructor Documentation

◆ MultiplicativePriceSeasonality() [1/2]

◆ MultiplicativePriceSeasonality() [2/2]

MultiplicativePriceSeasonality ( const Date seasonalityBaseDate,
Frequency  frequency,
const std::vector< Rate > &  seasonalityFactors 
)

Definition at line 91 of file seasonality.cpp.

+ Here is the call graph for this function:

◆ ~MultiplicativePriceSeasonality()

~MultiplicativePriceSeasonality ( )
overridedefault

Member Function Documentation

◆ set()

void set ( const Date seasonalityBaseDate,
Frequency  frequency,
const std::vector< Rate > &  seasonalityFactors 
)
virtual

Definition at line 97 of file seasonality.cpp.

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

◆ seasonalityBaseDate()

Date seasonalityBaseDate ( ) const
virtual

inspectors

Definition at line 110 of file seasonality.cpp.

+ Here is the caller graph for this function:

◆ frequency()

Frequency frequency ( ) const
virtual

Definition at line 114 of file seasonality.cpp.

+ Here is the caller graph for this function:

◆ seasonalityFactors()

std::vector< Rate > seasonalityFactors ( ) const
virtual

Definition at line 118 of file seasonality.cpp.

+ Here is the caller graph for this function:

◆ seasonalityFactor()

Real seasonalityFactor ( const Date d) const
virtual

The factor returned is NOT normalized relative to ANYTHING.

Reimplemented in KerkhofSeasonality.

Definition at line 145 of file seasonality.cpp.

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

◆ correctZeroRate()

Rate correctZeroRate ( const Date d,
Rate  r,
const InflationTermStructure iTS 
) const
overridevirtual

Implements Seasonality.

Definition at line 123 of file seasonality.cpp.

+ Here is the call graph for this function:

◆ correctYoYRate()

Rate correctYoYRate ( const Date d,
Rate  r,
const InflationTermStructure iTS 
) const
overridevirtual

Implements Seasonality.

Definition at line 136 of file seasonality.cpp.

+ Here is the call graph for this function:

◆ isConsistent()

bool isConsistent ( const InflationTermStructure iTS) const
overridevirtual

It is possible for multi-year seasonalities to be inconsistent with the inflation term structure they are given to. This method enables testing - but programmers are not required to implement it. E.g. for price seasonality the corrections at whole years after the inflation curve base date should be the same or else there can be an inconsistency with quoted instruments. Alternatively, the seasonality can be set before the inflation curve is bootstrapped.

Reimplemented from Seasonality.

Definition at line 64 of file seasonality.cpp.

+ Here is the call graph for this function:

◆ validate()

void validate ( ) const
protectedvirtual

Definition at line 36 of file seasonality.cpp.

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

◆ seasonalityCorrection()

Rate seasonalityCorrection ( Rate  r,
const Date d,
const DayCounter dc,
const Date curveBaseDate,
bool  isZeroRate 
) const
protectedvirtual

Reimplemented in KerkhofSeasonality.

Definition at line 191 of file seasonality.cpp.

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

Member Data Documentation

◆ seasonalityBaseDate_

Date seasonalityBaseDate_
private

Definition at line 122 of file seasonality.hpp.

◆ frequency_

Frequency frequency_
private

Definition at line 123 of file seasonality.hpp.

◆ seasonalityFactors_

std::vector<Rate> seasonalityFactors_
private

Definition at line 124 of file seasonality.hpp.