libs/test/doc/html/boost/unit_test/data/monomorphic/zip.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template zip</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/zip_hpp.html" title="Header &lt;boost/test/data/monomorphic/zip.hpp&gt;">
   9 <link rel="prev" href="is_datas_idm46279114106448.html" title="Struct template is_dataset&lt;zip&lt; DataSet1, DataSet2 &gt;&gt;">
  10 <link rel="next" href="zip/iterator.html" title="Struct 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="is_datas_idm46279114106448.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../../header/boost/test/data/monomorphic/zip_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="zip/iterator.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.zip"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class template zip</span></h2>
  29 <p>boost::unit_test::data::monomorphic::zip &#8212; Zip datasets. </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/zip_hpp.html" title="Header &lt;boost/test/data/monomorphic/zip.hpp&gt;">boost/test/data/monomorphic/zip.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> DataSet1<span class="special">,</span> <span class="keyword">typename</span> DataSet2<span class="special">&gt;</span>
  35 <span class="keyword">class</span> <a class="link" href="zip.html" title="Class template zip">zip</a> <span class="special">{</span>
  36 <span class="keyword">public</span><span class="special">:</span>
  37   <span class="comment">// member classes/structs/unions</span>
  38
  39   <span class="keyword">struct</span> <a class="link" href="zip/iterator.html" title="Struct iterator">iterator</a> <span class="special">{</span>
  40     <span class="comment">// types</span>
  41     <span class="keyword">typedef</span> <span class="keyword">decltype</span><span class="special">(</span><span class="identifier">sample_merge</span><span class="special">(</span><span class="special">*</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">declval</span><span class="special">&lt;</span> <span class="identifier">dataset1_iter</span> <span class="special">&gt;</span><span class="special">(</span><span class="special">)</span><span class="special">,</span> <span class="special">*</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">declval</span><span class="special">&lt;</span> <span class="identifier">dataset2_iter</span> <span class="special">&gt;</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">)</span> <a class="link" href="zip/iterator.html#boost.unit_test.data.monomorphic.zip.iterator.iterator_sample"><span class="identifier">iterator_sample</span></a><span class="special">;</span>
  42
  43     <span class="comment">// <a class="link" href="zip/iterator.html#boost.unit_test.data.monomorphic.zip.iteratorconstruct-copy-destruct">construct/copy/destruct</a></span>
  44     <span class="keyword">explicit</span> <a class="link" href="zip/iterator.html#idm46279114095968-bb"><span class="identifier">iterator</span></a><span class="special">(</span><span class="identifier">dataset1_iter</span><span class="special">,</span> <span class="identifier">dataset2_iter</span><span class="special">)</span><span class="special">;</span>
  45
  46     <span class="comment">// <a class="link" href="zip/iterator.html#idm46279114098656-bb">public member functions</a></span>
  47     <span class="keyword">auto</span> <a class="link" href="zip/iterator.html#idm46279114098096-bb"><span class="keyword">operator</span> <span class="special">*</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  48     <span class="keyword">void</span> <a class="link" href="zip/iterator.html#idm46279114096976-bb"><span class="keyword">operator</span><span class="special">++</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  49   <span class="special">}</span><span class="special">;</span>
  50
  51   <span class="keyword">enum</span> <a name="boost.unit_test.data.monomorphic.zip.@12"></a>@12 <span class="special">{</span> arity = = dataset1_decay::arity + dataset2_decay::arity <span class="special">}</span><span class="special">;</span>
  52   <span class="comment">// <a class="link" href="zip.html#boost.unit_test.data.monomorphic.zipconstruct-copy-destruct">construct/copy/destruct</a></span>
  53   <a class="link" href="zip.html#idm46279114089536-bb"><span class="identifier">zip</span></a><span class="special">(</span><span class="identifier">DataSet1</span> <span class="special">&amp;&amp;</span><span class="special">,</span> <span class="identifier">DataSet2</span> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  54   <a class="link" href="zip.html#idm46279114087152-bb"><span class="identifier">zip</span></a><span class="special">(</span><a class="link" href="zip.html" title="Class template zip">zip</a> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  55
  56   <span class="comment">// <a class="link" href="zip.html#idm46279114092752-bb">public member functions</a></span>
  57   <a class="link" href="../size_t.html" title="Class size_t">data::size_t</a> <a class="link" href="zip.html#idm46279114092192-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  58   <a class="link" href="zip/iterator.html" title="Struct iterator">iterator</a> <a class="link" href="zip.html#idm46279114090944-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  59
  60   <span class="comment">// <a class="link" href="zip.html#idm46279114085600-bb">private member functions</a></span>
  61   <a class="link" href="../size_t.html" title="Class size_t">data::size_t</a> <a class="link" href="zip.html#idm46279114085024-bb"><span class="identifier">zip_size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  62 <span class="special">}</span><span class="special">;</span></pre></div>
  63 <div class="refsect1">
  64 <a name="idm45313891561648"></a><h2>Description</h2>
  65 <p>A zip of two datasets is a dataset whose arity is the sum of the operand datasets arity. The size is given by the function creating the instance (see <code class="computeroutput">operator^</code> on datasets). </p>
  66 <div class="refsect2">
  67 <a name="idm45313891560096"></a><h3>
  68 <a name="boost.unit_test.data.monomorphic.zipconstruct-copy-destruct"></a><code class="computeroutput">zip</code>
  69         public
  70        construct/copy/destruct</h3>
  71 <div class="orderedlist"><ol class="orderedlist" type="1">
  72 <li class="listitem">
  73 <pre class="literallayout"><a name="idm46279114089536-bb"></a><span class="identifier">zip</span><span class="special">(</span><span class="identifier">DataSet1</span> <span class="special">&amp;&amp;</span> ds1<span class="special">,</span> <span class="identifier">DataSet2</span> <span class="special">&amp;&amp;</span> ds2<span class="special">)</span><span class="special">;</span></pre>Constructor. <p>The datasets are moved and not copied. </p>
  74 </li>
  75 <li class="listitem">
  76 <pre class="literallayout"><a name="idm46279114087152-bb"></a><span class="identifier">zip</span><span class="special">(</span><a class="link" href="zip.html" title="Class template zip">zip</a> <span class="special">&amp;&amp;</span> j<span class="special">)</span><span class="special">;</span></pre>Move constructor. </li>
  77 </ol></div>
  78 </div>
  79 <div class="refsect2">
  80 <a name="idm45313891544944"></a><h3>
  81 <a name="idm46279114092752-bb"></a><code class="computeroutput">zip</code> public member functions</h3>
  82 <div class="orderedlist"><ol class="orderedlist" type="1">
  83 <li class="listitem"><pre class="literallayout"><a class="link" href="../size_t.html" title="Class size_t">data::size_t</a> <a name="idm46279114092192-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  84 <li class="listitem"><pre class="literallayout"><a class="link" href="zip/iterator.html" title="Struct iterator">iterator</a> <a name="idm46279114090944-bb"></a><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  85 </ol></div>
  86 </div>
  87 <div class="refsect2">
  88 <a name="idm45313891532656"></a><h3>
  89 <a name="idm46279114085600-bb"></a><code class="computeroutput">zip</code> private member functions</h3>
  90 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  91 <pre class="literallayout"><a class="link" href="../size_t.html" title="Class size_t">data::size_t</a> <a name="idm46279114085024-bb"></a><span class="identifier">zip_size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Handles the sise of the resulting zipped dataset. </li></ol></div>
  92 </div>
  93 </div>
  94 </div>
  95 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  96 <td align="left"></td>
  97 <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2019 Boost.Test
  98       contributors<p>
  99         Distributed under the Boost Software License, Version 1.0. (See accompanying
 100         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>)
 101       </p>
 102 </div></td>
 103 </tr></table>
 104 <hr>
 105 <div class="spirit-nav">
 106 <a accesskey="p" href="is_datas_idm46279114106448.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../../header/boost/test/data/monomorphic/zip_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="zip/iterator.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
 107 </div>
 108 </body>
 109 </html>