mirror of https://github.com/CGAL/cgal
Address some review points
This commit is contained in:
parent
b210728610
commit
868ed01ad6
|
|
@ -4,6 +4,8 @@
|
||||||
/// \defgroup PkgFrechetDistanceFunctions Functions
|
/// \defgroup PkgFrechetDistanceFunctions Functions
|
||||||
/// \ingroup PkgFrechetDistanceRef
|
/// \ingroup PkgFrechetDistanceRef
|
||||||
|
|
||||||
|
/// \defgroup PkgFrechetDistanceTraits Traits Classes
|
||||||
|
/// \ingroup PkgFrechetDistanceRef
|
||||||
/*!
|
/*!
|
||||||
\addtogroup PkgFrechetDistanceRef
|
\addtogroup PkgFrechetDistanceRef
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -27,17 +27,19 @@ namespace CGAL
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \ingroup PkgFrechetDistanceFunctions
|
* \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 polyline1 the first polyline defined by a sequence of consecutive points
|
||||||
* \param polyline2 the second polyline defined by the sequence of consecutive points
|
* \param polyline2 the second polyline defined by a sequence of consecutive points
|
||||||
* \param distance the decision distance
|
* \param distance the distance to compare against
|
||||||
* \param traits the geometric traits object
|
* \param traits the geometric traits object
|
||||||
*
|
*
|
||||||
* \tparam Traits a model of `FrechetDistanceTraits`
|
* \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`
|
* \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>
|
template < class Traits, bool force_filtering = false, class PointRange>
|
||||||
bool is_Frechet_distance_larger(const PointRange& polyline1,
|
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
|
* approximates the Fréchet distance between two polylines up to an additive error
|
||||||
* of `precision`.
|
* of `precision`.
|
||||||
*
|
*
|
||||||
* \param polyline1 the first 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 the sequence of consecutive points
|
* \param polyline2 the second polyline defined by a sequence of consecutive points
|
||||||
* \param precision the precision of the approximation
|
* \param precision the precision of the approximation
|
||||||
* \param traits the geometric traits object
|
* \param traits the geometric traits object
|
||||||
*
|
*
|
||||||
* \tparam Traits a model of `FrechetDistanceTraits`
|
* \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`
|
* \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
|
* @return an interval enclosing the exact result, the difference between the upper and
|
||||||
* the lower bound being less than `precision`.
|
* the lower bound being less than `precision`.
|
||||||
|
|
|
||||||
|
|
@ -23,7 +23,7 @@
|
||||||
namespace CGAL
|
namespace CGAL
|
||||||
{
|
{
|
||||||
/*!
|
/*!
|
||||||
* \ingroup PkgFrechetDistanceRef
|
* \ingroup PkgFrechetDistanceTraits
|
||||||
*
|
*
|
||||||
* \cgalModels{FrechetDistanceTraits}
|
* \cgalModels{FrechetDistanceTraits}
|
||||||
* \tparam GT geometric traits class
|
* \tparam GT geometric traits class
|
||||||
|
|
|
||||||
|
|
@ -23,7 +23,7 @@
|
||||||
namespace CGAL
|
namespace CGAL
|
||||||
{
|
{
|
||||||
/*!
|
/*!
|
||||||
* \ingroup PkgFrechetDistanceRef
|
* \ingroup PkgFrechetDistanceTraits
|
||||||
*
|
*
|
||||||
* \cgalModels{FrechetDistanceTraits}
|
* \cgalModels{FrechetDistanceTraits}
|
||||||
* \tparam GT geometric traits class
|
* \tparam GT geometric traits class
|
||||||
|
|
|
||||||
|
|
@ -23,7 +23,7 @@
|
||||||
namespace CGAL
|
namespace CGAL
|
||||||
{
|
{
|
||||||
/*!
|
/*!
|
||||||
* \ingroup PkgFrechetDistanceRef
|
* \ingroup PkgFrechetDistanceTraits
|
||||||
*
|
*
|
||||||
* \cgalModels{FrechetDistanceTraits}
|
* \cgalModels{FrechetDistanceTraits}
|
||||||
* \tparam GT geometric traits class
|
* \tparam GT geometric traits class
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue