phynexis-deps/armadillo-code
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

improve docs for element access via better ordering

Browse Source
This commit is contained in:
conrad
2025-04-07 14:42:42 +10:00
parent 2456f676ec
commit 4e64c2e1b4
1 changed files with 31 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs.html
+31 -32
View File
@@ -2423,21 +2423,6 @@ An exception is thrown if the requested element is out of bounds.
</tr>
<tr>
<td style="vertical-align: top;">
<code>.at(i)</code>&nbsp;&nbsp;or&nbsp;&nbsp;<code>[i]</code>&nbsp;
</td>
<td style="vertical-align: top;"><br>
</td>
<td style="vertical-align: top;">
As for <code>(i)</code>, but without a bounds check; not recommended; see the caveats below
</td>
</tr>
<tr>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
</tr>
<tr>
<td style="vertical-align: top;">
<code>(r,c)</code>
</td>
<td style="vertical-align: top;"><br>
@@ -2454,6 +2439,37 @@ An exception is thrown if the requested element is out of bounds.
</tr>
<tr>
<td style="vertical-align: top;">
<code>(r,c,s)</code>
</td>
<td style="vertical-align: top;"><br>
</td>
<td style="vertical-align: top;">
For <i>cube</i> and <i>3D field</i> classes, access the element/object stored at row <i>r</i>, column <i>c</i>, and slice <i>s</i>.
An exception is thrown if the requested element is out of bounds.
</td>
</tr>
<tr>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
</tr>
<tr>
<td style="vertical-align: top;">
<code>.at(i)</code>&nbsp;&nbsp;or&nbsp;&nbsp;<code>[i]</code>&nbsp;
</td>
<td style="vertical-align: top;"><br>
</td>
<td style="vertical-align: top;">
As for <code>(i)</code>, but without a bounds check; not recommended; see the caveats below
</td>
</tr>
<tr>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
</tr>
<tr>
<td style="vertical-align: top;">
<code>.at(r,c)</code>
</td>
<td style="vertical-align: top;"><br>
@@ -2471,22 +2487,6 @@ As for <code>(r,c)</code>, but without a bounds check; not recommended; see the
</tr>
<tr>
<td style="vertical-align: top;">
<code>(r,c,s)</code>
</td>
<td style="vertical-align: top;"><br>
</td>
<td style="vertical-align: top;">
For <i>cube</i> and <i>3D field</i> classes, access the element/object stored at row <i>r</i>, column <i>c</i>, and slice <i>s</i>.
An exception is thrown if the requested element is out of bounds.
</td>
</tr>
<tr>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
</tr>
<tr>
<td style="vertical-align: top;">
<code>.at(r,c,s)</code>
</td>
<td style="vertical-align: top;"><br>
@@ -2550,7 +2550,6 @@ double y = v(0);
<li><a href="#iterators_mat">iterators (dense matrices)</a></li>
<li><a href="#iterators_cube">iterators (cubes)</a></li>
<li><a href="#iterators_spmat">iterators (sparse matrices)</a></li>
<li><a href="#config_hpp">config.hpp</a></li>
</ul>
</li>
<br>