/usr/include/ql/experimental/credit/defaultevent.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 | /* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
Copyright (C) 2009 StatPro Italia srl
Copyright (C) 2009 Jose Aparicio
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 defaultevent.hpp
\brief Classes for default-event description.
*/
#ifndef quantlib_default_event_hpp
#define quantlib_default_event_hpp
#include <ql/event.hpp>
#include <ql/currency.hpp>
#include <ql/math/comparison.hpp>
#include <ql/experimental/credit/defaulttype.hpp>
#include <ql/experimental/credit/defaultprobabilitykey.hpp>
#include <map>
namespace QuantLib {
/**
@class DefaultEvent
@brief Credit event on a bond of a certain seniority(ies)/currency
Represents a credit event affecting all bonds with a given \
seniority and currency. It assumes that all such bonds suffer \
the event simultaneously.
Some events affect all seniorities and this has to be encoded
through a different set of events of the same event type.
The event is an actual realization, not a contractual reference,
as such it contains only an atomic type.
*/
class DefaultEvent : public Event {
public:
class DefaultSettlement : public Event {
public:
friend class DefaultEvent;
protected:
/*! Default settlement events encode the settlement date
and the recovery rates for the affected
seniorities. Specific events might require different
sets of recoveries to be present. The way these
objects are constructed is a prerogative of the
particular event class.
*/
DefaultSettlement(const Date& date,
const std::map<Seniority, Real>& recoveryRates);
/*! When NoSeniority is passed all seniorities are assumed
to have settled to the recovery passed.
*/
DefaultSettlement(const Date& date = Date(),
Seniority seniority = NoSeniority,
Real recoveryRate = 0.4);
public:
Date date() const;
/*! Returns the recovery rate of a default event which has already
settled.
*/
Real recoveryRate(Seniority sen) const;
void accept(AcyclicVisitor&);
private:
Date settlementDate_;
//! Realized recovery rates
std::map<Seniority, Real> recoveryRates_;
};
private:
// for some reason, gcc chokes on the default parameter below
// unless we use the typedef
typedef std::map<Seniority, Real> rate_map;
public:
/*! Credit event with optional settlement
information. Represents a credit event that has taken
place. Realized events are of an atomic type. If the
settlement information is given seniorities present are
the seniorities/bonds affected by the event.
*/
DefaultEvent(const Date& creditEventDate,
const DefaultType& atomicEvType,
const Currency& curr,
Seniority bondsSen,
// Settlement information:
const Date& settleDate = Null<Date>(),
const std::map<Seniority, Real>& recoveryRates =
rate_map());
/*! Use NoSeniority to settle to all seniorities with that
recovery. In that case the event is assumed to have
affected all seniorities.
*/
DefaultEvent(const Date& creditEventDate,
const DefaultType& atomicEvType,
const Currency& curr,
Seniority bondsSen,
// Settlement information:
const Date& settleDate = Null<Date>(),
Real recoveryRate = 0.4);
public:
Date date() const;
bool isRestructuring() const { return eventType_.isRestructuring(); }
bool isDefault() const { return !isRestructuring();}
bool hasSettled() const {
return defSettlement_.date() != Null<Date>();
}
const DefaultSettlement& settlement() const {
return defSettlement_;
}
const DefaultType& defaultType() const {
return eventType_;
}
//! returns the currency of the bond this event refers to.
const Currency& currency() const {
return bondsCurrency_;
}
//! returns the seniority of the bond that triggered the event.
Seniority eventSeniority() const {
return bondsSeniority_;
}
/*! returns a value if the event lead to a settlement for the
requested seniority. Specializations on the default
atomics and recoveries could change the default policy.
*/
virtual Real recoveryRate(Seniority seniority) const {
if(hasSettled()) {
return defSettlement_.recoveryRate(seniority);
}
return Null<Real>();
}
/*! matches the event if this event would trigger a contract
related to the requested event type. Notice the
contractual event types are not neccesarily atomic.
Notice it does not check seniority or currency only event
type. typically used from Issuer
*/
virtual bool matchesEventType(
const boost::shared_ptr<DefaultType>& contractEvType) const {
// remember we are made of an atomic type.
// behaviour by default...
return
contractEvType->containsRestructuringType(
eventType_.restructuringType()) &&
contractEvType->containsDefaultType(
eventType_.defaultType());
}
/*! Returns true if this event would trigger a contract with
the arguments characteristics.
*/
virtual bool matchesDefaultKey(const DefaultProbKey& contractKey) const;
void accept(AcyclicVisitor&);
protected:
Currency bondsCurrency_;
Date defaultDate_;
DefaultType eventType_;
Seniority bondsSeniority_;
DefaultSettlement defSettlement_;
};
/*! Two credit events are the same independently of their
settlement member data. This has the side effect of
overwritting different settlements from the same credit event
when, say, inserting in a map. But on the other hand one given
event can only have one settlement. This means we can not have
two restructuring events on a bond on the same date.
*/
bool operator==(const DefaultEvent& lhs, const DefaultEvent& rhs);
inline bool operator!=(const DefaultEvent& lhs, const DefaultEvent& rhs) {
return !(lhs == rhs);
}
template<>
struct earlier_than<DefaultEvent>
: public std::binary_function<DefaultEvent, DefaultEvent, bool> {
bool operator()(const DefaultEvent& e1, const DefaultEvent& e2) {
return e1.date() < e2.date();
}
};
// ------------------------------------------------------------------------
class FailureToPayEvent : public DefaultEvent {
public:
FailureToPayEvent(const Date& creditEventDate,
const Currency& curr,
Seniority bondsSen,
Real defaultedAmount,
// Settlement information:
const Date& settleDate,
const std::map<Seniority, Real>& recoveryRates);
FailureToPayEvent(const Date& creditEventDate,
const Currency& curr,
Seniority bondsSen,
Real defaultedAmount,
// Settlement information:
const Date& settleDate,
Real recoveryRates);
Real amountDefaulted() const {return defaultedAmount_;}
bool matchesEventType(
const boost::shared_ptr<DefaultType>& contractEvType) const;
private:
Real defaultedAmount_;
};
// ------------------------------------------------------------------------
class BankruptcyEvent : public DefaultEvent {
public:
BankruptcyEvent(const Date& creditEventDate,
const Currency& curr,
Seniority bondsSen,
// Settlement information:
const Date& settleDate,
const std::map<Seniority, Real>& recoveryRates);
BankruptcyEvent(const Date& creditEventDate,
const Currency& curr,
Seniority bondsSen,
// Settlement information:
const Date& settleDate,
// means same for all
Real recoveryRates);
//! This is a stronger than all event and will trigger all of them.
bool matchesEventType(const boost::shared_ptr<DefaultType>&) const {
return true;
}
};
}
#endif
|