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
|
/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
Copyright (C) 2005 Toyin Akin
Copyright (C) 2007, 2009 StatPro Italia srl
Copyright (C) 2008 Ferdinando Ametrano
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 bondhelpers.hpp
\brief bond rate helpers
*/
#ifndef quantlib_bond_helpers_hpp
#define quantlib_bond_helpers_hpp
#include <ql/termstructures/yield/ratehelpers.hpp>
#include <ql/instruments/bonds/fixedratebond.hpp>
#include <ql/instruments/bonds/cpibond.hpp>
#include <ql/cashflows/cpicoupon.hpp>
namespace QuantLib {
//! Bond helper for curve bootstrap
/*! \warning This class assumes that the reference date
does not change between calls of setTermStructure().
*/
class BondHelper : public RateHelper {
public:
/*! \warning Setting a pricing engine to the passed bond from
external code will cause the bootstrap to fail or
to give wrong results. It is advised to discard
the bond after creating the helper, so that the
helper has sole ownership of it.
*/
BondHelper(const Handle<Quote>& price,
const ext::shared_ptr<Bond>& bond,
Bond::Price::Type priceType = Bond::Price::Clean);
//! \name RateHelper interface
//@{
Real impliedQuote() const override;
void setTermStructure(YieldTermStructure*) override;
//@}
//! \name Additional inspectors
//@{
ext::shared_ptr<Bond> bond() const;
Bond::Price::Type priceType() const;
//@}
//! \name Visitability
//@{
void accept(AcyclicVisitor&) override;
//@}
protected:
ext::shared_ptr<Bond> bond_;
RelinkableHandle<YieldTermStructure> termStructureHandle_;
Bond::Price::Type priceType_;
};
//! Fixed-coupon bond helper for curve bootstrap
class FixedRateBondHelper : public BondHelper {
public:
FixedRateBondHelper(const Handle<Quote>& price,
Natural settlementDays,
Real faceAmount,
Schedule schedule,
const std::vector<Rate>& coupons,
const DayCounter& dayCounter,
BusinessDayConvention paymentConv = Following,
Real redemption = 100.0,
const Date& issueDate = Date(),
const Calendar& paymentCalendar = Calendar(),
const Period& exCouponPeriod = Period(),
const Calendar& exCouponCalendar = Calendar(),
BusinessDayConvention exCouponConvention = Unadjusted,
bool exCouponEndOfMonth = false,
Bond::Price::Type priceType = Bond::Price::Clean);
//! \name Visitability
//@{
void accept(AcyclicVisitor&) override;
//@}
};
//! CPI bond helper for curve bootstrap
class CPIBondHelper : public BondHelper {
public:
CPIBondHelper(const Handle<Quote>& price,
Natural settlementDays,
Real faceAmount,
Real baseCPI,
const Period& observationLag,
const ext::shared_ptr<ZeroInflationIndex>& cpiIndex,
CPI::InterpolationType observationInterpolation,
Schedule schedule,
const std::vector<Rate>& fixedRate,
const DayCounter& accrualDayCounter,
BusinessDayConvention paymentConvention = Following,
const Date& issueDate = Date(),
const Calendar& paymentCalendar = Calendar(),
const Period& exCouponPeriod = Period(),
const Calendar& exCouponCalendar = Calendar(),
BusinessDayConvention exCouponConvention = Unadjusted,
bool exCouponEndOfMonth = false,
Bond::Price::Type priceType = Bond::Price::Clean);
/*! \deprecated Use the overload without the growthOnly parameter.
Deprecated in version 1.40.
*/
[[deprecated("Use the overload without the growthOnly parameter")]]
CPIBondHelper(const Handle<Quote>& price,
Natural settlementDays,
Real faceAmount,
bool growthOnly,
Real baseCPI,
const Period& observationLag,
const ext::shared_ptr<ZeroInflationIndex>& cpiIndex,
CPI::InterpolationType observationInterpolation,
Schedule schedule,
const std::vector<Rate>& fixedRate,
const DayCounter& accrualDayCounter,
BusinessDayConvention paymentConvention = Following,
const Date& issueDate = Date(),
const Calendar& paymentCalendar = Calendar(),
const Period& exCouponPeriod = Period(),
const Calendar& exCouponCalendar = Calendar(),
BusinessDayConvention exCouponConvention = Unadjusted,
bool exCouponEndOfMonth = false,
Bond::Price::Type priceType = Bond::Price::Clean);
//! \name Visitability
//@{
void accept(AcyclicVisitor&) override;
//@}
};
// inline
inline ext::shared_ptr<Bond> BondHelper::bond() const {
return bond_;
}
inline Bond::Price::Type BondHelper::priceType() const {
return priceType_;
}
}
#endif
|
