devtools/eigen
1
0
Fork 0
mirror of https://gitlab.com/libeigen/eigen.git synced 2026-04-10 11:34:33 +08:00
Code Issues Packages Projects Releases Wiki Activity

Doc: add link to doc of sparse solver concept

Browse Source
This commit is contained in:
Gael Guennebaud
2015-10-08 10:50:39 +02:00
parent 131db3c552
commit 64242b8bf3
15 changed files with 77 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
doc/Doxyfile.in
View File

@@ -223,7 +223,8 @@ ALIASES = "only_for_vectors=This is only for vectors (either row-
"note_about_using_kernel_to_study_multiple_solutions=If you need a complete analysis of the space of solutions, take the one solution obtained by this method and add to it elements of the kernel, as determined by kernel()." \
"note_about_checking_solutions=This method just tries to find as good a solution as possible. If you want to check whether a solution exists or if it is accurate, just call this function to get a result and then compute the error of this result, or use MatrixBase::isApprox() directly, for instance like this: \code bool a_solution_exists = (A*result).isApprox(b, precision); \endcode This method avoids dividing by zero, so that the non-existence of a solution doesn't by itself mean that you'll get \c inf or \c nan values." \
"note_try_to_help_rvo=This function returns the result by value. In order to make that efficient, it is implemented as just a return statement using a special constructor, hopefully allowing the compiler to perform a RVO (return value optimization)." \
"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\""
"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\"" \
"implsparsesolverconcept=This class follows the \link TutorialSparseSolverConcept sparse solver concept \endlink."
ALIASES += "eigenAutoToc= "

4
doc/SparseLinearSystems.dox
View File

@@ -4,7 +4,7 @@ In Eigen, there are several methods available to solve linear systems when the c
\eigenAutoToc
\section TutorialSparseDirectSolvers Sparse solvers
\section TutorialSparseSolverList List of sparse solvers
%Eigen currently provides a limited set of built-in solvers, as well as wrappers to external solver libraries.
They are summarized in the following table:
@@ -53,6 +53,8 @@ They are summarized in the following table:
Here \c SPD means symmetric positive definite.
\section TutorialSparseSolverConcept Sparse solver concept
All these solvers follow the same general concept.
Here is a typical and general example:
\code