summaryrefslogtreecommitdiff
path: root/libs/geometry/doc/html/geometry/reference/enumerations/validity_failure_type.html
blob: 3473e6da4b65f9788e81230c517e30d47a00d377 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>validity_failure_type</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="../enumerations.html" title="Enumerations">
<link rel="prev" href="piece_type.html" title="piece_type">
<link rel="next" href="../exceptions.html" title="Exceptions">
</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="piece_type.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../enumerations.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="../exceptions.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="geometry.reference.enumerations.validity_failure_type"></a><a class="link" href="validity_failure_type.html" title="validity_failure_type">validity_failure_type</a>
</h4></div></div></div>
<p>
          <a class="indexterm" name="idp123388144"></a>
<a class="indexterm" name="idp123388960"></a>
<a class="indexterm" name="idp123389776"></a>
<a class="indexterm" name="idp123390592"></a>
<a class="indexterm" name="idp123391424"></a>
<a class="indexterm" name="idp123392240"></a>
<a class="indexterm" name="idp123393072"></a>
<a class="indexterm" name="idp123393888"></a>
<a class="indexterm" name="idp123394720"></a>
<a class="indexterm" name="idp123395472"></a>
<a class="indexterm" name="idp123396224"></a>
<a class="indexterm" name="idp123397056"></a>
<a class="indexterm" name="idp123397888"></a>
<a class="indexterm" name="idp123398720"></a>
Enumerates the possible validity failure types for a geometry.
        </p>
<h6>
<a name="geometry.reference.enumerations.validity_failure_type.h0"></a>
          <span class="phrase"><a name="geometry.reference.enumerations.validity_failure_type.description"></a></span><a class="link" href="validity_failure_type.html#geometry.reference.enumerations.validity_failure_type.description">Description</a>
        </h6>
<p>
          The enumeration validity_failure_type enumerates the possible reasons for
          which a geometry may be found as invalid by the is_valid algorithm. Besides
          the values that indicate invalidity, there is an additional value (no_failure)
          that indicates validity.
        </p>
<h6>
<a name="geometry.reference.enumerations.validity_failure_type.h1"></a>
          <span class="phrase"><a name="geometry.reference.enumerations.validity_failure_type.synopsis"></a></span><a class="link" href="validity_failure_type.html#geometry.reference.enumerations.validity_failure_type.synopsis">Synopsis</a>
        </h6>
<p>
</p>
<pre class="programlisting"><span class="keyword">enum</span> <span class="identifier">validity_failure_type</span>
<span class="special">{</span>
    <span class="identifier">no_failure</span> <span class="special">=</span> <span class="number">0</span><span class="special">,</span>
    <span class="identifier">failure_few_points</span> <span class="special">=</span> <span class="number">10</span><span class="special">,</span>
    <span class="identifier">failure_wrong_topological_dimension</span> <span class="special">=</span> <span class="number">11</span><span class="special">,</span>
    <span class="identifier">failure_spikes</span> <span class="special">=</span> <span class="number">12</span><span class="special">,</span>
    <span class="identifier">failure_duplicate_points</span> <span class="special">=</span> <span class="number">13</span><span class="special">,</span>
    <span class="identifier">failure_not_closed</span> <span class="special">=</span> <span class="number">20</span><span class="special">,</span>
    <span class="identifier">failure_self_intersections</span> <span class="special">=</span> <span class="number">21</span><span class="special">,</span>
    <span class="identifier">failure_wrong_orientation</span> <span class="special">=</span> <span class="number">22</span><span class="special">,</span>
    <span class="identifier">failure_interior_rings_outside</span> <span class="special">=</span> <span class="number">30</span><span class="special">,</span>
    <span class="identifier">failure_nested_interior_rings</span> <span class="special">=</span> <span class="number">31</span><span class="special">,</span>
    <span class="identifier">failure_disconnected_interior</span> <span class="special">=</span> <span class="number">32</span><span class="special">,</span>
    <span class="identifier">failure_intersecting_interiors</span> <span class="special">=</span> <span class="number">40</span><span class="special">,</span>
    <span class="identifier">failure_wrong_corner_order</span> <span class="special">=</span> <span class="number">50</span>
<span class="special">};</span></pre>
<p>
        </p>
<h6>
<a name="geometry.reference.enumerations.validity_failure_type.h2"></a>
          <span class="phrase"><a name="geometry.reference.enumerations.validity_failure_type.values"></a></span><a class="link" href="validity_failure_type.html#geometry.reference.enumerations.validity_failure_type.values">Values</a>
        </h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                  <p>
                    Value
                  </p>
                </th>
<th>
                  <p>
                    Description
                  </p>
                </th>
</tr></thead>
<tbody>
<tr>
<td>
                  <p>
                    no_failure
                  </p>
                </td>
<td>
                  <p>
                    The geometry is valid
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    failure_few_points
                  </p>
                </td>
<td>
                  <p>
                    The geometry has a very small number of points, e.g., less than
                    2 for linestrings, less than 3 for open rings, a closed multi-polygon
                    that contains a polygon with less than 4 points, etc. (applies
                    to linestrings, rings, polygons, multi-linestrings and multi-polygons)
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    failure_wrong_topological_dimension
                  </p>
                </td>
<td>
                  <p>
                    The topological dimension of the geometry is smaller than its
                    dimension, e.g., a linestring with 3 identical points, an open
                    polygon with an interior ring consisting of 3 collinear points,
                    etc. (applies to linear and areal geometries, including segments
                    and boxes)
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    failure_spikes
                  </p>
                </td>
<td>
                  <p>
                    The geometry contains spikes (applies to linear and areal geometries)
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    failure_duplicate_points
                  </p>
                </td>
<td>
                  <p>
                    The geometry has (consecutive) duplicate points (applies to areal
                    geometries only)
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    failure_not_closed
                  </p>
                </td>
<td>
                  <p>
                    The geometry is defined as closed, the starting/ending points
                    are not equal (applies to areal geometries only)
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    failure_self_intersections
                  </p>
                </td>
<td>
                  <p>
                    The geometry has invalid self-intersections. (applies to areal
                    geometries only)
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    failure_wrong_orientation
                  </p>
                </td>
<td>
                  <p>
                    The actual orientation of the geometry is different from the
                    one defined (applies to areal geometries only)
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    failure_interior_rings_outside
                  </p>
                </td>
<td>
                  <p>
                    The geometry contains interior rings that lie outside the exterior
                    ring (applies to polygons and multi-polygons only)
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    failure_nested_interior_rings
                  </p>
                </td>
<td>
                  <p>
                    The geometry has nested interior rings (applies to polygons and
                    multi-polygons only)
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    failure_disconnected_interior
                  </p>
                </td>
<td>
                  <p>
                    The interior of the geometry is disconnected (applies to polygons
                    and multi-polygons only)
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    failure_intersecting_interiors
                  </p>
                </td>
<td>
                  <p>
                    The multi-polygon contains polygons whose interiors are not disjoint
                    (applies to multi-polygons only)
                  </p>
                </td>
</tr>
<tr>
<td>
                  <p>
                    failure_wrong_corner_order
                  </p>
                </td>
<td>
                  <p>
                    The top-right corner of the box is lexicographically smaller
                    than its bottom-left corner (applies to boxes only)
                  </p>
                </td>
</tr>
</tbody>
</table></div>
<h6>
<a name="geometry.reference.enumerations.validity_failure_type.h3"></a>
          <span class="phrase"><a name="geometry.reference.enumerations.validity_failure_type.header"></a></span><a class="link" href="validity_failure_type.html#geometry.reference.enumerations.validity_failure_type.header">Header</a>
        </h6>
<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">validity_failure_type</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
        </p>
<h6>
<a name="geometry.reference.enumerations.validity_failure_type.h4"></a>
          <span class="phrase"><a name="geometry.reference.enumerations.validity_failure_type.see_also"></a></span><a class="link" href="validity_failure_type.html#geometry.reference.enumerations.validity_failure_type.see_also">See
          also</a>
        </h6>
<p>
          <a class="link" href="../algorithms/is_valid.html" title="is_valid">The is_valid algorithm
          taking a reference to validity_failure_type as second argument</a>
        </p>
</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="piece_type.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../enumerations.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="../exceptions.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>