• 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/structboost_1_1geometry_1_1closing__iterator.xml]
16[section:closing_iterator closing_iterator]
17
18'''<indexterm><primary>closing_iterator</primary></indexterm>'''
19Iterator which iterates through a range, but adds first element at end of the range.
20
21[heading Synopsis]
22``template<typename Range>
23struct closing_iterator
24      : public boost::iterator_facade< closing_iterator< Range >, boost::range_value< Range >::type const, boost::random_access_traversal_tag, boost::range_reference< Range const >::type, boost::range_difference< Range >::type >
25{
26  // ...
27};
28``
29
30[heading Template parameter(s)]
31[table
32[[Parameter] [Description]]
33[[typename Range] [range on which this class is based on]]
34]
35
36[heading Constructor(s)]
37[table
38[[Function] [Description] [Parameters] ]
39[[``closing_iterator(Range & range)``
40
41] [Constructor including the range it is based on. ] [[* Range &]: ['range]:
42
43
44
45]]
46[[``closing_iterator(Range & range, bool )``
47
48] [Constructor to indicate the end of a range. ] [[* Range &]: ['range]:
49
50[* bool]: [']:
51
52
53
54]]
55[[``closing_iterator()``
56
57] [Default constructor. ] [
58
59]]
60]
61
62[heading Header]
63`#include <boost/geometry/iterators/closing_iterator.hpp>`
64
65[endsect]
66
67