/usr/include/ql/termstructures/yieldtermstructure.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 | /* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
Copyright (C) 2004, 2009 Ferdinando Ametrano
Copyright (C) 2000, 2001, 2002, 2003 RiskMap srl
Copyright (C) 2003, 2004, 2005, 2006 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
<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 yieldtermstructure.hpp
\brief Interest-rate term structure
*/
#ifndef quantlib_yield_term_structure_hpp
#define quantlib_yield_term_structure_hpp
#include <ql/termstructure.hpp>
#include <ql/interestrate.hpp>
#include <ql/quote.hpp>
#include <vector>
namespace QuantLib {
//! Interest-rate term structure
/*! This abstract class defines the interface of concrete
interest rate structures which will be derived from this one.
\ingroup yieldtermstructures
\test observability against evaluation date changes is checked.
*/
class YieldTermStructure : public TermStructure {
public:
/*! \name Constructors
See the TermStructure documentation for issues regarding
constructors.
*/
//@{
YieldTermStructure(const DayCounter& dc = DayCounter(),
const std::vector<Handle<Quote> >& jumps = std::vector<Handle<Quote> >(),
const std::vector<Date>& jumpDates = std::vector<Date>());
YieldTermStructure(const Date& referenceDate,
const Calendar& cal = Calendar(),
const DayCounter& dc = DayCounter(),
const std::vector<Handle<Quote> >& jumps = std::vector<Handle<Quote> >(),
const std::vector<Date>& jumpDates = std::vector<Date>());
YieldTermStructure(Natural settlementDays,
const Calendar& cal,
const DayCounter& dc = DayCounter(),
const std::vector<Handle<Quote> >& jumps = std::vector<Handle<Quote> >(),
const std::vector<Date>& jumpDates = std::vector<Date>());
//@}
/*! \name Discount factors
These methods return the discount factor from a given date or time
to the reference date. In the latter case, the time is calculated
as a fraction of year from the reference date.
*/
//@{
DiscountFactor discount(const Date& d,
bool extrapolate = false) const;
/*! The same day-counting rule used by the term structure
should be used for calculating the passed time t.
*/
DiscountFactor discount(Time t,
bool extrapolate = false) const;
//@}
/*! \name Zero-yield rates
These methods return the implied zero-yield rate for a
given date or time. In the former case, the time is
calculated as a fraction of year from the reference date.
*/
//@{
/*! The resulting interest rate has the required daycounting
rule.
*/
InterestRate zeroRate(const Date& d,
const DayCounter& resultDayCounter,
Compounding comp,
Frequency freq = Annual,
bool extrapolate = false) const;
/*! The resulting interest rate has the same day-counting rule
used by the term structure. The same rule should be used
for calculating the passed time t.
*/
InterestRate zeroRate(Time t,
Compounding comp,
Frequency freq = Annual,
bool extrapolate = false) const;
//@}
/*! \name Forward rates
These methods returns the forward interest rate between two dates
or times. In the former case, times are calculated as fractions
of year from the reference date.
If both dates (times) are equal the instantaneous forward rate is
returned.
*/
//@{
/*! The resulting interest rate has the required day-counting
rule.
*/
InterestRate forwardRate(const Date& d1,
const Date& d2,
const DayCounter& resultDayCounter,
Compounding comp,
Frequency freq = Annual,
bool extrapolate = false) const;
/*! The resulting interest rate has the required day-counting
rule.
\warning dates are not adjusted for holidays
*/
InterestRate forwardRate(const Date& d,
const Period& p,
const DayCounter& resultDayCounter,
Compounding comp,
Frequency freq = Annual,
bool extrapolate = false) const;
/*! The resulting interest rate has the same day-counting rule
used by the term structure. The same rule should be used
for calculating the passed times t1 and t2.
*/
InterestRate forwardRate(Time t1,
Time t2,
Compounding comp,
Frequency freq = Annual,
bool extrapolate = false) const;
//@}
//! \name Jump inspectors
//@{
const std::vector<Date>& jumpDates() const;
const std::vector<Time>& jumpTimes() const;
//@}
//! \name Observer interface
//@{
void update();
//@}
protected:
/*! \name Calculations
This method must be implemented in derived classes to
perform the actual calculations. When it is called,
range check has already been performed; therefore, it
must assume that extrapolation is required.
*/
//@{
//! discount factor calculation
virtual DiscountFactor discountImpl(Time) const = 0;
//@}
private:
// methods
void setJumps();
// data members
std::vector<Handle<Quote> > jumps_;
std::vector<Date> jumpDates_;
std::vector<Time> jumpTimes_;
Size nJumps_;
Date latestReference_;
};
// inline definitions
inline
DiscountFactor YieldTermStructure::discount(const Date& d,
bool extrapolate) const {
return discount(timeFromReference(d), extrapolate);
}
inline
InterestRate YieldTermStructure::forwardRate(const Date& d,
const Period& p,
const DayCounter& dayCounter,
Compounding comp,
Frequency freq,
bool extrapolate) const {
return forwardRate(d, d+p, dayCounter, comp, freq, extrapolate);
}
inline const std::vector<Date>& YieldTermStructure::jumpDates() const {
return this->jumpDates_;
}
inline const std::vector<Time>& YieldTermStructure::jumpTimes() const {
return this->jumpTimes_;
}
}
#endif
|