File: class_quant_lib_1_1_region.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 (182 lines) | stat: -rw-r--r-- 9,253 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
<!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>Region 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_region.html">Region</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="#related">Related Functions</a>  </div>
  <div class="headertitle">
<div class="title">Region Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::Region" -->
<p><a class="el" href="class_quant_lib_1_1_region.html" title="Region class, used for inflation applicability.">Region</a> class, used for inflation applicability.  
 <a href="class_quant_lib_1_1_region.html#details">More...</a></p>

<p><code>#include &lt;ql/indexes/region.hpp&gt;</code></p>
<div class="dynheader">
Inheritance diagram for Region:</div>
<div class="dyncontent">
<div class="center"><img src="class_quant_lib_1_1_region__inherit__graph.png" border="0" usemap="#_region_inherit__map" alt="Inheritance graph"/></div>
<map name="_region_inherit__map" id="_region_inherit__map">
<area shape="rect" id="node3" href="class_quant_lib_1_1_australia_region.html" title="Australia as geographical/economic region." alt="" coords="5,86,117,117"/><area shape="rect" id="node5" href="class_quant_lib_1_1_e_u_region.html" title="European Union as geographical/economic region." alt="" coords="141,86,221,117"/><area shape="rect" id="node7" href="class_quant_lib_1_1_france_region.html" title="France as geographical/economic region." alt="" coords="245,86,347,117"/><area shape="rect" id="node9" href="class_quant_lib_1_1_generic_region.html" title="Generic geographical/economic region." alt="" coords="371,86,477,117"/><area shape="rect" id="node11" href="class_quant_lib_1_1_u_k_region.html" title="United Kingdom as geographical/economic region." alt="" coords="501,86,581,117"/><area shape="rect" id="node13" href="class_quant_lib_1_1_u_s_region.html" title="USA as geographical/economic region." alt="" coords="605,86,685,117"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="class_quant_lib_1_1_region-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 colspan="2"><div class="groupHeader">Inspectors</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af8370604529de0f829b8424e1288a104"></a><!-- doxytag: member="QuantLib::Region::name" ref="af8370604529de0f829b8424e1288a104" args="() const " -->
const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>name</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1f07e72047bf0b8cc3c9c6f0c18b1bf9"></a><!-- doxytag: member="QuantLib::Region::code" ref="a1f07e72047bf0b8cc3c9c6f0c18b1bf9" args="() const " -->
const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>code</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="a210aee44be05928c82d452eba426b14d"></a><!-- doxytag: member="QuantLib::Region::data_" ref="a210aee44be05928c82d452eba426b14d" args="" -->
boost::shared_ptr&lt; Data &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>data_</b></td></tr>
<tr><td colspan="2"><h2><a name="related"></a>
Related Functions</h2></td></tr>
<tr><td class="ititle" colspan="2"><p>(Note that these are not member functions.) </p>
</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_region.html#a2693369a6f504bb273441569e0487054">operator==</a> (const <a class="el" href="class_quant_lib_1_1_region.html">Region</a> &amp;, const <a class="el" href="class_quant_lib_1_1_region.html">Region</a> &amp;)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_region.html#a91999f0d2a4817c3d44e56f8fa9b3a38">operator!=</a> (const <a class="el" href="class_quant_lib_1_1_region.html">Region</a> &amp;, const <a class="el" href="class_quant_lib_1_1_region.html">Region</a> &amp;)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="class_quant_lib_1_1_region.html" title="Region class, used for inflation applicability.">Region</a> class, used for inflation applicability. </p>
</div><hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a2693369a6f504bb273441569e0487054"></a><!-- doxytag: member="QuantLib::Region::operator==" ref="a2693369a6f504bb273441569e0487054" args="(const Region &amp;, const Region &amp;)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool operator== </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_quant_lib_1_1_region.html">Region</a> &amp;&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="class_quant_lib_1_1_region.html">Region</a> &amp;&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [related]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a91999f0d2a4817c3d44e56f8fa9b3a38"></a><!-- doxytag: member="QuantLib::Region::operator!=" ref="a91999f0d2a4817c3d44e56f8fa9b3a38" args="(const Region &amp;, const Region &amp;)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool operator!= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_quant_lib_1_1_region.html">Region</a> &amp;&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="class_quant_lib_1_1_region.html">Region</a> &amp;&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [related]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</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>