/usr/include/ql/termstructures/inflationtermstructure.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 | /* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
Copyright (C) 2007, 2009 Chris Kenyon
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 inflationtermstructure.hpp
\brief Base classes for inflation term structures.
*/
#ifndef quantlib_inflation_termstructure_hpp
#define quantlib_inflation_termstructure_hpp
#include <ql/termstructures/yieldtermstructure.hpp>
#include <ql/termstructures/inflation/seasonality.hpp>
namespace QuantLib {
class InflationIndex;
//! Interface for inflation term structures.
/*! \ingroup inflationtermstructures */
class InflationTermStructure : public TermStructure {
public:
//! \name Constructors
//@{
InflationTermStructure(Rate baseRate,
const Period& observationLag,
Frequency frequency,
bool indexIsInterpolated,
const Handle<YieldTermStructure>& yTS,
const DayCounter& dayCounter = DayCounter(),
const boost::shared_ptr<Seasonality> &seasonality = boost::shared_ptr<Seasonality>());
InflationTermStructure(const Date& referenceDate,
Rate baseRate,
const Period& observationLag,
Frequency frequency,
bool indexIsInterpolated,
const Handle<YieldTermStructure>& yTS,
const Calendar& calendar = Calendar(),
const DayCounter& dayCounter = DayCounter(),
const boost::shared_ptr<Seasonality> &seasonality = boost::shared_ptr<Seasonality>());
InflationTermStructure(Natural settlementDays,
const Calendar& calendar,
Rate baseRate,
const Period& observationLag,
Frequency frequency,
bool indexIsInterpolated,
const Handle<YieldTermStructure>& yTS,
const DayCounter& dayCounter = DayCounter(),
const boost::shared_ptr<Seasonality> &seasonality = boost::shared_ptr<Seasonality>());
//@}
//! \name Inflation interface
//@{
//! The TS observes with a lag that is usually different from the
//! availability lag of the index. An inflation rate is given,
//! by default, for the maturity requested assuming this lag.
virtual Period observationLag() const;
virtual Frequency frequency() const;
virtual bool indexIsInterpolated() const;
virtual Rate baseRate() const;
virtual Handle<YieldTermStructure> nominalTermStructure() const;
//! minimum (base) date
/*! Important in inflation since it starts before nominal
reference date. Changes depending whether index is
interpolated or not. When interpolated the base date
is just observation lag before nominal. When not
interpolated it is the beginning of the relevant period
(hence it is easy to create interpolated fixings from
a not-interpolated curve because interpolation, usually,
of fixings is forward looking).
*/
virtual Date baseDate() const = 0;
//@}
//! Functions to set and get seasonality.
/*! Calling setSeasonality with no arguments means unsetting
as the default is used to choose unsetting.
*/
void setSeasonality(const boost::shared_ptr<Seasonality>& seasonality =
boost::shared_ptr<Seasonality>());
boost::shared_ptr<Seasonality> seasonality() const;
bool hasSeasonality() const;
protected:
// This next part is required for piecewise- constructors
// because, for inflation, they need more than just the
// instruments to build the term structure, since the rate at
// time 0-lag is non-zero, since we deal (effectively) with
// "forwards".
virtual void setBaseRate(const Rate &r){baseRate_=r;}
// range-checking
void checkRange(const Date&,
bool extrapolate) const;
void checkRange(Time t,
bool extrapolate) const;
boost::shared_ptr<Seasonality> seasonality_;
Period observationLag_;
Frequency frequency_;
bool indexIsInterpolated_;
mutable Rate baseRate_;
Handle<YieldTermStructure> nominalTermStructure_;
};
//! Interface for zero inflation term structures.
// Child classes use templates but do not want that exposed to
// general users.
class ZeroInflationTermStructure : public InflationTermStructure {
public:
//! \name Constructors
//@{
ZeroInflationTermStructure(const DayCounter& dayCounter,
Rate baseZeroRate,
const Period& lag,
Frequency frequency,
bool indexIsInterpolated,
const Handle<YieldTermStructure>& yTS,
const boost::shared_ptr<Seasonality> &seasonality = boost::shared_ptr<Seasonality>());
ZeroInflationTermStructure(const Date& referenceDate,
const Calendar& calendar,
const DayCounter& dayCounter,
Rate baseZeroRate,
const Period& lag,
Frequency frequency,
const bool indexIsInterpolated,
const Handle<YieldTermStructure>& yTS,
const boost::shared_ptr<Seasonality> &seasonality = boost::shared_ptr<Seasonality>());
ZeroInflationTermStructure(Natural settlementDays,
const Calendar& calendar,
const DayCounter& dayCounter,
Rate baseZeroRate,
const Period& lag,
Frequency frequency,
bool indexIsInterpolated,
const Handle<YieldTermStructure>& yTS,
const boost::shared_ptr<Seasonality> &seasonality = boost::shared_ptr<Seasonality>());
//@}
//! \name Inspectors
//@{
//! zero-coupon inflation rate.
/*! Essentially the fair rate for a zero-coupon inflation swap
(by definition), i.e. the zero term structure uses yearly
compounding, which is assumed for ZCIIS instrument quotes.
\note by default you get the same as lag and interpolation
as the term structure.
If you want to get predictions of RPI/CPI/etc then use an
index.
*/
Rate zeroRate(const Date &d, const Period& instObsLag = Period(-1,Days),
bool forceLinearInterpolation = false,
bool extrapolate = false) const;
//! zero-coupon inflation rate.
/*! \warning Since inflation is highly linked to dates (lags,
interpolation, months for seasonality, etc) this
method cannot account for all effects. If you
call it, You'll have to manage lag, seasonality
etc. yourself.
*/
Rate zeroRate(Time t,
bool extrapolate = false) const;
//@}
protected:
//! to be defined in derived classes
virtual Rate zeroRateImpl(Time t) const = 0;
};
//! Base class for year-on-year inflation term structures.
class YoYInflationTermStructure : public InflationTermStructure {
public:
//! \name Constructors
//@{
YoYInflationTermStructure(const DayCounter& dayCounter,
Rate baseYoYRate,
const Period& lag,
Frequency frequency,
bool indexIsInterpolated,
const Handle<YieldTermStructure>& yieldTS,
const boost::shared_ptr<Seasonality> &seasonality = boost::shared_ptr<Seasonality>());
YoYInflationTermStructure(const Date& referenceDate,
const Calendar& calendar,
const DayCounter& dayCounter,
Rate baseYoYRate,
const Period& lag,
Frequency frequency,
bool indexIsInterpolated,
const Handle<YieldTermStructure>& yieldTS,
const boost::shared_ptr<Seasonality> &seasonality = boost::shared_ptr<Seasonality>());
YoYInflationTermStructure(Natural settlementDays,
const Calendar& calendar,
const DayCounter& dayCounter,
Rate baseYoYRate,
const Period& lag,
Frequency frequency,
bool indexIsInterpolated,
const Handle<YieldTermStructure>& yieldTS,
const boost::shared_ptr<Seasonality> &seasonality = boost::shared_ptr<Seasonality>());
//@}
//! \name Inspectors
//@{
//! year-on-year inflation rate.
/*! The forceLinearInterpolation parameter is relative to the
frequency of the TS.
\note this is not the year-on-year swap (YYIIS) rate.
*/
Rate yoyRate(const Date &d, const Period& instObsLag = Period(-1,Days),
bool forceLinearInterpolation = false,
bool extrapolate = false) const;
//! year-on-year inflation rate.
/*! \warning Since inflation is highly linked to dates (lags,
interpolation, months for seasonality, etc) this
method cannot account for all effects. If you
call it, You'll have to manage lag, seasonality
etc. yourself.
*/
Rate yoyRate(Time t,
bool extrapolate = false) const;
//@}
protected:
//! to be defined in derived classes
virtual Rate yoyRateImpl(Time time) const = 0;
};
//! utility function giving the inflation period for a given date
std::pair<Date,Date> inflationPeriod(const Date &,
Frequency);
//! utility function giving the time between two dates depending on
//! index frequency and interpolation, and a day counter
Time inflationYearFraction(Frequency ,
bool indexIsInterpolated,
const DayCounter &,
const Date &, const Date &);
// inline
inline Period InflationTermStructure::observationLag() const {
return observationLag_;
}
inline Frequency InflationTermStructure::frequency() const {
return frequency_;
}
inline bool InflationTermStructure::indexIsInterpolated() const {
return indexIsInterpolated_;
}
inline Rate InflationTermStructure::baseRate() const {
return baseRate_;
}
inline Handle<YieldTermStructure>
InflationTermStructure::nominalTermStructure() const {
return nominalTermStructure_;
}
inline boost::shared_ptr<Seasonality> InflationTermStructure::seasonality() const {
return seasonality_;
}
inline bool InflationTermStructure::hasSeasonality() const {
return static_cast<bool>(seasonality_);
}
}
#endif
|