aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/Doxyfile.in
diff options
context:
space:
mode:
authorGravatar Benoit Jacob <jacob.benoit.1@gmail.com>2009-10-29 21:11:05 -0400
committerGravatar Benoit Jacob <jacob.benoit.1@gmail.com>2009-10-29 21:11:05 -0400
commit6b48e932e9b68159d2b0cc9d0d14c4025808327c (patch)
treeb10f93514e0fea336606fd00999addc4ad63df1b /doc/Doxyfile.in
parente8dd552257f0e886ee281aa84b7094fc489608d0 (diff)
*port the Cholesky module to the new solve() API
*improve documentation
Diffstat (limited to 'doc/Doxyfile.in')
-rw-r--r--doc/Doxyfile.in2
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in
index fb00a3cc5..412831e14 100644
--- a/doc/Doxyfile.in
+++ b/doc/Doxyfile.in
@@ -218,7 +218,7 @@ ALIASES = "only_for_vectors=This is only for vectors (either row-
"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\"" \
"note_about_arbitrary_choice_of_solution=If there exists more than one solution, this method will arbitrarily choose one." \
"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 solution and then compute the error margin, or use MatrixBase::isApprox() directly, for instance like this: \code bool a_solution_exists = (A*result).isApprox(b, precision); \endcode The non-existence of a solution doesn't by itself mean that you'll get \c inf or \c nan values."
+ "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."
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
# sources only. Doxygen will then generate output that is more tailored for C.