diff --git a/doc/QuickReference.dox b/doc/QuickReference.dox index 70aede0b3..e657f1a7c 100644 --- a/doc/QuickReference.dox +++ b/doc/QuickReference.dox @@ -40,26 +40,22 @@ The Eigen library is divided in a Core module and several additional modules. Ea \b Recall: Eigen provides two kinds of dense objects: mathematical matrices and vectors which are both represented by the template class Matrix, and general 1D and 2D arrays represented by the template class Array: -
\code typedef Matrix MyMatrixType; typedef Array MyArrayType; \endcode -
\li \c Scalar is the scalar type of the coefficients (e.g., \c float, \c double, \c bool, \c int, etc.). \li \c RowsAtCompileTime and \c ColsAtCompileTime are the number of rows and columns of the matrix as known at compile-time or \c Dynamic. \li \c Options can be \c ColMajor or \c RowMajor, default is \c ColMajor. (see class Matrix for more options) All combinations are allowed: you can have a matrix with a fixed number of rows and a dynamic number of columns, etc. The following are all valid: -
\code Matrix // Dynamic number of columns (heap allocation) Matrix // Dynamic number of rows (heap allocation) Matrix // Fully dynamic, row major (heap allocation) Matrix // Fully fixed (static allocation) \endcode -
In most cases, you can simply use one of the convenience typedefs for \ref matrixtypedefs "matrices" and \ref arraytypedefs "arrays". Some examples: @@ -80,7 +76,6 @@ Array <=> Array4f
Conversion between the matrix and array worlds: -
\code Array44f a1, a1; Matrix4f m1, m2; @@ -91,7 +86,6 @@ m2 = a1.matrix() + m1; // and explicit conversion is required. ArrayWrapper m1a(m1); // m1a is an alias for m1.array(), they share the same coefficients MatrixWrapper a1m(a1); \endcode -
In the rest of this document we will use the following symbols to emphasize the features which are specifics to a given kind of object: \li \matrixworld linear algebra matrix and vector only @@ -459,32 +453,26 @@ mat = 2 7 8 Special versions of \link DenseBase::minCoeff(Index*,Index*) minCoeff \endlink and \link DenseBase::maxCoeff(Index*,Index*) maxCoeff \endlink: -
\code int i, j; s = vector.minCoeff(&i); // s == vector[i] s = matrix.maxCoeff(&i, &j); // s == matrix(i,j) \endcode -
Typical use cases of all() and any(): -
\code if((array1 > 0).all()) ... // if all coefficients of array1 are greater than 0 ... if((array1 < array2).any()) ... // if there exist a pair i,j such that array1(i,j) < array2(i,j) ... \endcode -
top\section QuickRef_Blocks Sub-matrices 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 mat1.row(i) = mat2.col(j); mat1.col(j1).swap(mat1.col(j2)); \endcode -
Read-write access to sub-vectors: diff --git a/doc/eigendoxy.css b/doc/eigendoxy.css index bfcbf61fb..e62958831 100644 --- a/doc/eigendoxy.css +++ b/doc/eigendoxy.css @@ -142,7 +142,7 @@ pre.fragment { padding: 4px 6px; margin: 4px 8px 4px 2px; overflow: auto; - word-wrap: break-word; + /*word-wrap: break-word;*/ font-size: 9pt; line-height: 125%; } @@ -700,14 +700,20 @@ img { border: 0; } -img.logo { +a.logo { float:right; margin:10px; +} -/* position:absolute; - border:none; - right:10px; - top:10px */ +div.fragment { + display:table; /* this allows the element to be larger than its parent */ + padding: 0pt; +} +pre.fragment { + border: 1px solid #cccccc; + + margin: 2px 0px 2px 0px ; + padding: 3px 5px 3px 5px; } /* Common style for all Eigen's tables */ @@ -872,7 +878,7 @@ table.tutorial_code td.note p.starttd { border: none; padding: 0px; } - +/* div.fragment { font-family: monospace, fixed; font-size: 95%; @@ -888,10 +894,7 @@ pre.fragment { background-color: #f5f5f5; } - -div.desired_tutorial_width { - width: 90%; -} +*/ div.eimainmenu { text-align: center;