From c70cff64547fdbd2d11bd8f4098305f28a968077 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Loriot?= Date: Fri, 20 Jan 2012 09:28:59 +0000 Subject: [PATCH] document default solver+ add more space in example --- .../Eigen_solver_traits.tex | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/Surface_mesh_parameterization/doc_tex/Surface_mesh_parameterization_ref/Eigen_solver_traits.tex b/Surface_mesh_parameterization/doc_tex/Surface_mesh_parameterization_ref/Eigen_solver_traits.tex index 50f6bc9688c..98d6ecebadb 100644 --- a/Surface_mesh_parameterization/doc_tex/Surface_mesh_parameterization_ref/Eigen_solver_traits.tex +++ b/Surface_mesh_parameterization/doc_tex/Surface_mesh_parameterization_ref/Eigen_solver_traits.tex @@ -14,7 +14,8 @@ The version 3.1 (or greater) of \eigen\ must be available on the system. \ccc{SparseLinearAlgebraTraits_d}. \ccParameters -\ccc{T}: a sparse solver of \eigen. +\ccc{T}: a sparse solver of \eigen. The default solver is the iterative bi-congugate gradient stabilized solver +\ccc{Eigen::BiCGSTAB} for \ccc{double}. \ccTypes \ccTypedef{typedef typename T::Scalar NT;}{} @@ -31,21 +32,23 @@ Returns a reference to the internal \eigen\ solver. This function can be used fo } \ccSeeAlso -\eigenpage\\ \ccRefIdfierPage{CGAL::Eigen_sparse_matrix} \\ \ccRefIdfierPage{CGAL::Eigen_sparse_symmetric_matrix} \\ \ccRefIdfierPage{CGAL::Eigen_vector} \\ +\eigenpage\\ \ccExample -The instantiation of this class assumes a \eigen\ sparse solver is provided. Here are few examples: +The instantiation of this class assumes an \eigen\ sparse solver is provided. Here are few examples: \begin{ccExampleCode} typedef CGAL::Eigen_sparse_matrix::EigenType EigenMatrix; //iterative general solver typedef CGAL::Eigen_solver_traits< Eigen::BiCGSTAB > Iterative_general_solver; + //iterative symmetric solver typedef CGAL::Eigen_solver_traits< Eigen::ConjugateGradient > Iterative_symmetric_solver; + //direct symmetric solver typedef CGAL::Eigen_solver_traits< Eigen::SimplicialCholesky > Direct_symmetric_solver; \end{ccExampleCode}