diff --git a/Documentation/doc/Documentation/Installation.txt b/Documentation/doc/Documentation/Installation.txt index 5f1f1cee0d1..68cc4adc3e5 100644 --- a/Documentation/doc/Documentation/Installation.txt +++ b/Documentation/doc/Documentation/Installation.txt @@ -513,7 +513,7 @@ The \sc{Eigen} web site is `http://eigen.tu \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 -kgJet_fitting_3 and the \ref PkgRidges_3 packages. +PkgJet_fitting_3 and the \ref PkgRidges_3 packages. The \sc{Lapack} web site is `http://www.netlib.org/lapack/`. diff --git a/Principal_component_analysis/doc/Principal_component_analysis/CGAL/linear_least_squares_fitting_3.h b/Principal_component_analysis/doc/Principal_component_analysis/CGAL/linear_least_squares_fitting_3.h index 414aeb67cf1..c115a235d47 100644 --- a/Principal_component_analysis/doc/Principal_component_analysis/CGAL/linear_least_squares_fitting_3.h +++ b/Principal_component_analysis/doc/Principal_component_analysis/CGAL/linear_least_squares_fitting_3.h @@ -71,7 +71,6 @@ can be omitted: if Eigen 3 (or greater) is available and implementation `Internal_diagonalize_traits` is used. - \cgalHeading{Requirements}
    diff --git a/Principal_component_analysis/doc/Principal_component_analysis/PackageDescription.txt b/Principal_component_analysis/doc/Principal_component_analysis/PackageDescription.txt index aec05605884..db46aee96ae 100644 --- a/Principal_component_analysis/doc/Principal_component_analysis/PackageDescription.txt +++ b/Principal_component_analysis/doc/Principal_component_analysis/PackageDescription.txt @@ -27,6 +27,7 @@ \cgalPkgSummaryEnd \cgalPkgShortInfoBegin \cgalPkgSince{3.2} +\cgalPkgDependsOn{\ref PkgSolverSummary} \cgalPkgBib{cgal:ap-pcad} \cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgDemo{Principal Component Analysis,pca.zip,Operations on Polygons,polygon.zip,Operations on Polyhedra,polyhedron_3.zip} diff --git a/Solver_interface/doc/Solver_interface/CGAL/Eigen_diagonalize_traits.h b/Solver_interface/doc/Solver_interface/CGAL/Eigen_diagonalize_traits.h index aee2d3363b6..78630853eac 100644 --- a/Solver_interface/doc/Solver_interface/CGAL/Eigen_diagonalize_traits.h +++ b/Solver_interface/doc/Solver_interface/CGAL/Eigen_diagonalize_traits.h @@ -13,9 +13,8 @@ available on the system. \cgalModels `DiagonalizeTraits` -`FT`: floating type - -`dim`: dimension of the matrices and vectors +\tparam FT Number type +\tparam dim Dimension of the matrices and vectors \sa http://eigen.tuxfamily.org diff --git a/Solver_interface/doc/Solver_interface/CGAL/Eigen_solver_traits.h b/Solver_interface/doc/Solver_interface/CGAL/Eigen_solver_traits.h index c758ed4ca92..b6ace272000 100644 --- a/Solver_interface/doc/Solver_interface/CGAL/Eigen_solver_traits.h +++ b/Solver_interface/doc/Solver_interface/CGAL/Eigen_solver_traits.h @@ -10,8 +10,7 @@ The version 3.1 (or greater) of \ref thirdpartyEigen "Eigen" must be available o \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 -`Eigen::BiCGSTAB` for `double`. +\tparam T A sparse solver of \ref thirdpartyEigen "Eigen". The default solver is the iterative bi-congugate gradient stabilized solver `Eigen::BiCGSTAB` for `double`. \sa `CGAL::Eigen_sparse_matrix` \sa `CGAL::Eigen_sparse_symmetric_matrix` diff --git a/Solver_interface/doc/Solver_interface/CGAL/Internal_diagonalize_traits.h b/Solver_interface/doc/Solver_interface/CGAL/Internal_diagonalize_traits.h index 44699475782..9c0cee1cff1 100644 --- a/Solver_interface/doc/Solver_interface/CGAL/Internal_diagonalize_traits.h +++ b/Solver_interface/doc/Solver_interface/CGAL/Internal_diagonalize_traits.h @@ -9,10 +9,8 @@ Matrices. \cgalModels `DiagonalizeTraits` - -`FT`: floating type - -`dim`: dimension of the matrices and vectors +\tparam FT Number type +\tparam dim Dimension of the matrices and vectors Example -------------- diff --git a/Solver_interface/doc/Solver_interface/PackageDescription.txt b/Solver_interface/doc/Solver_interface/PackageDescription.txt index c076230edfb..1fc89d13a10 100644 --- a/Solver_interface/doc/Solver_interface/PackageDescription.txt +++ b/Solver_interface/doc/Solver_interface/PackageDescription.txt @@ -25,10 +25,11 @@ ## Concepts ## +- `DiagonalizeTraits` - `SparseLinearAlgebraTraits_d` - `SparseLinearAlgebraTraitsWithFactor_d` - `SvdTraits` -- `DiagonalizeTraits` + ## Classes ## diff --git a/Solver_interface/doc/Solver_interface/dependencies b/Solver_interface/doc/Solver_interface/dependencies index 8dc4d44a8cc..5d9a51f054b 100644 --- a/Solver_interface/doc/Solver_interface/dependencies +++ b/Solver_interface/doc/Solver_interface/dependencies @@ -3,4 +3,3 @@ Kernel_23 STL_Extension Algebraic_foundations Miscellany -Jet_fitting_3 diff --git a/Solver_interface/examples/Solver_interface/sparse_solvers.cpp b/Solver_interface/examples/Solver_interface/sparse_solvers.cpp index f549a055456..a9e0ba4824b 100644 --- a/Solver_interface/examples/Solver_interface/sparse_solvers.cpp +++ b/Solver_interface/examples/Solver_interface/sparse_solvers.cpp @@ -1,6 +1,3 @@ -#include - -#include #include #include @@ -21,6 +18,8 @@ int main(void) Eigen_matrix A (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) { std::size_t x = rand () % degree; @@ -38,7 +37,8 @@ int main(void) for (std::size_t i = 0; i < degree; ++ i) A.add_coef (i, i, diag.vector()[i]); - + + // Create sparse matrix A.assemble_matrix(); Eigen_vector X (degree); diff --git a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Surface_mesh_parameterization.txt b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Surface_mesh_parameterization.txt index 4a0e711b544..b0db3a7d7d6 100644 --- a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Surface_mesh_parameterization.txt +++ b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Surface_mesh_parameterization.txt @@ -760,11 +760,6 @@ Square, circular and two-points border parameterizations are good starting point Obviously, this package would benefit of having robust algorithms 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 */ diff --git a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/examples.txt b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/examples.txt index ad452ebbd2c..0049c0118bb 100644 --- a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/examples.txt +++ b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/examples.txt @@ -1,5 +1,6 @@ -/// \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/Eigen_parameterization.cpp -/// \example Surface_mesh_parameterization/polyhedron_ex_parameterization.cpp +/*! + \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 +*/