diff options
| author |  Gael Guennebaud <g.gael@free.fr> | 2016-07-21 12:32:02 +0200 |
|---|---|---|
| committer | Gael Guennebaud <g.gael@free.fr> | 2016-07-21 12:32:02 +0200 |
| commit | 007edee1acb571223f36e62c9ee2e5a95c1a6bab (patch) | |
| tree | 866d2826d3993c4627d80a99fb953bab046f5c5e /doc/InplaceDecomposition.dox | |
| parent | 9b76be9d21a230fef53ceef5c20e7534bf9c13d2 (diff) | |
Add a doc page summarizing the true speed of Eigen's decompositions.
Diffstat (limited to 'doc/InplaceDecomposition.dox')
| -rw-r--r-- | doc/InplaceDecomposition.dox | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/InplaceDecomposition.dox b/doc/InplaceDecomposition.dox index fc89db4a1..639055b3f 100644 --- a/doc/InplaceDecomposition.dox +++ b/doc/InplaceDecomposition.dox @@ -3,7 +3,7 @@ namespace Eigen { /** \eigenManualPage InplaceDecomposition Inplace matrix decompositions Starting from %Eigen 3.3, the LU, Cholesky, and QR decompositions can operate \em inplace, that is, directly within the given input matrix. -This feature is especially useful when dealing with huae matrices, and or when the available memory is very limited (embedded systems). +This feature is especially useful when dealing with huge matrices, and or when the available memory is very limited (embedded systems). To this end, the respective decomposition class must be instantiated with a Ref<> matrix type, and the decomposition object must be constructed with the input matrix as argument. As an example, let us consider an inplace LU decomposition with partial pivoting. |