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

Address some review points

This commit is contained in:
Andreas Fabri 2024-12-19 16:30:29 +00:00
parent b210728610
commit 868ed01ad6
5 changed files with 19 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -4,6 +4,8 @@
/// \defgroup PkgFrechetDistanceFunctions Functions
/// \ingroup PkgFrechetDistanceRef
/// \defgroup PkgFrechetDistanceTraits Traits Classes
/// \ingroup PkgFrechetDistanceRef
/*!
\addtogroup PkgFrechetDistanceRef

24
Frechet_distance/include/CGAL/Frechet_distance.h
View File

@ -27,17 +27,19 @@ namespace CGAL
/**
* \ingroup PkgFrechetDistanceFunctions
* decides if the Frechet distance between two polylines is larger than a given distance.
* determines if the Frechet distance between two polylines is larger than a given distance.
*
* \param polyline1 the first polyline defined by the sequence of consecutive points
* \param polyline2 the second polyline defined by the sequence of consecutive points
* \param distance the decision distance
* \param polyline1 the first polyline defined by a sequence of consecutive points
* \param polyline2 the second polyline defined by a sequence of consecutive points
* \param distance the distance to compare against
* \param traits the geometric traits object
*
* \tparam Traits a model of `FrechetDistanceTraits`
* \tparam force_filtering if `true` interval arithmetic combined with exact rational will be used internally
* \tparam force_filtering if `true`, interval arithmetic combined with exact rational will be used internally
* \tparam PointRange a model of the concept `RandomAccessContainer`
* with `Traits::Point` as value type.
* with `Traits::Point_d` as value type.
*
* \pre the polylines must not be empty
*/
template < class Traits, bool force_filtering = false, class PointRange>
bool is_Frechet_distance_larger(const PointRange& polyline1,
@ -63,15 +65,17 @@ bool is_Frechet_distance_larger(const PointRange& polyline1,
* approximates the Fréchet distance between two polylines up to an additive error
* of `precision`.
*
* \param polyline1 the first polyline defined by the sequence of consecutive points
* \param polyline2 the second polyline defined by the sequence of consecutive points
* \param polyline1 the first polyline defined by a sequence of consecutive points
* \param polyline2 the second polyline defined by a sequence of consecutive points
* \param precision the precision of the approximation
* \param traits the geometric traits object
*
* \tparam Traits a model of `FrechetDistanceTraits`
* \tparam force_filtering if `true` interval arithmetic combined with exact rational will be used internally
* \tparam force_filtering if `true`, interval arithmetic combined with exact rational will be used internally
* \tparam PointRange a model of the concept `RandomAccessContainer`
* with `Traits::Point` as value type.
* with `Traits::Point_d` as value type.
*
* \pre the polylines must not be empty
*
* @return an interval enclosing the exact result, the difference between the upper and
* the lower bound being less than `precision`.

2
Frechet_distance/include/CGAL/Frechet_distance_traits_2.h
View File

@ -23,7 +23,7 @@
namespace CGAL
{
/*!
* \ingroup PkgFrechetDistanceRef
* \ingroup PkgFrechetDistanceTraits
*
* \cgalModels{FrechetDistanceTraits}
* \tparam GT geometric traits class

2
Frechet_distance/include/CGAL/Frechet_distance_traits_3.h
View File

@ -23,7 +23,7 @@
namespace CGAL
{
/*!
* \ingroup PkgFrechetDistanceRef
* \ingroup PkgFrechetDistanceTraits
*
* \cgalModels{FrechetDistanceTraits}
* \tparam GT geometric traits class

2
Frechet_distance/include/CGAL/Frechet_distance_traits_d.h
View File

@ -23,7 +23,7 @@
namespace CGAL
{
/*!
* \ingroup PkgFrechetDistanceRef
* \ingroup PkgFrechetDistanceTraits
*
* \cgalModels{FrechetDistanceTraits}
* \tparam GT geometric traits class