[ceph.git] / ceph / src / boost / libs / geometry / doc / reference / algorithms / comparable_distance.qbk

[/============================================================================
  Boost.Geometry (aka GGL, Generic Geometry Library)

  Copyright (c) 2009-2012 Barend Gehrels, Amsterdam, the Netherlands.
  Copyright (c) 2009-2012 Mateusz Loskot, London, UK.
  Copyright (c) 2009-2012 Bruno Lalande, Paris, France.

  Use, modification and distribution is subject to the Boost Software License,
  Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
  http://www.boost.org/LICENSE_1_0.txt)
=============================================================================/]

[def __this_function__ comparable_distance]

[heading_conformance_no_ogc __this_function__]

[heading Behaviour]
It depends on the coordinate system of the geometry's point type if there is
a strategy available which can determine (more efficient than the standard
strategy) a measure of comparable distance.

[include reference/status/distance_status.qbk]

[heading Complexity]
For point to geometry: linear

For multi-point to ring/polygon/multi-polygon: currently quadratic

For all other geometry combinations: linearithmic

[heading Example]
[comparable_distance]
[comparable_distance_output]
Commit	Line	Data
7c673cae FG	1	[/============================================================================
	2	Boost.Geometry (aka GGL, Generic Geometry Library)
	3
	4	Copyright (c) 2009-2012 Barend Gehrels, Amsterdam, the Netherlands.
	5	Copyright (c) 2009-2012 Mateusz Loskot, London, UK.
	6	Copyright (c) 2009-2012 Bruno Lalande, Paris, France.
	7
	8	Use, modification and distribution is subject to the Boost Software License,
	9	Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
	10	http://www.boost.org/LICENSE_1_0.txt)
	11	=============================================================================/]
	12
	13	[def __this_function__ comparable_distance]
	14
	15	[heading_conformance_no_ogc __this_function__]
	16
	17	[heading Behaviour]
	18	It depends on the coordinate system of the geometry's point type if there is
	19	a strategy available which can determine (more efficient than the standard
	20	strategy) a measure of comparable distance.
	21
	22	[include reference/status/distance_status.qbk]
	23
	24	[heading Complexity]
	25	For point to geometry: linear
	26
	27	For multi-point to ring/polygon/multi-polygon: currently quadratic
	28
	29	For all other geometry combinations: linearithmic
	30
	31	[heading Example]
	32	[comparable_distance]
	33	[comparable_distance_output]