diff --git a/Matrix_search/doc/Matrix_search/CGAL/Dynamic_matrix.h b/Matrix_search/doc/Matrix_search/CGAL/Dynamic_matrix.h index 5b025f5feca..13b435b2f18 100644 --- a/Matrix_search/doc/Matrix_search/CGAL/Dynamic_matrix.h +++ b/Matrix_search/doc/Matrix_search/CGAL/Dynamic_matrix.h @@ -4,8 +4,6 @@ namespace CGAL { /*! \ingroup PkgMatrixSearch -\todo advanced is missing - The class `Dynamic_matrix` is an adaptor for an arbitrary matrix class `M` to provide the dynamic operations needed for monotone matrix search. diff --git a/Matrix_search/doc/Matrix_search/CGAL/Sorted_matrix_search_traits_adaptor.h b/Matrix_search/doc/Matrix_search/CGAL/Sorted_matrix_search_traits_adaptor.h index 0e41b5e88e7..3ecdc88e140 100644 --- a/Matrix_search/doc/Matrix_search/CGAL/Sorted_matrix_search_traits_adaptor.h +++ b/Matrix_search/doc/Matrix_search/CGAL/Sorted_matrix_search_traits_adaptor.h @@ -4,8 +4,6 @@ namespace CGAL { /*! \ingroup PkgMatrixSearch -\todo advanced missing - The class `Sorted_matrix_search_traits_adaptor` can be used as an adaptor to create sorted matrix search traits classes for arbitrary feasibility test and matrix classes `F` resp. `M`. diff --git a/Matrix_search/doc/Matrix_search/CGAL/monotone_matrix_search.h b/Matrix_search/doc/Matrix_search/CGAL/monotone_matrix_search.h index fe232712cef..8c422652c37 100644 --- a/Matrix_search/doc/Matrix_search/CGAL/monotone_matrix_search.h +++ b/Matrix_search/doc/Matrix_search/CGAL/monotone_matrix_search.h @@ -3,7 +3,6 @@ namespace CGAL { /*! \ingroup PkgMatrixSearch -\todo advanced missing The function `monotone_matrix_search` computes the maxima for all rows of a totally monotone matrix. diff --git a/Matrix_search/doc/Matrix_search/CGAL/sorted_matrix_search.h b/Matrix_search/doc/Matrix_search/CGAL/sorted_matrix_search.h index d5b29170d4a..c953e709572 100644 --- a/Matrix_search/doc/Matrix_search/CGAL/sorted_matrix_search.h +++ b/Matrix_search/doc/Matrix_search/CGAL/sorted_matrix_search.h @@ -3,8 +3,6 @@ namespace CGAL { /*! \ingroup PkgMatrixSearch -\todo advanced missing - The function `sorted_matrix_search` selects the smallest entry in a set of sorted matrices that fulfills a certain feasibility criterion. @@ -56,17 +54,6 @@ Frederickson and Johnson\cite fj-fkppc-83, \cite fj-gsrsm-84 and runs in the number of input matrices, \f$ k\f$ denotes the maximal dimension of any input matrix and \f$ f\f$ the time needed for one feasibility test. -### Example ### - -In the following program we build a random vector \f$ a = -(a_i)_{i = 1,\,\ldots,\,5}\f$ (elements drawn uniformly from \f$ \{ -0,\,\ldots,\,99 \}\f$) and construct a Cartesian matrix \f$ M\f$ -containing as elements all sums \f$ a_i + a_j,\: i,\,j \in -\{1,\,\ldots,\,5\}\f$. If \f$ a\f$ is sorted, \f$ M\f$ is sorted as well. So -we can apply `sorted_matrix_search` to compute the upper bound -for the maximal entry of \f$ a\f$ in \f$ M\f$. - -\cgalexample{sorted_matrix_search.cpp} \sa `SortedMatrixSearchTraits` */ diff --git a/Matrix_search/doc/Matrix_search/Concepts/BasicMatrix.h b/Matrix_search/doc/Matrix_search/Concepts/BasicMatrix.h index 16859137221..e138987d7d9 100644 --- a/Matrix_search/doc/Matrix_search/Concepts/BasicMatrix.h +++ b/Matrix_search/doc/Matrix_search/Concepts/BasicMatrix.h @@ -3,7 +3,6 @@ \ingroup PkgMatrixSearchConcepts \cgalconcept -\todo advanced missing A class `BasicMatrix` has to provide the following types and operations in order to be a model for diff --git a/Matrix_search/doc/Matrix_search/Concepts/MonotoneMatrixSearchTraits.h b/Matrix_search/doc/Matrix_search/Concepts/MonotoneMatrixSearchTraits.h index 5d61f3a78ae..e5b3d5e5de0 100644 --- a/Matrix_search/doc/Matrix_search/Concepts/MonotoneMatrixSearchTraits.h +++ b/Matrix_search/doc/Matrix_search/Concepts/MonotoneMatrixSearchTraits.h @@ -3,7 +3,6 @@ \ingroup PkgMatrixSearchConcepts \cgalconcept -\todo advanced missing The concept `MonotoneMatrixSearchTraits` is a refinement of `BasicMatrix` and defines types and operations needed to diff --git a/Matrix_search/doc/Matrix_search/Concepts/SortedMatrixSearchTraits.h b/Matrix_search/doc/Matrix_search/Concepts/SortedMatrixSearchTraits.h index 33a3ed4931f..e0781adadda 100644 --- a/Matrix_search/doc/Matrix_search/Concepts/SortedMatrixSearchTraits.h +++ b/Matrix_search/doc/Matrix_search/Concepts/SortedMatrixSearchTraits.h @@ -3,8 +3,6 @@ \ingroup PkgMatrixSearchConcepts \cgalconcept -\todo advanced missing - The concept `SortedMatrixSearchTraits` defines types and operations needed to compute the smallest entry in a set of sorted matrices that fulfills a certain feasibility criterion using the function diff --git a/Matrix_search/doc/Matrix_search/Matrix_search.txt b/Matrix_search/doc/Matrix_search/Matrix_search.txt index 652ef3e511e..bf3fdc4f864 100644 --- a/Matrix_search/doc/Matrix_search/Matrix_search.txt +++ b/Matrix_search/doc/Matrix_search/Matrix_search.txt @@ -17,6 +17,18 @@ the computation of all furthest neighbors for the vertices of a convex polygon, maximal \f$ k\f$-gons inscribed into a planar point set, and computing rectangular \f$ p\f$-centers. +## Example ## + +In the following program we build a random vector \f$ a = +(a_i)_{i = 1,\,\ldots,\,5}\f$ (elements drawn uniformly from \f$ \{ +0,\,\ldots,\,99 \}\f$) and construct a Cartesian matrix \f$ M\f$ +containing as elements all sums \f$ a_i + a_j,\: i,\,j \in +\{1,\,\ldots,\,5\}\f$. If \f$ a\f$ is sorted, \f$ M\f$ is sorted as well. So +we can apply `sorted_matrix_search` to compute the upper bound +for the maximal entry of \f$ a\f$ in \f$ M\f$. + +\cgalexample{sorted_matrix_search.cpp} + */ } /* namespace CGAL */