mirror of
https://github.com/fjosw/pyerrors.git
synced 2025-03-15 14:50:25 +01:00
Documentation updated
This commit is contained in:
fjosw
parent
8770aad726
commit
d2d6932b39
3 changed files with 36 additions and 32 deletions
|
|
@ -1330,7 +1330,8 @@ ndarray.</p>
|
|||
<p>First mode, <code>buffer</code> is None:</p>
|
||||
|
||||
<div class="pdoc-code codehilite">
|
||||
<pre><span></span><code><span class="gp">>>> </span><span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">(</span><span class="n">shape</span><span class="o">=</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span><span class="mi">2</span><span class="p">),</span> <span class="n">dtype</span><span class="o">=</span><span class="nb">float</span><span class="p">,</span> <span class="n">order</span><span class="o">=</span><span class="s1">'F'</span><span class="p">)</span>
|
||||
<pre><span></span><code><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
|
||||
<span class="gp">>>> </span><span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">(</span><span class="n">shape</span><span class="o">=</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span><span class="mi">2</span><span class="p">),</span> <span class="n">dtype</span><span class="o">=</span><span class="nb">float</span><span class="p">,</span> <span class="n">order</span><span class="o">=</span><span class="s1">'F'</span><span class="p">)</span>
|
||||
<span class="go">array([[0.0e+000, 0.0e+000], # random</span>
|
||||
<span class="go"> [ nan, 2.5e-323]])</span>
|
||||
</code></pre>
|
||||
|
|
@ -1406,15 +1407,12 @@ in and out momenta of the propagator are exchanged.</p>
|
|||
<dd id="Npr_matrix.flatten" class="function">flatten</dd>
|
||||
<dd id="Npr_matrix.getfield" class="function">getfield</dd>
|
||||
<dd id="Npr_matrix.item" class="function">item</dd>
|
||||
<dd id="Npr_matrix.itemset" class="function">itemset</dd>
|
||||
<dd id="Npr_matrix.max" class="function">max</dd>
|
||||
<dd id="Npr_matrix.mean" class="function">mean</dd>
|
||||
<dd id="Npr_matrix.min" class="function">min</dd>
|
||||
<dd id="Npr_matrix.newbyteorder" class="function">newbyteorder</dd>
|
||||
<dd id="Npr_matrix.nonzero" class="function">nonzero</dd>
|
||||
<dd id="Npr_matrix.partition" class="function">partition</dd>
|
||||
<dd id="Npr_matrix.prod" class="function">prod</dd>
|
||||
<dd id="Npr_matrix.ptp" class="function">ptp</dd>
|
||||
<dd id="Npr_matrix.put" class="function">put</dd>
|
||||
<dd id="Npr_matrix.ravel" class="function">ravel</dd>
|
||||
<dd id="Npr_matrix.repeat" class="function">repeat</dd>
|
||||
|
|
@ -1438,6 +1436,7 @@ in and out momenta of the propagator are exchanged.</p>
|
|||
<dd id="Npr_matrix.transpose" class="function">transpose</dd>
|
||||
<dd id="Npr_matrix.var" class="function">var</dd>
|
||||
<dd id="Npr_matrix.view" class="function">view</dd>
|
||||
<dd id="Npr_matrix.to_device" class="function">to_device</dd>
|
||||
<dd id="Npr_matrix.ndim" class="variable">ndim</dd>
|
||||
<dd id="Npr_matrix.flags" class="variable">flags</dd>
|
||||
<dd id="Npr_matrix.shape" class="variable">shape</dd>
|
||||
|
|
@ -1453,6 +1452,11 @@ in and out momenta of the propagator are exchanged.</p>
|
|||
<dd id="Npr_matrix.flat" class="variable">flat</dd>
|
||||
<dd id="Npr_matrix.ctypes" class="variable">ctypes</dd>
|
||||
<dd id="Npr_matrix.T" class="variable">T</dd>
|
||||
<dd id="Npr_matrix.mT" class="variable">mT</dd>
|
||||
<dd id="Npr_matrix.ptp" class="variable">ptp</dd>
|
||||
<dd id="Npr_matrix.newbyteorder" class="variable">newbyteorder</dd>
|
||||
<dd id="Npr_matrix.itemset" class="variable">itemset</dd>
|
||||
<dd id="Npr_matrix.device" class="variable">device</dd>
|
||||
|
||||
</div>
|
||||
</dl>
|
||||
|
|
|
|||
|
|
@ -222,7 +222,7 @@
|
|||
</span></pre></div>
|
||||
|
||||
|
||||
<div class="docstring"><p>beta(x1, x2, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature, extobj])</p>
|
||||
<div class="docstring"><p>beta(x1, x2, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature])</p>
|
||||
|
||||
<p>beta(a, b, out=None)</p>
|
||||
|
||||
|
|
@ -338,7 +338,7 @@ Eq. 5.12.1. <a href="https://dlmf.nist.gov/5.12">https://dlmf.nist.gov/5.12</a>&
|
|||
</span></pre></div>
|
||||
|
||||
|
||||
<div class="docstring"><p>betainc(x1, x2, x3, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature, extobj])</p>
|
||||
<div class="docstring"><p>betainc(x1, x2, x3, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature])</p>
|
||||
|
||||
<p>betainc(a, b, x, out=None)</p>
|
||||
|
||||
|
|
@ -478,7 +478,7 @@ where \( F \) is the hypergeometric function <code>hyp2f1</code>:</p>
|
|||
</span></pre></div>
|
||||
|
||||
|
||||
<div class="docstring"><p>betaln(x1, x2, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature, extobj])</p>
|
||||
<div class="docstring"><p>betaln(x1, x2, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature])</p>
|
||||
|
||||
<p>betaln(a, b, out=None)</p>
|
||||
|
||||
|
|
@ -655,7 +655,7 @@ Real valued input</li>
|
|||
</span></pre></div>
|
||||
|
||||
|
||||
<div class="docstring"><p>psi(x, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature, extobj])</p>
|
||||
<div class="docstring"><p>psi(x, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature])</p>
|
||||
|
||||
<p>psi(z, out=None)</p>
|
||||
|
||||
|
|
@ -773,7 +773,7 @@ function should maintain full accuracy around the origin.</p>
|
|||
</span></pre></div>
|
||||
|
||||
|
||||
<div class="docstring"><p>psi(x, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature, extobj])</p>
|
||||
<div class="docstring"><p>psi(x, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature])</p>
|
||||
|
||||
<p>psi(z, out=None)</p>
|
||||
|
||||
|
|
@ -891,7 +891,7 @@ function should maintain full accuracy around the origin.</p>
|
|||
</span></pre></div>
|
||||
|
||||
|
||||
<div class="docstring"><p>gamma(x, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature, extobj])</p>
|
||||
<div class="docstring"><p>gamma(x, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature])</p>
|
||||
|
||||
<p>gamma(z, out=None)</p>
|
||||
|
||||
|
|
@ -1018,7 +1018,7 @@ the above identity for \( z = n \).</p>
|
|||
</span></pre></div>
|
||||
|
||||
|
||||
<div class="docstring"><p>gammaln(x, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature, extobj])</p>
|
||||
<div class="docstring"><p>gammaln(x, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature])</p>
|
||||
|
||||
<p>gammaln(x, out=None)</p>
|
||||
|
||||
|
|
@ -1135,7 +1135,7 @@ gammasgn(x) * gamma(x)</code>.</p>
|
|||
</span></pre></div>
|
||||
|
||||
|
||||
<div class="docstring"><p>gammainc(x1, x2, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature, extobj])</p>
|
||||
<div class="docstring"><p>gammainc(x1, x2, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature])</p>
|
||||
|
||||
<p>gammainc(a, x, out=None)</p>
|
||||
|
||||
|
|
@ -1244,7 +1244,7 @@ monotonically increases to 1.</p>
|
|||
</span></pre></div>
|
||||
|
||||
|
||||
<div class="docstring"><p>gammaincc(x1, x2, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature, extobj])</p>
|
||||
<div class="docstring"><p>gammaincc(x1, x2, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature])</p>
|
||||
|
||||
<p>gammaincc(a, x, out=None)</p>
|
||||
|
||||
|
|
@ -1354,7 +1354,7 @@ starts at 1 and monotonically decreases to 0.</p>
|
|||
</span></pre></div>
|
||||
|
||||
|
||||
<div class="docstring"><p>gammasgn(x, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature, extobj])</p>
|
||||
<div class="docstring"><p>gammasgn(x, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature])</p>
|
||||
|
||||
<p>gammasgn(x, out=None)</p>
|
||||
|
||||
|
|
@ -1470,7 +1470,7 @@ np.exp(gammaln(x))</code>.</p>
|
|||
</span></pre></div>
|
||||
|
||||
|
||||
<div class="docstring"><p>rgamma(x, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature, extobj])</p>
|
||||
<div class="docstring"><p>rgamma(x, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature])</p>
|
||||
|
||||
<p>rgamma(z, out=None)</p>
|
||||
|
||||
|
|
@ -1702,7 +1702,7 @@ shown above:</p>
|
|||
</span></pre></div>
|
||||
|
||||
|
||||
<div class="docstring"><p>j0(x, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature, extobj])</p>
|
||||
<div class="docstring"><p>j0(x, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature])</p>
|
||||
|
||||
<p>j0(x, out=None)</p>
|
||||
|
||||
|
|
@ -1823,7 +1823,7 @@ It should not be confused with the spherical Bessel functions (see
|
|||
</span></pre></div>
|
||||
|
||||
|
||||
<div class="docstring"><p>y0(x, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature, extobj])</p>
|
||||
<div class="docstring"><p>y0(x, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature])</p>
|
||||
|
||||
<p>y0(x, out=None)</p>
|
||||
|
||||
|
|
@ -1941,7 +1941,7 @@ two rational functions of degree 6/6 and 7/7.</p>
|
|||
</span></pre></div>
|
||||
|
||||
|
||||
<div class="docstring"><p>j1(x, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature, extobj])</p>
|
||||
<div class="docstring"><p>j1(x, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature])</p>
|
||||
|
||||
<p>j1(x, out=None)</p>
|
||||
|
||||
|
|
@ -2055,7 +2055,7 @@ It should not be confused with the spherical Bessel functions (see
|
|||
</span></pre></div>
|
||||
|
||||
|
||||
<div class="docstring"><p>y1(x, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature, extobj])</p>
|
||||
<div class="docstring"><p>y1(x, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature])</p>
|
||||
|
||||
<p>y1(x, out=None)</p>
|
||||
|
||||
|
|
@ -2169,7 +2169,7 @@ rational functions of degree 5/5.</p>
|
|||
</span></pre></div>
|
||||
|
||||
|
||||
<div class="docstring"><p>jv(x1, x2, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature, extobj])</p>
|
||||
<div class="docstring"><p>jv(x1, x2, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature])</p>
|
||||
|
||||
<p>jv(v, z, out=None)</p>
|
||||
|
||||
|
|
@ -2336,7 +2336,7 @@ of a Complex Argument and Nonnegative Order",
|
|||
</span></pre></div>
|
||||
|
||||
|
||||
<div class="docstring"><p>yn(x1, x2, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature, extobj])</p>
|
||||
<div class="docstring"><p>yn(x1, x2, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature])</p>
|
||||
|
||||
<p>yn(n, x, out=None)</p>
|
||||
|
||||
|
|
@ -2489,7 +2489,7 @@ To calculate the orders 0 and 1 for an 1D array:</p>
|
|||
</span></pre></div>
|
||||
|
||||
|
||||
<div class="docstring"><p>i0(x, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature, extobj])</p>
|
||||
<div class="docstring"><p>i0(x, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature])</p>
|
||||
|
||||
<p>i0(x, out=None)</p>
|
||||
|
||||
|
|
@ -2605,7 +2605,7 @@ Chebyshev polynomial expansions are employed in each interval.</p>
|
|||
</span></pre></div>
|
||||
|
||||
|
||||
<div class="docstring"><p>i1(x, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature, extobj])</p>
|
||||
<div class="docstring"><p>i1(x, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature])</p>
|
||||
|
||||
<p>i1(x, out=None)</p>
|
||||
|
||||
|
|
@ -2722,7 +2722,7 @@ Chebyshev polynomial expansions are employed in each interval.</p>
|
|||
</span></pre></div>
|
||||
|
||||
|
||||
<div class="docstring"><p>iv(x1, x2, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature, extobj])</p>
|
||||
<div class="docstring"><p>iv(x1, x2, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature])</p>
|
||||
|
||||
<p>iv(v, z, out=None)</p>
|
||||
|
||||
|
|
@ -2898,7 +2898,7 @@ of a Complex Argument and Nonnegative Order",
|
|||
</span></pre></div>
|
||||
|
||||
|
||||
<div class="docstring"><p>ive(x1, x2, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature, extobj])</p>
|
||||
<div class="docstring"><p>ive(x1, x2, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature])</p>
|
||||
|
||||
<p>ive(v, z, out=None)</p>
|
||||
|
||||
|
|
@ -3065,7 +3065,7 @@ of a Complex Argument and Nonnegative Order",
|
|||
</span></pre></div>
|
||||
|
||||
|
||||
<div class="docstring"><p>erf(x, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature, extobj])</p>
|
||||
<div class="docstring"><p>erf(x, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature])</p>
|
||||
|
||||
<p>erf(z, out=None)</p>
|
||||
|
||||
|
|
@ -3152,7 +3152,7 @@ The values of the error function at the given points <code>x</code>.</li>
|
|||
</span></pre></div>
|
||||
|
||||
|
||||
<div class="docstring"><p>erfc(x, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature, extobj])</p>
|
||||
<div class="docstring"><p>erfc(x, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature])</p>
|
||||
|
||||
<p>erfc(x, out=None)</p>
|
||||
|
||||
|
|
@ -3231,7 +3231,7 @@ Optional output array for the function results</li>
|
|||
</span></pre></div>
|
||||
|
||||
|
||||
<div class="docstring"><p>erfinv(x, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature, extobj])</p>
|
||||
<div class="docstring"><p>erfinv(x, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature])</p>
|
||||
|
||||
<p>erfinv(y, out=None)</p>
|
||||
|
||||
|
|
@ -3343,7 +3343,7 @@ The inverse of erf of y, element-wise</li>
|
|||
</span></pre></div>
|
||||
|
||||
|
||||
<div class="docstring"><p>erfcinv(x, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature, extobj])</p>
|
||||
<div class="docstring"><p>erfcinv(x, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature])</p>
|
||||
|
||||
<p>erfcinv(y, out=None)</p>
|
||||
|
||||
|
|
@ -3449,7 +3449,7 @@ The inverse of erfc of y, element-wise</li>
|
|||
</span></pre></div>
|
||||
|
||||
|
||||
<div class="docstring"><p>logit(x, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature, extobj])</p>
|
||||
<div class="docstring"><p>logit(x, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature])</p>
|
||||
|
||||
<p>"""
|
||||
logit(x, out=None)</p>
|
||||
|
|
@ -3557,7 +3557,7 @@ see <a href="https://docs.scipy.org/doc/numpy/reference/ufuncs.html">ufuncs </a>
|
|||
</span></pre></div>
|
||||
|
||||
|
||||
<div class="docstring"><p>expit(x, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature, extobj])</p>
|
||||
<div class="docstring"><p>expit(x, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature])</p>
|
||||
|
||||
<p>expit(x, out=None)</p>
|
||||
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
Loading…
Add table
Reference in a new issue