Imported Upstream version 1.72.0
[platform/upstream/boost.git] / libs / test / doc / html / boost / unit_test / data / make.html
1 <html>
2 <head>
3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>Function make</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/fwd_hpp.html" title="Header &lt;boost/test/data/monomorphic/fwd.hpp&gt;">
9 <link rel="prev" href="result_of/make.html" title="Struct template make">
10 <link rel="next" href="../../../header/boost/test/data/monomorphic/generate_hpp.html" title="Header &lt;boost/test/data/monomorphic/generate.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="result_of/make.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/test/data/monomorphic/fwd_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/generate_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.make"></a><div class="titlepage"></div>
27 <div class="refnamediv">
28 <h2><span class="refentrytitle">Function make</span></h2>
29 <p>boost::unit_test::data::make &#8212; Creates a dataset from a value, a collection or an array. </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/fwd_hpp.html" title="Header &lt;boost/test/data/monomorphic/fwd.hpp&gt;">boost/test/data/monomorphic/fwd.hpp</a>&gt;
33
34 </span>
35 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> DataSet<span class="special">&gt;</span> 
36   <span class="identifier">std</span><span class="special">::</span><span class="identifier">enable_if</span><span class="special">&lt;</span> <a class="link" href="monomorphic/is_dataset.html" title="Struct template is_dataset">monomorphic::is_dataset</a><span class="special">&lt;</span> <span class="identifier">DataSet</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">value</span><span class="special">,</span> <span class="identifier">DataSet</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> 
37   <span class="identifier">make</span><span class="special">(</span><span class="identifier">DataSet</span> <span class="special">&amp;&amp;</span> ds<span class="special">)</span><span class="special">;</span>
38 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> 
39   <span class="identifier">std</span><span class="special">::</span><span class="identifier">enable_if</span><span class="special">&lt;</span><span class="special">!</span><a class="link" href="../is_conta_idm46279112263952.html" title="Struct template is_container_forward_iterable">is_container_forward_iterable</a><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">value</span> <span class="special">&amp;&amp;</span><span class="special">!</span><a class="link" href="monomorphic/is_dataset.html" title="Struct template is_dataset">monomorphic::is_dataset</a><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">value</span> <span class="special">&amp;&amp;</span><span class="special">!</span><span class="identifier">is_array</span><span class="special">&lt;</span> <span class="keyword">typename</span> <span class="identifier">remove_reference</span><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">value</span><span class="special">,</span> <a class="link" href="monomorphic/singleton.html" title="Class template singleton">monomorphic::singleton</a><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> 
40   <span class="identifier">make</span><span class="special">(</span><span class="identifier">T</span> <span class="special">&amp;&amp;</span> v<span class="special">)</span><span class="special">;</span>
41 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> C<span class="special">&gt;</span> 
42   <span class="identifier">std</span><span class="special">::</span><span class="identifier">enable_if</span><span class="special">&lt;</span> <a class="link" href="../is_conta_idm46279112263952.html" title="Struct template is_container_forward_iterable">is_container_forward_iterable</a><span class="special">&lt;</span> <span class="identifier">C</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">value</span><span class="special">,</span> <a class="link" href="monomorphic/collection.html" title="Class template collection">monomorphic::collection</a><span class="special">&lt;</span> <span class="identifier">C</span> <span class="special">&gt;</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> 
43   <span class="identifier">make</span><span class="special">(</span><span class="identifier">C</span> <span class="special">&amp;&amp;</span> c<span class="special">)</span><span class="special">;</span>
44 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> size<span class="special">&gt;</span> 
45   <a class="link" href="monomorphic/array.html" title="Class template array">monomorphic::array</a><span class="special">&lt;</span> <span class="keyword">typename</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">remove_const</span><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> <span class="special">&gt;</span> <span class="identifier">make</span><span class="special">(</span><span class="identifier">T</span><span class="special">(</span><span class="special">&amp;</span><span class="special">)</span> a<span class="special">)</span><span class="special">;</span>
46 <a class="link" href="monomorphic/singleton.html" title="Class template singleton">monomorphic::singleton</a><span class="special">&lt;</span> <span class="keyword">char</span> <span class="special">*</span> <span class="special">&gt;</span> <span class="identifier">make</span><span class="special">(</span><span class="keyword">char</span> <span class="special">*</span> str<span class="special">)</span><span class="special">;</span>
47 <a class="link" href="monomorphic/singleton.html" title="Class template singleton">monomorphic::singleton</a><span class="special">&lt;</span> <span class="keyword">char</span> <span class="keyword">const</span>  <span class="special">*</span> <span class="special">&gt;</span> <span class="identifier">make</span><span class="special">(</span><span class="keyword">char</span> <span class="keyword">const</span> <span class="special">*</span> str<span class="special">)</span><span class="special">;</span>
48 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> 
49   <a class="link" href="monomorphic/init_list.html" title="Class template init_list">monomorphic::init_list</a><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span> <span class="identifier">make</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">initializer_list</span><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
50 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">class</span> <span class="special">...</span> Args<span class="special">&gt;</span> 
51   <span class="identifier">std</span><span class="special">::</span><span class="identifier">enable_if</span><span class="special">&lt;</span> <span class="special">!</span><a class="link" href="monomorphic/has_dataset.html" title="Struct template has_dataset">monomorphic::has_dataset</a><span class="special">&lt;</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">Args</span><span class="special">...</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">value</span><span class="special">,</span> <a class="link" href="monomorphic/init_list.html" title="Class template init_list">monomorphic::init_list</a><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;&gt;</span><span class="special">::</span><span class="identifier">type</span> 
52   <span class="identifier">make</span><span class="special">(</span><span class="identifier">T</span> <span class="special">&amp;&amp;</span> arg0<span class="special">,</span> <span class="identifier">Args</span> <span class="special">&amp;&amp;</span><span class="special">...</span> args<span class="special">)</span><span class="special">;</span></pre></div>
53 <div class="refsect1">
54 <a name="idm45313893831312"></a><h2>Description</h2>
55 <p>This function has several overloads: </p>
56 <pre class="programlisting"><span class="comment">// returns ds if ds is already a dataset</span>
57 <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">DataSet</span><span class="special">&gt;</span> <span class="identifier">DataSet</span> <span class="identifier">make</span><span class="special">(</span><span class="identifier">DataSet</span><span class="special">&amp;&amp;</span> <span class="identifier">ds</span><span class="special">)</span><span class="special">;</span> 
58
59 <span class="comment">// creates a singleton dataset, for non forward iterable and non dataset type T</span>
60 <span class="comment">// (a C string is not considered as a sequence).</span>
61 <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">monomorphic</span><span class="special">::</span><span class="identifier">singleton</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">make</span><span class="special">(</span><span class="identifier">T</span><span class="special">&amp;&amp;</span> <span class="identifier">v</span><span class="special">)</span><span class="special">;</span> 
62 <span class="identifier">monomorphic</span><span class="special">::</span><span class="identifier">singleton</span><span class="special">&lt;</span><span class="keyword">char</span><span class="special">*</span><span class="special">&gt;</span> <span class="identifier">make</span><span class="special">(</span> <span class="keyword">char</span><span class="special">*</span> <span class="identifier">str</span> <span class="special">)</span><span class="special">;</span>
63 <span class="identifier">monomorphic</span><span class="special">::</span><span class="identifier">singleton</span><span class="special">&lt;</span><span class="keyword">char</span> <span class="keyword">const</span><span class="special">*</span><span class="special">&gt;</span> <span class="identifier">make</span><span class="special">(</span> <span class="keyword">char</span> <span class="keyword">const</span><span class="special">*</span> <span class="identifier">str</span> <span class="special">)</span><span class="special">;</span>
64
65 <span class="comment">// creates a collection dataset, for forward iterable and non dataset type C</span>
66 <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">C</span><span class="special">&gt;</span> <span class="identifier">monomorphic</span><span class="special">::</span><span class="identifier">collection</span><span class="special">&lt;</span><span class="identifier">C</span><span class="special">&gt;</span> <span class="identifier">make</span><span class="special">(</span><span class="identifier">C</span> <span class="special">&amp;&amp;</span> <span class="identifier">c</span><span class="special">)</span><span class="special">;</span>
67
68 <span class="comment">// creates an array dataset</span>
69 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">size</span><span class="special">&gt;</span> <span class="identifier">monomorphic</span><span class="special">::</span><span class="identifier">array</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="identifier">make</span><span class="special">(</span> <span class="identifier">T</span> <span class="special">(</span><span class="special">&amp;</span><span class="identifier">a</span><span class="special">)</span><span class="special">[</span><span class="identifier">size</span><span class="special">]</span> <span class="special">)</span><span class="special">;</span>
70 </pre>
71 <p> </p>
72 </div>
73 </div>
74 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
75 <td align="left"></td>
76 <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2019 Boost.Test
77       contributors<p>
78         Distributed under the Boost Software License, Version 1.0. (See accompanying
79         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>)
80       </p>
81 </div></td>
82 </tr></table>
83 <hr>
84 <div class="spirit-nav">
85 <a accesskey="p" href="result_of/make.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/test/data/monomorphic/fwd_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/generate_hpp.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
86 </div>
87 </body>
88 </html>