Say that error_bound must be a positive number

This commit is contained in:
Andreas Fabri 2025-03-13 12:42:08 +01:00
parent b204758c4f
commit de044b50f5
1 changed files with 1 additions and 1 deletions

View File

@ -143,7 +143,7 @@ bool is_Frechet_distance_larger(const PointRange& polyline1,
/**
* \ingroup PkgFrechetDistanceFunctions
* returns an estimate of the Fréchet distance between the two polylines that is at most `error_bound`
* away from the exact Fréchet distance between the two polylines.
* away from the exact Fréchet distance between the two polylines, where `error_bound` must be a positive number.
*
* \tparam PointRange a model of the concept `RandomAccessContainer` whose value type is a `Point_d`.
* \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters"