Imported Upstream version 1.72.0
[platform/upstream/boost.git] / libs / test / doc / html / boost / unit_test / data / monomorphic / xrange_t.html
1 <html>
2 <head>
3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>Class template xrange_t</title>
5 <link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7 <link rel="home" href="../../../../index.html" title="Boost.Test">
8 <link rel="up" href="../../../../header/boost/test/data/monomorphic/generators/xrange_hpp.html" title="Header &lt;boost/test/data/monomorphic/generators/xrange.hpp&gt;">
9 <link rel="prev" href="../../../../header/boost/test/data/monomorphic/generators/xrange_hpp.html" title="Header &lt;boost/test/data/monomorphic/generators/xrange.hpp&gt;">
10 <link rel="next" href="../xrange.html" title="Function xrange">
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="../../../../header/boost/test/data/monomorphic/generators/xrange_hpp.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../../header/boost/test/data/monomorphic/generators/xrange_hpp.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="../xrange.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
24 </div>
25 <div class="refentry">
26 <a name="boost.unit_test.data.monomorphic.xrange_t"></a><div class="titlepage"></div>
27 <div class="refnamediv">
28 <h2><span class="refentrytitle">Class template xrange_t</span></h2>
29 <p>boost::unit_test::data::monomorphic::xrange_t &#8212; Generator for the range sequences. </p>
30 </div>
31 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
32 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../../../header/boost/test/data/monomorphic/generators/xrange_hpp.html" title="Header &lt;boost/test/data/monomorphic/generators/xrange.hpp&gt;">boost/test/data/monomorphic/generators/xrange.hpp</a>&gt;
33
34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> SampleType<span class="special">,</span> <span class="keyword">typename</span> StepType <span class="special">=</span> <span class="identifier">SampleType</span><span class="special">&gt;</span> 
35 <span class="keyword">class</span> <a class="link" href="xrange_t.html" title="Class template xrange_t">xrange_t</a> <span class="special">{</span>
36 <span class="keyword">public</span><span class="special">:</span>
37   <span class="comment">// types</span>
38   <span class="keyword">typedef</span> <span class="identifier">SampleType</span> <a name="boost.unit_test.data.monomorphic.xrange_t.sample"></a><span class="identifier">sample</span><span class="special">;</span>
39
40   <span class="comment">// <a class="link" href="xrange_t.html#boost.unit_test.data.monomorphic.xrange_tconstruct-copy-destruct">construct/copy/destruct</a></span>
41   <a class="link" href="xrange_t.html#idm46279114290592-bb"><span class="identifier">xrange_t</span></a><span class="special">(</span><span class="identifier">SampleType</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">StepType</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">,</span> <a class="link" href="../size_t.html" title="Class size_t">data::size_t</a><span class="special">)</span><span class="special">;</span>
42
43   <span class="comment">// <a class="link" href="xrange_t.html#idm46279114294256-bb">public member functions</a></span>
44   <a class="link" href="../size_t.html" title="Class size_t">data::size_t</a> <a class="link" href="xrange_t.html#idm46279114293696-bb"><span class="identifier">capacity</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
45   <span class="identifier">SampleType</span> <a class="link" href="xrange_t.html#idm46279114292448-bb"><span class="identifier">next</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
46   <span class="keyword">void</span> <a class="link" href="xrange_t.html#idm46279114291600-bb"><span class="identifier">reset</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
47 <span class="special">}</span><span class="special">;</span></pre></div>
48 <div class="refsect1">
49 <a name="idm45313893193984"></a><h2>Description</h2>
50 <p>This class implements the generator concept (see <a class="link" href="generated_by.html" title="Class template generated_by">boost::unit_test::data::monomorphic::generated_by</a>) for implementing a range like sequence of numbers. </p>
51 <div class="refsect2">
52 <a name="idm45313893192288"></a><h3>
53 <a name="boost.unit_test.data.monomorphic.xrange_tconstruct-copy-destruct"></a><code class="computeroutput">xrange_t</code> 
54         public
55        construct/copy/destruct</h3>
56 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idm46279114290592-bb"></a><span class="identifier">xrange_t</span><span class="special">(</span><span class="identifier">SampleType</span> <span class="keyword">const</span> <span class="special">&amp;</span> begin_<span class="special">,</span> <span class="identifier">StepType</span> <span class="keyword">const</span> <span class="special">&amp;</span> step_<span class="special">,</span> 
57          <a class="link" href="../size_t.html" title="Class size_t">data::size_t</a> size_<span class="special">)</span><span class="special">;</span></pre></li></ol></div>
58 </div>
59 <div class="refsect2">
60 <a name="idm45313893180208"></a><h3>
61 <a name="idm46279114294256-bb"></a><code class="computeroutput">xrange_t</code> public member functions</h3>
62 <div class="orderedlist"><ol class="orderedlist" type="1">
63 <li class="listitem"><pre class="literallayout"><a class="link" href="../size_t.html" title="Class size_t">data::size_t</a> <a name="idm46279114293696-bb"></a><span class="identifier">capacity</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
64 <li class="listitem"><pre class="literallayout"><span class="identifier">SampleType</span> <a name="idm46279114292448-bb"></a><span class="identifier">next</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
65 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm46279114291600-bb"></a><span class="identifier">reset</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
66 </ol></div>
67 </div>
68 </div>
69 </div>
70 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
71 <td align="left"></td>
72 <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2019 Boost.Test
73       contributors<p>
74         Distributed under the Boost Software License, Version 1.0. (See accompanying
75         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>)
76       </p>
77 </div></td>
78 </tr></table>
79 <hr>
80 <div class="spirit-nav">
81 <a accesskey="p" href="../../../../header/boost/test/data/monomorphic/generators/xrange_hpp.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../../header/boost/test/data/monomorphic/generators/xrange_hpp.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="../xrange.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
82 </div>
83 </body>
84 </html>