1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
|
/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
Copyright (C) 2007, 2009 Chris Kenyon
This file is part of QuantLib, a free-software/open-source library
for financial quantitative analysts and developers - http://quantlib.org/
QuantLib is free software: you can redistribute it and/or modify it
under the terms of the QuantLib license. You should have received a
copy of the license along with this program; if not, please email
<quantlib-dev@lists.sf.net>. The license is also available online at
<https://www.quantlib.org/license.shtml>.
This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the license for more details.
*/
/*! \file inflationtermstructure.hpp
\brief Base classes for inflation term structures.
*/
#ifndef quantlib_inflation_termstructure_hpp
#define quantlib_inflation_termstructure_hpp
#include <ql/termstructures/yieldtermstructure.hpp>
#include <ql/termstructures/inflation/seasonality.hpp>
namespace QuantLib {
class InflationIndex;
//! Interface for inflation term structures.
/*! \ingroup inflationtermstructures */
class InflationTermStructure : public TermStructure {
public:
//! \name 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;
QL_DEPRECATED_ENABLE_WARNING
//! \name Inflation interface
//@{
/*! \deprecated Do not use; inflation curves always have an explicit
base date now.
Deprecated in version 1.39.
*/
[[deprecated("Do not use; inflation curves always have an explicit base date now.")]]
virtual Period observationLag() const;
virtual Frequency frequency() const;
virtual Rate baseRate() const;
//! minimum (base) date
/*! The last date for which we have information. */
virtual Date baseDate() const;
/*! \deprecated Do not use; inflation curves always have an explicit
base date now.
Deprecated in version 1.39.
*/
[[deprecated("Do not use; inflation curves always have an explicit base date now.")]]
bool hasExplicitBaseDate() const {
return true;
}
//@}
//! \name Seasonality
//@{
void setSeasonality(const ext::shared_ptr<Seasonality>& seasonality);
ext::shared_ptr<Seasonality> seasonality() const;
bool hasSeasonality() const;
//@}
protected:
void checkRange(const Date&,
bool extrapolate) const;
void checkRange(Time t,
bool extrapolate) const;
ext::shared_ptr<Seasonality> seasonality_;
/*! \deprecated Do not use; inflation curves always have an explicit
base date now.
Deprecated in version 1.39.
*/
[[deprecated("Do not use; inflation curves always have an explicit base date now.")]]
Period observationLag_;
Frequency frequency_;
mutable Rate baseRate_;
// Can be set by subclasses that don't have baseDate available in constructors.
Date baseDate_;
};
//! Interface for zero inflation term structures.
class ZeroInflationTermStructure : public InflationTermStructure {
public:
//! \name Constructors
//@{
ZeroInflationTermStructure(Date baseDate,
Frequency frequency,
const DayCounter& dayCounter,
const ext::shared_ptr<Seasonality>& seasonality = {});
ZeroInflationTermStructure(const Date& referenceDate,
Date baseDate,
Frequency frequency,
const DayCounter& dayCounter,
const ext::shared_ptr<Seasonality>& seasonality = {});
ZeroInflationTermStructure(Natural settlementDays,
const Calendar& calendar,
Date baseDate,
Frequency frequency,
const DayCounter& dayCounter,
const ext::shared_ptr<Seasonality>& seasonality = {});
//@}
//! \name Inspectors
//@{
//! zero-coupon inflation rate.
/*! Essentially the fair rate for a zero-coupon inflation swap
(by definition), i.e. the zero term structure uses yearly
compounding, which is assumed for ZCIIS instrument quotes.
\note by default you get the same as lag and interpolation
as the term structure.
If you want to get predictions of RPI/CPI/etc then use an
index.
*/
Rate zeroRate(const Date& d, const Period& instObsLag = Period(-1,Days),
bool forceLinearInterpolation = false,
bool extrapolate = false) const;
//! zero-coupon inflation rate.
/*! \warning Since inflation is highly linked to dates (lags,
interpolation, months for seasonality, etc) this
method cannot account for all effects. If you
call it, You'll have to manage lag, seasonality
etc. yourself.
*/
Rate zeroRate(Time t,
bool extrapolate = false) const;
//@}
protected:
//! to be defined in derived classes
virtual Rate zeroRateImpl(Time t) const = 0;
};
//! Base class for year-on-year inflation term structures.
class YoYInflationTermStructure : public InflationTermStructure {
public:
//! \name Constructors
//@{
YoYInflationTermStructure(Date baseDate,
Rate baseYoYRate,
Frequency frequency,
const DayCounter& dayCounter,
const ext::shared_ptr<Seasonality>& seasonality = {});
YoYInflationTermStructure(const Date& referenceDate,
Date baseDate,
Rate baseYoYRate,
Frequency frequency,
const DayCounter& dayCounter,
const ext::shared_ptr<Seasonality>& seasonality = {});
YoYInflationTermStructure(Natural settlementDays,
const Calendar& calendar,
Date baseDate,
Rate baseYoYRate,
Frequency frequency,
const DayCounter& dayCounter,
const ext::shared_ptr<Seasonality>& seasonality = {});
/*! \deprecated Use an overload with an explicit base date and without indexIsInterpolated.
Deprecated in version 1.37.
*/
[[deprecated("Use an overload with an explicit base date and without indexIsInterpolated")]]
YoYInflationTermStructure(Date baseDate,
Rate baseYoYRate,
Frequency frequency,
bool indexIsInterpolated,
const DayCounter& dayCounter,
const ext::shared_ptr<Seasonality>& seasonality = {});
/*! \deprecated Use an overload with an explicit base date and without indexIsInterpolated.
Deprecated in version 1.37.
*/
[[deprecated("Use an overload with an explicit base date and without indexIsInterpolated")]]
YoYInflationTermStructure(const Date& referenceDate,
Date baseDate,
Rate baseYoYRate,
Frequency frequency,
bool indexIsInterpolated,
const DayCounter& dayCounter,
const ext::shared_ptr<Seasonality>& seasonality = {});
/*! \deprecated Use an overload with an explicit base date and without indexIsInterpolated.
Deprecated in version 1.37.
*/
[[deprecated("Use an overload with an explicit base date and without indexIsInterpolated")]]
YoYInflationTermStructure(Natural settlementDays,
const Calendar& calendar,
Date baseDate,
Rate baseYoYRate,
Frequency frequency,
bool indexIsInterpolated,
const DayCounter& dayCounter,
const ext::shared_ptr<Seasonality>& seasonality = {});
//@}
QL_DEPRECATED_DISABLE_WARNING
~YoYInflationTermStructure() override = default;
QL_DEPRECATED_ENABLE_WARNING
//! \name Inspectors
//@{
//! year-on-year inflation rate.
/*! The forceLinearInterpolation parameter is relative to the
frequency of the TS.
\note this is not the year-on-year swap (YYIIS) rate.
*/
Rate yoyRate(const Date& d, const Period& instObsLag = Period(-1,Days),
bool forceLinearInterpolation = false,
bool extrapolate = false) const;
//! year-on-year inflation rate.
/*! \warning Since inflation is highly linked to dates (lags,
interpolation, months for seasonality, etc) this
method cannot account for all effects. If you
call it, You'll have to manage lag, seasonality
etc. yourself.
*/
Rate yoyRate(Time t,
bool extrapolate = false) const;
//@}
/*! \deprecated This method will disappear. When it does, the curve will behave as if it returned false.
Deprecated in version 1.37.
*/
[[deprecated("This method will disappear. When it does, the curve will behave as if it returned false")]]
virtual bool indexIsInterpolated() const;
protected:
//! to be defined in derived classes
virtual Rate yoyRateImpl(Time time) const = 0;
/*! \deprecated This data member will disappear. When it does, the curve will behave as if it was false.
Deprecated in version 1.37.
*/
[[deprecated("This data member will disappear. When it does, the curve will behave as if it was false")]]
bool indexIsInterpolated_ = false;
};
//! utility function giving the inflation period for a given date
std::pair<Date,Date> inflationPeriod(const Date&,
Frequency);
//! utility function giving the time between two dates depending on
//! index frequency and interpolation, and a day counter
Time inflationYearFraction(Frequency ,
bool indexIsInterpolated,
const DayCounter&,
const Date&, const Date&);
// inline
inline Period InflationTermStructure::observationLag() const {
QL_DEPRECATED_DISABLE_WARNING
return observationLag_;
QL_DEPRECATED_ENABLE_WARNING
}
inline Frequency InflationTermStructure::frequency() const {
return frequency_;
}
inline Rate InflationTermStructure::baseRate() const {
QL_REQUIRE(baseRate_ != Null<Real>(), "base rate not available");
return baseRate_;
}
inline ext::shared_ptr<Seasonality> InflationTermStructure::seasonality() const {
return seasonality_;
}
inline bool InflationTermStructure::hasSeasonality() const {
return static_cast<bool>(seasonality_);
}
inline bool YoYInflationTermStructure::indexIsInterpolated() const {
QL_DEPRECATED_DISABLE_WARNING
return indexIsInterpolated_;
QL_DEPRECATED_ENABLE_WARNING
}
}
#endif
|
