/usr/include/ql/termstructures/bootstraphelper.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 | /* -*- 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, 2009, 2015 Ferdinando Ametrano
Copyright (C) 2015 Paolo Mazzocchi
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 bootstraphelper.hpp
\brief base helper class used for bootstrapping
*/
#ifndef quantlib_bootstrap_helper_hpp
#define quantlib_bootstrap_helper_hpp
#include <ql/quote.hpp>
#include <ql/time/date.hpp>
#include <ql/handle.hpp>
#include <ql/patterns/observable.hpp>
#include <ql/patterns/visitor.hpp>
#include <ql/quotes/simplequote.hpp>
#include <ql/settings.hpp>
namespace QuantLib {
struct Pillar {
//! Enumeration for pillar determination alternatives
/*! These alternatives specify the determination of the pillar date. */
enum Choice {
MaturityDate, //! instruments maturity date
LastRelevantDate, //! last date relevant for instrument pricing
CustomDate //! custom choice
};
};
std::ostream& operator<<(std::ostream& out, Pillar::Choice type);
//! Base helper class for bootstrapping
/*! This class provides an abstraction for the instruments used to
bootstrap a term structure.
It is advised that a bootstrap helper for an instrument
contains an instance of the actual instrument class to ensure
consistancy between the algorithms used during bootstrapping
and later instrument pricing. This is not yet fully enforced
in the available bootstrap helpers.
*/
template <class TS>
class BootstrapHelper : public Observer, public Observable {
public:
BootstrapHelper(const Handle<Quote>& quote);
BootstrapHelper(Real quote);
virtual ~BootstrapHelper() {}
//! \name BootstrapHelper interface
//@{
const Handle<Quote>& quote() const { return quote_; }
virtual Real impliedQuote() const = 0;
Real quoteError() const { return quote_->value() - impliedQuote(); }
//! sets the term structure to be used for pricing
/*! \warning Being a pointer and not a shared_ptr, the term
structure is not guaranteed to remain allocated
for the whole life of the rate helper. It is
responsibility of the programmer to ensure that
the pointer remains valid. It is advised that
this method is called only inside the term
structure being bootstrapped, setting the pointer
to <b>this</b>, i.e., the term structure itself.
*/
virtual void setTermStructure(TS*);
//! earliest relevant date
/*! The earliest date at which data are needed by the
helper in order to provide a quote.
*/
virtual Date earliestDate() const;
//! instrument's maturity date
virtual Date maturityDate() const;
//! latest relevant date
/*! The latest date at which data are needed by the helper
in order to provide a quote. It does not necessarily
equal the maturity of the underlying instrument.
*/
virtual Date latestRelevantDate() const;
//! pillar date
virtual Date pillarDate() const;
//! latest date
/*! equal to pillarDate()
*/
virtual Date latestDate() const;
//@}
//! \name Observer interface
//@{
virtual void update();
//@}
//! \name Visitability
//@{
virtual void accept(AcyclicVisitor&);
//@}
protected:
Handle<Quote> quote_;
TS* termStructure_;
Date earliestDate_, latestDate_;
Date maturityDate_, latestRelevantDate_, pillarDate_;
};
//! Bootstrap helper with date schedule relative to global evaluation date
/*! Derived classes must takes care of rebuilding the date schedule when
the global evaluation date changes
*/
template <class TS>
class RelativeDateBootstrapHelper : public BootstrapHelper<TS> {
public:
RelativeDateBootstrapHelper(const Handle<Quote>& quote);
RelativeDateBootstrapHelper(Real quote);
//! \name Observer interface
//@{
void update() {
if (evaluationDate_ != Settings::instance().evaluationDate()) {
evaluationDate_ = Settings::instance().evaluationDate();
initializeDates();
}
BootstrapHelper<TS>::update();
}
//@}
protected:
virtual void initializeDates() = 0;
Date evaluationDate_;
};
// template definitions
template <class TS>
BootstrapHelper<TS>::BootstrapHelper(const Handle<Quote>& quote)
: quote_(quote), termStructure_(0) {
registerWith(quote_);
}
template <class TS>
BootstrapHelper<TS>::BootstrapHelper(Real quote)
: quote_(Handle<Quote>(boost::shared_ptr<Quote>(new SimpleQuote(quote)))),
termStructure_(0) {}
template <class TS>
void BootstrapHelper<TS>::setTermStructure(TS* t) {
QL_REQUIRE(t != 0, "null term structure given");
termStructure_ = t;
}
template <class TS>
Date BootstrapHelper<TS>::earliestDate() const {
return earliestDate_;
}
template <class TS>
Date BootstrapHelper<TS>::maturityDate() const {
if (maturityDate_ == Date())
return latestRelevantDate();
return maturityDate_;
}
template <class TS>
Date BootstrapHelper<TS>::latestRelevantDate() const {
if (latestRelevantDate_ == Date())
return latestDate();
return latestRelevantDate_;
}
template <class TS>
Date BootstrapHelper<TS>::pillarDate() const {
if (pillarDate_==Date())
return latestDate();
return pillarDate_;
}
template <class TS>
Date BootstrapHelper<TS>::latestDate() const {
if (latestDate_ == Date())
return pillarDate_;
return latestDate_;
}
template <class TS>
void BootstrapHelper<TS>::update() {
notifyObservers();
}
template <class TS>
void BootstrapHelper<TS>::accept(AcyclicVisitor& v) {
Visitor<BootstrapHelper<TS> >* v1 =
dynamic_cast<Visitor<BootstrapHelper<TS> >*>(&v);
if (v1 != 0)
v1->visit(*this);
else
QL_FAIL("not a bootstrap-helper visitor");
}
template <class TS>
RelativeDateBootstrapHelper<TS>::RelativeDateBootstrapHelper(
const Handle<Quote>& quote)
: BootstrapHelper<TS>(quote) {
this->registerWith(Settings::instance().evaluationDate());
evaluationDate_ = Settings::instance().evaluationDate();
}
template <class TS>
RelativeDateBootstrapHelper<TS>::RelativeDateBootstrapHelper(Real quote)
: BootstrapHelper<TS>(quote) {
this->registerWith(Settings::instance().evaluationDate());
evaluationDate_ = Settings::instance().evaluationDate();
}
inline std::ostream& operator<<(std::ostream& out,
Pillar::Choice t) {
switch (t) {
case Pillar::MaturityDate:
return out << "MaturityPillarDate";
case Pillar::LastRelevantDate:
return out << "LastRelevantPillarDate";
case Pillar::CustomDate:
return out << "CustomPillarDate";
default:
QL_FAIL("unknown Pillar::Choice(" << Integer(t) << ")");
}
}
namespace detail {
class BootstrapHelperSorter {
public:
template <class Helper>
bool operator()(
const boost::shared_ptr<Helper>& h1,
const boost::shared_ptr<Helper>& h2) const {
return (h1->pillarDate() < h2->pillarDate());
}
};
}
}
#endif
|