/usr/include/ql/instruments/bond.hpp is in libquantlib0-dev 1.7.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | /* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
Copyright (C) 2004 Jeff Yu
Copyright (C) 2004 M-Dimension Consulting Inc.
Copyright (C) 2005, 2006, 2007, 2008 StatPro Italia srl
Copyright (C) 2007, 2008, 2009 Ferdinando Ametrano
Copyright (C) 2007 Chiara Fornarola
Copyright (C) 2008 Simon Ibbotson
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
<http://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 bond.hpp
\brief concrete bond class
*/
#ifndef quantlib_bond_hpp
#define quantlib_bond_hpp
#include <ql/instrument.hpp>
#include <ql/time/calendar.hpp>
#include <ql/cashflow.hpp>
#include <ql/compounding.hpp>
#include <vector>
namespace QuantLib {
class DayCounter;
//! Base bond class
/*! Derived classes must fill the uninitialized data members.
\warning Most methods assume that the cash flows are stored
sorted by date, the redemption(s) being after any
cash flow at the same date. In particular, if there's
one single redemption, it must be the last cash flow,
\ingroup instruments
\test
- price/yield calculations are cross-checked for consistency.
- price/yield calculations are checked against known good
values.
*/
class Bond : public Instrument {
public:
//! constructor for amortizing or non-amortizing bonds.
/*! Redemptions and maturity are calculated from the coupon
data, if available. Therefore, redemptions must not be
included in the passed cash flows.
*/
Bond(Natural settlementDays,
const Calendar& calendar,
const Date& issueDate = Date(),
const Leg& coupons = Leg());
//! old constructor for non amortizing bonds.
/*! \warning The last passed cash flow must be the bond
redemption. No other cash flow can have a date
later than the redemption date.
*/
Bond(Natural settlementDays,
const Calendar& calendar,
Real faceAmount,
const Date& maturityDate,
const Date& issueDate = Date(),
const Leg& cashflows = Leg());
class arguments;
class results;
class engine;
//! \name Instrument interface
//@{
bool isExpired() const;
//@}
//! \name Inspectors
//@{
Natural settlementDays() const;
const Calendar& calendar() const;
const std::vector<Real>& notionals() const;
virtual Real notional(Date d = Date()) const;
/*! \note returns all the cashflows, including the redemptions. */
const Leg& cashflows() const;
/*! returns just the redemption flows (not interest payments) */
const Leg& redemptions() const;
/*! returns the redemption, if only one is defined */
const boost::shared_ptr<CashFlow>& redemption() const;
Date startDate() const;
Date maturityDate() const;
Date issueDate() const;
bool isTradable(Date d = Date()) const;
Date settlementDate(Date d = Date()) const;
//@}
//! \name Calculations
//@{
//! theoretical clean price
/*! The default bond settlement is used for calculation.
\warning the theoretical price calculated from a flat term
structure might differ slightly from the price
calculated from the corresponding yield by means
of the other overload of this function. If the
price from a constant yield is desired, it is
advisable to use such other overload.
*/
Real cleanPrice() const;
//! theoretical dirty price
/*! The default bond settlement is used for calculation.
\warning the theoretical price calculated from a flat term
structure might differ slightly from the price
calculated from the corresponding yield by means
of the other overload of this function. If the
price from a constant yield is desired, it is
advisable to use such other overload.
*/
Real dirtyPrice() const;
//! theoretical settlement value
/*! The default bond settlement date is used for calculation. */
Real settlementValue() const;
//! theoretical bond yield
/*! The default bond settlement and theoretical price are used
for calculation.
*/
Rate yield(const DayCounter& dc,
Compounding comp,
Frequency freq,
Real accuracy = 1.0e-8,
Size maxEvaluations = 100) const;
//! clean price given a yield and settlement date
/*! The default bond settlement is used if no date is given. */
Real cleanPrice(Rate yield,
const DayCounter& dc,
Compounding comp,
Frequency freq,
Date settlementDate = Date()) const;
//! dirty price given a yield and settlement date
/*! The default bond settlement is used if no date is given. */
Real dirtyPrice(Rate yield,
const DayCounter& dc,
Compounding comp,
Frequency freq,
Date settlementDate = Date()) const;
//! settlement value as a function of the clean price
/*! The default bond settlement date is used for calculation. */
Real settlementValue(Real cleanPrice) const;
//! yield given a (clean) price and settlement date
/*! The default bond settlement is used if no date is given. */
Rate yield(Real cleanPrice,
const DayCounter& dc,
Compounding comp,
Frequency freq,
Date settlementDate = Date(),
Real accuracy = 1.0e-8,
Size maxEvaluations = 100) const;
//! accrued amount at a given date
/*! The default bond settlement is used if no date is given. */
virtual Real accruedAmount(Date d = Date()) const;
//@}
/*! Expected next coupon: depending on (the bond and) the given date
the coupon can be historic, deterministic or expected in a
stochastic sense. When the bond settlement date is used the coupon
is the already-fixed not-yet-paid one.
The current bond settlement is used if no date is given.
*/
virtual Rate nextCouponRate(Date d = Date()) const;
//! Previous coupon already paid at a given date
/*! Expected previous coupon: depending on (the bond and) the given
date the coupon can be historic, deterministic or expected in a
stochastic sense. When the bond settlement date is used the coupon
is the last paid one.
The current bond settlement is used if no date is given.
*/
Rate previousCouponRate(Date d = Date()) const;
Date nextCashFlowDate(Date d = Date()) const;
Date previousCashFlowDate(Date d = Date()) const;
protected:
void setupExpired() const;
void setupArguments(PricingEngine::arguments*) const;
void fetchResults(const PricingEngine::results*) const;
/*! This method can be called by derived classes in order to
build redemption payments from the existing cash flows.
It must be called after setting up the cashflows_ vector
and will fill the notionalSchedule_, notionals_, and
redemptions_ data members.
If given, the elements of the redemptions vector will
multiply the amount of the redemption cash flow. The
elements will be taken in base 100, i.e., a redemption
equal to 100 does not modify the amount.
\pre The cashflows_ vector must contain at least one
coupon and must be sorted by date.
*/
void addRedemptionsToCashflows(const std::vector<Real>& redemptions
= std::vector<Real>());
/*! This method can be called by derived classes in order to
build a bond with a single redemption payment. It will
fill the notionalSchedule_, notionals_, and redemptions_
data members.
*/
void setSingleRedemption(Real notional,
Real redemption,
const Date& date);
/*! This method can be called by derived classes in order to
build a bond with a single redemption payment. It will
fill the notionalSchedule_, notionals_, and redemptions_
data members.
*/
void setSingleRedemption(Real notional,
const boost::shared_ptr<CashFlow>& redemption);
/*! used internally to collect notional information from the
coupons. It should not be called by derived classes,
unless they already provide redemption cash flows (in
which case they must set up the redemptions_ data member
independently). It will fill the notionalSchedule_ and
notionals_ data members.
*/
void calculateNotionalsFromCashflows();
Natural settlementDays_;
Calendar calendar_;
std::vector<Date> notionalSchedule_;
std::vector<Real> notionals_;
Leg cashflows_; // all cashflows
Leg redemptions_; // the redemptions
Date maturityDate_, issueDate_;
mutable Real settlementValue_;
};
class Bond::arguments : public PricingEngine::arguments {
public:
Date settlementDate;
Leg cashflows;
Calendar calendar;
void validate() const;
};
class Bond::results : public Instrument::results {
public:
Real settlementValue;
void reset() {
settlementValue = Null<Real>();
Instrument::results::reset();
}
};
class Bond::engine : public GenericEngine<Bond::arguments,
Bond::results> {};
// inline definitions
inline Natural Bond::settlementDays() const {
return settlementDays_;
}
inline const Calendar& Bond::calendar() const {
return calendar_;
}
inline const std::vector<Real>& Bond::notionals() const {
return notionals_;
}
inline const Leg& Bond::cashflows() const {
return cashflows_;
}
inline const Leg& Bond::redemptions() const {
return redemptions_;
}
inline Date Bond::issueDate() const {
return issueDate_;
}
}
#endif
|