Skip to content

Commit

Permalink
Doc: Fix partial eigenspectrum indexing convention for ScaLAPACK API (#…
Browse files Browse the repository at this point in the history 
…1248)
  • Loading branch information
@rasolca
rasolca committed Dec 19, 2024
1 parent 7e1489d commit e36b58a
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 32 deletions.
48 changes: 24 additions & 24 deletions master/c_2eigensolver_2gen__eigensolver_8h.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -526,7 +526,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a0ae27d8ae09b66c3bcb28a47
<dl class="section return"><dt>Returns</dt><dd>0 if the eigensolver completed normally </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">eigenvalues_index_begin</td><td>index of the first eigenvalue to compute </td></tr>
<tr><td class="paramname">eigenvalues_index_begin</td><td>index of the first eigenvalue to compute (has to be 0) </td></tr>
<tr><td class="paramname">eigenvalues_index_end</td><td>index of the last eigenvalue to compute (exclusive) </td></tr>
</table>
</dd>
Expand Down Expand Up @@ -637,7 +637,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a9a0869c298a27810fd0f29f7
<dl class="section return"><dt>Returns</dt><dd>0 if the eigensolver completed normally </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">eigenvalues_index_begin</td><td>index of the first eigenvalue to compute </td></tr>
<tr><td class="paramname">eigenvalues_index_begin</td><td>index of the first eigenvalue to compute (has to be 0) </td></tr>
<tr><td class="paramname">eigenvalues_index_end</td><td>index of the last eigenvalue to compute (exclusive) </td></tr>
</table>
</dd>
Expand Down Expand Up @@ -748,7 +748,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#afbf10a3704b2242c76ac745a
<dl class="section return"><dt>Returns</dt><dd>0 if the eigensolver completed normally </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">eigenvalues_index_begin</td><td>index of the first eigenvalue to compute </td></tr>
<tr><td class="paramname">eigenvalues_index_begin</td><td>index of the first eigenvalue to compute (has to be 0) </td></tr>
<tr><td class="paramname">eigenvalues_index_end</td><td>index of the last eigenvalue to compute (exclusive) </td></tr>
</table>
</dd>
Expand Down Expand Up @@ -857,7 +857,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ab7b0bbde16be7558f9e7af81
<dl class="section return"><dt>Returns</dt><dd>0 if the eigensolver completed normally </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">eigenvalues_index_begin</td><td>index of the first eigenvalue to compute </td></tr>
<tr><td class="paramname">eigenvalues_index_begin</td><td>index of the first eigenvalue to compute (has to be 0) </td></tr>
<tr><td class="paramname">eigenvalues_index_end</td><td>index of the last eigenvalue to compute (exclusive) </td></tr>
</table>
</dd>
Expand Down Expand Up @@ -1357,8 +1357,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a80645826b4f6cd3de04a2965
<tr><td class="paramdir"></td><td class="paramname">jz</td><td>column index of the global matrix <picture><source srcset="form_0_dark.png" media="(prefers-color-scheme: dark)"/><img class="formulaInl" alt="$\mathbf{A}$" src="form_0.png"/></picture> identifying the first column of the submatrix <picture><source srcset="form_0_dark.png" media="(prefers-color-scheme: dark)"/><img class="formulaInl" alt="$\mathbf{A}$" src="form_0.png"/></picture>, has to be 1 </td></tr>
<tr><td class="paramdir"></td><td class="paramname">descz</td><td>ScaLAPACK array descriptor of the global matrix <picture><source srcset="form_1_dark.png" media="(prefers-color-scheme: dark)"/><img class="formulaInl" alt="$\mathbf{Z}$" src="form_1.png"/></picture> </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">info</td><td>0 if the eigensolver completed normally </td></tr>
<tr><td class="paramdir"></td><td class="paramname">eigenvalues_index_begin</td><td>index of the first eigenvalue to compute </td></tr>
<tr><td class="paramdir"></td><td class="paramname">eigenvalues_index_end</td><td>index of the last eigenvalue to compute (exclusive) </td></tr>
<tr><td class="paramdir"></td><td class="paramname">eigenvalues_index_begin</td><td>index of the first eigenvalue to compute (has to be 1) </td></tr>
<tr><td class="paramdir"></td><td class="paramname">eigenvalues_index_end</td><td>index of the last eigenvalue to compute (inclusive) </td></tr>
</table>
</dd>
</dl>
Expand Down Expand Up @@ -1490,8 +1490,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a005145080c7ce2a7764f11dd
<p></p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">eigenvalues_index_begin</td><td>index of the first eigenvalue to compute </td></tr>
<tr><td class="paramname">eigenvalues_index_end</td><td>index of the last eigenvalue to compute (exclusive) </td></tr>
<tr><td class="paramname">eigenvalues_index_begin</td><td>index of the first eigenvalue to compute (has to be 1) </td></tr>
<tr><td class="paramname">eigenvalues_index_end</td><td>index of the last eigenvalue to compute (inclusive) </td></tr>
</table>
</dd>
</dl>
Expand Down Expand Up @@ -1900,8 +1900,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#aae65d8ad332e1e6db4fd43fb
<tr><td class="paramdir"></td><td class="paramname">jz</td><td>column index of the global matrix <picture><source srcset="form_0_dark.png" media="(prefers-color-scheme: dark)"/><img class="formulaInl" alt="$\mathbf{A}$" src="form_0.png"/></picture> identifying the first column of the submatrix <picture><source srcset="form_0_dark.png" media="(prefers-color-scheme: dark)"/><img class="formulaInl" alt="$\mathbf{A}$" src="form_0.png"/></picture>, has to be 1 </td></tr>
<tr><td class="paramdir"></td><td class="paramname">descz</td><td>ScaLAPACK array descriptor of the global matrix <picture><source srcset="form_1_dark.png" media="(prefers-color-scheme: dark)"/><img class="formulaInl" alt="$\mathbf{Z}$" src="form_1.png"/></picture> </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">info</td><td>0 if the eigensolver completed normally </td></tr>
<tr><td class="paramdir"></td><td class="paramname">eigenvalues_index_begin</td><td>index of the first eigenvalue to compute </td></tr>
<tr><td class="paramdir"></td><td class="paramname">eigenvalues_index_end</td><td>index of the last eigenvalue to compute (exclusive) </td></tr>
<tr><td class="paramdir"></td><td class="paramname">eigenvalues_index_begin</td><td>index of the first eigenvalue to compute (has to be 1) </td></tr>
<tr><td class="paramdir"></td><td class="paramname">eigenvalues_index_end</td><td>index of the last eigenvalue to compute (inclusive) </td></tr>
</table>
</dd>
</dl>
Expand Down Expand Up @@ -2033,8 +2033,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a476cbc590d02f361ca8560cc
<p></p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">eigenvalues_index_begin</td><td>index of the first eigenvalue to compute </td></tr>
<tr><td class="paramname">eigenvalues_index_end</td><td>index of the last eigenvalue to compute (exclusive) </td></tr>
<tr><td class="paramname">eigenvalues_index_begin</td><td>index of the first eigenvalue to compute (has to be 1) </td></tr>
<tr><td class="paramname">eigenvalues_index_end</td><td>index of the last eigenvalue to compute (inclusive) </td></tr>
</table>
</dd>
</dl>
Expand Down Expand Up @@ -2468,8 +2468,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a99985fd6b4f8d966445f1b64
<tr><td class="paramdir"></td><td class="paramname">jz</td><td>column index of the global matrix <picture><source srcset="form_0_dark.png" media="(prefers-color-scheme: dark)"/><img class="formulaInl" alt="$\mathbf{A}$" src="form_0.png"/></picture> identifying the first column of the submatrix <picture><source srcset="form_0_dark.png" media="(prefers-color-scheme: dark)"/><img class="formulaInl" alt="$\mathbf{A}$" src="form_0.png"/></picture>, has to be 1 </td></tr>
<tr><td class="paramdir"></td><td class="paramname">descz</td><td>ScaLAPACK array descriptor of the global matrix <picture><source srcset="form_1_dark.png" media="(prefers-color-scheme: dark)"/><img class="formulaInl" alt="$\mathbf{Z}$" src="form_1.png"/></picture> </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">info</td><td>0 if the eigensolver completed normally </td></tr>
<tr><td class="paramdir"></td><td class="paramname">eigenvalues_index_begin</td><td>index of the first eigenvalue to compute </td></tr>
<tr><td class="paramdir"></td><td class="paramname">eigenvalues_index_end</td><td>index of the last eigenvalue to compute (exclusive) </td></tr>
<tr><td class="paramdir"></td><td class="paramname">eigenvalues_index_begin</td><td>index of the first eigenvalue to compute (has to be 1) </td></tr>
<tr><td class="paramdir"></td><td class="paramname">eigenvalues_index_end</td><td>index of the last eigenvalue to compute (inclusive) </td></tr>
</table>
</dd>
</dl>
Expand Down Expand Up @@ -2601,8 +2601,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a73e362caf4bdda425fba3abb
<p></p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">eigenvalues_index_begin</td><td>index of the first eigenvalue to compute </td></tr>
<tr><td class="paramname">eigenvalues_index_end</td><td>index of the last eigenvalue to compute (exclusive) </td></tr>
<tr><td class="paramname">eigenvalues_index_begin</td><td>index of the first eigenvalue to compute (has to be 1) </td></tr>
<tr><td class="paramname">eigenvalues_index_end</td><td>index of the last eigenvalue to compute (inclusive) </td></tr>
</table>
</dd>
</dl>
Expand Down Expand Up @@ -3011,8 +3011,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#aafc092a4bd71187d7d90c783
<tr><td class="paramdir"></td><td class="paramname">jz</td><td>column index of the global matrix <picture><source srcset="form_0_dark.png" media="(prefers-color-scheme: dark)"/><img class="formulaInl" alt="$\mathbf{A}$" src="form_0.png"/></picture> identifying the first column of the submatrix <picture><source srcset="form_0_dark.png" media="(prefers-color-scheme: dark)"/><img class="formulaInl" alt="$\mathbf{A}$" src="form_0.png"/></picture>, has to be 1 </td></tr>
<tr><td class="paramdir"></td><td class="paramname">descz</td><td>ScaLAPACK array descriptor of the global matrix <picture><source srcset="form_1_dark.png" media="(prefers-color-scheme: dark)"/><img class="formulaInl" alt="$\mathbf{Z}$" src="form_1.png"/></picture> </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">info</td><td>0 if the eigensolver completed normally </td></tr>
<tr><td class="paramdir"></td><td class="paramname">eigenvalues_index_begin</td><td>index of the first eigenvalue to compute </td></tr>
<tr><td class="paramdir"></td><td class="paramname">eigenvalues_index_end</td><td>index of the last eigenvalue to compute (exclusive) </td></tr>
<tr><td class="paramdir"></td><td class="paramname">eigenvalues_index_begin</td><td>index of the first eigenvalue to compute (has to be 1) </td></tr>
<tr><td class="paramdir"></td><td class="paramname">eigenvalues_index_end</td><td>index of the last eigenvalue to compute (inclusive) </td></tr>
</table>
</dd>
</dl>
Expand Down Expand Up @@ -3144,8 +3144,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a5b921396ff2a2b84d8331232
<p></p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">eigenvalues_index_begin</td><td>index of the first eigenvalue to compute </td></tr>
<tr><td class="paramname">eigenvalues_index_end</td><td>index of the last eigenvalue to compute (exclusive) </td></tr>
<tr><td class="paramname">eigenvalues_index_begin</td><td>index of the first eigenvalue to compute (has to be 1) </td></tr>
<tr><td class="paramname">eigenvalues_index_end</td><td>index of the last eigenvalue to compute (inclusive) </td></tr>
</table>
</dd>
</dl>
Expand Down Expand Up @@ -3525,7 +3525,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a22c1a8ab342d0d609a8ac7ed
<dl class="section return"><dt>Returns</dt><dd>0 if the eigensolver completed normally </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">eigenvalues_index_begin</td><td>index of the first eigenvalue to compute </td></tr>
<tr><td class="paramname">eigenvalues_index_begin</td><td>index of the first eigenvalue to compute (has to be 0) </td></tr>
<tr><td class="paramname">eigenvalues_index_end</td><td>index of the last eigenvalue to compute (exclusive) </td></tr>
</table>
</dd>
Expand Down Expand Up @@ -3636,7 +3636,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a422a0681d692061ea8dc7aef
<dl class="section return"><dt>Returns</dt><dd>0 if the eigensolver completed normally </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">eigenvalues_index_begin</td><td>index of the first eigenvalue to compute </td></tr>
<tr><td class="paramname">eigenvalues_index_begin</td><td>index of the first eigenvalue to compute (has to be 0) </td></tr>
<tr><td class="paramname">eigenvalues_index_end</td><td>index of the last eigenvalue to compute (exclusive) </td></tr>
</table>
</dd>
Expand Down Expand Up @@ -3747,7 +3747,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a419908ddcd30806b80bea047
<dl class="section return"><dt>Returns</dt><dd>0 if the eigensolver completed normally </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">eigenvalues_index_begin</td><td>index of the first eigenvalue to compute </td></tr>
<tr><td class="paramname">eigenvalues_index_begin</td><td>index of the first eigenvalue to compute (has to be 0) </td></tr>
<tr><td class="paramname">eigenvalues_index_end</td><td>index of the last eigenvalue to compute (exclusive) </td></tr>
</table>
</dd>
Expand Down Expand Up @@ -3856,7 +3856,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a0a015527df363a08b77fa18e
<dl class="section return"><dt>Returns</dt><dd>0 if the eigensolver completed normally </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">eigenvalues_index_begin</td><td>index of the first eigenvalue to compute </td></tr>
<tr><td class="paramname">eigenvalues_index_begin</td><td>index of the first eigenvalue to compute (has to be 0) </td></tr>
<tr><td class="paramname">eigenvalues_index_end</td><td>index of the last eigenvalue to compute (exclusive) </td></tr>
</table>
</dd>
Expand Down
16 changes: 8 additions & 8 deletions master/dlaf__c_2eigensolver_2eigensolver_8h.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -675,8 +675,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ad517e1f3e2774fc958333717
<p></p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">eigenvalues_index_begin</td><td>index of the first eigenvalue to compute (has to be 0) </td></tr>
<tr><td class="paramname">eigenvalues_index_end</td><td>index of the last eigenvalue to compute (exclusive) </td></tr>
<tr><td class="paramname">eigenvalues_index_begin</td><td>index of the first eigenvalue to compute (has to be 1) </td></tr>
<tr><td class="paramname">eigenvalues_index_end</td><td>index of the last eigenvalue to compute (inclusive) </td></tr>
</table>
</dd>
</dl>
Expand Down Expand Up @@ -897,8 +897,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ab6550e043c8f1bb08773aa54
<p></p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">eigenvalues_index_begin</td><td>index of the first eigenvalue to compute (has to be 0) </td></tr>
<tr><td class="paramname">eigenvalues_index_end</td><td>index of the last eigenvalue to compute (exclusive) </td></tr>
<tr><td class="paramname">eigenvalues_index_begin</td><td>index of the first eigenvalue to compute (has to be 1) </td></tr>
<tr><td class="paramname">eigenvalues_index_end</td><td>index of the last eigenvalue to compute (inclusive) </td></tr>
</table>
</dd>
</dl>
Expand Down Expand Up @@ -1115,8 +1115,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a7a5f26376d69dcb095ec7051
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">eigenvalues_index_begin</td><td>index of the first eigenvalue to compute (has to be 0) </td></tr>
<tr><td class="paramname">eigenvalues_index_end</td><td>index of the last eigenvalue to compute (exclusive) </td></tr>
<tr><td class="paramname">eigenvalues_index_begin</td><td>index of the first eigenvalue to compute (has to be 1) </td></tr>
<tr><td class="paramname">eigenvalues_index_end</td><td>index of the last eigenvalue to compute (inclusive) </td></tr>
</table>
</dd>
</dl>
Expand Down Expand Up @@ -1337,8 +1337,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a39242fd1fda4a731fa4ae7cf
<p></p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">eigenvalues_index_begin</td><td>index of the first eigenvalue to compute (has to be 0) </td></tr>
<tr><td class="paramname">eigenvalues_index_end</td><td>index of the last eigenvalue to compute (exclusive) </td></tr>
<tr><td class="paramname">eigenvalues_index_begin</td><td>index of the first eigenvalue to compute (has to be 1) </td></tr>
<tr><td class="paramname">eigenvalues_index_end</td><td>index of the last eigenvalue to compute (inclusive) </td></tr>
</table>
</dd>
</dl>
Expand Down

0 comments on commit e36b58a

Please sign in to comment.