1[/============================================================================ 2 Boost.Geometry (aka GGL, Generic Geometry Library) 3 4 Copyright (c) 2007-2013 Barend Gehrels, Amsterdam, the Netherlands. 5 Copyright (c) 2008-2013 Bruno Lalande, Paris, France. 6 Copyright (c) 2009-2013 Mateusz Loskot, London, UK. 7 8 Use, modification and distribution is subject to the Boost Software License, 9 Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at 10 http://www.boost.org/LICENSE_1_0.txt) 11=============================================================================/] 12 13 14[/ Generated by doxygen_xml2qbk 1.1.1, don't change, will be overwritten automatically] 15[/ Generated from doxy/doxygen_output/xml/group__is__valid.xml] 16[section:is_valid_2_with_strategy is_valid (with strategy)] 17 18'''<indexterm><primary>is_valid</primary></indexterm>''' 19Checks if a geometry is valid (in the OGC sense) 20 21[heading Synopsis] 22``template<typename Geometry, typename Strategy> 23bool is_valid(Geometry const & geometry, Strategy const & strategy)`` 24 25[heading Parameters] 26 27[table 28[[Type] [Concept] [Name] [Description] ] 29[[Geometry const &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept ]] 30[[Strategy const &] [Any type fulfilling a Is_valid Strategy Concept ] [strategy] [The strategy which will be used for is_valid calculations ]] 31] 32 33 34[heading Returns] 35Returns true if the geometry is valid (in the OGC sense); furthermore, the following geometries are considered valid: multi-geometries with no elements, linear geometries containing spikes, areal geometries with duplicate (consecutive) points 36 37[heading Header] 38Either 39 40`#include <boost/geometry.hpp>` 41 42 43Or 44 45`#include <boost/geometry/algorithms/is_valid.hpp>` 46 47[include reference/algorithms/is_valid.qbk] 48 49 50[endsect] 51 52[section:is_valid_1 is_valid] 53 54'''<indexterm><primary>is_valid</primary></indexterm>''' 55Checks if a geometry is valid (in the OGC sense) 56 57[heading Synopsis] 58``template<typename Geometry> 59bool is_valid(Geometry const & geometry)`` 60 61[heading Parameters] 62 63[table 64[[Type] [Concept] [Name] [Description] ] 65[[Geometry const &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept ]] 66] 67 68 69[heading Returns] 70Returns true if the geometry is valid (in the OGC sense); furthermore, the following geometries are considered valid: multi-geometries with no elements, linear geometries containing spikes, areal geometries with duplicate (consecutive) points 71 72[heading Header] 73Either 74 75`#include <boost/geometry.hpp>` 76 77 78Or 79 80`#include <boost/geometry/algorithms/is_valid.hpp>` 81 82[include reference/algorithms/is_valid.qbk] 83 84 85[endsect] 86 87[section:is_valid_3_with_failure_value_and_strategy is_valid (with failure value and strategy)] 88 89'''<indexterm><primary>is_valid</primary></indexterm>''' 90Checks if a geometry is valid (in the OGC sense) 91 92[heading Synopsis] 93``template<typename Geometry, typename Strategy> 94bool is_valid(Geometry const & geometry, validity_failure_type & failure, Strategy const & strategy)`` 95 96[heading Parameters] 97 98[table 99[[Type] [Concept] [Name] [Description] ] 100[[Geometry const &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept ]] 101[[validity_failure_type &] [] [failure] [An enumeration value indicating that the geometry is valid or not, and if not valid indicating the reason why ]] 102[[Strategy const &] [Any type fulfilling a Is_valid Strategy Concept ] [strategy] [The strategy which will be used for is_valid calculations ]] 103] 104 105 106[heading Returns] 107Returns true if the geometry is valid (in the OGC sense); furthermore, the following geometries are considered valid: multi-geometries with no elements, linear geometries containing spikes, areal geometries with duplicate (consecutive) points 108 109[heading Header] 110Either 111 112`#include <boost/geometry.hpp>` 113 114 115Or 116 117`#include <boost/geometry/algorithms/is_valid.hpp>` 118 119[include reference/algorithms/is_valid_with_failure.qbk] 120 121 122[endsect] 123 124[section:is_valid_2_with_failure_value is_valid (with failure value)] 125 126'''<indexterm><primary>is_valid</primary></indexterm>''' 127Checks if a geometry is valid (in the OGC sense) 128 129[heading Synopsis] 130``template<typename Geometry> 131bool is_valid(Geometry const & geometry, validity_failure_type & failure)`` 132 133[heading Parameters] 134 135[table 136[[Type] [Concept] [Name] [Description] ] 137[[Geometry const &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept ]] 138[[validity_failure_type &] [] [failure] [An enumeration value indicating that the geometry is valid or not, and if not valid indicating the reason why ]] 139] 140 141 142[heading Returns] 143Returns true if the geometry is valid (in the OGC sense); furthermore, the following geometries are considered valid: multi-geometries with no elements, linear geometries containing spikes, areal geometries with duplicate (consecutive) points 144 145[heading Header] 146Either 147 148`#include <boost/geometry.hpp>` 149 150 151Or 152 153`#include <boost/geometry/algorithms/is_valid.hpp>` 154 155[include reference/algorithms/is_valid_with_failure.qbk] 156 157 158[endsect] 159 160[section:is_valid_3_with_message_and_strategy is_valid (with message and strategy)] 161 162'''<indexterm><primary>is_valid</primary></indexterm>''' 163Checks if a geometry is valid (in the OGC sense) 164 165[heading Synopsis] 166``template<typename Geometry, typename Strategy> 167bool is_valid(Geometry const & geometry, std::string & message, Strategy const & strategy)`` 168 169[heading Parameters] 170 171[table 172[[Type] [Concept] [Name] [Description] ] 173[[Geometry const &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept ]] 174[[std::string &] [] [message] [A string containing a message stating if the geometry is valid or not, and if not valid a reason why ]] 175[[Strategy const &] [Any type fulfilling a Is_valid Strategy Concept ] [strategy] [The strategy which will be used for is_valid calculations ]] 176] 177 178 179[heading Returns] 180Returns true if the geometry is valid (in the OGC sense); furthermore, the following geometries are considered valid: multi-geometries with no elements, linear geometries containing spikes, areal geometries with duplicate (consecutive) points 181 182[heading Header] 183Either 184 185`#include <boost/geometry.hpp>` 186 187 188Or 189 190`#include <boost/geometry/algorithms/is_valid.hpp>` 191 192[include reference/algorithms/is_valid_with_message.qbk] 193 194 195[endsect] 196 197[section:is_valid_2_with_message is_valid (with message)] 198 199'''<indexterm><primary>is_valid</primary></indexterm>''' 200Checks if a geometry is valid (in the OGC sense) 201 202[heading Synopsis] 203``template<typename Geometry> 204bool is_valid(Geometry const & geometry, std::string & message)`` 205 206[heading Parameters] 207 208[table 209[[Type] [Concept] [Name] [Description] ] 210[[Geometry const &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept ]] 211[[std::string &] [] [message] [A string containing a message stating if the geometry is valid or not, and if not valid a reason why ]] 212] 213 214 215[heading Returns] 216Returns true if the geometry is valid (in the OGC sense); furthermore, the following geometries are considered valid: multi-geometries with no elements, linear geometries containing spikes, areal geometries with duplicate (consecutive) points 217 218[heading Header] 219Either 220 221`#include <boost/geometry.hpp>` 222 223 224Or 225 226`#include <boost/geometry/algorithms/is_valid.hpp>` 227 228[include reference/algorithms/is_valid_with_message.qbk] 229 230 231[endsect] 232 233