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
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
|
/* -*- 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.
*/
#include <ql/indexes/inflationindex.hpp>
#include <ql/termstructures/inflationtermstructure.hpp>
#include <utility>
namespace QuantLib {
QL_DEPRECATED_DISABLE_WARNING
InflationTermStructure::InflationTermStructure(
Date baseDate,
Frequency frequency,
const DayCounter& dayCounter,
ext::shared_ptr<Seasonality> seasonality,
Rate baseRate)
: TermStructure(dayCounter), seasonality_(std::move(seasonality)),
frequency_(frequency), baseRate_(baseRate), baseDate_(baseDate) {
if (seasonality_ != nullptr) {
QL_REQUIRE(seasonality_->isConsistent(*this),
"Seasonality inconsistent with inflation term structure");
}
}
InflationTermStructure::InflationTermStructure(
const Date& referenceDate,
Date baseDate,
Frequency frequency,
const DayCounter& dayCounter,
ext::shared_ptr<Seasonality> seasonality,
Rate baseRate)
: TermStructure(referenceDate, Calendar(), dayCounter), seasonality_(std::move(seasonality)),
frequency_(frequency), baseRate_(baseRate), baseDate_(baseDate) {
if (seasonality_ != nullptr) {
QL_REQUIRE(seasonality_->isConsistent(*this),
"Seasonality inconsistent with inflation term structure");
}
}
InflationTermStructure::InflationTermStructure(
Natural settlementDays,
const Calendar& calendar,
Date baseDate,
Frequency frequency,
const DayCounter& dayCounter,
ext::shared_ptr<Seasonality> seasonality,
Rate baseRate)
: TermStructure(settlementDays, calendar, dayCounter), seasonality_(std::move(seasonality)),
frequency_(frequency), baseRate_(baseRate), baseDate_(baseDate) {
if (seasonality_ != nullptr) {
QL_REQUIRE(seasonality_->isConsistent(*this),
"Seasonality inconsistent with inflation term structure");
}
}
QL_DEPRECATED_ENABLE_WARNING
Date InflationTermStructure::baseDate() const {
return baseDate_;
}
void InflationTermStructure::setSeasonality(
const ext::shared_ptr<Seasonality>& seasonality) {
// always reset, whether with null or new pointer
seasonality_ = seasonality;
if (seasonality_ != nullptr) {
QL_REQUIRE(seasonality_->isConsistent(*this),
"Seasonality inconsistent with inflation term structure");
}
update();
}
void InflationTermStructure::checkRange(const Date& d,
bool extrapolate) const {
QL_REQUIRE(d >= baseDate(),
"date (" << d << ") is before base date (" << baseDate() << ")");
QL_REQUIRE(extrapolate || allowsExtrapolation() || d <= maxDate(),
"date (" << d << ") is past max curve date ("
<< maxDate() << ")");
}
void InflationTermStructure::checkRange(Time t,
bool extrapolate) const {
QL_REQUIRE(t >= timeFromReference(baseDate()),
"time (" << t << ") is before base date");
QL_REQUIRE(extrapolate || allowsExtrapolation() || t <= maxTime(),
"time (" << t << ") is past max curve time ("
<< maxTime() << ")");
}
ZeroInflationTermStructure::ZeroInflationTermStructure(
Date baseDate,
Frequency frequency,
const DayCounter& dayCounter,
const ext::shared_ptr<Seasonality>& seasonality)
: InflationTermStructure(baseDate, frequency, dayCounter, seasonality) {}
ZeroInflationTermStructure::ZeroInflationTermStructure(
const Date& referenceDate,
Date baseDate,
Frequency frequency,
const DayCounter& dayCounter,
const ext::shared_ptr<Seasonality>& seasonality)
: InflationTermStructure(referenceDate, baseDate, frequency, dayCounter, seasonality) {}
ZeroInflationTermStructure::ZeroInflationTermStructure(
Natural settlementDays,
const Calendar& calendar,
Date baseDate,
Frequency frequency,
const DayCounter& dayCounter,
const ext::shared_ptr<Seasonality>& seasonality)
: InflationTermStructure(settlementDays, calendar, baseDate, frequency, dayCounter, seasonality) {}
Rate ZeroInflationTermStructure::zeroRate(const Date &d, const Period& instObsLag,
bool forceLinearInterpolation,
bool extrapolate) const {
Period useLag = instObsLag;
if (instObsLag == Period(-1,Days)) {
useLag = Period(0, Days);
}
Rate zeroRate;
if (forceLinearInterpolation) {
std::pair<Date,Date> dd = inflationPeriod(d-useLag, frequency());
dd.second = dd.second + Period(1,Days);
Real dp = dd.second - dd.first;
Real dt = d - dd.first;
// if we are interpolating we only check the exact point
// this prevents falling off the end at curve maturity
InflationTermStructure::checkRange(d, extrapolate);
Time t1 = timeFromReference(dd.first);
Time t2 = timeFromReference(dd.second);
Rate z1 = zeroRateImpl(t1);
Rate z2 = zeroRateImpl(t2);
zeroRate = z1 + (z2-z1) * (dt/dp);
} else {
std::pair<Date,Date> dd = inflationPeriod(d-useLag, frequency());
InflationTermStructure::checkRange(dd.first, extrapolate);
Time t = timeFromReference(dd.first);
zeroRate = zeroRateImpl(t);
}
if (hasSeasonality()) {
zeroRate = seasonality()->correctZeroRate(d-useLag, zeroRate, *this);
}
return zeroRate;
}
Rate ZeroInflationTermStructure::zeroRate(Time t,
bool extrapolate) const {
checkRange(t, extrapolate);
return zeroRateImpl(t);
}
QL_DEPRECATED_DISABLE_WARNING
YoYInflationTermStructure::YoYInflationTermStructure(
Date baseDate,
Rate baseYoYRate,
Frequency frequency,
const DayCounter& dayCounter,
const ext::shared_ptr<Seasonality> &seasonality)
: InflationTermStructure(baseDate, frequency, dayCounter, seasonality, baseYoYRate) {}
YoYInflationTermStructure::YoYInflationTermStructure(
const Date& referenceDate,
Date baseDate,
Rate baseYoYRate,
Frequency frequency,
const DayCounter& dayCounter,
const ext::shared_ptr<Seasonality> &seasonality)
: InflationTermStructure(referenceDate, baseDate, frequency, dayCounter, seasonality, baseYoYRate) {}
YoYInflationTermStructure::YoYInflationTermStructure(
Natural settlementDays,
const Calendar& calendar,
Date baseDate,
Rate baseYoYRate,
Frequency frequency,
const DayCounter& dayCounter,
const ext::shared_ptr<Seasonality> &seasonality)
: InflationTermStructure(settlementDays, calendar, baseDate, frequency, dayCounter, seasonality, baseYoYRate) {}
YoYInflationTermStructure::YoYInflationTermStructure(
Date baseDate,
Rate baseYoYRate,
Frequency frequency,
bool indexIsInterpolated,
const DayCounter& dayCounter,
const ext::shared_ptr<Seasonality> &seasonality)
: YoYInflationTermStructure(baseDate, baseYoYRate, frequency, dayCounter, seasonality) {
indexIsInterpolated_ = indexIsInterpolated;
}
YoYInflationTermStructure::YoYInflationTermStructure(
const Date& referenceDate,
Date baseDate,
Rate baseYoYRate,
Frequency frequency,
bool indexIsInterpolated,
const DayCounter& dayCounter,
const ext::shared_ptr<Seasonality> &seasonality)
: YoYInflationTermStructure(referenceDate, baseDate, baseYoYRate,
frequency, dayCounter, seasonality) {
indexIsInterpolated_ = indexIsInterpolated;
}
YoYInflationTermStructure::YoYInflationTermStructure(
Natural settlementDays,
const Calendar& calendar,
Date baseDate,
Rate baseYoYRate,
Frequency frequency,
bool indexIsInterpolated,
const DayCounter& dayCounter,
const ext::shared_ptr<Seasonality> &seasonality)
: YoYInflationTermStructure(settlementDays, calendar, baseDate, baseYoYRate,
frequency, dayCounter, seasonality) {
indexIsInterpolated_ = indexIsInterpolated;
}
QL_DEPRECATED_ENABLE_WARNING
Rate YoYInflationTermStructure::yoyRate(const Date &d, const Period& instObsLag,
bool forceLinearInterpolation,
bool extrapolate) const {
Period useLag = instObsLag;
if (instObsLag == Period(-1,Days)) {
useLag = Period(0, Days);
}
Rate yoyRate;
if (forceLinearInterpolation) {
std::pair<Date,Date> dd = inflationPeriod(d-useLag, frequency());
dd.second = dd.second + Period(1,Days);
Real dp = dd.second - dd.first;
Real dt = (d-useLag) - dd.first;
// if we are interpolating we only check the exact point
// this prevents falling off the end at curve maturity
InflationTermStructure::checkRange(d, extrapolate);
Time t1 = timeFromReference(dd.first);
Time t2 = timeFromReference(dd.second);
Rate y1 = yoyRateImpl(t1);
Rate y2 = yoyRateImpl(t2);
yoyRate = y1 + (y2-y1) * (dt/dp);
} else {
QL_DEPRECATED_DISABLE_WARNING
if (indexIsInterpolated()) {
InflationTermStructure::checkRange(d-useLag, extrapolate);
Time t = timeFromReference(d-useLag);
yoyRate = yoyRateImpl(t);
} else {
std::pair<Date,Date> dd = inflationPeriod(d-useLag, frequency());
InflationTermStructure::checkRange(dd.first, extrapolate);
Time t = timeFromReference(dd.first);
yoyRate = yoyRateImpl(t);
}
QL_DEPRECATED_ENABLE_WARNING
}
if (hasSeasonality()) {
yoyRate = seasonality()->correctYoYRate(d-useLag, yoyRate, *this);
}
return yoyRate;
}
Rate YoYInflationTermStructure::yoyRate(Time t,
bool extrapolate) const {
checkRange(t, extrapolate);
return yoyRateImpl(t);
}
std::pair<Date,Date> inflationPeriod(const Date& d,
Frequency frequency) {
Month month = d.month();
Year year = d.year();
Month startMonth, endMonth;
switch (frequency) {
case Annual:
case Semiannual:
case EveryFourthMonth:
case Quarterly:
case Bimonthly: {
int nMonths = 12 / frequency;
startMonth = Month(month - (month - 1) % nMonths);
endMonth = Month(startMonth + nMonths - 1);
}
break;
case Monthly:
startMonth = endMonth = month;
break;
default:
QL_FAIL("Frequency not handled: " << frequency);
break;
};
return {Date(1, startMonth, year), Date::endOfMonth(Date(1, endMonth, year))};
}
Time inflationYearFraction(Frequency f, bool indexIsInterpolated,
const DayCounter &dayCounter,
const Date &d1, const Date &d2) {
Time t=0;
if (indexIsInterpolated) {
// N.B. we do not use linear interpolation between flat
// fixing forecasts for forecasts. This avoids awkwardnesses
// when bootstrapping the inflation curve.
t = dayCounter.yearFraction(d1, d2);
} else {
// I.e. fixing is constant for the whole inflation period.
// Use the value for half way along the period.
// But the inflation time is the time between period starts
std::pair<Date,Date> limD1 = inflationPeriod(d1, f);
std::pair<Date,Date> limD2 = inflationPeriod(d2, f);
t = dayCounter.yearFraction(limD1.first, limD2.first);
}
return t;
}
}
|
