Imported Upstream version 1.57.0
[platform/upstream/boost.git] / libs / geometry / doc / html / geometry / reference / algorithms / within / within_2.html
index 71b0f31..6df2244 100644 (file)
@@ -3,7 +3,7 @@
 <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.76.1">
+<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">
 <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="id912923"></a>
+            <a class="indexterm" name="idp121480240"></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><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>
+            <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
@@ -40,7 +40,7 @@ Checks if the first geometry is completely inside the second geometry.
           </p>
 <h6>
 <a name="geometry.reference.algorithms.within.within_2.h1"></a>
-            <span><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>
+            <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>
@@ -50,7 +50,7 @@ Checks if the first geometry is completely inside the second geometry.
           </p>
 <h6>
 <a name="geometry.reference.algorithms.within.within_2.h2"></a>
-            <span><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>
+            <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>
@@ -132,20 +132,20 @@ Checks if the first geometry is completely inside the second geometry.
 </table></div>
 <h6>
 <a name="geometry.reference.algorithms.within.within_2.h3"></a>
-            <span><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>
+            <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><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>
+            <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">geometry</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
+            <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
@@ -155,7 +155,7 @@ Checks if the first geometry is completely inside the second geometry.
           </p>
 <h6>
 <a name="geometry.reference.algorithms.within.within_2.h5"></a>
-            <span><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>
+            <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
@@ -173,7 +173,7 @@ Checks if the first geometry is completely inside the second geometry.
 </table></div>
 <h6>
 <a name="geometry.reference.algorithms.within.within_2.h6"></a>
-            <span><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
+            <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">
@@ -188,6 +188,7 @@ Checks if the first geometry is completely inside the second geometry.
 <col>
 <col>
 <col>
+<col>
 </colgroup>
 <thead><tr>
 <th>
@@ -237,6 +238,11 @@ Checks if the first geometry is completely inside the second geometry.
                       MultiPolygon
                     </p>
                   </th>
+<th>
+                    <p>
+                      Variant
+                    </p>
+                  </th>
 </tr></thead>
 <tbody>
 <tr>
@@ -247,6 +253,11 @@ Checks if the first geometry is completely inside the second geometry.
                   </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>
@@ -299,6 +310,11 @@ Checks if the first geometry is completely inside the second geometry.
                   </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>
@@ -394,6 +410,11 @@ Checks if the first geometry is completely inside the second geometry.
                       <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>
@@ -403,7 +424,7 @@ Checks if the first geometry is completely inside the second geometry.
                   </td>
 <td>
                     <p>
-                      <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
+                      <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
                     </p>
                   </td>
 <td>
@@ -418,7 +439,7 @@ Checks if the first geometry is completely inside the second geometry.
                   </td>
 <td>
                     <p>
-                      <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
+                      <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
                     </p>
                   </td>
 <td>
@@ -438,6 +459,11 @@ Checks if the first geometry is completely inside the second geometry.
                   </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>
@@ -470,17 +496,17 @@ Checks if the first geometry is completely inside the second geometry.
                   </td>
 <td>
                     <p>
-                      <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
+                      <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>
+                      <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>
+                      <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
                     </p>
                   </td>
 <td>
@@ -490,12 +516,17 @@ Checks if the first geometry is completely inside the second geometry.
                   </td>
 <td>
                     <p>
-                      <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
+                      <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>
+                      <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>
@@ -522,17 +553,17 @@ Checks if the first geometry is completely inside the second geometry.
                   </td>
 <td>
                     <p>
-                      <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
+                      <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>
+                      <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>
+                      <span class="inlinemediaobject"><img src="../../../../img/ok.png" alt="ok"></span>
                     </p>
                   </td>
 <td>
@@ -542,12 +573,17 @@ Checks if the first geometry is completely inside the second geometry.
                   </td>
 <td>
                     <p>
-                      <span class="inlinemediaobject"><img src="../../../../img/nyi.png" alt="nyi"></span>
+                      <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>
+                      <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>
@@ -559,6 +595,11 @@ Checks if the first geometry is completely inside the second geometry.
                   </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>
@@ -611,6 +652,11 @@ Checks if the first geometry is completely inside the second geometry.
                   </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>
@@ -621,6 +667,11 @@ Checks if the first geometry is completely inside the second geometry.
                   </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>
@@ -636,6 +687,11 @@ Checks if the first geometry is completely inside the second geometry.
                   </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>
@@ -644,6 +700,23 @@ Checks if the first geometry is completely inside the second geometry.
                       <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>
@@ -651,14 +724,44 @@ Checks if the first geometry is completely inside the second geometry.
                   </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>
-                      MultiPolygon
+                      Variant
                     </p>
                   </td>
 <td>
@@ -706,6 +809,11 @@ Checks if the first geometry is completely inside the second geometry.
                       <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>
@@ -722,7 +830,7 @@ Checks if the first geometry is completely inside the second geometry.
 </table></div>
 <h6>
 <a name="geometry.reference.algorithms.within.within_2.h7"></a>
-            <span><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>
+            <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
@@ -737,22 +845,22 @@ Checks if the first geometry is completely inside the second geometry.
           </p>
 <h6>
 <a name="geometry.reference.algorithms.within.within_2.h8"></a>
-            <span><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>
+            <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><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
+            <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" type="disc"><li class="listitem">
+<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><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>
+            <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
@@ -766,8 +874,6 @@ Checks if the first geometry is completely inside the second geometry.
 <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="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">io</span><span class="special">/</span><span class="identifier">wkt</span><span class="special">/</span><span class="identifier">wkt</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>
@@ -798,8 +904,8 @@ Checks if the first geometry is completely inside the second geometry.
 </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-2012 Barend
-      Gehrels, Bruno Lalande, Mateusz Loskot<p>
+<td align="right"><div class="copyright-footer">Copyright &#169; 2009-2014 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>