12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394 |
- [/============================================================================
- 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__length.xml]
- [section:length_1 length]
- '''<indexterm><primary>length</primary></indexterm>'''
- Calculates the length of a geometry.
- [heading Description]
- The free function length calculates the length (the sum of distances between consecutive points) of a geometry. It uses the default strategy, based on the coordinate system of the geometry.
- [heading Synopsis]
- ``template<typename Geometry>
- default_length_result<Geometry>::type length(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 length
- [heading Header]
- Either
- `#include <boost/geometry.hpp>`
- Or
- `#include <boost/geometry/algorithms/length.hpp>`
- [include reference/algorithms/length.qbk]
- [length] [length_output]
- [endsect]
- [section:length_2_with_strategy length (with strategy)]
- '''<indexterm><primary>length</primary></indexterm>'''
- Calculates the length of a geometry using the specified strategy.
- [heading Description]
- The free function length calculates the length (the sum of distances between consecutive points) of a geometry using the specified strategy. Reasons to specify a strategy include: use another coordinate system for calculations; construct the strategy beforehand (e.g. with the radius of the Earth); select a strategy when there are more than one available for a calculation.
- [heading Synopsis]
- ``template<typename Geometry, typename Strategy>
- default_length_result<Geometry>::type length(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] [The strategy which will be used for distance calculations ]]
- ]
- [heading Returns]
- The calculated length
- [heading Header]
- Either
- `#include <boost/geometry.hpp>`
- Or
- `#include <boost/geometry/algorithms/length.hpp>`
- [include reference/algorithms/length.qbk]
- [length_with_strategy] [length_with_strategy_output]
- [endsect]
|