aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/AsciiQuickReference.txt
diff options
context:
space:
mode:
authorGravatar Gael Guennebaud <g.gael@free.fr>2018-12-05 17:17:23 +0100
committerGravatar Gael Guennebaud <g.gael@free.fr>2018-12-05 17:17:23 +0100
commitacc3459a49707c92ee96a710e05d7e18e144c780 (patch)
tree7f1b40cf2dc1da9a446e36dc029c4037e6b2503e /doc/AsciiQuickReference.txt
parente2e897298a670ea8024c8bb76894c45a9941cc1f (diff)
Add help messages in the quick ref/ascii docs regarding slicing, indexing, and reshaping.
Diffstat (limited to 'doc/AsciiQuickReference.txt')
-rw-r--r--doc/AsciiQuickReference.txt11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/AsciiQuickReference.txt b/doc/AsciiQuickReference.txt
index 0ca54cef3..18b4446c6 100644
--- a/doc/AsciiQuickReference.txt
+++ b/doc/AsciiQuickReference.txt
@@ -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