Imported Upstream version 1.72.0
[platform/upstream/boost.git] / libs / geometry / doc / html / geometry / reference / algorithms / touches / touches_1_one_geometry.html
1 <html>
2 <head>
3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>touches (one geometry)</title>
5 <link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7 <link rel="home" href="../../../../index.html" title="Chapter&#160;1.&#160;Geometry">
8 <link rel="up" href="../touches.html" title="touches">
9 <link rel="prev" href="../touches.html" title="touches">
10 <link rel="next" href="touches_2_two_geometries.html" title="touches (two geometries)">
11 </head>
12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13 <table cellpadding="2" width="100%"><tr>
14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td>
15 <td align="center"><a href="../../../../../../../../index.html">Home</a></td>
16 <td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td>
17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
19 <td align="center"><a href="../../../../../../../../more/index.htm">More</a></td>
20 </tr></table>
21 <hr>
22 <div class="spirit-nav">
23 <a accesskey="p" href="../touches.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../touches.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="touches_2_two_geometries.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
24 </div>
25 <div class="section">
26 <div class="titlepage"><div><div><h5 class="title">
27 <a name="geometry.reference.algorithms.touches.touches_1_one_geometry"></a><a class="link" href="touches_1_one_geometry.html" title="touches (one geometry)">touches
28           (one geometry)</a>
29 </h5></div></div></div>
30 <p>
31             <a class="indexterm" name="idm46186990886096"></a>
32 Checks if a geometry has at least one touching point (self-tangency)
33           </p>
34 <h6>
35 <a name="geometry.reference.algorithms.touches.touches_1_one_geometry.h0"></a>
36             <span class="phrase"><a name="geometry.reference.algorithms.touches.touches_1_one_geometry.synopsis"></a></span><a class="link" href="touches_1_one_geometry.html#geometry.reference.algorithms.touches.touches_1_one_geometry.synopsis">Synopsis</a>
37           </h6>
38 <p>
39 </p>
40 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Geometry</span><span class="special">&gt;</span>
41 <span class="keyword">bool</span> <span class="identifier">touches</span><span class="special">(</span><span class="identifier">Geometry</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">geometry</span><span class="special">)</span></pre>
42 <p>
43           </p>
44 <h6>
45 <a name="geometry.reference.algorithms.touches.touches_1_one_geometry.h1"></a>
46             <span class="phrase"><a name="geometry.reference.algorithms.touches.touches_1_one_geometry.parameters"></a></span><a class="link" href="touches_1_one_geometry.html#geometry.reference.algorithms.touches.touches_1_one_geometry.parameters">Parameters</a>
47           </h6>
48 <div class="informaltable"><table class="table">
49 <colgroup>
50 <col>
51 <col>
52 <col>
53 <col>
54 </colgroup>
55 <thead><tr>
56 <th>
57                     <p>
58                       Type
59                     </p>
60                   </th>
61 <th>
62                     <p>
63                       Concept
64                     </p>
65                   </th>
66 <th>
67                     <p>
68                       Name
69                     </p>
70                   </th>
71 <th>
72                     <p>
73                       Description
74                     </p>
75                   </th>
76 </tr></thead>
77 <tbody><tr>
78 <td>
79                     <p>
80                       Geometry const &amp;
81                     </p>
82                   </td>
83 <td>
84                     <p>
85                       Any type fulfilling a Geometry Concept
86                     </p>
87                   </td>
88 <td>
89                     <p>
90                       geometry
91                     </p>
92                   </td>
93 <td>
94                     <p>
95                       A model of the specified concept
96                     </p>
97                   </td>
98 </tr></tbody>
99 </table></div>
100 <h6>
101 <a name="geometry.reference.algorithms.touches.touches_1_one_geometry.h2"></a>
102             <span class="phrase"><a name="geometry.reference.algorithms.touches.touches_1_one_geometry.returns"></a></span><a class="link" href="touches_1_one_geometry.html#geometry.reference.algorithms.touches.touches_1_one_geometry.returns">Returns</a>
103           </h6>
104 <p>
105             Returns true if the geometry is self-touching
106           </p>
107 <h6>
108 <a name="geometry.reference.algorithms.touches.touches_1_one_geometry.h3"></a>
109             <span class="phrase"><a name="geometry.reference.algorithms.touches.touches_1_one_geometry.header"></a></span><a class="link" href="touches_1_one_geometry.html#geometry.reference.algorithms.touches.touches_1_one_geometry.header">Header</a>
110           </h6>
111 <p>
112             Either
113           </p>
114 <p>
115             <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>
116           </p>
117 <p>
118             Or
119           </p>
120 <p>
121             <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">touches</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
122           </p>
123 <h6>
124 <a name="geometry.reference.algorithms.touches.touches_1_one_geometry.h4"></a>
125             <span class="phrase"><a name="geometry.reference.algorithms.touches.touches_1_one_geometry.conformance"></a></span><a class="link" href="touches_1_one_geometry.html#geometry.reference.algorithms.touches.touches_1_one_geometry.conformance">Conformance</a>
126           </h6>
127 <p>
128             The function touches implements function Touches from the <a href="http://www.opengeospatial.org/standards/sfa" target="_top">OGC
129             Simple Feature Specification</a>.
130           </p>
131 <p>
132             The version with one parameter is additional and not described in the
133             OGC standard
134           </p>
135 <div class="note"><table border="0" summary="Note">
136 <tr>
137 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../../doc/src/images/note.png"></td>
138 <th align="left">Note</th>
139 </tr>
140 <tr><td align="left" valign="top"><p>
141               Implemented for Point/Linestring/MultiLinestring/Polygon/MultiPolygon.
142             </p></td></tr>
143 </table></div>
144 </div>
145 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
146 <td align="left"></td>
147 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2019 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam
148       Wulkiewicz, Oracle and/or its affiliates<p>
149         Distributed under the Boost Software License, Version 1.0. (See accompanying
150         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>)
151       </p>
152 </div></td>
153 </tr></table>
154 <hr>
155 <div class="spirit-nav">
156 <a accesskey="p" href="../touches.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../touches.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="touches_2_two_geometries.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
157 </div>
158 </body>
159 </html>