File: class_quant_lib_1_1_default_prob_key.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 (133 lines) | stat: -rw-r--r-- 8,813 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
<!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>DefaultProbKey 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_default_prob_key.html">DefaultProbKey</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a>  </div>
  <div class="headertitle">
<div class="title">DefaultProbKey Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::DefaultProbKey" -->
<p><code>#include &lt;ql/experimental/credit/defaultprobabilitykey.hpp&gt;</code></p>
<div class="dynheader">
Inheritance diagram for DefaultProbKey:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_default_prob_key__inherit__graph.png" border="0" usemap="#_default_prob_key_inherit__map" alt="Inheritance graph"/></div>
<map name="_default_prob_key_inherit__map" id="_default_prob_key_inherit__map">
<area shape="rect" id="node3" href="class_quant_lib_1_1_north_america_corp_default_key.html" title="ISDA standard default contractual key for corporate US debt." alt="" coords="5,86,195,117"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="class_quant_lib_1_1_default_prob_key-members.html">List of all members.</a></p>
<table class="memberdecls">
<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="af3b96dcf5df37be84fae5fb34afc09d3"></a><!-- doxytag: member="QuantLib::DefaultProbKey::DefaultProbKey" ref="af3b96dcf5df37be84fae5fb34afc09d3" args="(const std::vector&lt; boost::shared_ptr&lt; DefaultType &gt; &gt; &amp;eventTypes, const Currency cur, Seniority sen)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>DefaultProbKey</b> (const std::vector&lt; boost::shared_ptr&lt; <a class="el" href="class_quant_lib_1_1_default_type.html">DefaultType</a> &gt; &gt; &amp;eventTypes, const <a class="el" href="class_quant_lib_1_1_currency.html">Currency</a> cur, Seniority sen)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abc33baebf744532876f39f22cf971342"></a><!-- doxytag: member="QuantLib::DefaultProbKey::currency" ref="abc33baebf744532876f39f22cf971342" args="() const " -->
const <a class="el" href="class_quant_lib_1_1_currency.html">Currency</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>currency</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5b8c9356cc847f334f6eca69399f9dd9"></a><!-- doxytag: member="QuantLib::DefaultProbKey::seniority" ref="a5b8c9356cc847f334f6eca69399f9dd9" args="() const " -->
Seniority&#160;</td><td class="memItemRight" valign="bottom"><b>seniority</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ada1c87ba549de5a9ad051cf3da483370"></a><!-- doxytag: member="QuantLib::DefaultProbKey::eventTypes" ref="ada1c87ba549de5a9ad051cf3da483370" args="() const " -->
const std::vector<br class="typebreak"/>
&lt; boost::shared_ptr<br class="typebreak"/>
&lt; <a class="el" href="class_quant_lib_1_1_default_type.html">DefaultType</a> &gt; &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>eventTypes</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9d78a687cf2a391198bb3cbc08bc06cb"></a><!-- doxytag: member="QuantLib::DefaultProbKey::size" ref="a9d78a687cf2a391198bb3cbc08bc06cb" args="() const " -->
<a class="el" href="group__types.html#gaf38bdb4c54463b1f456655efa95b5c77">Size</a>&#160;</td><td class="memItemRight" valign="bottom"><b>size</b> () const </td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a40f11e724bff923d71c396f947c0b2ed"></a><!-- doxytag: member="QuantLib::DefaultProbKey::eventTypes_" ref="a40f11e724bff923d71c396f947c0b2ed" args="" -->
std::vector&lt; boost::shared_ptr<br class="typebreak"/>
&lt; <a class="el" href="class_quant_lib_1_1_default_type.html">DefaultType</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_default_prob_key.html#a40f11e724bff923d71c396f947c0b2ed">eventTypes_</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">aggregation of event types for which the contract is sensitive. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1ea2266a7b462db8d3a4ce2be61d65ca"></a><!-- doxytag: member="QuantLib::DefaultProbKey::obligationCurrency_" ref="a1ea2266a7b462db8d3a4ce2be61d65ca" args="" -->
<a class="el" href="class_quant_lib_1_1_currency.html">Currency</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_default_prob_key.html#a1ea2266a7b462db8d3a4ce2be61d65ca">obligationCurrency_</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_quant_lib_1_1_currency.html" title="Currency specification">Currency</a> of the bond and protection leg payment. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae35b512424ab0cb35502f8dd976cb8aa"></a><!-- doxytag: member="QuantLib::DefaultProbKey::seniority_" ref="ae35b512424ab0cb35502f8dd976cb8aa" args="" -->
Seniority&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_default_prob_key.html#ae35b512424ab0cb35502f8dd976cb8aa">seniority_</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Reference bonds seniority. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Used to index market implied credit curve probabilities. It is a proxy to the defaultable bond or class of bonds which determines the credit contract conditions. It aggregates the atomic default types in a group defining the contract conditions and which serves to index the probability curves calibrated to the market. </p>
</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>