devtools/eigen
1
0
Fork 0
mirror of https://gitlab.com/libeigen/eigen.git synced 2026-04-10 11:34:33 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fix all doxygen warnings.

Browse Source
This commit is contained in:
C. Antonio Sanchez
2025-02-15 21:10:48 -08:00
parent 88cd53774e
commit 7312765992
51 changed files with 785 additions and 2307 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
doc/TutorialSlicingIndexing.dox
View File

@@ -14,8 +14,8 @@ In particular, it supports \b slicing that consists in taking a set of rows, col
All the aforementioned operations are handled through the generic DenseBase::operator()(const RowIndices&, const ColIndices&) method.
Each argument can be:
- An integer indexing a single row or column, including symbolic indices.
- The symbol Eigen::placeholders::all representing the whole set of respective rows or columns in increasing order.
- An ArithmeticSequence as constructed by the Eigen::seq, Eigen::seqN, or Eigen::placeholders::lastN functions.
- The symbol Eigen::indexing::all representing the whole set of respective rows or columns in increasing order.
- An ArithmeticSequence as constructed by the Eigen::seq, Eigen::seqN, or Eigen::indexing::lastN functions.
- Any 1D vector/array of integers including %Eigen's vector/array, expressions, std::vector, std::array, as well as plain C arrays: `int[N]`.
More generally, it can accepts any object exposing the following two member functions:
@@ -72,12 +72,12 @@ Here are some examples for a 2D array/matrix \c A and a 1D array/vector \c v.
</tr>
<tr>
<td>%Block starting at \c i,j having \c m rows, and \c n columns</td>
<td>\code A(seqN(i,m), seqN(i,n)) \endcode</td>
<td>\code A(seqN(i,m), seqN(j,n)) \endcode</td>
<td>\code A.block(i,j,m,n) \endcode</td>
</tr>
<tr>
<td>%Block starting at \c i0,j0 and ending at \c i1,j1</td>
<td>\code A(seq(i0,i1), seq(j0,j1) \endcode</td>
<td>\code A(seq(i0,i1), seq(j0,j1)) \endcode</td>
<td>\code A.block(i0,j0,i1-i0+1,j1-j0+1) \endcode</td>
</tr>
<tr>
@@ -86,18 +86,18 @@ Here are some examples for a 2D array/matrix \c A and a 1D array/vector \c v.
<td></td>
</tr>
<tr>
<td>First \c n odd rows A</td>
<td>First \c n odd rows of A</td>
<td>\code A(seqN(1,n,2), all) \endcode</td>
<td></td>
</tr>
<tr>
<td>The last past one column</td>
<td>The second-last column</td>
<td>\code A(all, last-1) \endcode</td>
<td>\code A.col(A.cols()-2) \endcode</td>
</tr>
<tr>
<td>The middle row</td>
<td>\code A(last/2,all) \endcode</td>
<td>\code A(last/2, all) \endcode</td>
<td>\code A.row((A.rows()-1)/2) \endcode</td>
</tr>
<tr>
@@ -112,9 +112,10 @@ Here are some examples for a 2D array/matrix \c A and a 1D array/vector \c v.
</tr>
</table>
As seen in the last exemple, referencing the <i> last n </i> elements (or rows/columns) is a bit cumbersome to write.
As seen in the last example, referencing the <i> last n </i> elements (or rows/columns) is a bit cumbersome to write.
This becomes even more tricky and error prone with a non-default increment.
Here comes \link Eigen::lastN(SizeType) Eigen::lastN(size) \endlink, and \link Eigen::lastN(SizeType,IncrType) Eigen::lastN(size,incr) \endlink:
Here comes \link indexing_lastN Eigen::indexing::lastN(size) \endlink, and
\link indexing_lastN_with_incr Eigen::indexing::lastN(size,incr) \endlink:
<table class="manual">
<tr>
@@ -157,7 +158,7 @@ It is equivalent to:
\endcode
We can revisit the <i>even columns of A</i> example as follows:
\code A(all, seq(0,last,fix<2>))
\code A(all, seq(fix<0>,last,fix<2>))
\endcode
@@ -221,7 +222,7 @@ i = ind[i];
\endcode
This means you can easily build your own fancy sequence generator and pass it to `operator()`.
Here is an exemple enlarging a given matrix while padding the additional first rows and columns through repetition:
Here is an example enlarging a given matrix while padding the additional first rows and columns through repetition:
<table class="example">
<tr><th>Example:</th><th>Output:</th></tr>