aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/Doxyfile.in
diff options
context:
space:
mode:
authorGravatar Gael Guennebaud <g.gael@free.fr>2015-10-08 10:50:39 +0200
committerGravatar Gael Guennebaud <g.gael@free.fr>2015-10-08 10:50:39 +0200
commit64242b8bf367752df4d28170cbbb6b86037ff988 (patch)
tree20d60f6db4211b7af0227058f5b5864b9a8879ec /doc/Doxyfile.in
parent131db3c552304e1fa2c9438ec71a99ef32eea54e (diff)
Doc: add link to doc of sparse solver concept
Diffstat (limited to 'doc/Doxyfile.in')
-rw-r--r--doc/Doxyfile.in3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in
index 800bb30ee..e15ba84bd 100644
--- a/doc/Doxyfile.in
+++ b/doc/Doxyfile.in
@@ -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= "