1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192 |
- [/============================================================================
- Boost.Geometry (aka GGL, Generic Geometry Library)
- Copyright (c) 2007-2013 Barend Gehrels, Amsterdam, the Netherlands.
- Copyright (c) 2008-2013 Bruno Lalande, Paris, France.
- Copyright (c) 2009-2013 Mateusz Loskot, London, UK.
- Use, modification and distribution is subject to the Boost Software License,
- Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
- http://www.boost.org/LICENSE_1_0.txt)
- =============================================================================/]
- [/ Generated by doxygen_xml2qbk 1.1.1, don't change, will be overwritten automatically]
- [/ Generated from doxy/doxygen_output/xml/group__perimeter.xml]
- [section:perimeter_1 perimeter]
- '''<indexterm><primary>perimeter</primary></indexterm>'''
- Calculates the perimeter of a geometry.
- [heading Description]
- The function perimeter returns the perimeter of a geometry, using the default distance-calculation-strategy
- [heading Synopsis]
- ``template<typename Geometry>
- default_length_result<Geometry>::type perimeter(Geometry const & geometry)``
- [heading Parameters]
- [table
- [[Type] [Concept] [Name] [Description] ]
- [[Geometry const &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept ]]
- ]
- [heading Returns]
- The calculated perimeter
- [heading Header]
- Either
- `#include <boost/geometry.hpp>`
- Or
- `#include <boost/geometry/algorithms/perimeter.hpp>`
- [include reference/algorithms/perimeter.qbk]
- [endsect]
- [section:perimeter_2_with_strategy perimeter (with strategy)]
- '''<indexterm><primary>perimeter</primary></indexterm>'''
- Calculates the perimeter of a geometry using the specified strategy.
- [heading Description]
- The function perimeter returns the perimeter of a geometry, using specified strategy
- [heading Synopsis]
- ``template<typename Geometry, typename Strategy>
- default_length_result<Geometry>::type perimeter(Geometry const & geometry, Strategy const & strategy)``
- [heading Parameters]
- [table
- [[Type] [Concept] [Name] [Description] ]
- [[Geometry const &] [Any type fulfilling a Geometry Concept ] [geometry] [A model of the specified concept ]]
- [[Strategy const &] [Any type fulfilling a distance Strategy Concept ] [strategy] [strategy to be used for distance calculations. ]]
- ]
- [heading Returns]
- The calculated perimeter
- [heading Header]
- Either
- `#include <boost/geometry.hpp>`
- Or
- `#include <boost/geometry/algorithms/perimeter.hpp>`
- [include reference/algorithms/perimeter.qbk]
- [endsect]
|