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
|
/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
Copyright (C) 2000, 2001, 2002, 2003 RiskMap srl
Copyright (C) 2007, 2008 StatPro Italia srl
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 zerospreadedtermstructure.hpp
\brief Zero spreaded term structure
*/
#ifndef quantlib_zero_spreaded_term_structure_hpp
#define quantlib_zero_spreaded_term_structure_hpp
#include <ql/quote.hpp>
#include <ql/termstructures/yield/zeroyieldstructure.hpp>
#include <utility>
namespace QuantLib {
//! Term structure with an added spread on the zero yield rate
/*! \note This term structure will remain linked to the original
structure, i.e., any changes in the latter will be
reflected in this structure as well.
\ingroup yieldtermstructures
\test
- the correctness of the returned values is tested by
checking them against numerical calculations.
- observability against changes in the underlying term
structure and in the added spread is checked.
*/
class ZeroSpreadedTermStructure : public ZeroYieldStructure {
public:
ZeroSpreadedTermStructure(Handle<YieldTermStructure>,
Handle<Quote> spread,
Compounding comp = Continuous,
Frequency freq = NoFrequency,
DayCounter dc = DayCounter());
//! \name YieldTermStructure interface
//@{
DayCounter dayCounter() const override;
Calendar calendar() const override;
Natural settlementDays() const override;
const Date& referenceDate() const override;
Date maxDate() const override;
Time maxTime() const override;
//@}
//! \name Observer interface
//@{
void update() override;
//@}
protected:
//! returns the spreaded zero yield rate
Rate zeroYieldImpl(Time) const override;
//! returns the spreaded forward rate
/* This method must disappear should the spread become a curve */
Rate forwardImpl(Time) const;
private:
Handle<YieldTermStructure> originalCurve_;
Handle<Quote> spread_;
Compounding comp_;
Frequency freq_;
DayCounter dc_;
};
inline ZeroSpreadedTermStructure::ZeroSpreadedTermStructure(Handle<YieldTermStructure> h,
Handle<Quote> spread,
Compounding comp,
Frequency freq,
DayCounter dc)
: originalCurve_(std::move(h)), spread_(std::move(spread)), comp_(comp), freq_(freq),
dc_(std::move(dc)) {
if (!originalCurve_.empty())
enableExtrapolation(originalCurve_->allowsExtrapolation());
registerWith(originalCurve_);
registerWith(spread_);
}
inline DayCounter ZeroSpreadedTermStructure::dayCounter() const {
return originalCurve_->dayCounter();
}
inline Calendar ZeroSpreadedTermStructure::calendar() const {
return originalCurve_->calendar();
}
inline Natural ZeroSpreadedTermStructure::settlementDays() const {
return originalCurve_->settlementDays();
}
inline const Date& ZeroSpreadedTermStructure::referenceDate() const {
return originalCurve_->referenceDate();
}
inline Date ZeroSpreadedTermStructure::maxDate() const {
return originalCurve_->maxDate();
}
inline Time ZeroSpreadedTermStructure::maxTime() const {
return originalCurve_->maxTime();
}
inline void ZeroSpreadedTermStructure::update() {
if (!originalCurve_.empty()) {
YieldTermStructure::update();
enableExtrapolation(originalCurve_->allowsExtrapolation());
} else {
/* The implementation inherited from YieldTermStructure
asks for our reference date, which we don't have since
the original curve is still not set. Therefore, we skip
over that and just call the base-class behavior. */
// NOLINTNEXTLINE(bugprone-parent-virtual-call)
TermStructure::update();
}
}
inline Rate ZeroSpreadedTermStructure::zeroYieldImpl(Time t) const {
// to be fixed: user-defined daycounter should be used
InterestRate zeroRate =
originalCurve_->zeroRate(t, comp_, freq_, true);
InterestRate spreadedRate(zeroRate + spread_->value(),
zeroRate.dayCounter(),
zeroRate.compounding(),
zeroRate.frequency());
return spreadedRate.equivalentRate(Continuous, NoFrequency, t);
}
inline Rate ZeroSpreadedTermStructure::forwardImpl(Time t) const {
return originalCurve_->forwardRate(t, t, comp_, freq_, true)
+ spread_->value();
}
}
#endif
|
