Functions

Functions
template<class PointRange , class NamedParameters = parameters::Default_named_parameters>
bool	CGAL::is_Frechet_distance_larger (const PointRange &polyline1, const PointRange &polyline2, const double distance_bound, const NamedParameters &np=parameters::default_values())
	determines if the Frechet distance between two polylines is larger than a given distance bound.
template<class PointRange , class NamedParameters = parameters::Default_named_parameters>
std::pair< double, double >	CGAL::bounded_error_Frechet_distance (const PointRange &polyline1, const PointRange &polyline2, const double error_bound, const NamedParameters &np=parameters::default_values())
	returns an estimate of the Fréchet distance between the two polylines that is at most error_bound away from the actual Fréchet distance between the two polylines.

Function Documentation

bounded_error_Frechet_distance()

template<class PointRange , class NamedParameters = parameters::Default_named_parameters>

std::pair< double, double > CGAL::bounded_error_Frechet_distance	(	const PointRange &	polyline1,
		const PointRange &	polyline2,
		const double	error_bound,
		const NamedParameters &	np = parameters::default_values()
	)

#include <CGAL/Frechet_distance.h>

returns an estimate of the Fréchet distance between the two polylines that is at most error_bound away from the actual Fréchet distance between the two polylines.

Template Parameters

PointRange	a model of the concept RandomAccessContainer whose value type is a Point_d.
NamedParameters	a sequence of Named Parameters

Parameters

polyline1	the first polyline, defined by a sequence of consecutive points
polyline2	the second polyline, defined by a sequence of consecutive points
error_bound	a maximum bound by which the Fréchet distance estimate is allowed to deviate from the actual Fréchet distance
np	an optional sequence of Named Parameters containing the one listed below:

Optional Named Parameters

geom_traits an instance of a geometric traits class Type: a model of FrechetDistanceTraits Default: Frechet_distance_traits_2, Frechet_distance_traits_3, or Frechet_distance_traits_d, depending on the dimension of the point type deduced from the point type, using Kernel_traits. Extra: The input point type (the range's value type) must be equal to the traits' Point_d type.

Precondition

the polylines must not be empty

Returns

an interval enclosing the exact Fréchet distance, the difference between the upper and the lower bound being smaller than error_bound.

Examples

Frechet_distance/Frechet_DS_3.cpp, Frechet_distance/Frechet_distance_3.cpp, and Frechet_distance/Frechet_distance_d.cpp.

is_Frechet_distance_larger()

template<class PointRange , class NamedParameters = parameters::Default_named_parameters>

bool CGAL::is_Frechet_distance_larger	(	const PointRange &	polyline1,
		const PointRange &	polyline2,
		const double	distance_bound,
		const NamedParameters &	np = parameters::default_values()
	)

#include <CGAL/Frechet_distance.h>

determines if the Frechet distance between two polylines is larger than a given distance bound.

Template Parameters

PointRange	a model of the concept RandomAccessContainer whose value type is a Point_d
NamedParameters	a sequence of Named Parameters

Parameters

polyline1	the first polyline, defined by a sequence of consecutive points
polyline2	the second polyline, defined by a sequence of consecutive points
distance_bound	the distance to compare against
np	an optional sequence of Named Parameters containing the one listed below:

Optional Named Parameters

geom_traits an instance of a geometric traits class Type: a model of FrechetDistanceTraits Default: Frechet_distance_traits_2, Frechet_distance_traits_3, or Frechet_distance_traits_d, depending on the dimension of the point type deduced from the point type, using Kernel_traits. Extra: The input point type (the range's value type) must be equal to the traits' Point_d type.

Precondition

the polylines must not be empty

Examples

Frechet_distance/Frechet_distance_2.cpp.