libs/geometry/doc/html/geometry/reference/iterators/ever_circling_iterator.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>ever_circling_iterator</title>
   5 <link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../../../index.html" title="Chapter&#160;1.&#160;Geometry">
   8 <link rel="up" href="../iterators.html" title="Iterators">
   9 <link rel="prev" href="closing_iterator.html" title="closing_iterator">
  10 <link rel="next" href="../models.html" title="Models">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="closing_iterator.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../iterators.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../models.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h4 class="title">
  27 <a name="geometry.reference.iterators.ever_circling_iterator"></a><a class="link" href="ever_circling_iterator.html" title="ever_circling_iterator">ever_circling_iterator</a>
  28 </h4></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idp111781200"></a>
  31 Iterator which ever circles through a range.
  32         </p>
  33 <h6>
  34 <a name="geometry.reference.iterators.ever_circling_iterator.h0"></a>
  35           <span class="phrase"><a name="geometry.reference.iterators.ever_circling_iterator.synopsis"></a></span><a class="link" href="ever_circling_iterator.html#geometry.reference.iterators.ever_circling_iterator.synopsis">Synopsis</a>
  36         </h6>
  37 <p>
  38 </p>
  39 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Iterator</span><span class="special">&gt;</span>
  40 <span class="keyword">struct</span> <span class="identifier">ever_circling_iterator</span>
  41       <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">detail</span><span class="special">::</span><span class="identifier">iterators</span><span class="special">::</span><span class="identifier">iterator_base</span><span class="special">&lt;</span> <span class="identifier">ever_circling_iterator</span><span class="special">&lt;</span> <span class="identifier">Iterator</span> <span class="special">&gt;,</span> <span class="identifier">Iterator</span> <span class="special">&gt;</span>
  42 <span class="special">{</span>
  43   <span class="comment">// ...</span>
  44 <span class="special">};</span>
  45 </pre>
  46 <p>
  47         </p>
  48 <h6>
  49 <a name="geometry.reference.iterators.ever_circling_iterator.h1"></a>
  50           <span class="phrase"><a name="geometry.reference.iterators.ever_circling_iterator.template_parameter_s_"></a></span><a class="link" href="ever_circling_iterator.html#geometry.reference.iterators.ever_circling_iterator.template_parameter_s_">Template
  51           parameter(s)</a>
  52         </h6>
  53 <div class="informaltable"><table class="table">
  54 <colgroup>
  55 <col>
  56 <col>
  57 </colgroup>
  58 <thead><tr>
  59 <th>
  60                   <p>
  61                     Parameter
  62                   </p>
  63                 </th>
  64 <th>
  65                   <p>
  66                     Description
  67                   </p>
  68                 </th>
  69 </tr></thead>
  70 <tbody><tr>
  71 <td>
  72                   <p>
  73                     typename Iterator
  74                   </p>
  75                 </td>
  76 <td>
  77                   <p>
  78                     iterator on which this class is based on
  79                   </p>
  80                 </td>
  81 </tr></tbody>
  82 </table></div>
  83 <h6>
  84 <a name="geometry.reference.iterators.ever_circling_iterator.h2"></a>
  85           <span class="phrase"><a name="geometry.reference.iterators.ever_circling_iterator.constructor_s_"></a></span><a class="link" href="ever_circling_iterator.html#geometry.reference.iterators.ever_circling_iterator.constructor_s_">Constructor(s)</a>
  86         </h6>
  87 <div class="informaltable"><table class="table">
  88 <colgroup>
  89 <col>
  90 <col>
  91 <col>
  92 </colgroup>
  93 <thead><tr>
  94 <th>
  95                   <p>
  96                     Function
  97                   </p>
  98                 </th>
  99 <th>
 100                   <p>
 101                     Description
 102                   </p>
 103                 </th>
 104 <th>
 105                   <p>
 106                     Parameters
 107                   </p>
 108                 </th>
 109 </tr></thead>
 110 <tbody>
 111 <tr>
 112 <td>
 113                   <p>
 114 </p>
 115 <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">ever_circling_iterator</span><span class="special">(</span><span class="identifier">Iterator</span> <span class="identifier">begin</span><span class="special">,</span> <span class="identifier">Iterator</span> <span class="identifier">end</span><span class="special">,</span> <span class="keyword">bool</span> <span class="identifier">skip_first</span> <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span></pre>
 116 <p>
 117                   </p>
 118                 </td>
 119 <td>
 120                 </td>
 121 <td>
 122                   <p>
 123                     <span class="bold"><strong>Iterator</strong></span>: <span class="emphasis"><em>begin</em></span>:
 124                   </p>
 125                   <p>
 126                     <span class="bold"><strong>Iterator</strong></span>: <span class="emphasis"><em>end</em></span>:
 127                   </p>
 128                   <p>
 129                     <span class="bold"><strong>bool</strong></span>: <span class="emphasis"><em>skip_first</em></span>:
 130                   </p>
 131                 </td>
 132 </tr>
 133 <tr>
 134 <td>
 135                   <p>
 136 </p>
 137 <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">ever_circling_iterator</span><span class="special">(</span><span class="identifier">Iterator</span> <span class="identifier">begin</span><span class="special">,</span> <span class="identifier">Iterator</span> <span class="identifier">end</span><span class="special">,</span> <span class="identifier">Iterator</span> <span class="identifier">start</span><span class="special">,</span>
 138                         <span class="keyword">bool</span> <span class="identifier">skip_first</span> <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span></pre>
 139 <p>
 140                   </p>
 141                 </td>
 142 <td>
 143                 </td>
 144 <td>
 145                   <p>
 146                     <span class="bold"><strong>Iterator</strong></span>: <span class="emphasis"><em>begin</em></span>:
 147                   </p>
 148                   <p>
 149                     <span class="bold"><strong>Iterator</strong></span>: <span class="emphasis"><em>end</em></span>:
 150                   </p>
 151                   <p>
 152                     <span class="bold"><strong>Iterator</strong></span>: <span class="emphasis"><em>start</em></span>:
 153                   </p>
 154                   <p>
 155                     <span class="bold"><strong>bool</strong></span>: <span class="emphasis"><em>skip_first</em></span>:
 156                   </p>
 157                 </td>
 158 </tr>
 159 </tbody>
 160 </table></div>
 161 <h6>
 162 <a name="geometry.reference.iterators.ever_circling_iterator.h3"></a>
 163           <span class="phrase"><a name="geometry.reference.iterators.ever_circling_iterator.member_function_s_"></a></span><a class="link" href="ever_circling_iterator.html#geometry.reference.iterators.ever_circling_iterator.member_function_s_">Member
 164           Function(s)</a>
 165         </h6>
 166 <div class="informaltable"><table class="table">
 167 <colgroup>
 168 <col>
 169 <col>
 170 <col>
 171 <col>
 172 </colgroup>
 173 <thead><tr>
 174 <th>
 175                   <p>
 176                     Function
 177                   </p>
 178                 </th>
 179 <th>
 180                   <p>
 181                     Description
 182                   </p>
 183                 </th>
 184 <th>
 185                   <p>
 186                     Parameters
 187                   </p>
 188                 </th>
 189 <th>
 190                   <p>
 191                     Returns
 192                   </p>
 193                 </th>
 194 </tr></thead>
 195 <tbody><tr>
 196 <td>
 197                   <p>
 198 </p>
 199 <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="keyword">void</span> <span class="identifier">moveto</span><span class="special">(</span><span class="identifier">Iterator</span> <span class="identifier">it</span><span class="special">)</span></pre>
 200 <p>
 201                   </p>
 202                 </td>
 203 <td>
 204                 </td>
 205 <td>
 206                   <p>
 207                     <span class="bold"><strong>Iterator</strong></span>: <span class="emphasis"><em>it</em></span>:
 208                   </p>
 209                 </td>
 210 <td>
 211                 </td>
 212 </tr></tbody>
 213 </table></div>
 214 <h6>
 215 <a name="geometry.reference.iterators.ever_circling_iterator.h4"></a>
 216           <span class="phrase"><a name="geometry.reference.iterators.ever_circling_iterator.header"></a></span><a class="link" href="ever_circling_iterator.html#geometry.reference.iterators.ever_circling_iterator.header">Header</a>
 217         </h6>
 218 <p>
 219           <code class="computeroutput"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">iterators</span><span class="special">/</span><span class="identifier">ever_circling_iterator</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
 220         </p>
 221 </div>
 222 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 223 <td align="left"></td>
 224 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2017 Barend
 225       Gehrels, Bruno Lalande, Mateusz Loskot, Adam Wulkiewicz, Oracle and/or its
 226       affiliates<p>
 227         Distributed under the Boost Software License, Version 1.0. (See accompanying
 228         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
 229       </p>
 230 </div></td>
 231 </tr></table>
 232 <hr>
 233 <div class="spirit-nav">
 234 <a accesskey="p" href="closing_iterator.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../iterators.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../models.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 235 </div>
 236 </body>
 237 </html>