1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Function xrange</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 <boost/test/data/monomorphic/generators/xrange.hpp>"> 9<link rel="prev" href="monomorphic/xrange_t.html" title="Class template xrange_t"> 10<link rel="next" href="../../../header/boost/test/data/monomorphic/grid_hpp.html" title="Header <boost/test/data/monomorphic/grid.hpp>"> 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="monomorphic/xrange_t.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="../../../header/boost/test/data/monomorphic/grid_hpp.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="refentry"> 26<a name="boost.unit_test.data.xrange"></a><div class="titlepage"></div> 27<div class="refnamediv"> 28<h2><span class="refentrytitle">Function xrange</span></h2> 29<p>boost::unit_test::data::xrange — Creates a range (sequence) dataset. </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: <<a class="link" href="../../../header/boost/test/data/monomorphic/generators/xrange_hpp.html" title="Header <boost/test/data/monomorphic/generators/xrange.hpp>">boost/test/data/monomorphic/generators/xrange.hpp</a>> 33 34</span> 35<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> SampleType<span class="special">,</span> <span class="keyword">typename</span> Params<span class="special">></span> 36 <a class="link" href="monomorphic/generated_by.html" title="Class template generated_by">monomorphic::generated_by</a><span class="special"><</span> <a class="link" href="monomorphic/xrange_t.html" title="Class template xrange_t">monomorphic::xrange_t</a><span class="special"><</span> <span class="identifier">SampleType</span> <span class="special">></span> <span class="special">></span> 37 <span class="identifier">xrange</span><span class="special">(</span><span class="identifier">Params</span> <span class="keyword">const</span> <span class="special">&</span> params<span class="special">)</span><span class="special">;</span> 38<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> SampleType<span class="special">></span> 39 <a class="link" href="monomorphic/generated_by.html" title="Class template generated_by">monomorphic::generated_by</a><span class="special"><</span> <a class="link" href="monomorphic/xrange_t.html" title="Class template xrange_t">monomorphic::xrange_t</a><span class="special"><</span> <span class="identifier">SampleType</span> <span class="special">></span> <span class="special">></span> 40 <span class="identifier">xrange</span><span class="special">(</span><span class="identifier">SampleType</span> <span class="keyword">const</span> <span class="special">&</span> end_val<span class="special">)</span><span class="special">;</span> 41<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> SampleType<span class="special">,</span> <span class="keyword">typename</span> Params<span class="special">></span> 42 <span class="identifier">enable_if_c</span><span class="special"><</span> <a class="link" href="../../nfp/is_named_param_pack.html" title="Struct template is_named_param_pack">nfp::is_named_param_pack</a><span class="special"><</span> <span class="identifier">Params</span> <span class="special">></span><span class="special">::</span><span class="identifier">value</span><span class="special">,</span> <a class="link" href="monomorphic/generated_by.html" title="Class template generated_by">monomorphic::generated_by</a><span class="special"><</span> <a class="link" href="monomorphic/xrange_t.html" title="Class template xrange_t">monomorphic::xrange_t</a><span class="special"><</span> <span class="identifier">SampleType</span> <span class="special">></span> <span class="special">></span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> 43 <span class="identifier">xrange</span><span class="special">(</span><span class="identifier">SampleType</span> <span class="keyword">const</span> <span class="special">&</span> end_val<span class="special">,</span> <span class="identifier">Params</span> <span class="keyword">const</span> <span class="special">&</span> params<span class="special">)</span><span class="special">;</span> 44<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> SampleType<span class="special">></span> 45 <a class="link" href="monomorphic/generated_by.html" title="Class template generated_by">monomorphic::generated_by</a><span class="special"><</span> <a class="link" href="monomorphic/xrange_t.html" title="Class template xrange_t">monomorphic::xrange_t</a><span class="special"><</span> <span class="identifier">SampleType</span> <span class="special">></span> <span class="special">></span> 46 <span class="identifier">xrange</span><span class="special">(</span><span class="identifier">SampleType</span> <span class="keyword">const</span> <span class="special">&</span> begin_val<span class="special">,</span> <span class="identifier">SampleType</span> <span class="keyword">const</span> <span class="special">&</span> end_val<span class="special">)</span><span class="special">;</span> 47<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> SampleType<span class="special">,</span> <span class="keyword">typename</span> StepType<span class="special">></span> 48 <a class="link" href="monomorphic/generated_by.html" title="Class template generated_by">monomorphic::generated_by</a><span class="special"><</span> <a class="link" href="monomorphic/xrange_t.html" title="Class template xrange_t">monomorphic::xrange_t</a><span class="special"><</span> <span class="identifier">SampleType</span> <span class="special">></span> <span class="special">></span> 49 <span class="identifier">xrange</span><span class="special">(</span><span class="identifier">SampleType</span> <span class="keyword">const</span> <span class="special">&</span> begin_val<span class="special">,</span> <span class="identifier">SampleType</span> <span class="keyword">const</span> <span class="special">&</span> end_val<span class="special">,</span> 50 <span class="identifier">StepType</span> <span class="keyword">const</span> <span class="special">&</span> step_val<span class="special">)</span><span class="special">;</span></pre></div> 51<div class="refsect1"> 52<a name="idm46175622426880"></a><h2>Description</h2> 53<p>The following overloads are available: </p> 54<pre class="programlisting"><span class="keyword">auto</span> <span class="identifier">d</span> <span class="special">=</span> <span class="identifier">xrange</span><span class="special">(</span><span class="special">)</span><span class="special">;</span> 55<span class="keyword">auto</span> <span class="identifier">d</span> <span class="special">=</span> <span class="identifier">xrange</span><span class="special">(</span><span class="identifier">end_val</span><span class="special">)</span><span class="special">;</span> 56<span class="keyword">auto</span> <span class="identifier">d</span> <span class="special">=</span> <span class="identifier">xrange</span><span class="special">(</span><span class="identifier">end_val</span><span class="special">,</span> <span class="identifier">param</span><span class="special">)</span><span class="special">;</span> 57<span class="keyword">auto</span> <span class="identifier">d</span> <span class="special">=</span> <span class="identifier">xrange</span><span class="special">(</span><span class="identifier">begin_val</span><span class="special">,</span> <span class="identifier">end_val</span><span class="special">)</span><span class="special">;</span> 58<span class="keyword">auto</span> <span class="identifier">d</span> <span class="special">=</span> <span class="identifier">xrange</span><span class="special">(</span><span class="identifier">begin_val</span><span class="special">,</span> <span class="identifier">end_val</span><span class="special">,</span> <span class="identifier">step_val</span><span class="special">)</span><span class="special">;</span> 59<span class="keyword">auto</span> <span class="identifier">d</span> <span class="special">=</span> <span class="identifier">xrange</span><span class="special">(</span><span class="identifier">param</span><span class="special">)</span><span class="special">;</span> 60</pre> 61<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 62<li class="listitem"><p><code class="computeroutput">begin_val</code> indicates the start of the sequence (default to 0).</p></li> 63<li class="listitem"><p><code class="computeroutput">end_val</code> is the end of the sequence. If ommited, the dataset has infinite size.<br> 64</p></li> 65<li class="listitem"><p><code class="computeroutput">step_val</code> is the step between two consecutive elements of the sequence, and defaults to 1.<br> 66</p></li> 67<li class="listitem"> 68<p><code class="computeroutput">param</code> is the named parameters that describe the sequence. The following parameters are accepted:</p> 69<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; "> 70<li class="listitem"><p><code class="computeroutput">begin:</code> same meaning <code class="computeroutput">begin_val</code> </p></li> 71<li class="listitem"><p><code class="computeroutput">end:</code> same meaning as <code class="computeroutput">end_val</code> </p></li> 72<li class="listitem"><p><code class="computeroutput">step:</code> same meaning as <code class="computeroutput">step_val</code> </p></li> 73</ul></div> 74<p> 75</p> 76</li> 77</ul></div> 78<p> 79</p> 80<p>The returned value is an object that implements the dataset API.</p> 81<div class="note"><table border="0" summary="Note"> 82<tr> 83<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../doc/src/images/note.png"></td> 84<th align="left">Note</th> 85</tr> 86<tr><td align="left" valign="top"><p>the step size cannot be null, and it should be positive if <code class="computeroutput">begin_val</code> < <code class="computeroutput">end_val</code>, negative otherwise. </p></td></tr> 87</table></div> 88<p> 89</p> 90</div> 91</div> 92<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 93<td align="left"></td> 94<td align="right"><div class="copyright-footer">Copyright © 2001-2020 Boost.Test contributors<p> 95 Distributed under the Boost Software License, Version 1.0. (See accompanying 96 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>) 97 </p> 98</div></td> 99</tr></table> 100<hr> 101<div class="spirit-nav"> 102<a accesskey="p" href="monomorphic/xrange_t.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="../../../header/boost/test/data/monomorphic/grid_hpp.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> 103</div> 104</body> 105</html> 106
