GitHub-Proxy/eigen
1
0
Fork 0
mirror of https://gitlab.com/libeigen/eigen.git synced 2025-07-21 12:24:25 +08:00
Code Issues Packages Projects Releases Wiki Activity

Typos in tutorial 1.

Browse Source
This commit is contained in:
Jitse Niesen 2009-09-05 19:46:33 +01:00
parent e4f94b8c58
commit 5eea8f1824
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/C01_QuickStartGuide.dox
View File

@ -129,7 +129,7 @@ The default constructor leaves coefficients uninitialized. Any dynamic size is s
Matrix3f A; // construct 3x3 matrix with uninitialized coefficients Matrix3f A; // construct 3x3 matrix with uninitialized coefficients
A(0,0) = 5; // OK A(0,0) = 5; // OK
MatrixXf B; // construct 0x0 matrix without allocating anything MatrixXf B; // construct 0x0 matrix without allocating anything
A(0,0) = 5; // Error, B is uninitialized, doesn't have any coefficients to address B(0,0) = 5; // Error, B is uninitialized, doesn't have any coefficients to address
\endcode \endcode
In the above example, B is an uninitialized matrix. What to do with such a matrix? You can call resize() on it, or you can assign another matrix to it. Like this: In the above example, B is an uninitialized matrix. What to do with such a matrix? You can call resize() on it, or you can assign another matrix to it. Like this:
@ -261,7 +261,7 @@ v = 6 6 6
\subsection TutorialCasting Casting \subsection TutorialCasting Casting
In Eigen, any matrices of same size and same scalar type are all naturally compatible. The scalar type can be explicitely casted to another one using the template MatrixBase::cast() function: In Eigen, any matrices of same size and same scalar type are all naturally compatible. The scalar type can be explicitly casted to another one using the template MatrixBase::cast() function:
\code \code
Matrix3d md(1,2,3); Matrix3d md(1,2,3);
Matrix3f mf = md.cast<float>(); Matrix3f mf = md.cast<float>();
@ -328,7 +328,7 @@ In short, all arithmetic operators can be used right away as in the following ex
mat4 -= mat1*1.5 + mat2 * (mat3/4); mat4 -= mat1*1.5 + mat2 * (mat3/4);
\endcode \endcode
which includes two matrix scalar products ("mat1*1.5" and "mat3/4"), a matrix-matrix product ("mat2 * (mat3/4)"), which includes two matrix scalar products ("mat1*1.5" and "mat3/4"), a matrix-matrix product ("mat2 * (mat3/4)"),
a matrix addition ("+") and substraction with assignment ("-="). a matrix addition ("+") and subtraction with assignment ("-=").
<table class="tutorial_code"> <table class="tutorial_code">
<tr><td> <tr><td>
@ -464,7 +464,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. 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 combinaison 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 (\ref CwiseAll "example").</span>
@ -578,7 +578,7 @@ vec1.normalize();\endcode
<a href="#" class="top">top</a>\section TutorialCoreTriangularMatrix Dealing with triangular matrices <a href="#" class="top">top</a>\section TutorialCoreTriangularMatrix Dealing with triangular matrices
Currently, Eigen does not provide any explcit triangular matrix, with storage class. Instead, we Currently, Eigen does not provide any explicit triangular matrix, with storage class. Instead, we
can reference a triangular part of a square matrix or expression to perform special treatment on it. can reference a triangular part of a square matrix or expression to perform special treatment on it.
This is achieved by the class TriangularView and the MatrixBase::triangularView template function. This is achieved by the class TriangularView and the MatrixBase::triangularView template function.
Note that the opposite triangular part of the matrix is never referenced, and so it can, e.g., store Note that the opposite triangular part of the matrix is never referenced, and so it can, e.g., store
@ -595,12 +595,12 @@ m.triangularView<Eigen::LowerTriangular>()
m.triangularView<Eigen::UnitLowerTriangular>()\endcode m.triangularView<Eigen::UnitLowerTriangular>()\endcode
</td></tr> </td></tr>
<tr><td> <tr><td>
Writting to a specific triangular part:\n (only the referenced triangular part is evaluated) Writing to a specific triangular part:\n (only the referenced triangular part is evaluated)
</td><td>\code </td><td>\code
m1.triangularView<Eigen::LowerTriangular>() = m2 + m3 \endcode m1.triangularView<Eigen::LowerTriangular>() = m2 + m3 \endcode
</td></tr> </td></tr>
<tr><td> <tr><td>
Convertion to a dense matrix setting the opposite triangular part to zero: Conversion to a dense matrix setting the opposite triangular part to zero:
</td><td>\code </td><td>\code
m2 = m1.triangularView<Eigen::UnitUpperTriangular>()\endcode m2 = m1.triangularView<Eigen::UnitUpperTriangular>()\endcode
</td></tr> </td></tr>