File: functions.html

package info (click to toggle)
quantlib-refman-html 1.20-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, sid, trixie
  • size: 103,140 kB
  • sloc: javascript: 13,408; makefile: 35
file content (307 lines) | stat: -rw-r--r-- 16,965 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
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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>QuantLib: Class Members</title>
<link href='https://fonts.googleapis.com/css?family=Merriweather+Sans:800' rel='stylesheet' type='text/css'>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
  MathJax.Hub.Config({
    extensions: ["tex2jax.js"],
    jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="quantlibextra.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname"><a href="http://quantlib.org">
       <img alt="QuantLib" src="QL-title.jpg"></a>
   <div id="projectbrief">A free/open-source library for quantitative finance</div>
   <div id="projectnumber">Reference manual - version 1.20</div>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="contents">
<div class="textblock">Here is a list of all documented class members with links to the class documentation for each member:</div>

<h3><a id="index_a"></a>- a -</h3><ul>
<li>a()
: <a class="el" href="class_quant_lib_1_1_abcd_math_function.html#a962375e1380660f0a2fe72e737e3950b">AbcdMathFunction</a>
</li>
<li>AbcdAtmVolCurve()
: <a class="el" href="class_quant_lib_1_1_abcd_atm_vol_curve.html#a282567cc331809720d0c7821425ce25d">AbcdAtmVolCurve</a>
</li>
<li>AbcdInterpolation()
: <a class="el" href="class_quant_lib_1_1_abcd_interpolation.html#a542b36d65dc8ab29d77274d9e4cf6384">AbcdInterpolation</a>
</li>
<li>accrualDays()
: <a class="el" href="class_quant_lib_1_1_coupon.html#a24ea8bbfd10aa2e9cb57131307d35e5b">Coupon</a>
</li>
<li>accrualEndDate()
: <a class="el" href="class_quant_lib_1_1_coupon.html#aab7910dc8bec5253c960da6be9b92b7f">Coupon</a>
</li>
<li>accrualPeriod()
: <a class="el" href="class_quant_lib_1_1_coupon.html#aeadd3d9641f09dd113442c5719405bef">Coupon</a>
</li>
<li>accrualStartDate()
: <a class="el" href="class_quant_lib_1_1_coupon.html#a6eda08b65dcbddd26134d5571bfc3137">Coupon</a>
</li>
<li>accruedAmount()
: <a class="el" href="class_quant_lib_1_1_bond.html#a517807ce48c857066d1427431698270e">Bond</a>
, <a class="el" href="class_quant_lib_1_1_b_t_p.html#a480521ba30a51962e09bddd5fbb59036">BTP</a>
, <a class="el" href="class_quant_lib_1_1_c_c_t_e_u.html#a480521ba30a51962e09bddd5fbb59036">CCTEU</a>
, <a class="el" href="class_quant_lib_1_1_coupon.html#ad6b1c6e4a74184e4a2079858a75d3fcf">Coupon</a>
, <a class="el" href="class_quant_lib_1_1_fixed_rate_coupon.html#a8bf88aa11f876bd17edf990a82164b6f">FixedRateCoupon</a>
, <a class="el" href="class_quant_lib_1_1_floating_rate_coupon.html#a8bf88aa11f876bd17edf990a82164b6f">FloatingRateCoupon</a>
, <a class="el" href="class_quant_lib_1_1_inflation_coupon.html#a8bf88aa11f876bd17edf990a82164b6f">InflationCoupon</a>
</li>
<li>accruedDays()
: <a class="el" href="class_quant_lib_1_1_coupon.html#ae659d066beda02b5e6a15938fba1060b">Coupon</a>
</li>
<li>accruedPeriod()
: <a class="el" href="class_quant_lib_1_1_coupon.html#ae0916f7906b7f56ae16cfb344fb23d2d">Coupon</a>
</li>
<li>add()
: <a class="el" href="class_quant_lib_1_1_composite_instrument.html#a17f4129206e9cd104423285c9bb7457e">CompositeInstrument</a>
, <a class="el" href="class_quant_lib_1_1_exchange_rate_manager.html#a06d8b6a35265988b53450aeab76d5745">ExchangeRateManager</a>
, <a class="el" href="class_quant_lib_1_1_general_statistics.html#a3a1d26bb85ab23c2a935d09081c946fd">GeneralStatistics</a>
, <a class="el" href="class_quant_lib_1_1_incremental_statistics.html#a3a1d26bb85ab23c2a935d09081c946fd">IncrementalStatistics</a>
</li>
<li>addedHolidays()
: <a class="el" href="class_quant_lib_1_1_calendar.html#adf4529d65572865846917a4513fa35f5">Calendar</a>
</li>
<li>addFixing()
: <a class="el" href="class_quant_lib_1_1_index.html#a7a90b939ae6213878841b3a7d08776bd">Index</a>
, <a class="el" href="class_quant_lib_1_1_inflation_index.html#aa8992ffa6a24397eda41c2a7ac458c97">InflationIndex</a>
</li>
<li>addFixings()
: <a class="el" href="class_quant_lib_1_1_index.html#a7508199daa86b2f60ad153454b944558">Index</a>
</li>
<li>addHoliday()
: <a class="el" href="class_quant_lib_1_1_calendar.html#a656020bddfdb2d9f48c9f0dc12b26597">Calendar</a>
</li>
<li>additionalResults()
: <a class="el" href="class_quant_lib_1_1_instrument.html#ac736d55ac6d6815ec57e44f406546ac0">Instrument</a>
</li>
<li>addRedemptionsToCashflows()
: <a class="el" href="class_quant_lib_1_1_bond.html#a445d1870569644f947a7cbb0651bf193">Bond</a>
</li>
<li>addSequence()
: <a class="el" href="class_quant_lib_1_1_general_statistics.html#a536b63938a662f0138ab4f1e87669eef">GeneralStatistics</a>
, <a class="el" href="class_quant_lib_1_1_incremental_statistics.html#acd78fc587eb7cf80dd145cb3adda5ae8">IncrementalStatistics</a>
</li>
<li>addWeekend()
: <a class="el" href="class_quant_lib_1_1_bespoke_calendar.html#a4fd5f300b4e29a8d91452121d64ca6e3">BespokeCalendar</a>
</li>
<li>adjust()
: <a class="el" href="class_quant_lib_1_1_calendar.html#a712629806d9ef9a39f8144f368c81e4b">Calendar</a>
</li>
<li>adjustedFixing()
: <a class="el" href="class_quant_lib_1_1_c_p_i_coupon.html#a8b1b46f7fcdea7131e6b5a705168e82b">CPICoupon</a>
, <a class="el" href="class_quant_lib_1_1_floating_rate_coupon.html#a8b1b46f7fcdea7131e6b5a705168e82b">FloatingRateCoupon</a>
</li>
<li>adjustValues()
: <a class="el" href="class_quant_lib_1_1_discretized_asset.html#a3fd0b540d11b207a4dffcac657330b3d">DiscretizedAsset</a>
</li>
<li>advance()
: <a class="el" href="class_quant_lib_1_1_calendar.html#ab3fc4d2c4ba5243c3f5d51dcb3077ceb">Calendar</a>
</li>
<li>after()
: <a class="el" href="class_quant_lib_1_1_schedule.html#a944536ffbbe78900eddfd8626885e6ce">Schedule</a>
</li>
<li>Akima
: <a class="el" href="class_quant_lib_1_1_cubic_interpolation.html#aeccb633d9226f37b800589483ea2f0f6ab1ddc152184a0f96b8f6e9be8168e708">CubicInterpolation</a>
</li>
<li>allFactorCumulInverter()
: <a class="el" href="class_quant_lib_1_1_latent_model.html#a2b0482da26b94fcd714869c802efd590">LatentModel&lt; copulaPolicyImpl &gt;</a>
</li>
<li>allowsExtrapolation()
: <a class="el" href="class_quant_lib_1_1_extrapolator.html#a323f875818fddd62a1c56c25ddaee418">Extrapolator</a>
</li>
<li>allowsNativeFixings()
: <a class="el" href="class_quant_lib_1_1_index.html#a4d511459f4bbc7cc8598b479d2ac4faf">Index</a>
, <a class="el" href="class_quant_lib_1_1_swap_spread_index.html#aea5f974bf144125ae4971fe3f6089db1">SwapSpreadIndex</a>
</li>
<li>alpha()
: <a class="el" href="class_quant_lib_1_1_levy_flight_distribution.html#ad7530134b03a24df85bd5ffe06507e87">LevyFlightDistribution</a>
</li>
<li>alwaysForwardNotifications()
: <a class="el" href="class_quant_lib_1_1_lazy_object.html#a2ee394ca135f85485023ce3dc037149c">LazyObject</a>
</li>
<li>AmericanCondition()
: <a class="el" href="class_quant_lib_1_1_american_condition.html#ac53c8efa7cffaaa6844f494dade50cec">AmericanCondition</a>
</li>
<li>AmortizingFixedRateBond()
: <a class="el" href="class_quant_lib_1_1_amortizing_fixed_rate_bond.html#a567556aa2d12ed1a9a56a935cfe48c34">AmortizingFixedRateBond</a>
</li>
<li>amount()
: <a class="el" href="class_quant_lib_1_1_cash_flow.html#a9b47a18fd731fee50de8227ea00f85ca">CashFlow</a>
, <a class="el" href="class_quant_lib_1_1_c_p_i_cash_flow.html#a0f9e00674bde45229334727d2ee1637f">CPICashFlow</a>
, <a class="el" href="class_quant_lib_1_1_dividend.html#a9b47a18fd731fee50de8227ea00f85ca">Dividend</a>
, <a class="el" href="class_quant_lib_1_1_fixed_dividend.html#a0f9e00674bde45229334727d2ee1637f">FixedDividend</a>
, <a class="el" href="class_quant_lib_1_1_fixed_rate_coupon.html#aebd2894f0f18274fd9a79140833c5e96">FixedRateCoupon</a>
, <a class="el" href="class_quant_lib_1_1_floating_rate_coupon.html#aebd2894f0f18274fd9a79140833c5e96">FloatingRateCoupon</a>
, <a class="el" href="class_quant_lib_1_1_fractional_dividend.html#a0f9e00674bde45229334727d2ee1637f">FractionalDividend</a>
, <a class="el" href="class_quant_lib_1_1_indexed_cash_flow.html#aebd2894f0f18274fd9a79140833c5e96">IndexedCashFlow</a>
, <a class="el" href="class_quant_lib_1_1_inflation_coupon.html#aebd2894f0f18274fd9a79140833c5e96">InflationCoupon</a>
, <a class="el" href="class_quant_lib_1_1_simple_cash_flow.html#aebd2894f0f18274fd9a79140833c5e96">SimpleCashFlow</a>
</li>
<li>AnalyticCapFloorEngine()
: <a class="el" href="class_quant_lib_1_1_analytic_cap_floor_engine.html#a37b039e6dfcb50cd4d2f9348223cc9ac">AnalyticCapFloorEngine</a>
</li>
<li>AnalyticEuropeanEngine()
: <a class="el" href="class_quant_lib_1_1_analytic_european_engine.html#aee09bceb3a6a51ccbf13bc173e21a7cd">AnalyticEuropeanEngine</a>
</li>
<li>anchorEvaluationDate()
: <a class="el" href="class_quant_lib_1_1_settings.html#a9aa8356b35815cebac2f917f6d4e6b4f">Settings</a>
</li>
<li>appliesToSeniority()
: <a class="el" href="class_quant_lib_1_1_constant_recovery_model.html#adc5b75576b4cb3c5e1f03e1dd090b790">ConstantRecoveryModel</a>
, <a class="el" href="class_quant_lib_1_1_recovery_rate_model.html#a8be5f6243e76fbc12665e1111531fb66">RecoveryRateModel</a>
</li>
<li>apply()
: <a class="el" href="class_quant_lib_1_1_generalized_black_scholes_process.html#a181565755d35d36c7bf732e1905f3661">GeneralizedBlackScholesProcess</a>
, <a class="el" href="class_quant_lib_1_1_g_j_r_g_a_r_c_h_process.html#ad16a97eee0ebc79cbf0c11c69d46b490">GJRGARCHProcess</a>
, <a class="el" href="class_quant_lib_1_1_heston_process.html#ad16a97eee0ebc79cbf0c11c69d46b490">HestonProcess</a>
, <a class="el" href="class_quant_lib_1_1_hybrid_heston_hull_white_process.html#ad16a97eee0ebc79cbf0c11c69d46b490">HybridHestonHullWhiteProcess</a>
, <a class="el" href="class_quant_lib_1_1_libor_forward_model_process.html#ad16a97eee0ebc79cbf0c11c69d46b490">LiborForwardModelProcess</a>
, <a class="el" href="class_quant_lib_1_1_merton76_process.html#a80c11f9def74e04938f4c2319722c37c">Merton76Process</a>
, <a class="el" href="class_quant_lib_1_1_stochastic_process1_d.html#a6c8e95cb5b48a9ca86fef990c92c58c9">StochasticProcess1D</a>
, <a class="el" href="class_quant_lib_1_1_stochastic_process.html#a2f8f5deb5ff248f45bb56c4054f000ec">StochasticProcess</a>
, <a class="el" href="class_quant_lib_1_1_stochastic_process_array.html#ad16a97eee0ebc79cbf0c11c69d46b490">StochasticProcessArray</a>
</li>
<li>applyAfterApplying()
: <a class="el" href="class_quant_lib_1_1_boundary_condition.html#ad39ad7ad5ed0434b46036b0179e225f6">BoundaryCondition&lt; Operator &gt;</a>
</li>
<li>applyAfterSolving()
: <a class="el" href="class_quant_lib_1_1_boundary_condition.html#a22a8d3cbef1d118eda60ed4c5e8cf6a9">BoundaryCondition&lt; Operator &gt;</a>
</li>
<li>applyBeforeApplying()
: <a class="el" href="class_quant_lib_1_1_boundary_condition.html#a54cb24c54bd6209f5050ff45f49f5c4d">BoundaryCondition&lt; Operator &gt;</a>
, <a class="el" href="class_quant_lib_1_1_dirichlet_b_c.html#a771a3aded44b4bfae17e4bbffa7608d0">DirichletBC</a>
, <a class="el" href="class_quant_lib_1_1_neumann_b_c.html#a771a3aded44b4bfae17e4bbffa7608d0">NeumannBC</a>
</li>
<li>applyBeforeSolving()
: <a class="el" href="class_quant_lib_1_1_boundary_condition.html#a3b7d9d45ad90d4008c468da1fa4261f0">BoundaryCondition&lt; Operator &gt;</a>
</li>
<li>applyTo()
: <a class="el" href="class_quant_lib_1_1_tridiagonal_operator.html#a4ef7b49191e5b6b3d4312a0febec2f74">TridiagonalOperator</a>
</li>
<li>ArmijoLineSearch()
: <a class="el" href="class_quant_lib_1_1_armijo_line_search.html#aa9b7b48a8c23873cce8850ca4c91b983">ArmijoLineSearch</a>
</li>
<li>Array()
: <a class="el" href="class_quant_lib_1_1_array.html#ac8f631547f2056de2d839d0561554491">Array</a>
</li>
<li>asOptionlet()
: <a class="el" href="class_quant_lib_1_1_make_cap_floor.html#a0cf891fc8ae3104c048a54e50b329e41">MakeCapFloor</a>
, <a class="el" href="class_quant_lib_1_1_make_yo_y_inflation_cap_floor.html#a554c10f085b8efda37e357575aaafba1">MakeYoYInflationCapFloor</a>
</li>
<li>atmForwardVariance()
: <a class="el" href="class_quant_lib_1_1_equity_f_x_vol_surface.html#a6faf2f0bcfdc2110e5c280eba79e34d6">EquityFXVolSurface</a>
</li>
<li>atmForwardVol()
: <a class="el" href="class_quant_lib_1_1_equity_f_x_vol_surface.html#a74b7f55379c0c4289a1d18ab994921cd">EquityFXVolSurface</a>
</li>
<li>atmRate()
: <a class="el" href="class_quant_lib_1_1_cash_flows.html#ae3aa49c05366fc3a840988b8d44e8a94">CashFlows</a>
</li>
<li>atmVariance()
: <a class="el" href="class_quant_lib_1_1_black_atm_vol_curve.html#ac5a8ef9d3f36dca752ec48845b3f50bb">BlackAtmVolCurve</a>
</li>
<li>atmVarianceImpl()
: <a class="el" href="class_quant_lib_1_1_abcd_atm_vol_curve.html#a2e58867e19f6d30647160ccf0e155f0f">AbcdAtmVolCurve</a>
, <a class="el" href="class_quant_lib_1_1_black_atm_vol_curve.html#a3f60fbe8f11376ac813a5f751d33161c">BlackAtmVolCurve</a>
, <a class="el" href="class_quant_lib_1_1_black_vol_surface.html#a2e58867e19f6d30647160ccf0e155f0f">BlackVolSurface</a>
</li>
<li>atmVol()
: <a class="el" href="class_quant_lib_1_1_black_atm_vol_curve.html#abfb8263a22525a517536d56ad8c18f84">BlackAtmVolCurve</a>
</li>
<li>atmVolImpl()
: <a class="el" href="class_quant_lib_1_1_abcd_atm_vol_curve.html#a8b580ac38356b851bdcc70de81b5be5b">AbcdAtmVolCurve</a>
, <a class="el" href="class_quant_lib_1_1_black_atm_vol_curve.html#a3e805d2195b83e2011386f39514d6100">BlackAtmVolCurve</a>
, <a class="el" href="class_quant_lib_1_1_black_vol_surface.html#a8b580ac38356b851bdcc70de81b5be5b">BlackVolSurface</a>
</li>
<li>atmYoYSwapTimeRates()
: <a class="el" href="class_quant_lib_1_1_yo_y_cap_floor_term_price_surface.html#a20be174e308919cf524a2c32e83be976">YoYCapFloorTermPriceSurface</a>
</li>
<li>attachmentAmount()
: <a class="el" href="class_quant_lib_1_1_basket.html#a5a638fa55abd91be5e47a51efb8eb58c">Basket</a>
</li>
<li>attachmentRatio()
: <a class="el" href="class_quant_lib_1_1_basket.html#a51cde811cc78246d47aa3d55bb9c6ae6">Basket</a>
</li>
<li>AutomatedConversion
: <a class="el" href="class_quant_lib_1_1_money.html#ac32291f3a839fe01ad0708ab8c53d107ad49f32edf8f7bca53bf83458dd499f39">Money</a>
, <a class="el" href="class_quant_lib_1_1_quantity.html#ac32291f3a839fe01ad0708ab8c53d107ad49f32edf8f7bca53bf83458dd499f39">Quantity</a>
</li>
<li>availabilityLag()
: <a class="el" href="class_quant_lib_1_1_inflation_index.html#aee01d8031542a0054a2b5fe5d06bde1c">InflationIndex</a>
</li>
<li>averageLoss()
: <a class="el" href="class_quant_lib_1_1_binomial_loss_model.html#a8639f1998edbaa47532ba59d0e33c330">BinomialLossModel&lt; LLM &gt;</a>
</li>
<li>averageShortfall()
: <a class="el" href="class_quant_lib_1_1_generic_risk_statistics.html#a2ccba4cfd60a2cc4470b1a3adb02417c">GenericRiskStatistics&lt; S &gt;</a>
</li>
</ul>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.9.1-->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="http://www.doxygen.org/index.html">Doxygen</a>
1.8.20
</small></address>
</body>
</html>