• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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__num__interior__rings.xml]
16[section:num_interior_rings num_interior_rings]
17
18'''<indexterm><primary>num_interior_rings</primary></indexterm>'''
19Calculates the number of interior rings of a geometry.
20
21[heading Description]
22The free function num\u005finterior\u005frings calculates the number of interior rings of a geometry.
23
24[heading Synopsis]
25``template<typename Geometry>
26std::size_t num_interior_rings(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 number of interior rings
38
39[heading Header]
40Either
41
42`#include <boost/geometry.hpp>`
43
44
45Or
46
47`#include <boost/geometry/algorithms/num_interior_rings.hpp>`
48
49[include reference/algorithms/num_interior_rings.qbk]
50
51
52[endsect]
53
54