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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>closing_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="../iterators.html" title="Iterators">
  10 <link rel="next" href="ever_circling_iterator.html" title="ever_circling_iterator">
  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="../iterators.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="ever_circling_iterator.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.closing_iterator"></a><a class="link" href="closing_iterator.html" title="closing_iterator">closing_iterator</a>
  28 </h4></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idm46186984075296"></a>
  31 Iterator which iterates through a range, but adds first element at end
  32           of the range.
  33         </p>
  34 <h6>
  35 <a name="geometry.reference.iterators.closing_iterator.h0"></a>
  36           <span class="phrase"><a name="geometry.reference.iterators.closing_iterator.synopsis"></a></span><a class="link" href="closing_iterator.html#geometry.reference.iterators.closing_iterator.synopsis">Synopsis</a>
  37         </h6>
  38 <p>
  39 </p>
  40 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Range</span><span class="special">&gt;</span>
  41 <span class="keyword">struct</span> <span class="identifier">closing_iterator</span>
  42       <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">iterator_facade</span><span class="special">&lt;</span> <span class="identifier">closing_iterator</span><span class="special">&lt;</span> <span class="identifier">Range</span> <span class="special">&gt;,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_value</span><span class="special">&lt;</span> <span class="identifier">Range</span> <span class="special">&gt;::</span><span class="identifier">type</span> <span class="keyword">const</span><span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">random_access_traversal_tag</span><span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_reference</span><span class="special">&lt;</span> <span class="identifier">Range</span> <span class="keyword">const</span> <span class="special">&gt;::</span><span class="identifier">type</span><span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">range_difference</span><span class="special">&lt;</span> <span class="identifier">Range</span> <span class="special">&gt;::</span><span class="identifier">type</span> <span class="special">&gt;</span>
  43 <span class="special">{</span>
  44   <span class="comment">// ...</span>
  45 <span class="special">};</span>
  46 </pre>
  47 <p>
  48         </p>
  49 <h6>
  50 <a name="geometry.reference.iterators.closing_iterator.h1"></a>
  51           <span class="phrase"><a name="geometry.reference.iterators.closing_iterator.template_parameter_s_"></a></span><a class="link" href="closing_iterator.html#geometry.reference.iterators.closing_iterator.template_parameter_s_">Template
  52           parameter(s)</a>
  53         </h6>
  54 <div class="informaltable"><table class="table">
  55 <colgroup>
  56 <col>
  57 <col>
  58 </colgroup>
  59 <thead><tr>
  60 <th>
  61                   <p>
  62                     Parameter
  63                   </p>
  64                 </th>
  65 <th>
  66                   <p>
  67                     Description
  68                   </p>
  69                 </th>
  70 </tr></thead>
  71 <tbody><tr>
  72 <td>
  73                   <p>
  74                     typename Range
  75                   </p>
  76                 </td>
  77 <td>
  78                   <p>
  79                     range on which this class is based on
  80                   </p>
  81                 </td>
  82 </tr></tbody>
  83 </table></div>
  84 <h6>
  85 <a name="geometry.reference.iterators.closing_iterator.h2"></a>
  86           <span class="phrase"><a name="geometry.reference.iterators.closing_iterator.constructor_s_"></a></span><a class="link" href="closing_iterator.html#geometry.reference.iterators.closing_iterator.constructor_s_">Constructor(s)</a>
  87         </h6>
  88 <div class="informaltable"><table class="table">
  89 <colgroup>
  90 <col>
  91 <col>
  92 <col>
  93 </colgroup>
  94 <thead><tr>
  95 <th>
  96                   <p>
  97                     Function
  98                   </p>
  99                 </th>
 100 <th>
 101                   <p>
 102                     Description
 103                   </p>
 104                 </th>
 105 <th>
 106                   <p>
 107                     Parameters
 108                   </p>
 109                 </th>
 110 </tr></thead>
 111 <tbody>
 112 <tr>
 113 <td>
 114                   <p>
 115 </p>
 116 <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">closing_iterator</span><span class="special">(</span><span class="identifier">Range</span> <span class="special">&amp;</span> <span class="identifier">range</span><span class="special">)</span></pre>
 117 <p>
 118                   </p>
 119                 </td>
 120 <td>
 121                   <p>
 122                     Constructor including the range it is based on.
 123                   </p>
 124                 </td>
 125 <td>
 126                   <p>
 127                     <span class="bold"><strong>Range &amp;</strong></span>: <span class="emphasis"><em>range</em></span>:
 128                   </p>
 129                 </td>
 130 </tr>
 131 <tr>
 132 <td>
 133                   <p>
 134 </p>
 135 <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">closing_iterator</span><span class="special">(</span><span class="identifier">Range</span> <span class="special">&amp;</span> <span class="identifier">range</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">)</span></pre>
 136 <p>
 137                   </p>
 138                 </td>
 139 <td>
 140                   <p>
 141                     Constructor to indicate the end of a range.
 142                   </p>
 143                 </td>
 144 <td>
 145                   <p>
 146                     <span class="bold"><strong>Range &amp;</strong></span>: <span class="emphasis"><em>range</em></span>:
 147                   </p>
 148                   <p>
 149                     <span class="bold"><strong>bool</strong></span>: <span class="emphasis"><em></em></span>:
 150                   </p>
 151                 </td>
 152 </tr>
 153 <tr>
 154 <td>
 155                   <p>
 156 </p>
 157 <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">closing_iterator</span><span class="special">()</span></pre>
 158 <p>
 159                   </p>
 160                 </td>
 161 <td>
 162                   <p>
 163                     Default constructor.
 164                   </p>
 165                 </td>
 166 <td>
 167                 </td>
 168 </tr>
 169 </tbody>
 170 </table></div>
 171 <h6>
 172 <a name="geometry.reference.iterators.closing_iterator.h3"></a>
 173           <span class="phrase"><a name="geometry.reference.iterators.closing_iterator.header"></a></span><a class="link" href="closing_iterator.html#geometry.reference.iterators.closing_iterator.header">Header</a>
 174         </h6>
 175 <p>
 176           <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">closing_iterator</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
 177         </p>
 178 </div>
 179 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 180 <td align="left"></td>
 181 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2019 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam
 182       Wulkiewicz, Oracle and/or its affiliates<p>
 183         Distributed under the Boost Software License, Version 1.0. (See accompanying
 184         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>)
 185       </p>
 186 </div></td>
 187 </tr></table>
 188 <hr>
 189 <div class="spirit-nav">
 190 <a accesskey="p" href="../iterators.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="ever_circling_iterator.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 191 </div>
 192 </body>
 193 </html>