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__correct.xml] 16[section:correct_1 correct] 17 18'''<indexterm><primary>correct</primary></indexterm>''' 19Corrects a geometry. 20 21[heading Description] 22Corrects a geometry: all rings which are wrongly oriented with respect to their expected orientation are reversed. To all rings which do not have a closing point and are typed as they should have one, the first point is appended. Also boxes can be corrected. 23 24[heading Synopsis] 25``template<typename Geometry> 26void correct(Geometry & geometry)`` 27 28[heading Parameters] 29 30[table 31[[Type] [Concept] [Name] [Description] ] 32[[Geometry &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept which will be corrected if necessary]] 33] 34 35 36[heading Header] 37Either 38 39`#include <boost/geometry.hpp>` 40 41 42Or 43 44`#include <boost/geometry/algorithms/correct.hpp>` 45 46[include reference/algorithms/correct.qbk] 47 48 49[endsect] 50 51[section:correct_2_with_strategy correct (with strategy)] 52 53'''<indexterm><primary>correct</primary></indexterm>''' 54Corrects a geometry. 55 56[heading Description] 57Corrects a geometry: all rings which are wrongly oriented with respect to their expected orientation are reversed. To all rings which do not have a closing point and are typed as they should have one, the first point is appended. Also boxes can be corrected. 58 59[heading Synopsis] 60``template<typename Geometry, typename Strategy> 61void correct(Geometry & geometry, Strategy const & strategy)`` 62 63[heading Parameters] 64 65[table 66[[Type] [Concept] [Name] [Description] ] 67[[Geometry &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept which will be corrected if necessary ]] 68[[Strategy const &] [Any type fulfilling a Area Strategy Concept ] [strategy] [The strategy which will be used for area calculations]] 69] 70 71 72[heading Header] 73Either 74 75`#include <boost/geometry.hpp>` 76 77 78Or 79 80`#include <boost/geometry/algorithms/correct.hpp>` 81 82[include reference/algorithms/correct.qbk] 83 84 85[endsect] 86 87