• 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_1ever__circling__iterator.xml]
16[section:ever_circling_iterator ever_circling_iterator]
17
18'''<indexterm><primary>ever_circling_iterator</primary></indexterm>'''
19Iterator which ever circles through a range.
20
21[heading Synopsis]
22``template<typename Iterator>
23struct ever_circling_iterator
24      : public detail::iterators::iterator_base< ever_circling_iterator< Iterator >, Iterator >
25{
26  // ...
27};
28``
29
30[heading Template parameter(s)]
31[table
32[[Parameter] [Description]]
33[[typename Iterator] [iterator on which this class is based on]]
34]
35
36[heading Constructor(s)]
37[table
38[[Function] [Description] [Parameters] ]
39[[``ever_circling_iterator(Iterator begin, Iterator end, bool skip_first = false)``
40
41] [] [[* Iterator]: ['begin]:
42
43[* Iterator]: ['end]:
44
45[* bool]: ['skip_first]:
46
47
48
49]]
50[[``ever_circling_iterator(Iterator begin, Iterator end, Iterator start,
51                        bool skip_first = false)``
52
53] [] [[* Iterator]: ['begin]:
54
55[* Iterator]: ['end]:
56
57[* Iterator]: ['start]:
58
59[* bool]: ['skip_first]:
60
61
62
63]]
64]
65
66[heading Member Function(s)]
67[table
68[[Function] [Description] [Parameters]  [Returns]]
69[[``void moveto(Iterator it)``
70
71] [] [[* Iterator]: ['it]:
72
73
74
75][
76
77]
78]
79]
80
81[heading Header]
82`#include <boost/geometry/iterators/ever_circling_iterator.hpp>`
83
84[endsect]
85
86