songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Document class

This commit is contained in:
Andreas Fabri 2024-12-27 16:14:34 +00:00
parent 6104cce18b
commit 05667adc39
2 changed files with 16 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Frechet_distance/doc/Frechet_distance/PackageDescription.txt
View File

@ -34,6 +34,7 @@ This package provides functions for computing the Fréchet distance of polylines
- `FrechetDistanceTraits` - `FrechetDistanceTraits`
\cgalCRPSection{Classes} \cgalCRPSection{Classes}
- `CGAL::Frechet_distance::Neighbor_search`
- `CGAL::Frechet_distance_traits_2` - `CGAL::Frechet_distance_traits_2`
- `CGAL::Frechet_distance_traits_3` - `CGAL::Frechet_distance_traits_3`
- `CGAL::Frechet_distance_traits_d` - `CGAL::Frechet_distance_traits_d`

27
Frechet_distance/include/CGAL/Frechet_distance/Neighbor_search.h
View File

@ -13,8 +13,8 @@
// Andreas Fabri // Andreas Fabri
// ============================================================================= // =============================================================================
#ifndef CGAL_FRECHET_DISTANCE_NEAR_NEIGHBORS_DS_H #ifndef CGAL_FRECHET_DISTANCE_NEIGHBOR_SEARCH_H
#define CGAL_FRECHET_DISTANCE_NEAR_NEIGHBORS_DS_H #define CGAL_FRECHET_DISTANCE_NEIGHBOR_SEARCH_H
#include <CGAL/license/Frechet_distance.h> #include <CGAL/license/Frechet_distance.h>
#include <CGAL/Frechet_distance.h> #include <CGAL/Frechet_distance.h>
@ -27,13 +27,13 @@
namespace CGAL { namespace CGAL {
namespace Frechet_distance { namespace Frechet_distance {
// TODO: hide away in Frechet_distance_::internal (different naming but nvm) /*!
template <typename PointRange> * A data structure to store curves with a function that enables to find those curves which are close to a query curve.
using PointRangeKernel = typename CGAL::Kernel_traits< *
typename std::iterator_traits<typename PointRange::iterator>::value_type>:: * \tparam Traits a model of `FrechetDistanceTraits`
Kernel; // TODO: replace by CORE type for initial testing * \tparam PointRange a model of the concept `RandomAccessContainer` with `Traits::Point_d` as value type.
*/
template <class PointRange, class Traits = PointRangeKernel<PointRange>> template <class PointRange, class Traits>
class Neighbor_search class Neighbor_search
{ {
using PT = Traits; // Polyline_traits_2<Traits, double>; using PT = Traits; // Polyline_traits_2<Traits, double>;
@ -47,10 +47,13 @@ class Neighbor_search
public: public:
Neighbor_search() = default; Neighbor_search() = default;
void insert(const Polyline& curve); /*! inserts curves
*/
void insert(const Polylines& curves); void insert(const Polylines& curves);
PolylineIDs get_close_curves(const Polyline& curve, double distance); /*! returns the indices of the inserted curves that are closer than `distance` to `curve`.
*/
std::vector<std::size_t> get_close_curves(const Polyline& curve, double distance);
private: private:
Polylines curves; Polylines curves;
@ -89,4 +92,4 @@ auto Neighbor_search<PointRange, Traits>::get_close_curves(
} }
} // end of namespace CGAL } // end of namespace CGAL
#endif // CGAL_FRECHET_DISTANCE_NEAR_NEIGHBORS_DS_H #endif // CGAL_FRECHET_DISTANCE_NEIGHBOR_SEARCH_H