summaryrefslogtreecommitdiff
path: root/libs/geometry/doc/reference/algorithms/is_valid_with_failure.qbk
diff options
context:
space:
mode:
Diffstat (limited to 'libs/geometry/doc/reference/algorithms/is_valid_with_failure.qbk')
-rw-r--r--libs/geometry/doc/reference/algorithms/is_valid_with_failure.qbk33
1 files changed, 33 insertions, 0 deletions
diff --git a/libs/geometry/doc/reference/algorithms/is_valid_with_failure.qbk b/libs/geometry/doc/reference/algorithms/is_valid_with_failure.qbk
new file mode 100644
index 000000000..8c6df261a
--- /dev/null
+++ b/libs/geometry/doc/reference/algorithms/is_valid_with_failure.qbk
@@ -0,0 +1,33 @@
+[/============================================================================
+ Boost.Geometry (aka GGL, Generic Geometry Library)
+
+ Copyright (c) 2015, Oracle and/or its affiliates.
+
+ Contributed and/or modified by Menelaos Karavelas, on behalf of Oracle
+
+ Licensed under the Boost Software License version 1.0.
+ http://www.boost.org/users/license.html
+=============================================================================/]
+
+[def __this_function__ is_valid]
+
+[heading_conformance_no_ogc __this_function__]
+
+[include reference/status/is_valid_status.qbk]
+
+[heading Complexity]
+Constant-time for points, segments, boxes and multi-points
+
+Linear for linestrings and multi-linestrings
+
+Linearithmic for rings
+
+Currently, worst-case quadratic for polygons and multi-polygons
+
+[heading Example]
+[is_valid_failure]
+[is_valid_failure_output]
+
+[heading See also]
+* [link geometry.reference.algorithms.is_simple is_simple]
+* [link geometry.reference.enumerations.validity_failure_type validity_failure_type]