From acc3459a49707c92ee96a710e05d7e18e144c780 Mon Sep 17 00:00:00 2001
From: Gael Guennebaud <g.gael@free.fr>
Date: Wed, 5 Dec 2018 17:17:23 +0100
Subject: Add help messages in the quick ref/ascii docs regarding slicing,
 indexing, and reshaping.

---
 doc/AsciiQuickReference.txt | 11 +++++++++++
 doc/QuickReference.dox      | 11 +++++++++++
 doc/eigendoxy.css           |  7 +++++++
 3 files changed, 29 insertions(+)

(limited to 'doc')

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
diff --git a/doc/QuickReference.dox b/doc/QuickReference.dox
index 18c90a2a9..9c8e6fb4a 100644
--- a/doc/QuickReference.dox
+++ b/doc/QuickReference.dox
@@ -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
diff --git a/doc/eigendoxy.css b/doc/eigendoxy.css
index 6147c7154..6148655f3 100644
--- a/doc/eigendoxy.css
+++ b/doc/eigendoxy.css
@@ -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 ****/
 
 
-- 
cgit v1.2.3