Debian Codegraph @

src/Spatial_searching/doc/Intro_spatial_searching.h

raw
1 /* This file is part of the Gudhi Library - https://gudhi.inria.fr/ - which is released under MIT.
2 * See file LICENSE or go to https://gudhi.inria.fr/licensing/ for full license details.
3 * Author(s): Clement Jamin
4 *
5 * Copyright (C) 2016 Inria
6 *
7 * Modification(s):
8 * - YYYY/MM Author: Description of the modification
9 */
10
11 #ifndef DOC_SPATIAL_SEARCHING_INTRO_SPATIAL_SEARCHING_H_
12 #define DOC_SPATIAL_SEARCHING_INTRO_SPATIAL_SEARCHING_H_
13
14 // needs namespaces for Doxygen to link on classes
15 namespace Gudhi {
16 namespace spatial_searching {
17
18 /** \defgroup spatial_searching Spatial_searching
19 *
20 * \author Clément Jamin
21 *
22 * @{
23 *
24 * \section introduction Introduction
25 *
26 * This Gudhi component is a wrapper around
27 * <a target="_blank" href="http://doc.cgal.org/latest/Spatial_searching/index.html">CGAL dD spatial searching algorithms</a>.
28 * It provides a simplified API to perform (approximate) neighbor searches. Contrary to CGAL default behavior, the tree
29 * does not store the points themselves, but stores indices.
30 *
31 * For more details about the data structure or the algorithms, or for more advanced usages, reading
32 * <a target="_blank" href="http://doc.cgal.org/latest/Spatial_searching/index.html">CGAL documentation</a>
33 * is highly recommended.
34 *
35 * \section spatial_searching_examples Example
36 *
37 * This example generates 500 random points, then performs all-near-neighbors searches, and queries for nearest and furthest neighbors using different methods.
38 *
39 * \include example_spatial_searching.cpp
40 *
41 */
42 /** @} */ // end defgroup spatial_searching
43
44 } // namespace spatial_searching
45
46 } // namespace Gudhi
47
48 #endif // DOC_SPATIAL_SEARCHING_INTRO_SPATIAL_SEARCHING_H_