Improving doc

This commit is contained in:
Simon Giraudot 2015-09-02 15:29:21 +02:00
parent e3ce17eb0a
commit 09f3659353
11 changed files with 19 additions and 27 deletions

View File

@ -513,7 +513,7 @@ The \sc{Eigen} web site is <A HREF="http://eigen.tuxfamily.org">`http://eigen.tu
\sc{Lapack} is a `Fortran` library for linear algebra. \sc{Lapack} is a `Fortran` library for linear algebra.
In \cgal, \sc{Lapack} is an alternative to \sc{Eigen} for singular value decomposition for the \ref In \cgal, \sc{Lapack} is an alternative to \sc{Eigen} for singular value decomposition for the \ref
kgJet_fitting_3 and the \ref PkgRidges_3 packages. PkgJet_fitting_3 and the \ref PkgRidges_3 packages.
The \sc{Lapack} web site is <A HREF="http://www.netlib.org/lapack/">`http://www.netlib.org/lapack/`</A>. The \sc{Lapack} web site is <A HREF="http://www.netlib.org/lapack/">`http://www.netlib.org/lapack/`</A>.

View File

@ -71,7 +71,6 @@ can be omitted: if Eigen 3 (or greater) is available and
implementation `Internal_diagonalize_traits` is used. implementation `Internal_diagonalize_traits` is used.
\cgalHeading{Requirements} \cgalHeading{Requirements}
<OL> <OL>

View File

@ -27,6 +27,7 @@
\cgalPkgSummaryEnd \cgalPkgSummaryEnd
\cgalPkgShortInfoBegin \cgalPkgShortInfoBegin
\cgalPkgSince{3.2} \cgalPkgSince{3.2}
\cgalPkgDependsOn{\ref PkgSolverSummary}
\cgalPkgBib{cgal:ap-pcad} \cgalPkgBib{cgal:ap-pcad}
\cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgDemo{Principal Component Analysis,pca.zip,Operations on Polygons,polygon.zip,Operations on Polyhedra,polyhedron_3.zip} \cgalPkgDemo{Principal Component Analysis,pca.zip,Operations on Polygons,polygon.zip,Operations on Polyhedra,polyhedron_3.zip}

View File

@ -13,9 +13,8 @@ available on the system.
\cgalModels `DiagonalizeTraits` \cgalModels `DiagonalizeTraits`
`FT`: floating type \tparam FT Number type
\tparam dim Dimension of the matrices and vectors
`dim`: dimension of the matrices and vectors
\sa http://eigen.tuxfamily.org \sa http://eigen.tuxfamily.org

View File

@ -10,8 +10,7 @@ The version 3.1 (or greater) of \ref thirdpartyEigen "Eigen" must be available o
\cgalModels `SparseLinearAlgebraTraitsWithFactor_d` and `NormalEquationSparseLinearAlgebraTraits_d` \cgalModels `SparseLinearAlgebraTraitsWithFactor_d` and `NormalEquationSparseLinearAlgebraTraits_d`
`T`: a sparse solver of \ref thirdpartyEigen "Eigen". The default solver is the iterative bi-congugate gradient stabilized solver \tparam T A sparse solver of \ref thirdpartyEigen "Eigen". The default solver is the iterative bi-congugate gradient stabilized solver `Eigen::BiCGSTAB` for `double`.
`Eigen::BiCGSTAB` for `double`.
\sa `CGAL::Eigen_sparse_matrix<T>` \sa `CGAL::Eigen_sparse_matrix<T>`
\sa `CGAL::Eigen_sparse_symmetric_matrix<T>` \sa `CGAL::Eigen_sparse_symmetric_matrix<T>`

View File

@ -9,10 +9,8 @@ Matrices.
\cgalModels `DiagonalizeTraits` \cgalModels `DiagonalizeTraits`
\tparam FT Number type
`FT`: floating type \tparam dim Dimension of the matrices and vectors
`dim`: dimension of the matrices and vectors
Example Example
-------------- --------------

View File

@ -25,10 +25,11 @@
## Concepts ## ## Concepts ##
- `DiagonalizeTraits`
- `SparseLinearAlgebraTraits_d` - `SparseLinearAlgebraTraits_d`
- `SparseLinearAlgebraTraitsWithFactor_d` - `SparseLinearAlgebraTraitsWithFactor_d`
- `SvdTraits` - `SvdTraits`
- `DiagonalizeTraits`
## Classes ## ## Classes ##

View File

@ -3,4 +3,3 @@ Kernel_23
STL_Extension STL_Extension
Algebraic_foundations Algebraic_foundations
Miscellany Miscellany
Jet_fitting_3

View File

@ -1,6 +1,3 @@
#include <set>
#include <CGAL/Simple_cartesian.h>
#include <CGAL/Eigen_solver_traits.h> #include <CGAL/Eigen_solver_traits.h>
#include <CGAL/Eigen_matrix.h> #include <CGAL/Eigen_matrix.h>
@ -21,6 +18,8 @@ int main(void)
Eigen_matrix A (degree); Eigen_matrix A (degree);
Eigen_vector diag (degree); Eigen_vector diag (degree);
// Randomly make some coefficients of the matrix non-zero
for (std::size_t i = 0; i < nb_nonzero_coef; ++ i) for (std::size_t i = 0; i < nb_nonzero_coef; ++ i)
{ {
std::size_t x = rand () % degree; std::size_t x = rand () % degree;
@ -38,7 +37,8 @@ int main(void)
for (std::size_t i = 0; i < degree; ++ i) for (std::size_t i = 0; i < degree; ++ i)
A.add_coef (i, i, diag.vector()[i]); A.add_coef (i, i, diag.vector()[i]);
// Create sparse matrix
A.assemble_matrix(); A.assemble_matrix();
Eigen_vector X (degree); Eigen_vector X (degree);

View File

@ -760,11 +760,6 @@ Square, circular and two-points border parameterizations are good starting point
Obviously, this package would benefit of having robust algorithms Obviously, this package would benefit of having robust algorithms
which transform arbitrary meshes into topological disks. which transform arbitrary meshes into topological disks.
\example Surface_mesh_parameterization/Simple_parameterization.cpp
\example Surface_mesh_parameterization/Mesh_cutting_parameterization.cpp
\example Surface_mesh_parameterization/Complete_parameterization_example.cpp
\example Surface_mesh_parameterization/polyhedron_ex_parameterization.cpp
*/ */
} /* namespace CGAL */ } /* namespace CGAL */

View File

@ -1,5 +1,6 @@
/// \example Surface_mesh_parameterization/Simple_parameterization.cpp /*!
/// \example Surface_mesh_parameterization/Mesh_cutting_parameterization.cpp \example Surface_mesh_parameterization/Simple_parameterization.cpp
/// \example Surface_mesh_parameterization/Complete_parameterization_example.cpp \example Surface_mesh_parameterization/Mesh_cutting_parameterization.cpp
/// \example Surface_mesh_parameterization/Eigen_parameterization.cpp \example Surface_mesh_parameterization/Complete_parameterization_example.cpp
/// \example Surface_mesh_parameterization/polyhedron_ex_parameterization.cpp \example Surface_mesh_parameterization/polyhedron_ex_parameterization.cpp
*/