GitHub-Proxy/eigen
1
0
Fork 0
mirror of https://gitlab.com/libeigen/eigen.git synced 2025-08-03 02:30:38 +08:00
Code Issues Packages Projects Releases Wiki Activity

bug #1378: fix doc (DiagonalIndex vs Diagonal)

Browse Source 
(grafted from 22a172751e7b91f97f33ba769a2d5e1955c44280
)
This commit is contained in:
Gael Guennebaud 2017-01-21 22:09:59 +01:00
parent ce463b9fa4
commit 556c03a09d
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Eigen/src/Core/Diagonal.h
View File

@ -21,7 +21,7 @@ namespace Eigen {
* \param MatrixType the type of the object in which we are taking a sub/main/super diagonal * \param MatrixType the type of the object in which we are taking a sub/main/super diagonal
* \param DiagIndex the index of the sub/super diagonal. The default is 0 and it means the main diagonal. * \param DiagIndex the index of the sub/super diagonal. The default is 0 and it means the main diagonal.
* A positive value means a superdiagonal, a negative value means a subdiagonal. * A positive value means a superdiagonal, a negative value means a subdiagonal.
* You can also use Dynamic so the index can be set at runtime. * You can also use DynamicIndex so the index can be set at runtime.
* *
* The matrix is not required to be square. * The matrix is not required to be square.
* *