/usr/include/ql/termstructures/yield/piecewiseyieldcurve.hpp is in libquantlib0-dev 1.4-2.
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 | /* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
Copyright (C) 2005, 2006, 2007, 2008 StatPro Italia srl
Copyright (C) 2007, 2008, 2009 Ferdinando Ametrano
Copyright (C) 2007 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 piecewiseyieldcurve.hpp
\brief piecewise-interpolated term structure
*/
#ifndef quantlib_piecewise_yield_curve_hpp
#define quantlib_piecewise_yield_curve_hpp
#include <ql/termstructures/iterativebootstrap.hpp>
#include <ql/termstructures/localbootstrap.hpp>
#include <ql/termstructures/yield/bootstraptraits.hpp>
#include <ql/patterns/lazyobject.hpp>
namespace QuantLib {
//! Piecewise yield term structure
/*! This term structure is bootstrapped on a number of interest
rate instruments which are passed as a vector of handles to
RateHelper instances. Their maturities mark the boundaries of
the interpolated segments.
Each segment is determined sequentially starting from the
earliest period to the latest and is chosen so that the
instrument whose maturity marks the end of such segment is
correctly repriced on the curve.
\warning The bootstrapping algorithm will raise an exception if
any two instruments have the same maturity date.
\ingroup yieldtermstructures
\test
- the correctness of the returned values is tested by
checking them against the original inputs.
- the observability of the term structure is tested.
*/
template <class Traits, class Interpolator,
template <class> class Bootstrap = IterativeBootstrap>
class PiecewiseYieldCurve
: public Traits::template curve<Interpolator>::type,
public LazyObject {
private:
typedef typename Traits::template curve<Interpolator>::type base_curve;
typedef PiecewiseYieldCurve<Traits,Interpolator,Bootstrap> this_curve;
public:
typedef Traits traits_type;
typedef Interpolator interpolator_type;
//! \name Constructors
//@{
PiecewiseYieldCurve(
const Date& referenceDate,
const std::vector<boost::shared_ptr<typename Traits::helper> >&
instruments,
const DayCounter& dayCounter,
const std::vector<Handle<Quote> >& jumps =
std::vector<Handle<Quote> >(),
const std::vector<Date>& jumpDates = std::vector<Date>(),
Real accuracy = 1.0e-12,
const Interpolator& i = Interpolator(),
const Bootstrap<this_curve>& bootstrap = Bootstrap<this_curve>())
: base_curve(referenceDate, dayCounter, jumps, jumpDates, i),
instruments_(instruments),
accuracy_(accuracy), bootstrap_(bootstrap) {
bootstrap_.setup(this);
}
PiecewiseYieldCurve(
const Date& referenceDate,
const std::vector<boost::shared_ptr<typename Traits::helper> >&
instruments,
const DayCounter& dayCounter,
Real accuracy,
const Interpolator& i = Interpolator(),
const Bootstrap<this_curve>& bootstrap = Bootstrap<this_curve>())
: base_curve(referenceDate, dayCounter,
std::vector<Handle<Quote> >(), std::vector<Date>(), i),
instruments_(instruments),
accuracy_(accuracy), bootstrap_(bootstrap) {
bootstrap_.setup(this);
}
PiecewiseYieldCurve(
const Date& referenceDate,
const std::vector<boost::shared_ptr<typename Traits::helper> >&
instruments,
const DayCounter& dayCounter,
const Interpolator& i,
const Bootstrap<this_curve>& bootstrap = Bootstrap<this_curve>())
: base_curve(referenceDate, dayCounter,
std::vector<Handle<Quote> >(), std::vector<Date>(), i),
instruments_(instruments),
accuracy_(1.0e-12), bootstrap_(bootstrap) {
bootstrap_.setup(this);
}
PiecewiseYieldCurve(
Natural settlementDays,
const Calendar& calendar,
const std::vector<boost::shared_ptr<typename Traits::helper> >&
instruments,
const DayCounter& dayCounter,
const std::vector<Handle<Quote> >& jumps = std::vector<Handle<Quote> >(),
const std::vector<Date>& jumpDates = std::vector<Date>(),
Real accuracy = 1.0e-12,
const Interpolator& i = Interpolator(),
const Bootstrap<this_curve>& bootstrap = Bootstrap<this_curve>())
: base_curve(settlementDays, calendar, dayCounter, jumps, jumpDates, i),
instruments_(instruments),
accuracy_(accuracy), bootstrap_(bootstrap) {
bootstrap_.setup(this);
}
PiecewiseYieldCurve(
Natural settlementDays,
const Calendar& calendar,
const std::vector<boost::shared_ptr<typename Traits::helper> >&
instruments,
const DayCounter& dayCounter,
Real accuracy,
const Interpolator& i = Interpolator(),
const Bootstrap<this_curve>& bootstrap = Bootstrap<this_curve>())
: base_curve(settlementDays, calendar, dayCounter,
std::vector<Handle<Quote> >(), std::vector<Date>(), i),
instruments_(instruments),
accuracy_(accuracy), bootstrap_(bootstrap) {
bootstrap_.setup(this);
}
PiecewiseYieldCurve(
Natural settlementDays,
const Calendar& calendar,
const std::vector<boost::shared_ptr<typename Traits::helper> >&
instruments,
const DayCounter& dayCounter,
const Interpolator& i,
const Bootstrap<this_curve>& bootstrap = Bootstrap<this_curve>())
: base_curve(settlementDays, calendar, dayCounter,
std::vector<Handle<Quote> >(), std::vector<Date>(), i),
instruments_(instruments),
accuracy_(1.0e-12), bootstrap_(bootstrap) {
bootstrap_.setup(this);
}
//@}
//! \name TermStructure interface
//@{
Date maxDate() const;
//@}
//! \name base_curve interface
//@{
const std::vector<Time>& times() const;
const std::vector<Date>& dates() const;
const std::vector<Real>& data() const;
std::vector<std::pair<Date, Real> > nodes() const;
//@}
//! \name Observer interface
//@{
void update();
//@}
private:
//! \name LazyObject interface
//@{
void performCalculations() const;
//@}
// methods
DiscountFactor discountImpl(Time) const;
// data members
std::vector<boost::shared_ptr<typename Traits::helper> > instruments_;
Real accuracy_;
// bootstrapper classes are declared as friend to manipulate
// the curve data. They might be passed the data instead, but
// it would increase the complexity---which is high enough
// already.
friend class Bootstrap<this_curve>;
friend class BootstrapError<this_curve> ;
friend class PenaltyFunction<this_curve>;
Bootstrap<this_curve> bootstrap_;
};
// inline definitions
template <class C, class I, template <class> class B>
inline Date PiecewiseYieldCurve<C,I,B>::maxDate() const {
calculate();
return base_curve::maxDate();
}
template <class C, class I, template <class> class B>
inline const std::vector<Time>& PiecewiseYieldCurve<C,I,B>::times() const {
calculate();
return base_curve::times();
}
template <class C, class I, template <class> class B>
inline const std::vector<Date>& PiecewiseYieldCurve<C,I,B>::dates() const {
calculate();
return base_curve::dates();
}
template <class C, class I, template <class> class B>
inline const std::vector<Real>& PiecewiseYieldCurve<C,I,B>::data() const {
calculate();
return base_curve::data();
}
template <class C, class I, template <class> class B>
inline std::vector<std::pair<Date, Real> >
PiecewiseYieldCurve<C,I,B>::nodes() const {
calculate();
return base_curve::nodes();
}
template <class C, class I, template <class> class B>
inline void PiecewiseYieldCurve<C,I,B>::update() {
// it dispatches notifications only if (!calculated_ && !frozen_)
LazyObject::update();
// do not use base_curve::update() as it would always notify observers
// TermStructure::update() update part
if (this->moving_)
this->updated_ = false;
}
template <class C, class I, template <class> class B>
inline
DiscountFactor PiecewiseYieldCurve<C,I,B>::discountImpl(Time t) const {
calculate();
return base_curve::discountImpl(t);
}
template <class C, class I, template <class> class B>
inline void PiecewiseYieldCurve<C,I,B>::performCalculations() const {
// just delegate to the bootstrapper
bootstrap_.calculate();
}
}
#endif
|