songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

document default solver+ add more space in example

This commit is contained in:
Sébastien Loriot 2012-01-20 09:28:59 +00:00
parent 062869883e
commit c70cff6454
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Surface_mesh_parameterization/doc_tex/Surface_mesh_parameterization_ref/Eigen_solver_traits.tex
View File

@ -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<T>} \\
\ccRefIdfierPage{CGAL::Eigen_sparse_symmetric_matrix<T>} \\
\ccRefIdfierPage{CGAL::Eigen_vector<T>} \\
\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<double>::EigenType EigenMatrix;
//iterative general solver
typedef CGAL::Eigen_solver_traits< Eigen::BiCGSTAB<EigenMatrix> > Iterative_general_solver;
//iterative symmetric solver
typedef CGAL::Eigen_solver_traits< Eigen::ConjugateGradient<EigenMatrix> > Iterative_symmetric_solver;
//direct symmetric solver
typedef CGAL::Eigen_solver_traits< Eigen::SimplicialCholesky<EigenMatrix> > Direct_symmetric_solver;
\end{ccExampleCode}