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
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
|
<!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>InterestRate 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_interest_rate.html">InterestRate</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#related">Related Functions</a> </div>
<div class="headertitle">
<div class="title">InterestRate Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="QuantLib::InterestRate" -->
<p>Concrete interest rate class.
<a href="class_quant_lib_1_1_interest_rate.html#details">More...</a></p>
<p><code>#include <ql/interestrate.hpp></code></p>
<p><a href="class_quant_lib_1_1_interest_rate-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">constructors</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa302b38a9a595c752fb01fcb473e2924"></a><!-- doxytag: member="QuantLib::InterestRate::InterestRate" ref="aa302b38a9a595c752fb01fcb473e2924" args="()" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_interest_rate.html#aa302b38a9a595c752fb01fcb473e2924">InterestRate</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor returning a null interest rate. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab8a1baa4ac690cf1e2cf6da375b3f11e"></a><!-- doxytag: member="QuantLib::InterestRate::InterestRate" ref="ab8a1baa4ac690cf1e2cf6da375b3f11e" args="(Rate r, const DayCounter &dc, Compounding comp, Frequency freq)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_interest_rate.html#ab8a1baa4ac690cf1e2cf6da375b3f11e">InterestRate</a> (<a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> r, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &dc, Compounding comp, <a class="el" href="group__datetime.html#ga6d41db8ba0ea90d22df35889df452ada">Frequency</a> freq)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Standard constructor. <br/></td></tr>
<tr><td colspan="2"><div class="groupHeader">conversions</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a00223984215971fb8036aec3aedcc2bb"></a><!-- doxytag: member="QuantLib::InterestRate::operator Rate" ref="a00223984215971fb8036aec3aedcc2bb" args="() const " -->
 </td><td class="memItemRight" valign="bottom"><b>operator Rate</b> () const </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="a5b4bfa298dfe61af7cd976b87fc7fd22"></a><!-- doxytag: member="QuantLib::InterestRate::rate" ref="a5b4bfa298dfe61af7cd976b87fc7fd22" args="() const " -->
<a class="el" href="group__types.html#gaede435af51236692b1107d7639581d39">Rate</a> </td><td class="memItemRight" valign="bottom"><b>rate</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a677cd8177f9f43a90321e2a7cea44b00"></a><!-- doxytag: member="QuantLib::InterestRate::dayCounter" ref="a677cd8177f9f43a90321e2a7cea44b00" args="() const " -->
const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> & </td><td class="memItemRight" valign="bottom"><b>dayCounter</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6968bd096b10d7259e742fa324abade3"></a><!-- doxytag: member="QuantLib::InterestRate::compounding" ref="a6968bd096b10d7259e742fa324abade3" args="() const " -->
Compounding </td><td class="memItemRight" valign="bottom"><b>compounding</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a70fafd3d3f212d824101e977784dbcf5"></a><!-- doxytag: member="QuantLib::InterestRate::frequency" ref="a70fafd3d3f212d824101e977784dbcf5" args="() const " -->
<a class="el" href="group__datetime.html#ga6d41db8ba0ea90d22df35889df452ada">Frequency</a> </td><td class="memItemRight" valign="bottom"><b>frequency</b> () const </td></tr>
<tr><td colspan="2"><div class="groupHeader">discount/compound factor calculations</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__types.html#ga642a971a0bcbbd2fb26c35e1a06e5761">DiscountFactor</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_interest_rate.html#a009346f1741a384db90b95e6f02b7a36">discountFactor</a> (<a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> t) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">discount factor implied by the rate compounded at time t. <a href="#a009346f1741a384db90b95e6f02b7a36"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a155da734e9f9d00dbc775644f176adff"></a><!-- doxytag: member="QuantLib::InterestRate::discountFactor" ref="a155da734e9f9d00dbc775644f176adff" args="(const Date &d1, const Date &d2, const Date &refStart=Date(), const Date &refEnd=Date()) const " -->
<a class="el" href="group__types.html#ga642a971a0bcbbd2fb26c35e1a06e5761">DiscountFactor</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_interest_rate.html#a155da734e9f9d00dbc775644f176adff">discountFactor</a> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &d1, const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &d2, const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &refStart=<a class="el" href="class_quant_lib_1_1_date.html">Date</a>(), const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &refEnd=<a class="el" href="class_quant_lib_1_1_date.html">Date</a>()) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">discount factor implied by the rate compounded between two dates <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_interest_rate.html#aac316c9ade1203219bfab37e91726386">compoundFactor</a> (<a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> t) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">compound factor implied by the rate compounded at time t. <a href="#aac316c9ade1203219bfab37e91726386"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_interest_rate.html#ac86ed2ab8a602bfc623d65af6b85f2ff">compoundFactor</a> (const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &d1, const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &d2, const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &refStart=<a class="el" href="class_quant_lib_1_1_date.html">Date</a>(), const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &refEnd=<a class="el" href="class_quant_lib_1_1_date.html">Date</a>()) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">compound factor implied by the rate compounded between two dates <a href="#ac86ed2ab8a602bfc623d65af6b85f2ff"></a><br/></td></tr>
<tr><td colspan="2"><div class="groupHeader">equivalent rate calculations</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_quant_lib_1_1_interest_rate.html">InterestRate</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_interest_rate.html#a3dda956718db96b302e4023950c6f409">equivalentRate</a> (Compounding comp, <a class="el" href="group__datetime.html#ga6d41db8ba0ea90d22df35889df452ada">Frequency</a> freq, <a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> t) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">equivalent interest rate for a compounding period t. <a href="#a3dda956718db96b302e4023950c6f409"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_quant_lib_1_1_interest_rate.html">InterestRate</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_interest_rate.html#a2b03fbc97a8faff6eb6695e10f83cc27">equivalentRate</a> (const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &resultDC, Compounding comp, <a class="el" href="group__datetime.html#ga6d41db8ba0ea90d22df35889df452ada">Frequency</a> freq, <a class="el" href="class_quant_lib_1_1_date.html">Date</a> d1, <a class="el" href="class_quant_lib_1_1_date.html">Date</a> d2, const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &refStart=<a class="el" href="class_quant_lib_1_1_date.html">Date</a>(), const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &refEnd=<a class="el" href="class_quant_lib_1_1_date.html">Date</a>()) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">equivalent rate for a compounding period between two dates <a href="#a2b03fbc97a8faff6eb6695e10f83cc27"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">implied rate calculations</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_quant_lib_1_1_interest_rate.html">InterestRate</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_interest_rate.html#a9805f175eeb2f7eb24689d784df29470">impliedRate</a> (<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> compound, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &resultDC, Compounding comp, <a class="el" href="group__datetime.html#ga6d41db8ba0ea90d22df35889df452ada">Frequency</a> freq, <a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> t)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">implied interest rate for a given compound factor at a given time. <a href="#a9805f175eeb2f7eb24689d784df29470"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_quant_lib_1_1_interest_rate.html">InterestRate</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_interest_rate.html#a779d7cefddffa0b2fd85199c840dd3c3">impliedRate</a> (<a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> compound, const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> &resultDC, Compounding comp, <a class="el" href="group__datetime.html#ga6d41db8ba0ea90d22df35889df452ada">Frequency</a> freq, const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &d1, const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &d2, const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &refStart=<a class="el" href="class_quant_lib_1_1_date.html">Date</a>(), const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> &refEnd=<a class="el" href="class_quant_lib_1_1_date.html">Date</a>())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">implied rate for a given compound factor between two dates. <a href="#a779d7cefddffa0b2fd85199c840dd3c3"></a><br/></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">std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_quant_lib_1_1_interest_rate.html#a470e6cf45fe6bf07123c0ba59f292814">operator<<</a> (std::ostream &, const <a class="el" href="class_quant_lib_1_1_interest_rate.html">InterestRate</a> &)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Concrete interest rate class. </p>
<p>This class encapsulate the interest rate compounding algebra. It manages day-counting conventions, compounding conventions, conversion between different conventions, discount/compound factor calculations, and implied/equivalent rate calculations.</p>
<dl class="test"><dt><b><a class="el" href="test.html#_test000023">Tests:</a></b></dt><dd>Converted rates are checked against known good results </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="_callable_bonds_8cpp-example.html#_a8">CallableBonds.cpp</a>.</dd>
</dl></div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a009346f1741a384db90b95e6f02b7a36"></a><!-- doxytag: member="QuantLib::InterestRate::discountFactor" ref="a009346f1741a384db90b95e6f02b7a36" args="(Time t) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__types.html#ga642a971a0bcbbd2fb26c35e1a06e5761">DiscountFactor</a> <a class="el" href="class_quant_lib_1_1_interest_rate.html#a009346f1741a384db90b95e6f02b7a36">discountFactor</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> </td>
<td class="paramname"><em>t</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>discount factor implied by the rate compounded at time t. </p>
<dl class="caveats"><dt><b><a class="el" href="caveats.html#_caveats000064">Warning:</a></b></dt><dd>Time must be measured using <a class="el" href="class_quant_lib_1_1_interest_rate.html" title="Concrete interest rate class.">InterestRate</a>'s own day counter. </dd></dl>
</div>
</div>
<a class="anchor" id="aac316c9ade1203219bfab37e91726386"></a><!-- doxytag: member="QuantLib::InterestRate::compoundFactor" ref="aac316c9ade1203219bfab37e91726386" args="(Time t) 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_interest_rate.html#aac316c9ade1203219bfab37e91726386">compoundFactor</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> </td>
<td class="paramname"><em>t</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>compound factor implied by the rate compounded at time t. </p>
<p>returns the compound (a.k.a capitalization) factor implied by the rate compounded at time t.</p>
<dl class="caveats"><dt><b><a class="el" href="caveats.html#_caveats000065">Warning:</a></b></dt><dd>Time must be measured using <a class="el" href="class_quant_lib_1_1_interest_rate.html" title="Concrete interest rate class.">InterestRate</a>'s own day counter. </dd></dl>
</div>
</div>
<a class="anchor" id="ac86ed2ab8a602bfc623d65af6b85f2ff"></a><!-- doxytag: member="QuantLib::InterestRate::compoundFactor" ref="ac86ed2ab8a602bfc623d65af6b85f2ff" args="(const Date &d1, const Date &d2, const Date &refStart=Date(), const Date &refEnd=Date()) 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_interest_rate.html#aac316c9ade1203219bfab37e91726386">compoundFactor</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> & </td>
<td class="paramname"><em>d1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> & </td>
<td class="paramname"><em>d2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> & </td>
<td class="paramname"><em>refStart</em> = <code><a class="el" href="class_quant_lib_1_1_date.html">Date</a>()</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> & </td>
<td class="paramname"><em>refEnd</em> = <code><a class="el" href="class_quant_lib_1_1_date.html">Date</a>()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>compound factor implied by the rate compounded between two dates </p>
<p>returns the compound (a.k.a capitalization) factor implied by the rate compounded between two dates. </p>
</div>
</div>
<a class="anchor" id="a9805f175eeb2f7eb24689d784df29470"></a><!-- doxytag: member="QuantLib::InterestRate::impliedRate" ref="a9805f175eeb2f7eb24689d784df29470" args="(Real compound, const DayCounter &resultDC, Compounding comp, Frequency freq, Time t)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="class_quant_lib_1_1_interest_rate.html">InterestRate</a> <a class="el" href="class_quant_lib_1_1_interest_rate.html#a9805f175eeb2f7eb24689d784df29470">impliedRate</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td>
<td class="paramname"><em>compound</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> & </td>
<td class="paramname"><em>resultDC</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Compounding </td>
<td class="paramname"><em>comp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__datetime.html#ga6d41db8ba0ea90d22df35889df452ada">Frequency</a> </td>
<td class="paramname"><em>freq</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> </td>
<td class="paramname"><em>t</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>implied interest rate for a given compound factor at a given time. </p>
<p>The resulting <a class="el" href="class_quant_lib_1_1_interest_rate.html" title="Concrete interest rate class.">InterestRate</a> has the day-counter provided as input.</p>
<dl class="caveats"><dt><b><a class="el" href="caveats.html#_caveats000066">Warning:</a></b></dt><dd>Time must be measured using the day-counter provided as input. </dd></dl>
</div>
</div>
<a class="anchor" id="a779d7cefddffa0b2fd85199c840dd3c3"></a><!-- doxytag: member="QuantLib::InterestRate::impliedRate" ref="a779d7cefddffa0b2fd85199c840dd3c3" args="(Real compound, const DayCounter &resultDC, Compounding comp, Frequency freq, const Date &d1, const Date &d2, const Date &refStart=Date(), const Date &refEnd=Date())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="class_quant_lib_1_1_interest_rate.html">InterestRate</a> <a class="el" href="class_quant_lib_1_1_interest_rate.html#a9805f175eeb2f7eb24689d784df29470">impliedRate</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__types.html#ga4bdf4bfe76b9ffa6fa64c47d8bfa0c78">Real</a> </td>
<td class="paramname"><em>compound</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> & </td>
<td class="paramname"><em>resultDC</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Compounding </td>
<td class="paramname"><em>comp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__datetime.html#ga6d41db8ba0ea90d22df35889df452ada">Frequency</a> </td>
<td class="paramname"><em>freq</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> & </td>
<td class="paramname"><em>d1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> & </td>
<td class="paramname"><em>d2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> & </td>
<td class="paramname"><em>refStart</em> = <code><a class="el" href="class_quant_lib_1_1_date.html">Date</a>()</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> & </td>
<td class="paramname"><em>refEnd</em> = <code><a class="el" href="class_quant_lib_1_1_date.html">Date</a>()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>implied rate for a given compound factor between two dates. </p>
<p>The resulting rate is calculated taking the required day-counting rule into account. </p>
</div>
</div>
<a class="anchor" id="a3dda956718db96b302e4023950c6f409"></a><!-- doxytag: member="QuantLib::InterestRate::equivalentRate" ref="a3dda956718db96b302e4023950c6f409" args="(Compounding comp, Frequency freq, Time t) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_quant_lib_1_1_interest_rate.html">InterestRate</a> <a class="el" href="class_quant_lib_1_1_interest_rate.html#a3dda956718db96b302e4023950c6f409">equivalentRate</a> </td>
<td>(</td>
<td class="paramtype">Compounding </td>
<td class="paramname"><em>comp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__datetime.html#ga6d41db8ba0ea90d22df35889df452ada">Frequency</a> </td>
<td class="paramname"><em>freq</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__types.html#ga14fb8fca43a68f4168654e1f9f7e22f7">Time</a> </td>
<td class="paramname"><em>t</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>equivalent interest rate for a compounding period t. </p>
<p>The resulting <a class="el" href="class_quant_lib_1_1_interest_rate.html" title="Concrete interest rate class.">InterestRate</a> shares the same implicit day-counting rule of the original <a class="el" href="class_quant_lib_1_1_interest_rate.html" title="Concrete interest rate class.">InterestRate</a> instance.</p>
<dl class="caveats"><dt><b><a class="el" href="caveats.html#_caveats000067">Warning:</a></b></dt><dd>Time must be measured using the <a class="el" href="class_quant_lib_1_1_interest_rate.html" title="Concrete interest rate class.">InterestRate</a>'s own day counter. </dd></dl>
</div>
</div>
<a class="anchor" id="a2b03fbc97a8faff6eb6695e10f83cc27"></a><!-- doxytag: member="QuantLib::InterestRate::equivalentRate" ref="a2b03fbc97a8faff6eb6695e10f83cc27" args="(const DayCounter &resultDC, Compounding comp, Frequency freq, Date d1, Date d2, const Date &refStart=Date(), const Date &refEnd=Date()) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_quant_lib_1_1_interest_rate.html">InterestRate</a> <a class="el" href="class_quant_lib_1_1_interest_rate.html#a3dda956718db96b302e4023950c6f409">equivalentRate</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_quant_lib_1_1_day_counter.html">DayCounter</a> & </td>
<td class="paramname"><em>resultDC</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Compounding </td>
<td class="paramname"><em>comp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__datetime.html#ga6d41db8ba0ea90d22df35889df452ada">Frequency</a> </td>
<td class="paramname"><em>freq</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_quant_lib_1_1_date.html">Date</a> </td>
<td class="paramname"><em>d1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_quant_lib_1_1_date.html">Date</a> </td>
<td class="paramname"><em>d2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> & </td>
<td class="paramname"><em>refStart</em> = <code><a class="el" href="class_quant_lib_1_1_date.html">Date</a>()</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="class_quant_lib_1_1_date.html">Date</a> & </td>
<td class="paramname"><em>refEnd</em> = <code><a class="el" href="class_quant_lib_1_1_date.html">Date</a>()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>equivalent rate for a compounding period between two dates </p>
<p>The resulting rate is calculated taking the required day-counting rule into account. </p>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a470e6cf45fe6bf07123c0ba59f292814"></a><!-- doxytag: member="QuantLib::InterestRate::operator<<" ref="a470e6cf45fe6bf07123c0ba59f292814" args="(std::ostream &, const InterestRate &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::ostream & operator<< </td>
<td>(</td>
<td class="paramtype">std::ostream & </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_interest_rate.html">InterestRate</a> & </td>
<td class="paramname"> </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>
|
