Skip to content

Commit cdabaf6

Browse files
committed
Deploying to gh-pages from @ 3bc1070 🚀
1 parent 109ce7f commit cdabaf6

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

generated/array_api_extra.create_diagonal.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -276,15 +276,16 @@ <h1>array_api_extra.create_diagonal<a class="headerlink" href="#array-api-extra-
276276
<dl class="field-list simple">
277277
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
278278
<dd class="field-odd"><ul class="simple">
279-
<li><p><strong>x</strong> (<em>array</em>) – A 1-D array.</p></li>
279+
<li><p><strong>x</strong> (<em>array</em>) – An array having shape <code class="docutils literal notranslate"><span class="pre">(*batch_dims,</span> <span class="pre">k)</span></code>.</p></li>
280280
<li><p><strong>offset</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a><em>, </em><em>optional</em>) – Offset from the leading diagonal (default is <code class="docutils literal notranslate"><span class="pre">0</span></code>).
281281
Use positive ints for diagonals above the leading diagonal,
282282
and negative ints for diagonals below the leading diagonal.</p></li>
283283
<li><p><strong>xp</strong> (<em>array_namespace</em><em>, </em><em>optional</em>) – The standard-compatible namespace for <cite>x</cite>. Default: infer.</p></li>
284284
</ul>
285285
</dd>
286286
<dt class="field-even">Returns<span class="colon">:</span></dt>
287-
<dd class="field-even"><p>A 2-D array with <cite>x</cite> on the diagonal (offset by <cite>offset</cite>).</p>
287+
<dd class="field-even"><p>An array having shape <code class="docutils literal notranslate"><span class="pre">(*batch_dims,</span> <span class="pre">k+abs(offset),</span> <span class="pre">k+abs(offset))</span></code> with <cite>x</cite>
288+
on the diagonal (offset by <cite>offset</cite>).</p>
288289
</dd>
289290
<dt class="field-odd">Return type<span class="colon">:</span></dt>
290291
<dd class="field-odd"><p>array</p>

0 commit comments

Comments
 (0)