[ceph.git] / ceph / src / boost / libs / geometry / doc / reference / algorithms / covered_by.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__ covered_by]

[heading_conformance_no_ogc __this_function__]
[note Both PostGIS and Oracle contain an algorithm with the same name and the 
  same functionality.
  See the [@http://www.postgis.org/docs/ST_CoveredBy.html PostGIS documentation]. 
]

[include reference/status/covered_by_status.qbk]
[note In this status matrix above: columns are types of first parameter
  and rows are types of second parameter. So a point can be checked to be 
  covered by a polygon, but not vice versa.
]

[heading Complexity]
Linear

[heading See also]
* [link geometry.reference.algorithms.within within]

[note The difference with the `within` algorithm is that this algorithm checks the
  border by default
]
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__ covered_by]
	14
	15	[heading_conformance_no_ogc __this_function__]
	16	[note Both PostGIS and Oracle contain an algorithm with the same name and the
	17	same functionality.
	18	See the [@http://www.postgis.org/docs/ST_CoveredBy.html PostGIS documentation].
	19	]
	20
	21	[include reference/status/covered_by_status.qbk]
	22	[note In this status matrix above: columns are types of first parameter
	23	and rows are types of second parameter. So a point can be checked to be
	24	covered by a polygon, but not vice versa.
	25	]
	26
	27	[heading Complexity]
	28	Linear
	29
	30	[heading See also]
	31	* [link geometry.reference.algorithms.within within]
	32
	33	[note The difference with the `within` algorithm is that this algorithm checks the
	34	border by default
	35	]