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
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
|
/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
Copyright (C) 2004, 2005, 2006, 2007, 2008, 2014 Ferdinando Ametrano
Copyright (C) 2006 Katiuscia Manzoni
Copyright (C) 2000, 2001, 2002, 2003 RiskMap srl
Copyright (C) 2003, 2004, 2005, 2006, 2008 StatPro Italia srl
Copyright (C) 2014 Paolo Mazzocchi
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/time/period.hpp>
#include <ql/errors.hpp>
namespace QuantLib {
Period::Period(Frequency f) {
switch (f) {
case NoFrequency:
// same as Period()
units_ = Days;
length_ = 0;
break;
case Once:
units_ = Years;
length_ = 0;
break;
case Annual:
units_ = Years;
length_ = 1;
break;
case Semiannual:
case EveryFourthMonth:
case Quarterly:
case Bimonthly:
case Monthly:
units_ = Months;
length_ = 12/f;
break;
case EveryFourthWeek:
case Biweekly:
case Weekly:
units_ = Weeks;
length_ = 52/f;
break;
case Daily:
units_ = Days;
length_ = 1;
break;
case OtherFrequency:
QL_FAIL("unknown frequency"); // no point in showing 999...
default:
QL_FAIL("unknown frequency (" << Integer(f) << ")");
}
}
Frequency Period::frequency() const {
// unsigned version
Size length = std::abs(length_);
if (length==0) {
if (units_==Years) return Once;
return NoFrequency;
}
switch (units_) {
case Years:
if (length == 1)
return Annual;
else
return OtherFrequency;
case Months:
if (12%length == 0 && length <= 12)
return Frequency(12/length);
else
return OtherFrequency;
case Weeks:
if (length==1)
return Weekly;
else if (length==2)
return Biweekly;
else if (length==4)
return EveryFourthWeek;
else
return OtherFrequency;
case Days:
if (length==1)
return Daily;
else
return OtherFrequency;
default:
QL_FAIL("unknown time unit (" << Integer(units_) << ")");
}
}
void Period::normalize() {
if (length_ == 0) {
units_ = Days;
} else {
switch (units_) {
case Months:
if ((length_ % 12) == 0) {
length_ /= 12;
units_ = Years;
}
break;
case Days:
if ((length_ % 7) == 0) {
length_ /= 7;
units_ = Weeks;
}
break;
case Weeks:
case Years:
break;
default:
QL_FAIL("unknown time unit (" << Integer(units_) << ")");
}
}
}
Period& Period::operator+=(const Period& p) {
if (length_==0) {
length_ = p.length();
units_ = p.units();
} else if (units_==p.units()) {
// no conversion needed
length_ += p.length();
} else {
switch (units_) {
case Years:
switch (p.units()) {
case Months:
units_ = Months;
length_ = length_*12 + p.length();
break;
case Weeks:
case Days:
QL_REQUIRE(p.length()==0,
"impossible addition between " << *this <<
" and " << p);
break;
default:
QL_FAIL("unknown time unit (" << Integer(p.units()) << ")");
}
break;
case Months:
switch (p.units()) {
case Years:
length_ += p.length()*12;
break;
case Weeks:
case Days:
QL_REQUIRE(p.length()==0,
"impossible addition between " << *this <<
" and " << p);
break;
default:
QL_FAIL("unknown time unit (" << Integer(p.units()) << ")");
}
break;
case Weeks:
switch (p.units()) {
case Days:
units_ = Days;
length_ = length_*7 + p.length();
break;
case Years:
case Months:
QL_REQUIRE(p.length()==0,
"impossible addition between " << *this <<
" and " << p);
break;
default:
QL_FAIL("unknown time unit (" << Integer(p.units()) << ")");
}
break;
case Days:
switch (p.units()) {
case Weeks:
length_ += p.length()*7;
break;
case Years:
case Months:
QL_REQUIRE(p.length()==0,
"impossible addition between " << *this <<
" and " << p);
break;
default:
QL_FAIL("unknown time unit (" << Integer(p.units()) << ")");
}
break;
default:
QL_FAIL("unknown time unit (" << Integer(units_) << ")");
}
}
return *this;
}
Period& Period::operator-=(const Period& p) {
return operator+=(-p);
}
Period& Period::operator*=(Integer n) {
length_ *= n;
return *this;
}
Period& Period::operator/=(Integer n) {
QL_REQUIRE(n != 0, "cannot be divided by zero");
if (length_ % n == 0) {
// keep the original units. If the user created a
// 24-months period, he'll probably want a 12-months one
// when he halves it.
length_ /= n;
} else {
// try
TimeUnit units = units_;
Integer length = length_;
switch (units) {
case Years:
length *= 12;
units = Months;
break;
case Weeks:
length *= 7;
units = Days;
break;
default:
;
}
QL_REQUIRE(length % n == 0,
*this << " cannot be divided by " << n);
length_ = length/n;
units_ = units;
}
return *this;
}
namespace {
std::pair<Integer,Integer> daysMinMax(const Period& p) {
switch (p.units()) {
case Days:
return std::make_pair(p.length(), p.length());
case Weeks:
return std::make_pair(7*p.length(), 7*p.length());
case Months:
return std::make_pair(28*p.length(), 31*p.length());
case Years:
return std::make_pair(365*p.length(), 366*p.length());
default:
QL_FAIL("unknown time unit (" << Integer(p.units()) << ")");
}
}
}
Real years(const Period& p) {
if (p.length()==0) return 0.0;
switch (p.units()) {
case Days:
QL_FAIL("cannot convert Days into Years");
case Weeks:
QL_FAIL("cannot convert Weeks into Years");
case Months:
return p.length()/12.0;
case Years:
return p.length();
default:
QL_FAIL("unknown time unit (" << Integer(p.units()) << ")");
}
}
Real months(const Period& p) {
if (p.length()==0) return 0.0;
switch (p.units()) {
case Days:
QL_FAIL("cannot convert Days into Months");
case Weeks:
QL_FAIL("cannot convert Weeks into Months");
case Months:
return p.length();
case Years:
return p.length()*12.0;
default:
QL_FAIL("unknown time unit (" << Integer(p.units()) << ")");
}
}
Real weeks(const Period& p) {
if (p.length()==0) return 0.0;
switch (p.units()) {
case Days:
return p.length()/7.0;
case Weeks:
return p.length();
case Months:
QL_FAIL("cannot convert Months into Weeks");
case Years:
QL_FAIL("cannot convert Years into Weeks");
default:
QL_FAIL("unknown time unit (" << Integer(p.units()) << ")");
}
}
Real days(const Period& p) {
if (p.length()==0) return 0.0;
switch (p.units()) {
case Days:
return p.length();
case Weeks:
return p.length()*7.0;
case Months:
QL_FAIL("cannot convert Months into Days");
case Years:
QL_FAIL("cannot convert Years into Days");
default:
QL_FAIL("unknown time unit (" << Integer(p.units()) << ")");
}
}
bool operator<(const Period& p1, const Period& p2) {
// special cases
if (p1.length() == 0)
return p2.length() > 0;
if (p2.length() == 0)
return p1.length() < 0;
// exact comparisons
if (p1.units() == p2.units())
return p1.length() < p2.length();
if (p1.units() == Months && p2.units() == Years)
return p1.length() < 12*p2.length();
if (p1.units() == Years && p2.units() == Months)
return 12*p1.length() < p2.length();
if (p1.units() == Days && p2.units() == Weeks)
return p1.length() < 7*p2.length();
if (p1.units() == Weeks && p2.units() == Days)
return 7*p1.length() < p2.length();
// inexact comparisons (handled by converting to days and using limits)
std::pair<Integer, Integer> p1lim = daysMinMax(p1);
std::pair<Integer, Integer> p2lim = daysMinMax(p2);
if (p1lim.second < p2lim.first)
return true;
else if (p1lim.first > p2lim.second)
return false;
else
QL_FAIL("undecidable comparison between " << p1 << " and " << p2);
}
Period operator+(const Period& p1, const Period& p2) {
Period result = p1;
result += p2;
return result;
}
Period operator-(const Period& p1, const Period& p2) {
return p1+(-p2);
}
Period operator/(const Period& p, Integer n) {
Period result = p;
result /= n;
return result;
}
// period formatting
std::ostream& operator<<(std::ostream& out, const Period& p) {
return out << io::short_period(p);
}
namespace detail {
std::ostream& operator<<(std::ostream& out,
const long_period_holder& holder) {
Integer n = holder.p.length();
switch (holder.p.units()) {
case Days:
return out << n << (n == 1 ? " day" : " days");
case Weeks:
return out << n << (n == 1 ? " week" : " weeks");
case Months:
return out << n << (n == 1 ? " month" : " months");
case Years:
return out << n << (n == 1 ? " year" : " years");
default:
QL_FAIL("unknown time unit (" << Integer(holder.p.units()) << ")");
}
}
std::ostream& operator<<(std::ostream& out,
const short_period_holder& holder) {
Integer n = holder.p.length();
switch (holder.p.units()) {
case Hours:
return out << n << "h";
case Minutes:
return out << n << "m";
case Seconds:
return out << n << "s";
case Days:
return out << n << "D";
case Weeks:
return out << n << "W";
case Months:
return out << n << "M";
case Years:
return out << n << "Y";
default:
QL_FAIL("unknown time unit (" << Integer(holder.p.units()) << ")");
}
}
}
namespace io {
detail::long_period_holder long_period(const Period& p) {
return detail::long_period_holder(p);
}
detail::short_period_holder short_period(const Period& p) {
return detail::short_period_holder(p);
}
}
}
|
