option_lab 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.rspec +3 -0
- data/.rubocop.yml +139 -0
- data/.yard/hooks/before_generate.rb +7 -0
- data/.yardopts +11 -0
- data/Gemfile +26 -0
- data/LICENSE.txt +21 -0
- data/README.md +180 -0
- data/Rakefile +44 -0
- data/docs/OptionLab/BinomialTree.html +1271 -0
- data/docs/OptionLab/BjerksundStensland.html +2022 -0
- data/docs/OptionLab/BlackScholes.html +2388 -0
- data/docs/OptionLab/Engine.html +1716 -0
- data/docs/OptionLab/Models/AmericanModelInputs.html +937 -0
- data/docs/OptionLab/Models/ArrayInputs.html +463 -0
- data/docs/OptionLab/Models/BaseModel.html +223 -0
- data/docs/OptionLab/Models/BinomialModelInputs.html +1161 -0
- data/docs/OptionLab/Models/BlackScholesInfo.html +967 -0
- data/docs/OptionLab/Models/BlackScholesModelInputs.html +851 -0
- data/docs/OptionLab/Models/ClosedPosition.html +445 -0
- data/docs/OptionLab/Models/EngineData.html +2523 -0
- data/docs/OptionLab/Models/EngineDataResults.html +435 -0
- data/docs/OptionLab/Models/Inputs.html +2241 -0
- data/docs/OptionLab/Models/LaplaceInputs.html +777 -0
- data/docs/OptionLab/Models/Option.html +736 -0
- data/docs/OptionLab/Models/Outputs.html +1753 -0
- data/docs/OptionLab/Models/PoPOutputs.html +645 -0
- data/docs/OptionLab/Models/PricingResult.html +848 -0
- data/docs/OptionLab/Models/Stock.html +583 -0
- data/docs/OptionLab/Models/TreeVisualization.html +688 -0
- data/docs/OptionLab/Models.html +251 -0
- data/docs/OptionLab/Plotting.html +548 -0
- data/docs/OptionLab/Support.html +2884 -0
- data/docs/OptionLab/Utils.html +619 -0
- data/docs/OptionLab.html +133 -0
- data/docs/_index.html +376 -0
- data/docs/class_list.html +54 -0
- data/docs/css/common.css +1 -0
- data/docs/css/full_list.css +58 -0
- data/docs/css/style.css +503 -0
- data/docs/file.LICENSE.html +70 -0
- data/docs/file.README.html +263 -0
- data/docs/file_list.html +64 -0
- data/docs/frames.html +22 -0
- data/docs/index.html +263 -0
- data/docs/js/app.js +344 -0
- data/docs/js/full_list.js +242 -0
- data/docs/js/jquery.js +4 -0
- data/docs/method_list.html +1974 -0
- data/docs/top-level-namespace.html +110 -0
- data/examples/american_options.rb +163 -0
- data/examples/covered_call.rb +76 -0
- data/lib/option_lab/binomial_tree.rb +238 -0
- data/lib/option_lab/bjerksund_stensland.rb +276 -0
- data/lib/option_lab/black_scholes.rb +323 -0
- data/lib/option_lab/engine.rb +492 -0
- data/lib/option_lab/models.rb +768 -0
- data/lib/option_lab/plotting.rb +182 -0
- data/lib/option_lab/support.rb +471 -0
- data/lib/option_lab/utils.rb +107 -0
- data/lib/option_lab/version.rb +5 -0
- data/lib/option_lab.rb +134 -0
- data/option_lab.gemspec +43 -0
- metadata +207 -0
|
@@ -0,0 +1,937 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Class: OptionLab::Models::AmericanModelInputs
|
|
8
|
+
|
|
9
|
+
— OptionLab Documentation
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript">
|
|
18
|
+
pathId = "OptionLab::Models::AmericanModelInputs";
|
|
19
|
+
relpath = '../../';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="../../class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="../../_index.html">Index (A)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../../OptionLab.html" title="OptionLab (module)">OptionLab</a></span></span> » <span class='title'><span class='object_link'><a href="../Models.html" title="OptionLab::Models (module)">Models</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">AmericanModelInputs</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="../../class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="content"><h1>Class: OptionLab::Models::AmericanModelInputs
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
<dl>
|
|
70
|
+
<dt>Inherits:</dt>
|
|
71
|
+
<dd>
|
|
72
|
+
<span class="inheritName"><span class='object_link'><a href="BaseModel.html" title="OptionLab::Models::BaseModel (class)">BaseModel</a></span></span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next"><span class='object_link'><a href="BaseModel.html" title="OptionLab::Models::BaseModel (class)">BaseModel</a></span></li>
|
|
78
|
+
|
|
79
|
+
<li class="next">OptionLab::Models::AmericanModelInputs</li>
|
|
80
|
+
|
|
81
|
+
</ul>
|
|
82
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
83
|
+
|
|
84
|
+
</dd>
|
|
85
|
+
</dl>
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
<dl>
|
|
98
|
+
<dt>Defined in:</dt>
|
|
99
|
+
<dd>lib/option_lab/models.rb</dd>
|
|
100
|
+
</dl>
|
|
101
|
+
|
|
102
|
+
</div>
|
|
103
|
+
|
|
104
|
+
<h2>Overview</h2><div class="docstring">
|
|
105
|
+
<div class="discussion">
|
|
106
|
+
<p>Bjerksund-Stensland model inputs for American options</p>
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
</div>
|
|
110
|
+
</div>
|
|
111
|
+
<div class="tags">
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
</div>
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
119
|
+
<ul class="summary">
|
|
120
|
+
|
|
121
|
+
<li class="public ">
|
|
122
|
+
<span class="summary_signature">
|
|
123
|
+
|
|
124
|
+
<a href="#dividend_yield-instance_method" title="#dividend_yield (instance method)">#<strong>dividend_yield</strong> ⇒ Object </a>
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
</span>
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute dividend_yield.</p>
|
|
142
|
+
</div></span>
|
|
143
|
+
|
|
144
|
+
</li>
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
<li class="public ">
|
|
148
|
+
<span class="summary_signature">
|
|
149
|
+
|
|
150
|
+
<a href="#interest_rate-instance_method" title="#interest_rate (instance method)">#<strong>interest_rate</strong> ⇒ Object </a>
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
</span>
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute interest_rate.</p>
|
|
168
|
+
</div></span>
|
|
169
|
+
|
|
170
|
+
</li>
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
<li class="public ">
|
|
174
|
+
<span class="summary_signature">
|
|
175
|
+
|
|
176
|
+
<a href="#option_type-instance_method" title="#option_type (instance method)">#<strong>option_type</strong> ⇒ Object </a>
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
</span>
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute option_type.</p>
|
|
194
|
+
</div></span>
|
|
195
|
+
|
|
196
|
+
</li>
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
<li class="public ">
|
|
200
|
+
<span class="summary_signature">
|
|
201
|
+
|
|
202
|
+
<a href="#stock_price-instance_method" title="#stock_price (instance method)">#<strong>stock_price</strong> ⇒ Object </a>
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
</span>
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute stock_price.</p>
|
|
220
|
+
</div></span>
|
|
221
|
+
|
|
222
|
+
</li>
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
<li class="public ">
|
|
226
|
+
<span class="summary_signature">
|
|
227
|
+
|
|
228
|
+
<a href="#strike-instance_method" title="#strike (instance method)">#<strong>strike</strong> ⇒ Object </a>
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
</span>
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute strike.</p>
|
|
246
|
+
</div></span>
|
|
247
|
+
|
|
248
|
+
</li>
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
<li class="public ">
|
|
252
|
+
<span class="summary_signature">
|
|
253
|
+
|
|
254
|
+
<a href="#volatility-instance_method" title="#volatility (instance method)">#<strong>volatility</strong> ⇒ Object </a>
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
</span>
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute volatility.</p>
|
|
272
|
+
</div></span>
|
|
273
|
+
|
|
274
|
+
</li>
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
<li class="public ">
|
|
278
|
+
<span class="summary_signature">
|
|
279
|
+
|
|
280
|
+
<a href="#years_to_maturity-instance_method" title="#years_to_maturity (instance method)">#<strong>years_to_maturity</strong> ⇒ Object </a>
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
</span>
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute years_to_maturity.</p>
|
|
298
|
+
</div></span>
|
|
299
|
+
|
|
300
|
+
</li>
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
</ul>
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
<h2>
|
|
310
|
+
Instance Method Summary
|
|
311
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
312
|
+
</h2>
|
|
313
|
+
|
|
314
|
+
<ul class="summary">
|
|
315
|
+
|
|
316
|
+
<li class="public ">
|
|
317
|
+
<span class="summary_signature">
|
|
318
|
+
|
|
319
|
+
<a href="#greeks-instance_method" title="#greeks (instance method)">#<strong>greeks</strong> ⇒ Object </a>
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
</span>
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
334
|
+
|
|
335
|
+
</li>
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
<li class="public ">
|
|
339
|
+
<span class="summary_signature">
|
|
340
|
+
|
|
341
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(attributes = {}) ⇒ AmericanModelInputs </a>
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
</span>
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
<span class="note title constructor">constructor</span>
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
<span class="summary_desc"><div class='inline'><p>A new instance of AmericanModelInputs.</p>
|
|
358
|
+
</div></span>
|
|
359
|
+
|
|
360
|
+
</li>
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
<li class="public ">
|
|
364
|
+
<span class="summary_signature">
|
|
365
|
+
|
|
366
|
+
<a href="#price-instance_method" title="#price (instance method)">#<strong>price</strong> ⇒ Object </a>
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
</span>
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
381
|
+
|
|
382
|
+
</li>
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
<li class="public ">
|
|
386
|
+
<span class="summary_signature">
|
|
387
|
+
|
|
388
|
+
<a href="#validate!-instance_method" title="#validate! (instance method)">#<strong>validate!</strong> ⇒ Object </a>
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
</span>
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
|
|
401
|
+
|
|
402
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
403
|
+
|
|
404
|
+
</li>
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
</ul>
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
<div id="constructor_details" class="method_details_list">
|
|
413
|
+
<h2>Constructor Details</h2>
|
|
414
|
+
|
|
415
|
+
<div class="method_details first">
|
|
416
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
417
|
+
|
|
418
|
+
#<strong>initialize</strong>(attributes = {}) ⇒ <tt><span class='object_link'><a href="" title="OptionLab::Models::AmericanModelInputs (class)">AmericanModelInputs</a></span></tt>
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
|
|
424
|
+
</h3><div class="docstring">
|
|
425
|
+
<div class="discussion">
|
|
426
|
+
<p>Returns a new instance of AmericanModelInputs.</p>
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
</div>
|
|
430
|
+
</div>
|
|
431
|
+
<div class="tags">
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
</div><table class="source_code">
|
|
435
|
+
<tr>
|
|
436
|
+
<td>
|
|
437
|
+
<pre class="lines">
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
628
|
|
441
|
+
629
|
|
442
|
+
630
|
|
443
|
+
631
|
|
444
|
+
632
|
|
445
|
+
633
|
|
446
|
+
634</pre>
|
|
447
|
+
</td>
|
|
448
|
+
<td>
|
|
449
|
+
<pre class="code"><span class="info file"># File 'lib/option_lab/models.rb', line 628</span>
|
|
450
|
+
|
|
451
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_attributes'>attributes</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
452
|
+
<span class='comment'># Set defaults
|
|
453
|
+
</span> <span class='ivar'>@option_type</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>call</span><span class='tstring_end'>'</span></span>
|
|
454
|
+
<span class='ivar'>@dividend_yield</span> <span class='op'>=</span> <span class='float'>0.0</span>
|
|
455
|
+
|
|
456
|
+
<span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_attributes'>attributes</span><span class='rparen'>)</span>
|
|
457
|
+
<span class='kw'>end</span></pre>
|
|
458
|
+
</td>
|
|
459
|
+
</tr>
|
|
460
|
+
</table>
|
|
461
|
+
</div>
|
|
462
|
+
|
|
463
|
+
</div>
|
|
464
|
+
|
|
465
|
+
<div id="instance_attr_details" class="attr_details">
|
|
466
|
+
<h2>Instance Attribute Details</h2>
|
|
467
|
+
|
|
468
|
+
|
|
469
|
+
<span id="dividend_yield=-instance_method"></span>
|
|
470
|
+
<div class="method_details first">
|
|
471
|
+
<h3 class="signature first" id="dividend_yield-instance_method">
|
|
472
|
+
|
|
473
|
+
#<strong>dividend_yield</strong> ⇒ <tt>Object</tt>
|
|
474
|
+
|
|
475
|
+
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
|
|
479
|
+
</h3><div class="docstring">
|
|
480
|
+
<div class="discussion">
|
|
481
|
+
<p>Returns the value of attribute dividend_yield.</p>
|
|
482
|
+
|
|
483
|
+
|
|
484
|
+
</div>
|
|
485
|
+
</div>
|
|
486
|
+
<div class="tags">
|
|
487
|
+
|
|
488
|
+
|
|
489
|
+
</div><table class="source_code">
|
|
490
|
+
<tr>
|
|
491
|
+
<td>
|
|
492
|
+
<pre class="lines">
|
|
493
|
+
|
|
494
|
+
|
|
495
|
+
620
|
|
496
|
+
621
|
|
497
|
+
622</pre>
|
|
498
|
+
</td>
|
|
499
|
+
<td>
|
|
500
|
+
<pre class="code"><span class="info file"># File 'lib/option_lab/models.rb', line 620</span>
|
|
501
|
+
|
|
502
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_dividend_yield'>dividend_yield</span>
|
|
503
|
+
<span class='ivar'>@dividend_yield</span>
|
|
504
|
+
<span class='kw'>end</span></pre>
|
|
505
|
+
</td>
|
|
506
|
+
</tr>
|
|
507
|
+
</table>
|
|
508
|
+
</div>
|
|
509
|
+
|
|
510
|
+
|
|
511
|
+
<span id="interest_rate=-instance_method"></span>
|
|
512
|
+
<div class="method_details ">
|
|
513
|
+
<h3 class="signature " id="interest_rate-instance_method">
|
|
514
|
+
|
|
515
|
+
#<strong>interest_rate</strong> ⇒ <tt>Object</tt>
|
|
516
|
+
|
|
517
|
+
|
|
518
|
+
|
|
519
|
+
|
|
520
|
+
|
|
521
|
+
</h3><div class="docstring">
|
|
522
|
+
<div class="discussion">
|
|
523
|
+
<p>Returns the value of attribute interest_rate.</p>
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
</div>
|
|
527
|
+
</div>
|
|
528
|
+
<div class="tags">
|
|
529
|
+
|
|
530
|
+
|
|
531
|
+
</div><table class="source_code">
|
|
532
|
+
<tr>
|
|
533
|
+
<td>
|
|
534
|
+
<pre class="lines">
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
620
|
|
538
|
+
621
|
|
539
|
+
622</pre>
|
|
540
|
+
</td>
|
|
541
|
+
<td>
|
|
542
|
+
<pre class="code"><span class="info file"># File 'lib/option_lab/models.rb', line 620</span>
|
|
543
|
+
|
|
544
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_interest_rate'>interest_rate</span>
|
|
545
|
+
<span class='ivar'>@interest_rate</span>
|
|
546
|
+
<span class='kw'>end</span></pre>
|
|
547
|
+
</td>
|
|
548
|
+
</tr>
|
|
549
|
+
</table>
|
|
550
|
+
</div>
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
<span id="option_type=-instance_method"></span>
|
|
554
|
+
<div class="method_details ">
|
|
555
|
+
<h3 class="signature " id="option_type-instance_method">
|
|
556
|
+
|
|
557
|
+
#<strong>option_type</strong> ⇒ <tt>Object</tt>
|
|
558
|
+
|
|
559
|
+
|
|
560
|
+
|
|
561
|
+
|
|
562
|
+
|
|
563
|
+
</h3><div class="docstring">
|
|
564
|
+
<div class="discussion">
|
|
565
|
+
<p>Returns the value of attribute option_type.</p>
|
|
566
|
+
|
|
567
|
+
|
|
568
|
+
</div>
|
|
569
|
+
</div>
|
|
570
|
+
<div class="tags">
|
|
571
|
+
|
|
572
|
+
|
|
573
|
+
</div><table class="source_code">
|
|
574
|
+
<tr>
|
|
575
|
+
<td>
|
|
576
|
+
<pre class="lines">
|
|
577
|
+
|
|
578
|
+
|
|
579
|
+
620
|
|
580
|
+
621
|
|
581
|
+
622</pre>
|
|
582
|
+
</td>
|
|
583
|
+
<td>
|
|
584
|
+
<pre class="code"><span class="info file"># File 'lib/option_lab/models.rb', line 620</span>
|
|
585
|
+
|
|
586
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_option_type'>option_type</span>
|
|
587
|
+
<span class='ivar'>@option_type</span>
|
|
588
|
+
<span class='kw'>end</span></pre>
|
|
589
|
+
</td>
|
|
590
|
+
</tr>
|
|
591
|
+
</table>
|
|
592
|
+
</div>
|
|
593
|
+
|
|
594
|
+
|
|
595
|
+
<span id="stock_price=-instance_method"></span>
|
|
596
|
+
<div class="method_details ">
|
|
597
|
+
<h3 class="signature " id="stock_price-instance_method">
|
|
598
|
+
|
|
599
|
+
#<strong>stock_price</strong> ⇒ <tt>Object</tt>
|
|
600
|
+
|
|
601
|
+
|
|
602
|
+
|
|
603
|
+
|
|
604
|
+
|
|
605
|
+
</h3><div class="docstring">
|
|
606
|
+
<div class="discussion">
|
|
607
|
+
<p>Returns the value of attribute stock_price.</p>
|
|
608
|
+
|
|
609
|
+
|
|
610
|
+
</div>
|
|
611
|
+
</div>
|
|
612
|
+
<div class="tags">
|
|
613
|
+
|
|
614
|
+
|
|
615
|
+
</div><table class="source_code">
|
|
616
|
+
<tr>
|
|
617
|
+
<td>
|
|
618
|
+
<pre class="lines">
|
|
619
|
+
|
|
620
|
+
|
|
621
|
+
620
|
|
622
|
+
621
|
|
623
|
+
622</pre>
|
|
624
|
+
</td>
|
|
625
|
+
<td>
|
|
626
|
+
<pre class="code"><span class="info file"># File 'lib/option_lab/models.rb', line 620</span>
|
|
627
|
+
|
|
628
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_stock_price'>stock_price</span>
|
|
629
|
+
<span class='ivar'>@stock_price</span>
|
|
630
|
+
<span class='kw'>end</span></pre>
|
|
631
|
+
</td>
|
|
632
|
+
</tr>
|
|
633
|
+
</table>
|
|
634
|
+
</div>
|
|
635
|
+
|
|
636
|
+
|
|
637
|
+
<span id="strike=-instance_method"></span>
|
|
638
|
+
<div class="method_details ">
|
|
639
|
+
<h3 class="signature " id="strike-instance_method">
|
|
640
|
+
|
|
641
|
+
#<strong>strike</strong> ⇒ <tt>Object</tt>
|
|
642
|
+
|
|
643
|
+
|
|
644
|
+
|
|
645
|
+
|
|
646
|
+
|
|
647
|
+
</h3><div class="docstring">
|
|
648
|
+
<div class="discussion">
|
|
649
|
+
<p>Returns the value of attribute strike.</p>
|
|
650
|
+
|
|
651
|
+
|
|
652
|
+
</div>
|
|
653
|
+
</div>
|
|
654
|
+
<div class="tags">
|
|
655
|
+
|
|
656
|
+
|
|
657
|
+
</div><table class="source_code">
|
|
658
|
+
<tr>
|
|
659
|
+
<td>
|
|
660
|
+
<pre class="lines">
|
|
661
|
+
|
|
662
|
+
|
|
663
|
+
620
|
|
664
|
+
621
|
|
665
|
+
622</pre>
|
|
666
|
+
</td>
|
|
667
|
+
<td>
|
|
668
|
+
<pre class="code"><span class="info file"># File 'lib/option_lab/models.rb', line 620</span>
|
|
669
|
+
|
|
670
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_strike'>strike</span>
|
|
671
|
+
<span class='ivar'>@strike</span>
|
|
672
|
+
<span class='kw'>end</span></pre>
|
|
673
|
+
</td>
|
|
674
|
+
</tr>
|
|
675
|
+
</table>
|
|
676
|
+
</div>
|
|
677
|
+
|
|
678
|
+
|
|
679
|
+
<span id="volatility=-instance_method"></span>
|
|
680
|
+
<div class="method_details ">
|
|
681
|
+
<h3 class="signature " id="volatility-instance_method">
|
|
682
|
+
|
|
683
|
+
#<strong>volatility</strong> ⇒ <tt>Object</tt>
|
|
684
|
+
|
|
685
|
+
|
|
686
|
+
|
|
687
|
+
|
|
688
|
+
|
|
689
|
+
</h3><div class="docstring">
|
|
690
|
+
<div class="discussion">
|
|
691
|
+
<p>Returns the value of attribute volatility.</p>
|
|
692
|
+
|
|
693
|
+
|
|
694
|
+
</div>
|
|
695
|
+
</div>
|
|
696
|
+
<div class="tags">
|
|
697
|
+
|
|
698
|
+
|
|
699
|
+
</div><table class="source_code">
|
|
700
|
+
<tr>
|
|
701
|
+
<td>
|
|
702
|
+
<pre class="lines">
|
|
703
|
+
|
|
704
|
+
|
|
705
|
+
620
|
|
706
|
+
621
|
|
707
|
+
622</pre>
|
|
708
|
+
</td>
|
|
709
|
+
<td>
|
|
710
|
+
<pre class="code"><span class="info file"># File 'lib/option_lab/models.rb', line 620</span>
|
|
711
|
+
|
|
712
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_volatility'>volatility</span>
|
|
713
|
+
<span class='ivar'>@volatility</span>
|
|
714
|
+
<span class='kw'>end</span></pre>
|
|
715
|
+
</td>
|
|
716
|
+
</tr>
|
|
717
|
+
</table>
|
|
718
|
+
</div>
|
|
719
|
+
|
|
720
|
+
|
|
721
|
+
<span id="years_to_maturity=-instance_method"></span>
|
|
722
|
+
<div class="method_details ">
|
|
723
|
+
<h3 class="signature " id="years_to_maturity-instance_method">
|
|
724
|
+
|
|
725
|
+
#<strong>years_to_maturity</strong> ⇒ <tt>Object</tt>
|
|
726
|
+
|
|
727
|
+
|
|
728
|
+
|
|
729
|
+
|
|
730
|
+
|
|
731
|
+
</h3><div class="docstring">
|
|
732
|
+
<div class="discussion">
|
|
733
|
+
<p>Returns the value of attribute years_to_maturity.</p>
|
|
734
|
+
|
|
735
|
+
|
|
736
|
+
</div>
|
|
737
|
+
</div>
|
|
738
|
+
<div class="tags">
|
|
739
|
+
|
|
740
|
+
|
|
741
|
+
</div><table class="source_code">
|
|
742
|
+
<tr>
|
|
743
|
+
<td>
|
|
744
|
+
<pre class="lines">
|
|
745
|
+
|
|
746
|
+
|
|
747
|
+
620
|
|
748
|
+
621
|
|
749
|
+
622</pre>
|
|
750
|
+
</td>
|
|
751
|
+
<td>
|
|
752
|
+
<pre class="code"><span class="info file"># File 'lib/option_lab/models.rb', line 620</span>
|
|
753
|
+
|
|
754
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_years_to_maturity'>years_to_maturity</span>
|
|
755
|
+
<span class='ivar'>@years_to_maturity</span>
|
|
756
|
+
<span class='kw'>end</span></pre>
|
|
757
|
+
</td>
|
|
758
|
+
</tr>
|
|
759
|
+
</table>
|
|
760
|
+
</div>
|
|
761
|
+
|
|
762
|
+
</div>
|
|
763
|
+
|
|
764
|
+
|
|
765
|
+
<div id="instance_method_details" class="method_details_list">
|
|
766
|
+
<h2>Instance Method Details</h2>
|
|
767
|
+
|
|
768
|
+
|
|
769
|
+
<div class="method_details first">
|
|
770
|
+
<h3 class="signature first" id="greeks-instance_method">
|
|
771
|
+
|
|
772
|
+
#<strong>greeks</strong> ⇒ <tt>Object</tt>
|
|
773
|
+
|
|
774
|
+
|
|
775
|
+
|
|
776
|
+
|
|
777
|
+
|
|
778
|
+
</h3><table class="source_code">
|
|
779
|
+
<tr>
|
|
780
|
+
<td>
|
|
781
|
+
<pre class="lines">
|
|
782
|
+
|
|
783
|
+
|
|
784
|
+
658
|
|
785
|
+
659
|
|
786
|
+
660
|
|
787
|
+
661
|
|
788
|
+
662
|
|
789
|
+
663
|
|
790
|
+
664
|
|
791
|
+
665
|
|
792
|
+
666
|
|
793
|
+
667
|
|
794
|
+
668</pre>
|
|
795
|
+
</td>
|
|
796
|
+
<td>
|
|
797
|
+
<pre class="code"><span class="info file"># File 'lib/option_lab/models.rb', line 658</span>
|
|
798
|
+
|
|
799
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_greeks'>greeks</span>
|
|
800
|
+
<span class='const'><span class='object_link'><a href="../../OptionLab.html" title="OptionLab (module)">OptionLab</a></span></span><span class='period'>.</span><span class='id identifier rubyid_get_american_greeks'>get_american_greeks</span><span class='lparen'>(</span>
|
|
801
|
+
<span class='id identifier rubyid_option_type'>option_type</span><span class='comma'>,</span>
|
|
802
|
+
<span class='id identifier rubyid_stock_price'>stock_price</span><span class='comma'>,</span>
|
|
803
|
+
<span class='id identifier rubyid_strike'>strike</span><span class='comma'>,</span>
|
|
804
|
+
<span class='id identifier rubyid_interest_rate'>interest_rate</span><span class='comma'>,</span>
|
|
805
|
+
<span class='id identifier rubyid_volatility'>volatility</span><span class='comma'>,</span>
|
|
806
|
+
<span class='id identifier rubyid_years_to_maturity'>years_to_maturity</span><span class='comma'>,</span>
|
|
807
|
+
<span class='id identifier rubyid_dividend_yield'>dividend_yield</span><span class='comma'>,</span>
|
|
808
|
+
<span class='rparen'>)</span>
|
|
809
|
+
<span class='kw'>end</span></pre>
|
|
810
|
+
</td>
|
|
811
|
+
</tr>
|
|
812
|
+
</table>
|
|
813
|
+
</div>
|
|
814
|
+
|
|
815
|
+
<div class="method_details ">
|
|
816
|
+
<h3 class="signature " id="price-instance_method">
|
|
817
|
+
|
|
818
|
+
#<strong>price</strong> ⇒ <tt>Object</tt>
|
|
819
|
+
|
|
820
|
+
|
|
821
|
+
|
|
822
|
+
|
|
823
|
+
|
|
824
|
+
</h3><table class="source_code">
|
|
825
|
+
<tr>
|
|
826
|
+
<td>
|
|
827
|
+
<pre class="lines">
|
|
828
|
+
|
|
829
|
+
|
|
830
|
+
646
|
|
831
|
+
647
|
|
832
|
+
648
|
|
833
|
+
649
|
|
834
|
+
650
|
|
835
|
+
651
|
|
836
|
+
652
|
|
837
|
+
653
|
|
838
|
+
654
|
|
839
|
+
655
|
|
840
|
+
656</pre>
|
|
841
|
+
</td>
|
|
842
|
+
<td>
|
|
843
|
+
<pre class="code"><span class="info file"># File 'lib/option_lab/models.rb', line 646</span>
|
|
844
|
+
|
|
845
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_price'>price</span>
|
|
846
|
+
<span class='const'><span class='object_link'><a href="../../OptionLab.html" title="OptionLab (module)">OptionLab</a></span></span><span class='period'>.</span><span class='id identifier rubyid_price_american'>price_american</span><span class='lparen'>(</span>
|
|
847
|
+
<span class='id identifier rubyid_option_type'>option_type</span><span class='comma'>,</span>
|
|
848
|
+
<span class='id identifier rubyid_stock_price'>stock_price</span><span class='comma'>,</span>
|
|
849
|
+
<span class='id identifier rubyid_strike'>strike</span><span class='comma'>,</span>
|
|
850
|
+
<span class='id identifier rubyid_interest_rate'>interest_rate</span><span class='comma'>,</span>
|
|
851
|
+
<span class='id identifier rubyid_volatility'>volatility</span><span class='comma'>,</span>
|
|
852
|
+
<span class='id identifier rubyid_years_to_maturity'>years_to_maturity</span><span class='comma'>,</span>
|
|
853
|
+
<span class='id identifier rubyid_dividend_yield'>dividend_yield</span><span class='comma'>,</span>
|
|
854
|
+
<span class='rparen'>)</span>
|
|
855
|
+
<span class='kw'>end</span></pre>
|
|
856
|
+
</td>
|
|
857
|
+
</tr>
|
|
858
|
+
</table>
|
|
859
|
+
</div>
|
|
860
|
+
|
|
861
|
+
<div class="method_details ">
|
|
862
|
+
<h3 class="signature " id="validate!-instance_method">
|
|
863
|
+
|
|
864
|
+
#<strong>validate!</strong> ⇒ <tt>Object</tt>
|
|
865
|
+
|
|
866
|
+
|
|
867
|
+
|
|
868
|
+
|
|
869
|
+
|
|
870
|
+
</h3><div class="docstring">
|
|
871
|
+
<div class="discussion">
|
|
872
|
+
|
|
873
|
+
|
|
874
|
+
</div>
|
|
875
|
+
</div>
|
|
876
|
+
<div class="tags">
|
|
877
|
+
|
|
878
|
+
<p class="tag_title">Raises:</p>
|
|
879
|
+
<ul class="raise">
|
|
880
|
+
|
|
881
|
+
<li>
|
|
882
|
+
|
|
883
|
+
|
|
884
|
+
<span class='type'>(<tt>ArgumentError</tt>)</span>
|
|
885
|
+
|
|
886
|
+
|
|
887
|
+
|
|
888
|
+
</li>
|
|
889
|
+
|
|
890
|
+
</ul>
|
|
891
|
+
|
|
892
|
+
</div><table class="source_code">
|
|
893
|
+
<tr>
|
|
894
|
+
<td>
|
|
895
|
+
<pre class="lines">
|
|
896
|
+
|
|
897
|
+
|
|
898
|
+
636
|
|
899
|
+
637
|
|
900
|
+
638
|
|
901
|
+
639
|
|
902
|
+
640
|
|
903
|
+
641
|
|
904
|
+
642
|
|
905
|
+
643
|
|
906
|
+
644</pre>
|
|
907
|
+
</td>
|
|
908
|
+
<td>
|
|
909
|
+
<pre class="code"><span class="info file"># File 'lib/option_lab/models.rb', line 636</span>
|
|
910
|
+
|
|
911
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_validate!'>validate!</span>
|
|
912
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>option_type must be 'call' or 'put'</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='const'><span class='object_link'><a href="../Models.html#OPTION_TYPES-constant" title="OptionLab::Models::OPTION_TYPES (constant)">OPTION_TYPES</a></span></span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_option_type'>option_type</span><span class='rparen'>)</span>
|
|
913
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>stock_price must be positive</span><span class='tstring_end'>'</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_stock_price'>stock_price</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Numeric</span><span class='rparen'>)</span> <span class='op'>&&</span> <span class='id identifier rubyid_stock_price'>stock_price</span><span class='period'>.</span><span class='id identifier rubyid_positive?'>positive?</span>
|
|
914
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>strike must be positive</span><span class='tstring_end'>'</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_strike'>strike</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Numeric</span><span class='rparen'>)</span> <span class='op'>&&</span> <span class='id identifier rubyid_strike'>strike</span><span class='period'>.</span><span class='id identifier rubyid_positive?'>positive?</span>
|
|
915
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>interest_rate must be non-negative</span><span class='tstring_end'>'</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_interest_rate'>interest_rate</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Numeric</span><span class='rparen'>)</span> <span class='op'>&&</span> <span class='id identifier rubyid_interest_rate'>interest_rate</span> <span class='op'>>=</span> <span class='int'>0</span>
|
|
916
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>volatility must be positive</span><span class='tstring_end'>'</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_volatility'>volatility</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Numeric</span><span class='rparen'>)</span> <span class='op'>&&</span> <span class='id identifier rubyid_volatility'>volatility</span><span class='period'>.</span><span class='id identifier rubyid_positive?'>positive?</span>
|
|
917
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>years_to_maturity must be non-negative</span><span class='tstring_end'>'</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_years_to_maturity'>years_to_maturity</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Numeric</span><span class='rparen'>)</span> <span class='op'>&&</span> <span class='id identifier rubyid_years_to_maturity'>years_to_maturity</span> <span class='op'>>=</span> <span class='int'>0</span>
|
|
918
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>dividend_yield must be non-negative</span><span class='tstring_end'>'</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_dividend_yield'>dividend_yield</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Numeric</span><span class='rparen'>)</span> <span class='op'>&&</span> <span class='id identifier rubyid_dividend_yield'>dividend_yield</span> <span class='op'>>=</span> <span class='int'>0</span>
|
|
919
|
+
<span class='kw'>end</span></pre>
|
|
920
|
+
</td>
|
|
921
|
+
</tr>
|
|
922
|
+
</table>
|
|
923
|
+
</div>
|
|
924
|
+
|
|
925
|
+
</div>
|
|
926
|
+
|
|
927
|
+
</div>
|
|
928
|
+
|
|
929
|
+
<div id="footer">
|
|
930
|
+
Generated on Sun Apr 27 16:09:34 2025 by
|
|
931
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
932
|
+
0.9.37 (ruby-3.3.3).
|
|
933
|
+
</div>
|
|
934
|
+
|
|
935
|
+
</div>
|
|
936
|
+
</body>
|
|
937
|
+
</html>
|