xrange.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  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 &lt;boost/test/data/monomorphic/generators/xrange.hpp&gt;">
  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 &lt;boost/test/data/monomorphic/grid.hpp&gt;">
  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 &#8212; 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: &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. </span>
  34. <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> Params<span class="special">&gt;</span>
  35. <a class="link" href="monomorphic/generated_by.html" title="Class template generated_by">monomorphic::generated_by</a><span class="special">&lt;</span> <a class="link" href="monomorphic/xrange_t.html" title="Class template xrange_t">monomorphic::xrange_t</a><span class="special">&lt;</span> <span class="identifier">SampleType</span> <span class="special">&gt;</span> <span class="special">&gt;</span>
  36. <span class="identifier">xrange</span><span class="special">(</span><span class="identifier">Params</span> <span class="keyword">const</span> <span class="special">&amp;</span> params<span class="special">)</span><span class="special">;</span>
  37. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> SampleType<span class="special">&gt;</span>
  38. <a class="link" href="monomorphic/generated_by.html" title="Class template generated_by">monomorphic::generated_by</a><span class="special">&lt;</span> <a class="link" href="monomorphic/xrange_t.html" title="Class template xrange_t">monomorphic::xrange_t</a><span class="special">&lt;</span> <span class="identifier">SampleType</span> <span class="special">&gt;</span> <span class="special">&gt;</span>
  39. <span class="identifier">xrange</span><span class="special">(</span><span class="identifier">SampleType</span> <span class="keyword">const</span> <span class="special">&amp;</span> end_val<span class="special">)</span><span class="special">;</span>
  40. <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> Params<span class="special">&gt;</span>
  41. <span class="identifier">enable_if_c</span><span class="special">&lt;</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">&lt;</span> <span class="identifier">Params</span> <span class="special">&gt;</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">&lt;</span> <a class="link" href="monomorphic/xrange_t.html" title="Class template xrange_t">monomorphic::xrange_t</a><span class="special">&lt;</span> <span class="identifier">SampleType</span> <span class="special">&gt;</span> <span class="special">&gt;</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span>
  42. <span class="identifier">xrange</span><span class="special">(</span><span class="identifier">SampleType</span> <span class="keyword">const</span> <span class="special">&amp;</span> end_val<span class="special">,</span> <span class="identifier">Params</span> <span class="keyword">const</span> <span class="special">&amp;</span> params<span class="special">)</span><span class="special">;</span>
  43. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> SampleType<span class="special">&gt;</span>
  44. <a class="link" href="monomorphic/generated_by.html" title="Class template generated_by">monomorphic::generated_by</a><span class="special">&lt;</span> <a class="link" href="monomorphic/xrange_t.html" title="Class template xrange_t">monomorphic::xrange_t</a><span class="special">&lt;</span> <span class="identifier">SampleType</span> <span class="special">&gt;</span> <span class="special">&gt;</span>
  45. <span class="identifier">xrange</span><span class="special">(</span><span class="identifier">SampleType</span> <span class="keyword">const</span> <span class="special">&amp;</span> begin_val<span class="special">,</span> <span class="identifier">SampleType</span> <span class="keyword">const</span> <span class="special">&amp;</span> end_val<span class="special">)</span><span class="special">;</span>
  46. <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">&gt;</span>
  47. <a class="link" href="monomorphic/generated_by.html" title="Class template generated_by">monomorphic::generated_by</a><span class="special">&lt;</span> <a class="link" href="monomorphic/xrange_t.html" title="Class template xrange_t">monomorphic::xrange_t</a><span class="special">&lt;</span> <span class="identifier">SampleType</span> <span class="special">&gt;</span> <span class="special">&gt;</span>
  48. <span class="identifier">xrange</span><span class="special">(</span><span class="identifier">SampleType</span> <span class="keyword">const</span> <span class="special">&amp;</span> begin_val<span class="special">,</span> <span class="identifier">SampleType</span> <span class="keyword">const</span> <span class="special">&amp;</span> end_val<span class="special">,</span>
  49. <span class="identifier">StepType</span> <span class="keyword">const</span> <span class="special">&amp;</span> step_val<span class="special">)</span><span class="special">;</span></pre></div>
  50. <div class="refsect1">
  51. <a name="idm45313893078240"></a><h2>Description</h2>
  52. <p>The following overloads are available: </p>
  53. <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>
  54. <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>
  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="identifier">param</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">begin_val</span><span class="special">,</span> <span class="identifier">end_val</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="identifier">step_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">param</span><span class="special">)</span><span class="special">;</span>
  59. </pre>
  60. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  61. <li class="listitem"><p><code class="computeroutput">begin_val</code> indicates the start of the sequence (default to 0).</p></li>
  62. <li class="listitem"><p><code class="computeroutput">end_val</code> is the end of the sequence. If ommited, the dataset has infinite size.<br>
  63. </p></li>
  64. <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>
  65. </p></li>
  66. <li class="listitem">
  67. <p><code class="computeroutput">param</code> is the named parameters that describe the sequence. The following parameters are accepted:</p>
  68. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
  69. <li class="listitem"><p><code class="computeroutput">begin:</code> same meaning <code class="computeroutput">begin_val</code> </p></li>
  70. <li class="listitem"><p><code class="computeroutput">end:</code> same meaning as <code class="computeroutput">end_val</code> </p></li>
  71. <li class="listitem"><p><code class="computeroutput">step:</code> same meaning as <code class="computeroutput">step_val</code> </p></li>
  72. </ul></div>
  73. <p>
  74. </p>
  75. </li>
  76. </ul></div>
  77. <p>
  78. </p>
  79. <p>The returned value is an object that implements the dataset API.</p>
  80. <div class="note"><table border="0" summary="Note">
  81. <tr>
  82. <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../doc/src/images/note.png"></td>
  83. <th align="left">Note</th>
  84. </tr>
  85. <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> &lt; <code class="computeroutput">end_val</code>, negative otherwise. </p></td></tr>
  86. </table></div>
  87. <p>
  88. </p>
  89. </div>
  90. </div>
  91. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  92. <td align="left"></td>
  93. <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2019 Boost.Test
  94. 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>