blob: f800038672bea4c0e1354e97f499abdd7c96c680 [file] [log] [blame]
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>ever_circling_iterator</title>
<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="../../../index.html" title="Chapter&#160;1.&#160;Geometry 1.0">
<link rel="up" href="../iterators.html" title="Iterators">
<link rel="prev" href="closing_iterator.html" title="closing_iterator">
<link rel="next" href="../models.html" title="Models">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<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>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<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>
</h4></div></div></div>
<p>
<a class="indexterm" name="id932634"></a>
Iterator which ever circles through a range.
</p>
<a name="geometry.reference.iterators.ever_circling_iterator.synopsis"></a><h6>
<a name="geometry.reference.iterators.ever_circling_iterator.synopsis-heading"></a>
<a class="link" href="ever_circling_iterator.html#geometry.reference.iterators.ever_circling_iterator.synopsis">Synopsis</a>
</h6>
<p>
</p>
<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>
<span class="keyword">struct</span> <span class="identifier">ever_circling_iterator</span>
<span class="special">{</span>
<span class="comment">// ...</span>
<span class="special">};</span>
</pre>
<p>
</p>
<a name="geometry.reference.iterators.ever_circling_iterator.template_parameter_s_"></a><h6>
<a name="geometry.reference.iterators.ever_circling_iterator.template_parameter_s_-heading"></a>
<a class="link" href="ever_circling_iterator.html#geometry.reference.iterators.ever_circling_iterator.template_parameter_s_">Template
parameter(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Parameter
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
typename Iterator
</p>
</td>
<td>
<p>
iterator on which this class is based on
</p>
</td>
</tr></tbody>
</table></div>
<a name="geometry.reference.iterators.ever_circling_iterator.constructor_s_"></a><h6>
<a name="geometry.reference.iterators.ever_circling_iterator.constructor_s_-heading"></a>
<a class="link" href="ever_circling_iterator.html#geometry.reference.iterators.ever_circling_iterator.constructor_s_">Constructor(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Function
</p>
</th>
<th>
<p>
Description
</p>
</th>
<th>
<p>
Parameters
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
</p>
<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>
<p>
</p>
</td>
<td>
</td>
<td>
<p>
<span class="bold"><strong>Iterator</strong></span>: <span class="emphasis"><em>begin</em></span>:
</p>
<p>
<span class="bold"><strong>Iterator</strong></span>: <span class="emphasis"><em>end</em></span>:
</p>
<p>
<span class="bold"><strong>bool</strong></span>: <span class="emphasis"><em>skip_first</em></span>:
</p>
</td>
</tr>
<tr>
<td>
<p>
</p>
<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> <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>
<p>
</p>
</td>
<td>
</td>
<td>
<p>
<span class="bold"><strong>Iterator</strong></span>: <span class="emphasis"><em>begin</em></span>:
</p>
<p>
<span class="bold"><strong>Iterator</strong></span>: <span class="emphasis"><em>end</em></span>:
</p>
<p>
<span class="bold"><strong>Iterator</strong></span>: <span class="emphasis"><em>start</em></span>:
</p>
<p>
<span class="bold"><strong>bool</strong></span>: <span class="emphasis"><em>skip_first</em></span>:
</p>
</td>
</tr>
</tbody>
</table></div>
<a name="geometry.reference.iterators.ever_circling_iterator.member_function_s_"></a><h6>
<a name="geometry.reference.iterators.ever_circling_iterator.member_function_s_-heading"></a>
<a class="link" href="ever_circling_iterator.html#geometry.reference.iterators.ever_circling_iterator.member_function_s_">Member
Function(s)</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Function
</p>
</th>
<th>
<p>
Description
</p>
</th>
<th>
<p>
Parameters
</p>
</th>
<th>
<p>
Returns
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
</p>
<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>
<p>
</p>
</td>
<td>
</td>
<td>
<p>
<span class="bold"><strong>Iterator</strong></span>: <span class="emphasis"><em>it</em></span>:
</p>
</td>
</tr></tbody>
</table></div>
<a name="geometry.reference.iterators.ever_circling_iterator.header"></a><h6>
<a name="geometry.reference.iterators.ever_circling_iterator.header-heading"></a>
<a class="link" href="ever_circling_iterator.html#geometry.reference.iterators.ever_circling_iterator.header">Header</a>
</h6>
<p>
<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>
</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2011 Barend Gehrels, Bruno Lalande, Mateusz Loskot<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
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>)
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<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>
</div>
</body>
</html>