aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/Doxyfile.in
diff options
context:
space:
mode:
authorGravatar Benoit Jacob <jacob.benoit.1@gmail.com>2009-09-22 20:58:29 -0400
committerGravatar Benoit Jacob <jacob.benoit.1@gmail.com>2009-09-22 20:58:29 -0400
commitab5cc8284aedae58885902f3764d19a8ff05f758 (patch)
treec4af7c4c5ba3801cb789c76ff875d8ad9934f9e9 /doc/Doxyfile.in
parentc1c780a94f148c618a74cfcccf40037442ae2d7c (diff)
convert LU::solve() to the new API
Diffstat (limited to 'doc/Doxyfile.in')
-rw-r--r--doc/Doxyfile.in5
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in
index 5b055ed11..b62ba3238 100644
--- a/doc/Doxyfile.in
+++ b/doc/Doxyfile.in
@@ -215,7 +215,10 @@ ALIASES = "only_for_vectors=This is only for vectors (either row-
"eigenvalues_module=This is defined in the %Eigenvalues module. \code #include <Eigen/Eigenvalues> \endcode" \
"label=\bug" \
"redstar=<a href='#warningarraymodule' style='color:red;text-decoration: none;'>*</a>" \
- "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\" \
+ "note_about_arbitrary_choice_of_solution=If there exist 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_inexistant_solutions=If only an approximate solution exists, then the result is only such an approximate solution. The case where no solution exists isn't treated separately, as that would require one to use an arbitrary threshold. If you want to check whether a solution exists, just call this function to get a solution and then compute the margin of error, or use MatrixBase::isApprox() directly, for instance like this: \code bool = a_solution_exists = (A*result).isApprox(b, precision); \endcode As long as the input matrices have finite numeric coefficients (no \c inf or \c nan values), the result will also have finite numeric coefficients, there is no risk of getting \nan values if no solution exists.""
# 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.