Commit Graph
28 Commits
Author SHA1 Message Date
Ryan CurtinandDirk Eddelbuettel e30f83c028 Document RectangleTree and RTree (#3885)
* First attempt at documenting the RectangleTree.

* Add Insert() and Delete() to RectangleTree; they have a nicer user interface than what was previously there.

* Add R-tree documentation.

* Fix default arguments for RectangleTree typedefs.

* Fix some minor documentation display issues.

* Fix link.

* Fix links.

* Try to clarify what trees are a little bit.

* Apply suggestions from code review

Co-authored-by: Dirk Eddelbuettel <edd@debian.org>

* Update doc/user/core/trees/r_tree.md

Co-authored-by: Dirk Eddelbuettel <edd@debian.org>

---------

Co-authored-by: Dirk Eddelbuettel <edd@debian.org>
2025-02-12 15:17:21 -05:00
Ryan Curtin 3c4ead453b Merge remote-tracking branch 'origin/master' into doc-rp-trees 2024-11-04 09:13:38 -05:00
Omar Shrit 67ef37e3c6 Merge pull request #3815 from rcurtin/doc-ub-tree
Document `UBTree`
2024-10-31 17:09:02 +01:00
Ryan Curtin 66bb13648d Merge remote-tracking branch 'origin/master' into doc-rp-trees 2024-10-25 10:20:38 -04:00
Martin Lambertsen 855a22f267 Modernize typedefs in docs 2024-10-25 11:20:47 +02:00
Ryan Curtin f09846cc2b Merge remote-tracking branch 'origin/master' into doc-ub-tree 2024-10-23 17:37:52 -04:00
Ryan Curtin cac046a9c1 Add links to UBTree documentation. 2024-10-21 21:26:18 -04:00
Martin Lambertsen f05ae22d60 Merge remote-tracking branch 'origin/master' into feature/modernize-type-traits 2024-10-17 06:56:56 +02:00
Ryan Curtin d545a99713 Update sidebar. 2024-10-16 15:17:37 -04:00
Martin Lambertsen 471a3daa27 Modernize STL type traits
With newer standards the readability of template heavy code can
be improved a lot by using a form with trailing _t for ::type and
_v for ::value respectively. Especially for ::type it also makes
the additional typename before the trait dispensable.

This PR combines multiple commits that modernize the traits,
starting with what clang-tidy could achieve while analyzing test files
and continuing by regex replaces with few manual corrections.

While it does not guarantee that all current occurrences are modernized,
it moves the codebase considerably into the modern direction. Note that
also before this PR both notations were used, so missing a few should
be acceptable.
2024-10-14 08:28:05 +02:00
Ryan Curtin 299a80a307 Merge remote-tracking branch 'rcurtin/doc-ball-tree' into doc-mean-split-ball-tree 2024-09-30 14:50:07 -04:00
Ryan Curtin 1bbe494936 Merge remote-tracking branch 'origin/master' into doc-mean-split-ball-tree 2024-09-30 14:49:36 -04:00
Ryan Curtin 4e654ea321 Document MeanSplitBallTree. 2024-09-30 14:48:28 -04:00
Ryan Curtin 14fe038844 Merge remote-tracking branch 'origin/master' into doc-ball-tree 2024-09-30 11:50:39 -04:00
Ryan Curtin 9d959099c2 Add documentation for BallBound and BallTree. 2024-09-25 12:47:18 -04:00
Ryan Curtin d79111f86b Update links in TreeType API documentation. 2024-09-23 17:38:26 -04:00
Ryan Curtin 62275b0571 Fix links in documentation. 2024-09-19 09:16:05 -04:00
Ryan Curtin f21ce5016d Fix minor issues in examples. 2024-09-12 19:36:09 -04:00
Ryan Curtin b963b60815 Add documentation for trees in its own file. 2024-09-12 18:33:13 -04:00
Ryan Curtin d2a470b71d First pass at documenting kd-trees. 2024-09-05 11:32:02 -04:00
Ryan Curtin cccf60d974 Move metrics to distances/ and dists to distributions/. And adapt... everything. 2024-06-14 15:14:48 -04:00
Ryan Curtin 72cf442586 Fix all broken links and handle a few other TODOs. 2024-02-26 20:13:04 -05:00
Adarsh SantoriaandRyan Curtin 58d3f1f515 Update doc/developer/trees.md
Co-authored-by: Ryan Curtin <ryan@ratml.org>
2023-02-02 01:19:07 +05:30
Adarsh SantoriaandRyan Curtin 430d071d11 Update doc/developer/trees.md
Co-authored-by: Ryan Curtin <ryan@ratml.org>
2023-02-02 01:17:45 +05:30
Adarsh Santoria 54ec3046c4 fixing typo in trees.md 2023-02-01 17:02:45 +05:30
Adarsh Santoria 0327f2edf8 fixing links in trees.md 2023-02-01 16:46:47 +05:30
Ryan Curtin e6ad5f78c0 Remove namespaces (#3269) 2022-09-21 03:40:20 +02:00
Ryan Curtin 5825287e9b Adapt tutorials to Markdown and remove Doxygen entirely. 2022-08-31 23:02:27 -04:00