| Home | Libraries | People | FAQ | More

##### covered_by

Checks if the first geometry is inside or on border the second geometry.

###### Description

The free function covered_by checks if the first geometry is inside or on border the second geometry.

###### Synopsis

    template<typename Geometry1, typename Geometry2>
    bool covered_by(Geometry1 const & geometry1, Geometry2 const & geometry2)

###### Parameters

Type | Concept | Name | Description
--- | --- | --- | ---
Geometry1 const & | Any type fulfilling a Geometry Concept | geometry1 | A model of the specified concept which might be inside or on the border of the second geometry
Geometry2 const & | Any type fulfilling a Geometry Concept | geometry2 | A model of the specified concept which might cover the first geometry

###### Returns

true if geometry1 is inside of or on the border of geometry2, else false

###### Header

Either

`#include <boost/geometry/geometry.hpp>`

Or

`#include <boost/geometry/algorithms/covered_by.hpp>`

###### Conformance

The function covered_by is not defined by OGC.

| Note
Both PostGIS and Oracle contain an algorithm with the same name and the same functionality. See the PostGIS documentation.

###### Supported geometries

| Point | Segment | Box | Linestring | Ring | Polygon | MultiPoint | MultiLinestring | MultiPolygon
--- | --- | --- | --- | --- | --- | --- | --- | --- | ---
Point |  |  |  |  |  |  |  |  |
Segment |  |  |  |  |  |  |  |  |
Box |  |  |  |  |  |  |  |  |
Linestring |  |  |  |  |  |  |  |  |
Ring |  |  |  |  |  |  |  |  |
Polygon |  |  |  |  |  |  |  |  |
MultiPoint |  |  |  |  |  |  |  |  |
MultiLinestring |  |  |  |  |  |  |  |  |
MultiPolygon |  |  |  |  |  |  |  |  |

| 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.

###### Complexity

Linear

###### See also

- within

| Note
The difference with the `within` algorithm is that this algorithm checks the border by default