File: class_quant_lib_1_1_synthetic_c_d_o.html

package info (click to toggle)
quantlib-refman-html 1.2-1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd, wheezy
  • size: 84,552 kB
  • ctags: 5,132
  • sloc: makefile: 33
file content (247 lines) | stat: -rw-r--r-- 18,520 bytes parent folder | download
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<meta name="robots" content="none">
<title>SyntheticCDO Class Reference</title>
<link rel="stylesheet" href="quantlib.css" type="text/css">
<link rel="stylesheet" href="print.css" type="text/css" media="print">
<link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
<link rel="icon" href="favicon.ico" type="image/x-icon">
</head>
<body>

<div id="container">
<div id="header">
<img class="titleimage"
 src="QL-title.jpg" width="185" height="50" border="0"
 alt="QuantLib">
<br>
<h3 class="subtitle">A free/open-source library for quantitative finance</h3>
</div>
<div id="menu">

<h3 class="navbartitle">Version 1.2</h3>

<hr>

<h3 class="navbartitle">Getting started</h3>
<ul class="navbarlist">
<li class="navlink"><a href="index.html">Introduction</a></li>
<li class="navlink"><a href="where.html">Where to get QuantLib</a></li>
<li class="navlink"><a href="install.html">Installation</a></li>
<li class="navlink"><a href="config.html">Configuration</a></li>
<li class="navlink"><a href="usage.html">Usage</a></li>
<li class="navlink"><a href="history.html">Version history</a></li>
<li class="navlink"><a href="resources.html">Additional resources</a></li>
<li class="navlink"><a href="group.html">The QuantLib group</a></li>
<li class="navlink"><a href="license.html">Copyright and license</a></li>
</ul>

<hr>

<h3 class="navbartitle">Reference manual</h3>
<ul class="navbarlist">
<li class="navlink"><a href="modules.html">Modules</a></li>
<li class="navlink"><a href="hierarchy.html">Class Hierarchy</a></li>
<li class="navlink"><a href="annotated.html">Compound List</a></li>
<li class="navlink"><a href="files.html">File List</a></li>
<li class="navlink"><a href="functions.html">Compound Members</a></li>
<li class="navlink"><a href="globals.html">File Members</a></li>
<li class="navlink"><a href="todo.html">Todo List</a></li>
<li class="navlink"><a href="bug.html">Known Bugs</a></li>
<li class="navlink"><a href="caveats.html">Caveats</a></li>
<li class="navlink"><a href="test.html">Test Suite</a></li>
<li class="navlink"><a href="examples.html">Examples</a></li>
</ul>
</div>

<div id="content">
<!--Doxygen-generated content-->

<!-- Generated by Doxygen 1.7.6.1 -->
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><b>QuantLib</b>      </li>
      <li class="navelem"><a class="el" href="class_quant_lib_1_1_synthetic_c_d_o.html">SyntheticCDO</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">SyntheticCDO Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::SyntheticCDO" --><!-- doxytag: inherits="QuantLib::Instrument" -->
<p>Synthetic Collateralized Debt Obligation.  
 <a href="class_quant_lib_1_1_synthetic_c_d_o.html#details">More...</a></p>

<p><code>#include &lt;ql/experimental/credit/syntheticcdo.hpp&gt;</code></p>
<div class="dynheader">
Inheritance diagram for SyntheticCDO:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_synthetic_c_d_o__inherit__graph.png" border="0" usemap="#_synthetic_c_d_o_inherit__map" alt="Inheritance graph"/></div>
<map name="_synthetic_c_d_o_inherit__map" id="_synthetic_c_d_o_inherit__map">
<area shape="rect" id="node2" href="class_quant_lib_1_1_instrument.html" title="Abstract instrument class." alt="" coords="16,6,99,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="class_quant_lib_1_1_synthetic_c_d_o-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_synthetic_c_d_o_1_1engine.html">engine</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_quant_lib_1_1_c_d_o.html" title="collateralized debt obligation">CDO</a> base engine.  <a href="class_quant_lib_1_1_synthetic_c_d_o_1_1engine.html#details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab89b4f3cb58712bcfd1811c51191e43e"></a><!-- doxytag: member="QuantLib::SyntheticCDO::SyntheticCDO" ref="ab89b4f3cb58712bcfd1811c51191e43e" args="(const boost::shared_ptr&lt; Basket &gt; basket, Protection::Side side, const Schedule &amp;schedule, Rate upfrontRate, Rate runningRate, const DayCounter &amp;dayCounter, BusinessDayConvention paymentConvention, const Handle&lt; YieldTermStructure &gt; &amp;yieldTS)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>SyntheticCDO</b> (const boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_basket.html">Basket</a> &gt; basket, Protection::Side side, const <a class="el" href="class_quant_lib_1_1_schedule.html">Schedule</a> &amp;schedule, <a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> upfrontRate, <a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> runningRate, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &amp;dayCounter, <a class="el" href="group__datetime.html#gaff46c5ae9385d20709bedade86edd368">BusinessDayConvention</a> paymentConvention, const <a class="el" href="class_quant_lib_1_1_handle.html">Handle</a>&lt; <a class="el" href="class_quant_lib_1_1_yield_term_structure.html">YieldTermStructure</a> &gt; &amp;yieldTS)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aea4975364ce04215976c4cecddba7261"></a><!-- doxytag: member="QuantLib::SyntheticCDO::basket" ref="aea4975364ce04215976c4cecddba7261" args="() const " -->
boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_basket.html">Basket</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>basket</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a274c03751addc5c2ea63cc23d14a0bfe"></a><!-- doxytag: member="QuantLib::SyntheticCDO::isExpired" ref="a274c03751addc5c2ea63cc23d14a0bfe" args="() const " -->
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_synthetic_c_d_o.html#a274c03751addc5c2ea63cc23d14a0bfe">isExpired</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">returns whether the instrument might have value greater than zero. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a439b4331763c1772af92bec6b182c62c"></a><!-- doxytag: member="QuantLib::SyntheticCDO::fairPremium" ref="a439b4331763c1772af92bec6b182c62c" args="() const " -->
<a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a>&#160;</td><td class="memItemRight" valign="bottom"><b>fairPremium</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9f9a340d55784f63ccfff9cf1979bd54"></a><!-- doxytag: member="QuantLib::SyntheticCDO::fairUpfrontPremium" ref="a9f9a340d55784f63ccfff9cf1979bd54" args="() const " -->
<a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a>&#160;</td><td class="memItemRight" valign="bottom"><b>fairUpfrontPremium</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8729d80e43b77566cbdf0cfe0b9b93dd"></a><!-- doxytag: member="QuantLib::SyntheticCDO::premiumValue" ref="a8729d80e43b77566cbdf0cfe0b9b93dd" args="() const " -->
<a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a>&#160;</td><td class="memItemRight" valign="bottom"><b>premiumValue</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abb77e8f956fe2e7458681bef8f73f9d0"></a><!-- doxytag: member="QuantLib::SyntheticCDO::protectionValue" ref="abb77e8f956fe2e7458681bef8f73f9d0" args="() const " -->
<a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a>&#160;</td><td class="memItemRight" valign="bottom"><b>protectionValue</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2f0a1cec9683f9dee08ad2ea12eda7aa"></a><!-- doxytag: member="QuantLib::SyntheticCDO::premiumLegNPV" ref="a2f0a1cec9683f9dee08ad2ea12eda7aa" args="() const " -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>premiumLegNPV</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a28658c93a5819086e55488a2a2e0e463"></a><!-- doxytag: member="QuantLib::SyntheticCDO::protectionLegNPV" ref="a28658c93a5819086e55488a2a2e0e463" args="() const " -->
<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><b>protectionLegNPV</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_synthetic_c_d_o.html#afb6649efb47dd3d59ef63002f3d27002">remainingNotional</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_synthetic_c_d_o.html#a73193d76dd420560c91dbefc6874dd93">expectedTrancheLoss</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afca3e3cf414a77cea53374f408cf8e0a"></a><!-- doxytag: member="QuantLib::SyntheticCDO::error" ref="afca3e3cf414a77cea53374f408cf8e0a" args="() const " -->
<a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a>&#160;</td><td class="memItemRight" valign="bottom"><b>error</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_synthetic_c_d_o.html#aad6958108bfaef12bc4ccd6b3d7a7231">setupArguments</a> (PricingEngine::arguments *) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_synthetic_c_d_o.html#aa0a3105ddebcff9f233fb76a8a31fafe">fetchResults</a> (const PricingEngine::results *) const </td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Synthetic Collateralized Debt Obligation. </p>
<p>The instrument prices a mezzanine <a class="el" href="class_quant_lib_1_1_c_d_o.html" title="collateralized debt obligation">CDO</a> tranche with loss given default between attachment point <img class="formulaInl" alt="$ D_1$" src="form_66.png"/> and detachment point <img class="formulaInl" alt="$ D_2 > D_1 $" src="form_67.png"/>.</p>
<p>For purchased protection, the instrument value is given by the difference of the protection value <img class="formulaInl" alt="$ V_1 $" src="form_68.png"/> and premium value <img class="formulaInl" alt="$ V_2 $" src="form_69.png"/>,</p>
<p class="formulaDsp">
<img class="formulaDsp" alt="\[ V = V_1 - V_2. \]" src="form_70.png"/>
</p>
<p>The protection leg is priced as follows:</p>
<ul>
<li>Build the probability distribution for volume of defaults <img class="formulaInl" alt="$ L $" src="form_46.png"/> (before recovery) or Loss Given Default <img class="formulaInl" alt="$ LGD = (1-r)\,L $" src="form_71.png"/> at times/dates <img class="formulaInl" alt="$ t_i, i=1, ..., N$" src="form_72.png"/> (premium schedule times with intermediate steps)</li>
</ul>
<ul>
<li>Determine the expected value <img class="formulaInl" alt="$ E_i = E_{t_i}\,\left[Pay(LGD)\right] $" src="form_73.png"/> of the protection payoff <img class="formulaInl" alt="$ Pay(LGD) $" src="form_74.png"/> at each time <img class="formulaInl" alt="$ t_i$" src="form_75.png"/> where <p class="formulaDsp">
<img class="formulaDsp" alt="\[ Pay(L) = min (D_1, LGD) - min (D_2, LGD) = \left\{ \begin{array}{lcl} \displaystyle 0 &amp;;&amp; LGD < D_1 \\ \displaystyle LGD - D_1 &amp;;&amp; D_1 \leq LGD \leq D_2 \\ \displaystyle D_2 - D_1 &amp;;&amp; LGD > D_2 \end{array} \right. \]" src="form_76.png"/>
</p>
</li>
</ul>
<ul>
<li>The protection value is then calculated as <p class="formulaDsp">
<img class="formulaDsp" alt="\[ V_1 \:=\: \sum_{i=1}^N (E_i - E_{i-1}) \cdot d_i \]" src="form_77.png"/>
</p>
 where <img class="formulaInl" alt="$ d_i$" src="form_78.png"/> is the discount factor at time/date <img class="formulaInl" alt="$ t_i $" src="form_57.png"/></li>
</ul>
<p>The premium is paid on the protected notional amount, initially <img class="formulaInl" alt="$ D_2 - D_1. $" src="form_79.png"/> This notional amount is reduced by the expected protection payments <img class="formulaInl" alt="$ E_i $" src="form_80.png"/> at times <img class="formulaInl" alt="$ t_i, $" src="form_81.png"/> so that the premium value is calculated as</p>
<p class="formulaDsp">
<img class="formulaDsp" alt="\[ V_2 = m \, \cdot \sum_{i=1}^N \,(D_2 - D_1 - E_i) \cdot \Delta_{i-1,i}\,d_i \]" src="form_82.png"/>
</p>
<p>where <img class="formulaInl" alt="$ m $" src="form_39.png"/> is the premium rate, <img class="formulaInl" alt="$ \Delta_{i-1, i}$" src="form_83.png"/> is the day count fraction between date/time <img class="formulaInl" alt="$ t_{i-1}$" src="form_84.png"/> and <img class="formulaInl" alt="$ t_i.$" src="form_85.png"/></p>
<p>The construction of the portfolio loss distribution <img class="formulaInl" alt="$ E_i $" src="form_80.png"/> is based on the probability bucketing algorithm described in</p>
<p><b> John Hull and Alan White, "Valuation of a CDO and nth to default CDS
      without Monte Carlo simulation", Journal of Derivatives 12, 2, 2004 </b></p>
<p>The pricing algorithm allows for varying notional amounts and default termstructures of the underlyings.</p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000011">Possible enhancements:</a></b></dt><dd>Investigate and fix cases <img class="formulaInl" alt="$ E_{i+1} < E_i. $" src="form_86.png"/> </dd></dl>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="afb6649efb47dd3d59ef63002f3d27002"></a><!-- doxytag: member="QuantLib::SyntheticCDO::remainingNotional" ref="afb6649efb47dd3d59ef63002f3d27002" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> <a class="el" href="class_quant_lib_1_1_synthetic_c_d_o.html#afb6649efb47dd3d59ef63002f3d27002">remainingNotional</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Total outstanding tranche notional, not wiped out </p>

</div>
</div>
<a class="anchor" id="a73193d76dd420560c91dbefc6874dd93"></a><!-- doxytag: member="QuantLib::SyntheticCDO::expectedTrancheLoss" ref="a73193d76dd420560c91dbefc6874dd93" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::vector&lt;<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a>&gt; <a class="el" href="class_quant_lib_1_1_synthetic_c_d_o.html#a73193d76dd420560c91dbefc6874dd93">expectedTrancheLoss</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Expected tranche loss for all payment dates </p>

</div>
</div>
<a class="anchor" id="aad6958108bfaef12bc4ccd6b3d7a7231"></a><!-- doxytag: member="QuantLib::SyntheticCDO::setupArguments" ref="aad6958108bfaef12bc4ccd6b3d7a7231" args="(PricingEngine::arguments *) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_quant_lib_1_1_synthetic_c_d_o.html#aad6958108bfaef12bc4ccd6b3d7a7231">setupArguments</a> </td>
          <td>(</td>
          <td class="paramtype">PricingEngine::arguments *&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>When a derived argument structure is defined for an instrument, this method should be overridden to fill it. This is mandatory in case a pricing engine is used. </p>

<p>Reimplemented from <a class="el" href="class_quant_lib_1_1_instrument.html#aad6958108bfaef12bc4ccd6b3d7a7231">Instrument</a>.</p>

</div>
</div>
<a class="anchor" id="aa0a3105ddebcff9f233fb76a8a31fafe"></a><!-- doxytag: member="QuantLib::SyntheticCDO::fetchResults" ref="aa0a3105ddebcff9f233fb76a8a31fafe" args="(const PricingEngine::results *) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_quant_lib_1_1_synthetic_c_d_o.html#aa0a3105ddebcff9f233fb76a8a31fafe">fetchResults</a> </td>
          <td>(</td>
          <td class="paramtype">const PricingEngine::results *&#160;</td>
          <td class="paramname"><em>r</em></td><td>)</td>
          <td> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>When a derived result structure is defined for an instrument, this method should be overridden to read from it. This is mandatory in case a pricing engine is used. </p>

<p>Reimplemented from <a class="el" href="class_quant_lib_1_1_instrument.html#aa0a3105ddebcff9f233fb76a8a31fafe">Instrument</a>.</p>

</div>
</div>
</div><!-- contents -->

</div>

<div class="footer">
<div class="endmatter">
Documentation generated by
<a href="http://www.doxygen.org">Doxygen</a> 1.7.6.1
</div>
</div>

</div>

</body>
</html>