Skip to content

Commit

Permalink
Update documentation from github actions
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Oct 16, 2024
1 parent dffbe86 commit 9f8bc4c
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 18 deletions.
1 change: 1 addition & 0 deletions FinancialApplications/_sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -83,3 +83,4 @@

utils.rst


35 changes: 18 additions & 17 deletions FinancialApplications/qml4var.losses.html
Original file line number Diff line number Diff line change
Expand Up @@ -118,23 +118,7 @@
<dl class="py function">
<dt class="sig sig-object py" id="QQuantLib.qml4var.losses.compute_integral">
<span class="sig-prename descclassname"><span class="pre">QQuantLib.qml4var.losses.</span></span><span class="sig-name descname"><span class="pre">compute_integral</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">y_array</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x_array</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dask_client</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#QQuantLib.qml4var.losses.compute_integral" title="Link to this definition"></a></dt>
<dd><dl class="simple">
<dt>Function for computing numerical integral of inputs arrays. Considerations:</dt><dd><ul class="simple">
<li><p>if x_array has shape(n, 1) then numpy trapz is used for computing integral.</p></li>
<li><dl class="simple">
<dt>if x_array has shape(n, 2) and dask_client is None numpy trapz</dt><dd><p>is used for computing the double integral.</p>
</dd>
</dl>
</li>
<li><dl class="simple">
<dt>if x_array has shape(n, 2) and dask_client is provided then MonteCarlo</dt><dd><p>integration is used</p>
</dd>
</dl>
</li>
<li><p>if x_array has shape(n, &gt; 2) MonteCarlo integration is used</p></li>
</ul>
</dd>
</dl>
<dd><p>Function for computing numerical integral of inputs arrays.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
Expand All @@ -153,6 +137,23 @@
<dd class="field-odd"><p>float or future</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<ul class="simple">
<li><p>if x_array has shape(n, 1) then numpy trapz is used for computing integral.</p></li>
<li><dl class="simple">
<dt>if x_array has shape(n, 2) and dask_client is None numpy trapz</dt><dd><p>is used for computing the double integral.</p>
</dd>
</dl>
</li>
<li><dl class="simple">
<dt>if x_array has shape(n, 2) and dask_client is provided then MonteCarlo</dt><dd><p>integration is used</p>
</dd>
</dl>
</li>
<li><p>if x_array has shape(n, &gt; 2) MonteCarlo integration is used</p></li>
</ul>
</div>
</dd></dl>

<dl class="py function">
Expand Down
2 changes: 1 addition & 1 deletion FinancialApplications/searchindex.js

Large diffs are not rendered by default.

0 comments on commit 9f8bc4c

Please sign in to comment.