Commit Graph

176 Commits

Author SHA1 Message Date
Marc Glisse e5c8142bcf Merge branch 'Spatial_searching-misc-glisse-old' into Spatial_searching-misc-glisse 2017-04-29 09:46:05 +02:00
Mael Rouxel-Labbé 2d3daa5f58 Doc changes 2017-01-09 22:52:56 +01:00
Mael Rouxel-Labbé fe8f36bcac Trailing whitespace in Spatial searching 2017-01-09 17:46:47 +01:00
Mael Rouxel-Labbé e64f271451 Updated the documentation of Fuzzy Query Items 2017-01-09 17:43:53 +01:00
Marc Glisse 36af1c17f4 Let remove() take a functor as argument. 2016-10-27 23:17:42 +02:00
Marc Glisse 158c77dc8b Document invalidate_built.
And detail the interactions between insertions and removals.
2016-10-27 22:33:16 +02:00
Sébastien Loriot 96c1d4c45b remove a non needed requirement from concepts
Kernel_traits was needed for the random generator in the examples/tests
2016-10-27 09:41:44 +02:00
Marc Glisse df573404d0 Merge branch 'Spatial_searching-misc-glisse-old' into Spatial_searching-misc-glisse 2016-10-26 11:12:04 +02:00
Marc Glisse 3038832982 Handle insert-after-remove in Kd_tree.
Untested.
2016-10-26 11:02:41 +02:00
Andreas Fabri 64a901a863 Add the documentation for Kd_tree::build() and unify it with AABB_tree::build.
The latter was in a Section 'Advanced' (not \cgalAdvanced, just a \heading).
They are now both in the Section `Creation`.
2016-10-13 10:07:48 +02:00
Clement Jamin fa6ecf39be Merge branch 'Triangulation-add_regular_tri-cjamin_mglisse-old' into Triangulation-add_regular_tri-cjamin_mglisse 2016-09-09 12:55:43 +02:00
Jane Tournois 47a5606eea this commit fixes the following issue :
<<The AABB_tree<AT> internally use the spatial searching and in particular instantiates Search_traits_3 with AT. This implies according to that page that the concept AABBTraits must be a Kernel.

A clean solution is adding a new concept in Spatial searching that describes requirements of the template parameter of Search_traits_3. Then we can say that AABBTraits refines this concept. For consistency, we do the same for the template parameter of Search_traits_2.
>>
2016-08-23 16:28:50 +02:00
Clement Jamin 88b86f96f4 Add concept/model relationship 2016-07-29 12:06:01 +02:00
Marc Glisse 98c7108630 Typo Construct_squared_radius_d
The code is using Compute_* and the doc Construct_*, change the doc.
2016-07-07 18:57:32 +02:00
Clement Jamin 5e03101540 Add concept/model relationship 2016-07-06 11:06:26 +02:00
Marc Glisse d9d1c79f28 Point removal in kd-tree. 2016-04-07 16:05:21 +02:00
Philipp Möller 0a04a3a48f Use CGAL_DOC_VERSION 2016-02-11 15:37:54 +01:00
Philipp Möller 71b4e9c515 Use CGAL_FULL_VERSION in all Doxyfile.in 2015-12-17 16:33:28 +01:00
Philipp Möller 81a8f982dc Handle the easy INPUT cases
If INPUT is just PKG/doc/PKG, handle it automatically.
2015-12-10 17:00:26 +01:00
Andreas Fabri 34099dfe3a replace pair<Point,bool> wiyh optional<Point> 2015-09-26 10:42:27 +02:00
Andreas Fabri 482ea27103 Add Kd_tree.search_any_point(Point_d,FuzzyQueryItem) 2015-09-23 11:17:58 +02:00
Andreas Fabri 46b156a955 Update Spatial_searching.txt
typo (whitespace)
2015-09-09 16:29:00 +02:00
Sébastien Loriot 4494fe089f add missing typedef in the doc 2015-05-19 11:42:13 +02:00
Andreas Fabri af84e62b6c Use the Epick_d kernel in two examples, and for 4d and not 2D 2015-02-26 18:08:26 +01:00
Andreas Fabri 63945bdac9 fix links. They went into the dD kernel 2015-02-10 10:50:50 +01:00
Andreas Fabri 2cf40cafab Search_traits is not a model of RangeSearchTraits 2015-02-10 10:33:40 +01:00
Andreas Fabri d6af92ced2 cleanup in the ref manal 2015-02-10 10:02:11 +01:00
Andreas Fabri 567a557930 fix links 2015-01-29 10:04:03 +01:00
Andreas Fabri c0286ce026 Add examples to search the closest vertices of a polygonal mesh 2015-01-27 10:51:48 +01:00
Andreas Fabri d444701fa0 Add that Kd_tree::begin(0/end() is not in the insertion order 2015-01-20 10:40:10 +01:00
Andreas Fabri 275e4ba47b remove modefBegin/End 2015-01-08 15:58:36 +01:00
Andreas Fabri af3315aa5f cleanup 2015-01-08 11:36:08 +01:00
Andreas Fabri 6c38bf7f08 use \@ in a .txt file as @ is a special character for doxygen 2015-01-08 10:43:29 +01:00
Andreas Fabri cb5b17f873 chmod -x 2015-01-07 18:55:19 +01:00
Andreas Fabri 78bd64cc9c lowercase file names 2015-01-07 18:55:16 +01:00
Andreas Fabri fba3da1d78 chmod -x 2015-01-07 18:55:13 +01:00
Andreas Fabri eb6146e0dc no need for passing the vector dists through the recursive function 2015-01-07 17:44:58 +01:00
m.overtheil f375123e69 Added figure of orthogonal distance 2014-12-15 15:06:25 +01:00
m.overtheil 967053e3c7 Added example for orthogonal search with a sphere
Fixed wrong splitter in benchmark
2014-12-12 15:33:45 +01:00
m.overtheil 799de1db05 Merge branch 'Spatial_searching-final_acceleration-gf' of ssh://scm.cgal.org/var/git/cgal-gsoc into Spatial_searching-final_acceleration-gf 2014-12-11 10:09:58 +01:00
m.overtheil ffeabb441d Updated changes.html 2014-12-11 10:09:45 +01:00
Andreas Fabri d711ae3968 Add more to \modif 2014-12-11 09:54:36 +01:00
m.overtheil 6b28c7df6d Pointed out what orthogonal search is 2014-12-11 08:44:42 +01:00
m.overtheil 9eab8bccf4 Changed description of vector dists, restructured user manual 2014-12-10 10:18:48 +01:00
m.overtheil 23f87a839d Merge branch 'Spatial_searching-final_acceleration-gf' of ssh://scm.cgal.org/var/git/cgal-gsoc into Spatial_searching-final_acceleration-gf 2014-12-09 12:51:21 +01:00
m.overtheil 09878d56f0 typos in doc 2014-12-09 12:51:05 +01:00
Andreas Fabri a0ccf4aa7a Add benchmark 2014-12-09 12:43:06 +01:00
m.overtheil 0dd696c045 Added Modif's to doc 2014-12-09 11:34:15 +01:00
m.overtheil f801015712 Merge branch 'Spatial_searching-final_acceleration-gf' of ssh://scm.cgal.org/var/git/cgal-gsoc into Spatial_searching-final_acceleration-gf 2014-12-09 10:18:04 +01:00
m.overtheil bf7f340e61 Added loop to benchmark, slightly changed doc 2014-12-09 10:15:16 +01:00
Andreas Fabri c775be2506 typos in the user manual 2014-12-08 16:57:44 +01:00
m.overtheil 53aecd416f Deleted double indirection 2014-12-08 12:10:52 +01:00
m.overtheil 76cb978a13 Added Figures,benchmark and implementation History 2014-12-08 09:38:20 +01:00
Andreas Fabri df2a957fbe add illustration gfor benchmark 2014-12-05 16:28:34 +01:00
m.overtheil 7fe5f7c9ae Fixed most of the old benchmarks 2014-12-05 14:36:46 +01:00
m.overtheil 1e6b69ccd9 Added tparam to doc 2014-12-04 15:58:03 +01:00
Andreas Fabri 9c7ab7568c typos and partial switching to \tparam 2014-12-04 10:07:52 +01:00
Andreas Fabri 9650d226a1 typos and partial switching to \tparam 2014-12-04 09:52:01 +01:00
m.overtheil 88dca7f9af Typo 2014-12-03 15:09:28 +01:00
m.overtheil 17068ae8b4 Documentation 2014-12-03 14:55:20 +01:00
m.overtheil d598526bfe added dimension template argument to doc 2014-11-04 15:59:56 +01:00
Sébastien Loriot 7247e971fc fix wrong documented traits 2014-09-12 13:23:46 +02:00
Sébastien Loriot e97efd228f prevent linking 2014-07-15 14:25:21 +02:00
Eric Berberich dee9fc8235 Merge branch 'Snap_rounding_2-kd_tree_replacement-wkhan-old' into Snap_rounding_2-kd_tree_replacement-wkhan
Conflicts:
	Installation/changes.html
2014-04-09 10:11:35 +02:00
Eric Berberich 9d8a02aa46 rephrased documentation for capacity in Kd_tree 2014-03-28 14:50:18 +01:00
Waqar Khan 98e6007dd3 * Added the capacity() function to the Kd_tree.h and also added its documentation
* Added a test that checks the reserve() and capacity() function for Kd_tree
2014-03-26 18:02:04 +01:00
Eric Berberich 398613ec71 rephrased documentation of "reserve" to proposal of Sebastien 2014-03-10 12:12:59 +01:00
Waqar Khan 1c355ef42a 1. "Snap_rounding_traits_2.h" "Snap_rounding_kd_2.h" "Kd_tree.h" "snap_rounding_data.cpp", Changed the File header signature to match the templated signatures.
2. Made the required changes in the concepts i.e. in "Snap_rounding_2/doc/Snap_rounding_2/Concepts/SnapRoundingTraits_2.h"
 3. Added documentation for the reserve() method of Kd_tree
 4. Deleted the un maintained olk kd_tree package
2014-03-07 16:13:44 +01:00
Sébastien Loriot 7451a3a238 fix incorrect name 2014-02-21 15:46:56 +01:00
Sébastien Loriot 0b3c2ae383 fix a documentation bug and add static assertions
the class Search_traits_adapter must use only Lvalue_property_map since
  it uses the Cartesian_const_iterator from the base class which is usually
  simply the pointer on the double in the point. If the point returned by
  the property map is a temporaty, the iterator is invalid and its behavior
  is undefined
2014-02-21 15:36:40 +01:00
Sébastien Loriot d282ade623 use \cgalCite instead of \cite
using perl -i -pe 's/\\cite\s*{?([a-zA-Z0-9:-]+)}?/\\cgalCite{$1}/g'
2013-08-05 18:25:26 +02:00
Sébastien Loriot b2ef3b8673 Merge branch 'doc-remove_gif-local'
Successfully test in CGAL-4.3-Ic-102

This commit fixes a few issues in the doxygen documentation and in particular
the figure for the generation of latex doc.

Approved by the interim release manager

xplain why this merge is necessary,
2013-07-26 17:50:07 +02:00
Sébastien Loriot 2dfe8a3d73 workaround for a doxygen bug: remove space after /!* to avoid a verbatim env
this happens if you have an empty line or the text directly after /!*
to find them in the generated documentation, grep for "pre class=\"fragment\""
(a few of them are legitimate however)
2013-07-25 14:58:53 +02:00
Sébastien Loriot 519b301130 remove gif files from doxygen doc include path 2013-07-25 11:14:16 +02:00
Sébastien Loriot d4d9bc212b replace in the doc \R by \mathbb{R}
\R is not a valid latex command
I used: sed -i 's/\\f$\s*\\R/\\f$ \\mathbb{R}/g'
2013-07-10 17:07:43 +02:00
Sébastien Loriot 716f87d2d7 rename Hidden_type to unspecified_type and update its description 2013-06-13 18:48:58 +02:00
Ross Hemsley 4d9caf3763 Added names that were missing into the Doxyfile.in entries.
Also modified Installation/CMakeLists.txt to push the version number variable to the parent level
so that it can be accessed by the documentation
2013-05-30 17:55:43 +02:00
Philipp Möller 4d469821f7 Generated Doxyfile.in and dependencies 2013-05-30 14:13:47 +02:00
Sébastien Loriot 7e15467c72 new cgal doxygen advanced macro to put the text inside a div 2013-05-27 19:36:33 +02:00
Sébastien Loriot 7412cdb650 add all property maps concepts to ease linking to them. Update pages using them 2013-03-14 16:59:27 +01:00
Alexandros Konstantinakis-Karmis 3b1d281efb Abbreviations trigger end of \brief description
Fixes bug #15482:
https://gforge.inria.fr/tracker/index.php?func=detail&aid=15482&group_id=52&atid=13845
2013-03-13 11:58:56 +01:00
Sébastien Loriot e991fe72ad really add last missing classified reference manual pages 2013-03-13 10:57:01 +01:00
Sébastien Loriot b0bd160355 add missing back-ticks in see also 2013-01-09 19:48:41 +01:00
Andreas Fabri 42f6145233 Avoids advanced brief descriptions 2013-01-08 14:53:44 +01:00
Sébastien Loriot 318c280932 less linking 2013-01-07 19:26:50 +01:00
Sébastien Loriot 5ec28b1cf4 replacing the usage of section in user man by \cgalHeading macro call 2013-01-07 18:04:37 +01:00
Philipp Möller 75f69570dc Change the titles of mainpages to "User Manual"
This leads to a slightly odd result in the search for "User Manual",
but makes the pages themselves more consistent.
2012-12-13 14:47:09 +01:00
Sébastien Loriot 920eb63882 backporting documentation changes of master@9fcc5b57 into doxy-port-pmoeller
Conflicts:
	Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_linear_traits_2.h
	Installation/doc_tex/Installation/usage.tex
	Kernel_23/doc/Kernel_23/CGAL/Projection_traits_xy_3.h
	Mesh_2/doc/Mesh_2/Concepts/ConformingDelaunayTriangulationTraits_2.h
	Spatial_searching/doc/Spatial_searching/CGAL/Incremental_neighbor_search.h
	Spatial_searching/doc/Spatial_searching/CGAL/K_neighbor_search.h
	Spatial_searching/doc/Spatial_searching/CGAL/Orthogonal_incremental_neighbor_search.h
2012-11-23 22:54:31 +01:00
Sébastien Loriot 12f13a686c backport commit in tex file from master into doxygen 2012-11-23 19:08:44 +01:00
Andreas Fabri 5f7e44a277 small fixes 2012-11-23 14:30:41 +01:00
Andreas Fabri 72f48d7e8d Polish dD Spatial Searching 2012-11-23 13:59:31 +01:00
Sébastien Loriot bfca42081d add missing backquotes in cgalModels 2012-11-23 09:55:55 +01:00
Sébastien Loriot 834dd92263 special cases for replacing \cgalModels ::FOO by \cgalModels `FOO` 2012-11-23 09:42:09 +01:00
Sébastien Loriot ae8362b7d6 replace \cgalModels ::FOO by \cgalModels `FOO`
using:
 perl  -pi -e 's/\\cgalModels\s+::([A-Za-z0-9_:]+)\s*$/\\cgalModels `$1`\n/'
2012-11-23 09:37:53 +01:00
Sébastien Loriot 8d741d504d remove % in section name 2012-11-14 16:10:15 +01:00
Sébastien Loriot 128b02abb8 update CGAL custom doxygen macros
corresponds to a run of the script Documentation/conversion_tools/rename_macros.sh
+manual edit of doxyassist.xml and pkglist_filter.py
2012-11-14 00:31:05 +01:00
Sébastien Loriot ae159cbdf3 replace markup #, ##, ### by \section, \subsection and \subsubsection
(script replacement)
2012-11-06 22:02:15 +00:00
Philipp Möller 31a3c07418 Turn \refines :: into \refines `X` globally 2012-10-25 09:48:39 +00:00
Philipp Möller 31e9eadf8b Fix all PackageDescriptions to a newer layout 2012-10-19 15:52:31 +00:00
Andreas Fabri 376ed06365 remove todo 2012-10-05 07:45:45 +00:00