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__perimeter.xml] 16[section:perimeter_1 perimeter] 17 18'''<indexterm><primary>perimeter</primary></indexterm>''' 19Calculates the perimeter of a geometry. 20 21[heading Description] 22The function perimeter returns the perimeter of a geometry, using the default distance-calculation-strategy 23 24[heading Synopsis] 25``template<typename Geometry> 26default_length_result<Geometry>::type perimeter(Geometry const & geometry)`` 27 28[heading Parameters] 29 30[table 31[[Type] [Concept] [Name] [Description] ] 32[[Geometry const &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept ]] 33] 34 35 36[heading Returns] 37The calculated perimeter 38 39[heading Header] 40Either 41 42`#include <boost/geometry.hpp>` 43 44 45Or 46 47`#include <boost/geometry/algorithms/perimeter.hpp>` 48 49[include reference/algorithms/perimeter.qbk] 50[heading Example] 51[perimeter] 52[perimeter_output] 53 54 55[endsect] 56 57[section:perimeter_2_with_strategy perimeter (with strategy)] 58 59'''<indexterm><primary>perimeter</primary></indexterm>''' 60Calculates the perimeter of a geometry using the specified strategy. 61 62[heading Description] 63The function perimeter returns the perimeter of a geometry, using specified strategy 64 65[heading Synopsis] 66``template<typename Geometry, typename Strategy> 67default_length_result<Geometry>::type perimeter(Geometry const & geometry, Strategy const & strategy)`` 68 69[heading Parameters] 70 71[table 72[[Type] [Concept] [Name] [Description] ] 73[[Geometry const &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept ]] 74[[Strategy const &] [Any type fulfilling a distance Strategy Concept ] [strategy] [strategy to be used for distance calculations. ]] 75] 76 77 78[heading Returns] 79The calculated perimeter 80 81[heading Header] 82Either 83 84`#include <boost/geometry.hpp>` 85 86 87Or 88 89`#include <boost/geometry/algorithms/perimeter.hpp>` 90 91[include reference/algorithms/perimeter.qbk] 92 93 94[endsect] 95 96