geometry/doc/generated/num_interior_rings.qbk
Barend Gehrels eb0bc69f56 Doc update
[SVN r69343]
2011-02-27 18:20:28 +00:00

52 lines
1.5 KiB
Plaintext

[/============================================================================
Boost.Geometry (aka GGL, Generic Geometry Library)
Copyright (c) 2009-2011 Barend Gehrels, Geodan, Amsterdam, the Netherlands.
Copyright (c) 2009-2011 Mateusz Loskot (mateusz@loskot.net)
Copyright (c) 2009-2011 Bruno Lalande, Paris, France.
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, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__num__interior__rings.xml]
[section:num_interior_rings num_interior_rings]
Calculates the number of interior rings of a geometry.
[heading Description]
The free function num\u005finterior\u005frings calculates the number of interior rings of a geometry.
[heading Synopsis]
``template<typename Geometry>
std::size_t num_interior_rings(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 number of interior rings
[heading Header]
Either
`#include <boost/geometry/geometry.hpp>`
Or
`#include <boost/geometry/algorithms/num_interior_rings.hpp>`
[include reference/algorithms/num_interior_rings.qbk]
[endsect]