Skip to content

Commit 0e9597b

Browse files
author
array-api-bot
committed
Deploy: 3a801d3
1 parent 61a6f67 commit 0e9597b

3 files changed

Lines changed: 4 additions & 8 deletions

File tree

draft/extensions/generated/array_api.linalg.eigh.html

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -366,10 +366,6 @@ <h1 id="extensions-generated-array-api-linalg-eigh--page-root">eigh<a class="hea
366366
<p class="admonition-title">Note</p>
367367
<p>Whether an array library explicitly checks whether an input array is Hermitian or a symmetric matrix (or a stack of matrices) is implementation-defined.</p>
368368
</div>
369-
<div class="admonition note">
370-
<p class="admonition-title">Note</p>
371-
<p>The function <code class="docutils literal notranslate"><span class="pre">eig</span></code> will be added in a future version of the specification.</p>
372-
</div>
373369
<dl class="field-list simple">
374370
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
375371
<dd class="field-odd"><p><strong>x</strong> (<em>array</em>) – input array having shape <code class="docutils literal notranslate"><span class="pre">(...,</span> <span class="pre">M,</span> <span class="pre">M)</span></code> and whose innermost two dimensions form square matrices. Should have a floating-point data type.</p>
@@ -378,7 +374,7 @@ <h1 id="extensions-generated-array-api-linalg-eigh--page-root">eigh<a class="hea
378374
<dd class="field-even"><p><strong>out</strong> (<em>Tuple[array, array]</em>) – a namedtuple (<code class="docutils literal notranslate"><span class="pre">eigenvalues</span></code>, <code class="docutils literal notranslate"><span class="pre">eigenvectors</span></code>) whose</p>
379375
<ul class="simple">
380376
<li><p>first element must have the field name <code class="docutils literal notranslate"><span class="pre">eigenvalues</span></code> (corresponding to <span class="math notranslate nohighlight">\(\operatorname{diag}\Lambda\)</span> above) and must be an array consisting of computed eigenvalues. The array containing the eigenvalues must have shape <code class="docutils literal notranslate"><span class="pre">(...,</span> <span class="pre">M)</span></code> and must have a real-valued floating-point data type whose precision matches the precision of <code class="docutils literal notranslate"><span class="pre">x</span></code> (e.g., if <code class="docutils literal notranslate"><span class="pre">x</span></code> is <code class="docutils literal notranslate"><span class="pre">complex128</span></code>, then <code class="docutils literal notranslate"><span class="pre">eigenvalues</span></code> must be <code class="docutils literal notranslate"><span class="pre">float64</span></code>).</p></li>
381-
<li><p>second element have have the field name <code class="docutils literal notranslate"><span class="pre">eigenvectors</span></code> (corresponding to <span class="math notranslate nohighlight">\(Q\)</span> above) and must be an array where the columns of the inner most matrices contain the computed eigenvectors. These matrices must be orthogonal. The array containing the eigenvectors must have shape <code class="docutils literal notranslate"><span class="pre">(...,</span> <span class="pre">M,</span> <span class="pre">M)</span></code> and must have the same data type as <code class="docutils literal notranslate"><span class="pre">x</span></code>.</p></li>
377+
<li><p>second element must have the field name <code class="docutils literal notranslate"><span class="pre">eigenvectors</span></code> (corresponding to <span class="math notranslate nohighlight">\(Q\)</span> above) and must be an array where the columns of the inner most matrices contain the computed eigenvectors. These matrices must be orthogonal. The array containing the eigenvectors must have shape <code class="docutils literal notranslate"><span class="pre">(...,</span> <span class="pre">M,</span> <span class="pre">M)</span></code> and must have the same data type as <code class="docutils literal notranslate"><span class="pre">x</span></code>.</p></li>
382378
</ul>
383379
</dd>
384380
</dl>

draft/extensions/generated/array_api.linalg.eigvalsh.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -355,11 +355,11 @@ <h1 id="extensions-generated-array-api-linalg-eigvalsh--page-root">eigvalsh<a cl
355355
<p>where <span class="math notranslate nohighlight">\(\lambda \in \mathbb{R}\)</span> and where <span class="math notranslate nohighlight">\(I_n\)</span> is the <em>n</em>-dimensional identity matrix.</p>
356356
<div class="admonition note">
357357
<p class="admonition-title">Note</p>
358-
<p>Whether an array library explicitly checks whether an input array is Hermitian or a symmetric matrix (or a stack of matrices) is implementation-defined.</p>
358+
<p>The eigenvalues of a complex Hermitian or real symmetric matrix are always real.</p>
359359
</div>
360360
<div class="admonition note">
361361
<p class="admonition-title">Note</p>
362-
<p>The function <code class="docutils literal notranslate"><span class="pre">eigvals</span></code> will be added in a future version of the specification.</p>
362+
<p>Whether an array library explicitly checks whether an input array is Hermitian or a symmetric matrix (or a stack of matrices) is implementation-defined.</p>
363363
</div>
364364
<dl class="field-list simple">
365365
<dt class="field-odd">Parameters<span class="colon">:</span></dt>

draft/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)