mirror/eigen
2
0
Fork 0
mirror of https://gitlab.com/libeigen/eigen.git synced 2025-03-31 19:00:35 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add help messages in the quick ref/ascii docs regarding slicing, indexing, and reshaping.

Browse Source
This commit is contained in:
Gael Guennebaud 2018-12-05 17:17:23 +01:00
parent e2e897298a
commit acc3459a49
3 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/AsciiQuickReference.txt
View File

@ -50,6 +50,12 @@ VectorXi::LinSpaced(((hi-low)/step)+1, // low:step:hi
// Matrix slicing and blocks. All expressions listed here are read/write.
// Templated size versions are faster. Note that Matlab is 1-based (a size N
// vector is x(1)...x(N)).
/******************************************************************************/
/* PLEASE HELP US IMPROVING THIS SECTION */
/* Eigen 3.4 supports a much improved API for sub-matrices, including, */
/* slicing and indexing from arrays: */
/* http://eigen.tuxfamily.org/dox-devel/group__TutorialSlicingIndexing.html */
/******************************************************************************/
// Eigen // Matlab
x.head(n) // x(1:n)
x.head<n>() // x(1:n)
@ -88,6 +94,11 @@ R.row(i) = P.col(j); // R(i, :) = P(:, j)
R.col(j1).swap(mat1.col(j2)); // R(:, [j1 j2]) = R(:, [j2, j1])
// Views, transpose, etc;
/******************************************************************************/
/* PLEASE HELP US IMPROVING THIS SECTION */
/* Eigen 3.4 supports a new API for reshaping: */
/* http://eigen.tuxfamily.org/dox-devel/group__TutorialReshape.html */
/******************************************************************************/
// Eigen // Matlab
R.adjoint() // R'
R.transpose() // R.' or conj(R') // Read-write

11
doc/QuickReference.dox
View File

@ -529,6 +529,12 @@ if((array1 < array2).any()) ... // if there exist a pair i,j such that array1(i,
<a href="#" class="top">top</a>\section QuickRef_Blocks Sub-matrices
<div class="warningbox">
<strong>PLEASE HELP US IMPROVING THIS SECTION.</strong>
%Eigen 3.4 supports a much improved API for sub-matrices, including,
slicing and indexing from arrays: \ref TutorialSlicingIndexing
</div>
Read-write access to a \link DenseBase::col(Index) column \endlink
or a \link DenseBase::row(Index) row \endlink of a matrix (or array):
\code
@ -584,6 +590,11 @@ Read-write access to sub-matrices:</td></tr>
<a href="#" class="top">top</a>\section QuickRef_Misc Miscellaneous operations
<div class="warningbox">
<strong>PLEASE HELP US IMPROVING THIS SECTION.</strong>
%Eigen 3.4 supports a new API for reshaping: \ref TutorialReshape
</div>
\subsection QuickRef_Reverse Reverse
Vectors, rows, and/or columns of a matrix can be reversed (see DenseBase::reverse(), DenseBase::reverseInPlace(), VectorwiseOp::reverse()).
\code

7
doc/eigendoxy.css
View File

@ -188,6 +188,13 @@ span.cpp11,span.cpp14,span.cpp17 {
font-weight: bold;
}
div.warningbox {
max-width:60em;
border-style: solid solid solid solid;
border-color: red;
border-width: 3px;
}
/**** old Eigen's styles ****/