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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template collection</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/collection_hpp.html" title="Header &lt;boost/test/data/monomorphic/collection.hpp&gt;">
   9 <link rel="prev" href="../../../../header/boost/test/data/monomorphic/collection_hpp.html" title="Header &lt;boost/test/data/monomorphic/collection.hpp&gt;">
  10 <link rel="next" href="is_datas_idm46279114455616.html" title="Struct template is_dataset&lt;collection&lt; C &gt;&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="../../../../header/boost/test/data/monomorphic/collection_hpp.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../../header/boost/test/data/monomorphic/collection_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="is_datas_idm46279114455616.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.collection"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class template collection</span></h2>
  29 <p>boost::unit_test::data::monomorphic::collection &#8212; Dataset from a forward iterable container (collection) </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/collection_hpp.html" title="Header &lt;boost/test/data/monomorphic/collection.hpp&gt;">boost/test/data/monomorphic/collection.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> C<span class="special">&gt;</span>
  35 <span class="keyword">class</span> <a class="link" href="collection.html" title="Class template collection">collection</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">col_type</span><span class="special">::</span><span class="identifier">value_type</span>     <a name="boost.unit_test.data.monomorphic.collection.sample"></a><span class="identifier">sample</span><span class="special">;</span>
  39   <span class="keyword">typedef</span> <span class="identifier">col_type</span><span class="special">::</span><span class="identifier">const_iterator</span> <a name="boost.unit_test.data.monomorphic.collection.iterator"></a><span class="identifier">iterator</span><span class="special">;</span>
  40
  41   <span class="keyword">enum</span> <a name="boost.unit_test.data.monomorphic.collection.@7"></a>@7 <span class="special">{</span> arity = = 1 <span class="special">}</span><span class="special">;</span>
  42
  43   <span class="comment">// <a class="link" href="collection.html#boost.unit_test.data.monomorphic.collectionconstruct-copy-destruct">construct/copy/destruct</a></span>
  44   <span class="keyword">explicit</span> <a class="link" href="collection.html#idm46279114458752-bb"><span class="identifier">collection</span></a><span class="special">(</span><span class="identifier">C</span> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  45   <a class="link" href="collection.html#idm46279114457168-bb"><span class="identifier">collection</span></a><span class="special">(</span><a class="link" href="collection.html" title="Class template collection">collection</a> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  46
  47   <span class="comment">// <a class="link" href="collection.html#idm46279114463552-bb">public member functions</a></span>
  48   <span class="identifier">C</span> <span class="keyword">const</span>  <span class="special">&amp;</span> <a class="link" href="collection.html#idm46279114462992-bb"><span class="identifier">col</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  49   <a class="link" href="../size_t.html" title="Class size_t">data::size_t</a> <a class="link" href="collection.html#idm46279114461568-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  50   <span class="identifier">iterator</span> <a class="link" href="collection.html#idm46279114460032-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  51 <span class="special">}</span><span class="special">;</span></pre></div>
  52 <div class="refsect1">
  53 <a name="idm45313894552704"></a><h2>Description</h2>
  54 <p>This dataset is applicable to any container implementing a forward iterator. Note that container with one element will be considered as singletons. This dataset is constructible with the boost::unit_test::data::make function. </p>
  55 <div class="refsect2">
  56 <a name="idm45313894551792"></a><h3>
  57 <a name="boost.unit_test.data.monomorphic.collectionconstruct-copy-destruct"></a><code class="computeroutput">collection</code>
  58         public
  59        construct/copy/destruct</h3>
  60 <div class="orderedlist"><ol class="orderedlist" type="1">
  61 <li class="listitem">
  62 <pre class="literallayout"><span class="keyword">explicit</span> <a name="idm46279114458752-bb"></a><span class="identifier">collection</span><span class="special">(</span><span class="identifier">C</span> <span class="special">&amp;&amp;</span> col<span class="special">)</span><span class="special">;</span></pre>Constructor consumed a temporary collection or stores a reference. </li>
  63 <li class="listitem">
  64 <pre class="literallayout"><a name="idm46279114457168-bb"></a><span class="identifier">collection</span><span class="special">(</span><a class="link" href="collection.html" title="Class template collection">collection</a> <span class="special">&amp;&amp;</span> c<span class="special">)</span><span class="special">;</span></pre>Move constructor. </li>
  65 </ol></div>
  66 </div>
  67 <div class="refsect2">
  68 <a name="idm45313894538464"></a><h3>
  69 <a name="idm46279114463552-bb"></a><code class="computeroutput">collection</code> public member functions</h3>
  70 <div class="orderedlist"><ol class="orderedlist" type="1">
  71 <li class="listitem">
  72 <pre class="literallayout"><span class="identifier">C</span> <span class="keyword">const</span>  <span class="special">&amp;</span> <a name="idm46279114462992-bb"></a><span class="identifier">col</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the underlying collection. </li>
  73 <li class="listitem">
  74 <pre class="literallayout"><a class="link" href="../size_t.html" title="Class size_t">data::size_t</a> <a name="idm46279114461568-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>dataset interface </li>
  75 <li class="listitem"><pre class="literallayout"><span class="identifier">iterator</span> <a name="idm46279114460032-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>
  76 </ol></div>
  77 </div>
  78 </div>
  79 </div>
  80 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  81 <td align="left"></td>
  82 <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2019 Boost.Test
  83       contributors<p>
  84         Distributed under the Boost Software License, Version 1.0. (See accompanying
  85         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>)
  86       </p>
  87 </div></td>
  88 </tr></table>
  89 <hr>
  90 <div class="spirit-nav">
  91 <a accesskey="p" href="../../../../header/boost/test/data/monomorphic/collection_hpp.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../../header/boost/test/data/monomorphic/collection_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="is_datas_idm46279114455616.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
  92 </div>
  93 </body>
  94 </html>