diff options
| -rw-r--r-- | Eigen/Householder | 2 | ||||
| -rw-r--r-- | Eigen/src/Core/PermutationMatrix.h | 2 | ||||
| -rw-r--r-- | doc/C01_QuickStartGuide.dox | 2 | ||||
| -rw-r--r-- | doc/Doxyfile.in | 11 | ||||
| -rw-r--r-- | doc/I01_TopicLazyEvaluation.dox | 6 | ||||
| -rw-r--r-- | doc/Overview.dox | 2 | ||||
| -rw-r--r-- | doc/snippets/PartialPivLU_solve.cpp (renamed from doc/snippets/PartialLU_solve.cpp) | 0 |
7 files changed, 13 insertions, 12 deletions
diff --git a/Eigen/Householder b/Eigen/Householder index 98970ef0c..dcaeeeae8 100644 --- a/Eigen/Householder +++ b/Eigen/Householder @@ -8,7 +8,7 @@ namespace Eigen { /** \defgroup Householder_Module Householder module - * This module provides householder transformations. + * This module provides Householder transformations. * * \code * #include <Eigen/Householder> diff --git a/Eigen/src/Core/PermutationMatrix.h b/Eigen/src/Core/PermutationMatrix.h index 147c48734..284baf678 100644 --- a/Eigen/src/Core/PermutationMatrix.h +++ b/Eigen/src/Core/PermutationMatrix.h @@ -95,7 +95,7 @@ class PermutationMatrix : public AnyMatrixBase<PermutationMatrix<SizeAtCompileTi * array has the meaning that the permutations sends each integer i to indices[i]. * * \warning It is your responsibility to check that the indices array that you passes actually - * describes a permutation, \ie each value between 0 and n-1 occurs exactly once, where n is the + * describes a permutation, i.e., each value between 0 and n-1 occurs exactly once, where n is the * array's size. */ template<typename Other> diff --git a/doc/C01_QuickStartGuide.dox b/doc/C01_QuickStartGuide.dox index 0c545f735..7c4aa8f76 100644 --- a/doc/C01_QuickStartGuide.dox +++ b/doc/C01_QuickStartGuide.dox @@ -470,7 +470,7 @@ mat = 2 7 8 Also note that maxCoeff and minCoeff can takes optional arguments returning the coordinates of the respective min/max coeff: \link MatrixBase::maxCoeff(int*,int*) const maxCoeff(int* i, int* j) \endlink, \link MatrixBase::minCoeff(int*,int*) const minCoeff(int* i, int* j) \endlink. -<span class="note">\b Side \b note: The all() and any() functions are especially useful in combination with coeff-wise comparison operators (\ref CwiseAll "example").</span> +<span class="note">\b Side \b note: The all() and any() functions are especially useful in combination with coeff-wise comparison operators.</span> diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index 497f7ab6c..3d79a300d 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -197,14 +197,15 @@ TAB_SIZE = 8 ALIASES = "only_for_vectors=This is only for vectors (either row-vectors or column-vectors), i.e. matrices which are known at compile-time to have either one row or one column." \ "array_module=This is defined in the %Array module. \code #include <Eigen/Array> \endcode" \ - "lu_module=This is defined in the %LU module. \code #include <Eigen/LU> \endcode" \ "cholesky_module=This is defined in the %Cholesky module. \code #include <Eigen/Cholesky> \endcode" \ - "qr_module=This is defined in the %QR module. \code #include <Eigen/QR> \endcode" \ - "jacobi_module=This is defined in the %Jacobi module. \code #include <Eigen/Jacobi> \endcode" \ - "svd_module=This is defined in the %SVD module. \code #include <Eigen/SVD> \endcode" \ + "eigenvalues_module=This is defined in the %Eigenvalues module. \code #include <Eigen/Eigenvalues> \endcode" \ "geometry_module=This is defined in the %Geometry module. \code #include <Eigen/Geometry> \endcode" \ + "householder_module=This is defined in the %Householder module. \code #include <Eigen/Householder> \endcode" \ + "jacobi_module=This is defined in the %Jacobi module. \code #include <Eigen/Jacobi> \endcode" \ "leastsquares_module=This is defined in the %LeastSquares module. \code #include <Eigen/LeastSquares> \endcode" \ - "eigenvalues_module=This is defined in the %Eigenvalues module. \code #include <Eigen/Eigenvalues> \endcode" \ + "lu_module=This is defined in the %LU module. \code #include <Eigen/LU> \endcode" \ + "qr_module=This is defined in the %QR module. \code #include <Eigen/QR> \endcode" \ + "svd_module=This is defined in the %SVD module. \code #include <Eigen/SVD> \endcode" \ "label=\bug" \ "redstar=<a href='#warningarraymodule' style='color:red;text-decoration: none;'>*</a>" \ "nonstableyet=\warning This is not considered to be part of the stable public API yet. Changes may happen in future releases. See \ref Experimental \"Experimental parts of Eigen\"" \ diff --git a/doc/I01_TopicLazyEvaluation.dox b/doc/I01_TopicLazyEvaluation.dox index f40afa06d..68fa1e2df 100644 --- a/doc/I01_TopicLazyEvaluation.dox +++ b/doc/I01_TopicLazyEvaluation.dox @@ -36,7 +36,7 @@ Here is now a more involved example: Eigen chooses lazy evaluation at every stage in that example, which is clearly the correct choice. In fact, lazy evaluation is the "default choice" and Eigen will choose it except in a few circumstances. -<b>The first circumstance</b> in which Eigen chooses immediate evaluation, is when it sees an assignment <tt>a = b;</tt> and the expression \c b has the evaluate-before-assigning \link flags flag\endlink. The most important example of such an expression is the \link Product matrix product expression\endlink. For example, when you do +<b>The first circumstance</b> in which Eigen chooses immediate evaluation, is when it sees an assignment <tt>a = b;</tt> and the expression \c b has the evaluate-before-assigning \link flags flag\endlink. The most important example of such an expression is the \link GeneralProduct matrix product expression\endlink. For example, when you do \code matrix = matrix * matrix; \endcode @@ -48,7 +48,7 @@ What if you know that the result does no alias the operand of the product and wa Here, since we know that matrix2 is not the same matrix as matrix1, we know that lazy evaluation is not dangerous, so we may force lazy evaluation. Concretely, the effect of noalias() here is to bypass the evaluate-before-assigning \link flags flag\endlink. -<b>The second circumstance</b> in which Eigen chooses immediate evaluation, is when it sees a nested expression such as <tt>a + b</tt> where \c b is already an expression having the evaluate-before-nesting \link flags flag\endlink. Again, the most important example of such an expression is the \link Product matrix product expression\endlink. For example, when you do +<b>The second circumstance</b> in which Eigen chooses immediate evaluation, is when it sees a nested expression such as <tt>a + b</tt> where \c b is already an expression having the evaluate-before-nesting \link flags flag\endlink. Again, the most important example of such an expression is the \link GeneralProduct matrix product expression\endlink. For example, when you do \code matrix1 = matrix2 + matrix3 * matrix4; \endcode @@ -62,4 +62,4 @@ Here, provided the matrices have at least 2 rows and 2 columns, each coefficienc */ -}
\ No newline at end of file +} diff --git a/doc/Overview.dox b/doc/Overview.dox index db0d9587a..78bf5f9dd 100644 --- a/doc/Overview.dox +++ b/doc/Overview.dox @@ -15,7 +15,7 @@ For a first contact with Eigen, the best place is to have a look at the \ref Tut Most of the API is available as methods in MatrixBase, so this is a good starting point for browsing. Also have a look at Matrix, as a few methods and the matrix constructors are there. Other notable classes for the Eigen API are Cwise, which contains the methods for doing certain coefficient-wise operations, and Part. -In fact, except for advanced use, the only class that you'll have to explicitly name in your program, i.e. of which you'll explicitly contruct objects, is Matrix. For instance, vectors are handled as a special case of Matrix with one column. Typedefs are provided, e.g. Vector2f is a typedef for Matrix<float, 2, 1>. Finally, you might also have look at the \ref ExampleList "the list of selected examples". +In fact, except for advanced use, the only class that you'll have to explicitly name in your program, i.e. of which you'll explicitly contruct objects, is Matrix. For instance, vectors are handled as a special case of Matrix with one column. Typedefs are provided, e.g. Vector2f is a typedef for Matrix<float, 2, 1>. Most of the other classes are just return types for MatrixBase methods. diff --git a/doc/snippets/PartialLU_solve.cpp b/doc/snippets/PartialPivLU_solve.cpp index fa3570ab8..fa3570ab8 100644 --- a/doc/snippets/PartialLU_solve.cpp +++ b/doc/snippets/PartialPivLU_solve.cpp |