Google Git
Sign in
nest-open-source / nest-cam / 4320010 / boost / 62d1066a6d52d5ac4e10c106f0eab14c820be0ce / . / boost / libs / geometry / doc / html / geometry / reference / algorithms / within / within_2.html
blob: e96a7667802ac6f20571e6d9ff679186ddc87dbc [file] [log] [blame]
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>within</title>
<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="../../../../index.html" title="Chapter&#160;1.&#160;Geometry">
<link rel="up" href="../within.html" title="within">
<link rel="prev" href="../within.html" title="within">
<link rel="next" href="within_3_with_strategy.html" title="within (with strategy)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../within.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../within.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="within_3_with_strategy.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry.reference.algorithms.within.within_2"></a><a class="link" href="within_2.html" title="within">within</a>
</h5></div></div></div>
<p>
<a class="indexterm" name="idp119202896"></a>
Checks if the first geometry is completely inside the second geometry.
</p>
<h6>
<a name="geometry.reference.algorithms.within.within_2.h0"></a>
<span class="phrase"><a name="geometry.reference.algorithms.within.within_2.description"></a></span><a class="link" href="within_2.html#geometry.reference.algorithms.within.within_2.description">Description</a>
</h6>
<p>
The free function within checks if the first geometry is completely inside
the second geometry.
</p>
<h6>
<a name="geometry.reference.algorithms.within.within_2.h1"></a>
<span class="phrase"><a name="geometry.reference.algorithms.within.within_2.synopsis"></a></span><a class="link" href="within_2.html#geometry.reference.algorithms.within.within_2.synopsis">Synopsis</a>
</h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Geometry1</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Geometry2</span><span class="special">&gt;</span>
<span class="keyword">bool</span> <span class="identifier">within</span><span class="special">(</span><span class="identifier">Geometry1</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">geometry1</span><span class="special">,</span> <span class="identifier">Geometry2</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">geometry2</span><span class="special">)</span></pre>
<p>
</p>
<h6>
<a name="geometry.reference.algorithms.within.within_2.h2"></a>
<span class="phrase"><a name="geometry.reference.algorithms.within.within_2.parameters"></a></span><a class="link" href="within_2.html#geometry.reference.algorithms.within.within_2.parameters">Parameters</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Type
</p>
</th>
<th>
<p>
Concept
</p>
</th>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
Geometry1 const &amp;
</p>
</td>
<td>
<p>
Any type fulfilling a Geometry Concept
</p>
</td>
<td>
<p>
geometry1
</p>
</td>
<td>
<p>
A model of the specified concept which might be within the
second geometry
</p>
</td>
</tr>
<tr>
<td>
<p>
Geometry2 const &amp;
</p>
</td>
<td>
<p>
Any type fulfilling a Geometry Concept
</p>
</td>
<td>
<p>
geometry2
</p>
</td>
<td>
<p>
A model of the specified concept which might contain the first
geometry
</p>
</td>
</tr>
</tbody>
</table></div>
<h6>
<a name="geometry.reference.algorithms.within.within_2.h3"></a>
<span class="phrase"><a name="geometry.reference.algorithms.within.within_2.returns"></a></span><a class="link" href="within_2.html#geometry.reference.algorithms.within.within_2.returns">Returns</a>
</h6>
<p>
true if geometry1 is completely contained within geometry2, else false
</p>
<h6>
<a name="geometry.reference.algorithms.within.within_2.h4"></a>
<span class="phrase"><a name="geometry.reference.algorithms.within.within_2.header"></a></span><a class="link" href="within_2.html#geometry.reference.algorithms.within.within_2.header">Header</a>
</h6>
<p>
Either
</p>
<p>
<code class="computeroutput"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
</p>
<p>
Or
</p>
<p>
<code class="computeroutput"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">algorithms</span><span class="special">/</span><span class="identifier">within</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
</p>
<h6>
<a name="geometry.reference.algorithms.within.within_2.h5"></a>
<span class="phrase"><a name="geometry.reference.algorithms.within.within_2.conformance"></a></span><a class="link" href="within_2.html#geometry.reference.algorithms.within.within_2.conformance">Conformance</a>
</h6>
<p>
The function within implements function Within from the <a href="http://www.opengeospatial.org/standards/sfa" target="_top">OGC
Simple Feature Specification</a>.
</p>
<div class="note"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../../doc/src/images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top"><p>
OGC defines within as completely within and not on the border. See
the notes for within / on the border
</p></td></tr>
</table></div>
<h6>
<a name="geometry.reference.algorithms.within.within_2.h6"></a>
<span class="phrase"><a name="geometry.reference.algorithms.within.within_2.supported_geometries"></a></span><a class="link" href="within_2.html#geometry.reference.algorithms.within.within_2.supported_geometries">Supported
geometries</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
<col>
<col>
<col>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
</th>
<th>
<p>
Point
</p>
</th>
<th>
<p>
Segment
</p>
</th>
<th>
<p>
Box
</p>
</th>
<th>
<p>
Linestring
</p>
</th>
<th>
<p>
Ring
</p>
</th>
<th>
<p>
Polygon
</p>
</th>
<th>
<p>
MultiPoint
</p>
</th>
<th>
<p>
MultiLinestring
</p>
</th>
<th>
<p>
MultiPolygon
</p>
</th>
<th>
<p>
Variant
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
Point
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
</tr>
<tr>
<td>
<p>
Segment
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
</tr>
<tr>
<td>
<p>
Box
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
</tr>
<tr>
<td>
<p>
Linestring
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
</tr>
<tr>
<td>
<p>
Ring
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
</p>
</td>
</tr>
<tr>
<td>
<p>
Polygon
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
</p>
</td>
</tr>
<tr>
<td>
<p>
MultiPoint
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
</tr>
<tr>
<td>
<p>
MultiLinestring
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
</tr>
<tr>
<td>
<p>
MultiPolygon
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
</p>
</td>
</tr>
<tr>
<td>
<p>
Variant
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
<td>
<p>
<span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
</p>
</td>
</tr>
</tbody>
</table></div>
<div class="note"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../../doc/src/images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top"><p>
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
within a polygon, but not vice versa.
</p></td></tr>
</table></div>
<h6>
<a name="geometry.reference.algorithms.within.within_2.h7"></a>
<span class="phrase"><a name="geometry.reference.algorithms.within.within_2.notes"></a></span><a class="link" href="within_2.html#geometry.reference.algorithms.within.within_2.notes">Notes</a>
</h6>
<p>
If a point is located exactly on the border of a geometry, the result
depends on the strategy. The default strategy (<a class="link" href="../../strategies/strategy_within_winding.html" title="strategy::within::winding">Winding
(coordinate system agnostic)</a>) returns false in that case.
</p>
<p>
If a polygon has a reverse oriented (e.g. counterclockwise for a clockwise
typed polygon), the result also depends on the strategy. The default
strategy returns still true if a point is completely within the reversed
polygon. There is a specific strategy which returns false in this case.
</p>
<h6>
<a name="geometry.reference.algorithms.within.within_2.h8"></a>
<span class="phrase"><a name="geometry.reference.algorithms.within.within_2.complexity"></a></span><a class="link" href="within_2.html#geometry.reference.algorithms.within.within_2.complexity">Complexity</a>
</h6>
<p>
Linear
</p>
<h6>
<a name="geometry.reference.algorithms.within.within_2.h9"></a>
<span class="phrase"><a name="geometry.reference.algorithms.within.within_2.see_also"></a></span><a class="link" href="within_2.html#geometry.reference.algorithms.within.within_2.see_also">See
also</a>
</h6>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
<a class="link" href="../covered_by.html" title="covered_by">covered_by</a>
</li></ul></div>
<h6>
<a name="geometry.reference.algorithms.within.within_2.h10"></a>
<span class="phrase"><a name="geometry.reference.algorithms.within.within_2.example"></a></span><a class="link" href="within_2.html#geometry.reference.algorithms.within.within_2.example">Example</a>
</h6>
<p>
Shows how to detect if a point is inside a polygon, or not
</p>
<p>
</p>
<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">iostream</span><span class="special">&gt;</span>
<span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">list</span><span class="special">&gt;</span>
<span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
<span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">geometries</span><span class="special">/</span><span class="identifier">point_xy</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
<span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">geometries</span><span class="special">/</span><span class="identifier">polygon</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
<span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span>
<span class="special">{</span>
<span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">model</span><span class="special">::</span><span class="identifier">d2</span><span class="special">::</span><span class="identifier">point_xy</span><span class="special">&lt;</span><span class="keyword">double</span><span class="special">&gt;</span> <span class="identifier">point_type</span><span class="special">;</span>
<span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">model</span><span class="special">::</span><span class="identifier">polygon</span><span class="special">&lt;</span><span class="identifier">point_type</span><span class="special">&gt;</span> <span class="identifier">polygon_type</span><span class="special">;</span>
<span class="identifier">polygon_type</span> <span class="identifier">poly</span><span class="special">;</span>
<span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">read_wkt</span><span class="special">(</span>
<span class="string">"POLYGON((2 1.3,2.4 1.7,2.8 1.8,3.4 1.2,3.7 1.6,3.4 2,4.1 3,5.3 2.6,5.4 1.2,4.9 0.8,2.9 0.7,2 1.3)"</span>
<span class="string">"(4.0 2.0, 4.2 1.4, 4.8 1.9, 4.4 2.2, 4.0 2.0))"</span><span class="special">,</span> <span class="identifier">poly</span><span class="special">);</span>
<span class="identifier">point_type</span> <span class="identifier">p</span><span class="special">(</span><span class="number">4</span><span class="special">,</span> <span class="number">1</span><span class="special">);</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="string">"within: "</span> <span class="special">&lt;&lt;</span> <span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">::</span><span class="identifier">within</span><span class="special">(</span><span class="identifier">p</span><span class="special">,</span> <span class="identifier">poly</span><span class="special">)</span> <span class="special">?</span> <span class="string">"yes"</span> <span class="special">:</span> <span class="string">"no"</span><span class="special">)</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
<span class="keyword">return</span> <span class="number">0</span><span class="special">;</span>
<span class="special">}</span>
</pre>
<p>
</p>
<p>
Output:
</p>
<pre class="programlisting">within: yes
<img src="../../../../img/algorithms/within.png" alt="within">
</pre>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2009-2015 Barend Gehrels, Bruno Lalande,
Mateusz Loskot, Adam Wulkiewicz, Oracle and/or its affiliates<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../within.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../within.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="within_3_with_strategy.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>