arm_compute v18.05
[platform/upstream/armcl.git] / documentation / namespacearm__compute_1_1support_1_1cpp14.xhtml
1 <!-- HTML header for doxygen 1.8.9.1-->
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
4 <head>
5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
7 <meta name="generator" content="Doxygen 1.8.11"/>
8 <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
9 <title>Compute Library: arm_compute::support::cpp14 Namespace Reference</title>
10 <link href="tabs.css" rel="stylesheet" type="text/css"/>
11 <script type="text/javascript" src="jquery.js"></script>
12 <script type="text/javascript" src="dynsections.js"></script>
13 <link href="navtree.css" rel="stylesheet" type="text/css"/>
14 <script type="text/javascript" src="resize.js"></script>
15 <script type="text/javascript" src="navtreedata.js"></script>
16 <script type="text/javascript" src="navtree.js"></script>
17 <script type="text/javascript">
18   $(document).ready(initResizable);
19   $(window).load(resizeHeight);
20 </script>
21 <link href="search/search.css" rel="stylesheet" type="text/css"/>
22 <script type="text/javascript" src="search/searchdata.js"></script>
23 <script type="text/javascript" src="search/search.js"></script>
24 <script type="text/javascript">
25   $(document).ready(function() { init_search(); });
26 </script>
27 <script type="text/x-mathjax-config">
28   MathJax.Hub.Config({
29     extensions: ["tex2jax.js"],
30     jax: ["input/TeX","output/HTML-CSS"],
31 });
32 </script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
33 <link href="doxygen.css" rel="stylesheet" type="text/css" />
34 </head>
35 <body>
36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
37 <div id="titlearea">
38 <table cellspacing="0" cellpadding="0">
39  <tbody>
40  <tr style="height: 56px;">
41   <td style="padding-left: 0.5em;">
42    <div id="projectname">Compute Library
43    &#160;<span id="projectnumber">18.05</span>
44    </div>
45   </td>
46  </tr>
47  </tbody>
48 </table>
49 </div>
50 <!-- end header part -->
51 <!-- Generated by Doxygen 1.8.11 -->
52 <script type="text/javascript">
53 var searchBox = new SearchBox("searchBox", "search",false,'Search');
54 </script>
55   <div id="navrow1" class="tabs">
56     <ul class="tablist">
57       <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
58       <li><a href="pages.xhtml"><span>Related&#160;Pages</span></a></li>
59       <li class="current"><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
60       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
61       <li><a href="files.xhtml"><span>Files</span></a></li>
62       <li>
63         <div id="MSearchBox" class="MSearchBoxInactive">
64         <span class="left">
65           <img id="MSearchSelect" src="search/mag_sel.png"
66                onmouseover="return searchBox.OnSearchSelectShow()"
67                onmouseout="return searchBox.OnSearchSelectHide()"
68                alt=""/>
69           <input type="text" id="MSearchField" value="Search" accesskey="S"
70                onfocus="searchBox.OnSearchFieldFocus(true)" 
71                onblur="searchBox.OnSearchFieldFocus(false)" 
72                onkeyup="searchBox.OnSearchFieldChange(event)"/>
73           </span><span class="right">
74             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
75           </span>
76         </div>
77       </li>
78     </ul>
79   </div>
80   <div id="navrow2" class="tabs2">
81     <ul class="tablist">
82       <li><a href="namespaces.xhtml"><span>Namespace&#160;List</span></a></li>
83       <li><a href="namespacemembers.xhtml"><span>Namespace&#160;Members</span></a></li>
84     </ul>
85   </div>
86 </div><!-- top -->
87 <div id="side-nav" class="ui-resizable side-nav-resizable">
88   <div id="nav-tree">
89     <div id="nav-tree-contents">
90       <div id="nav-sync" class="sync"></div>
91     </div>
92   </div>
93   <div id="splitbar" style="-moz-user-select:none;" 
94        class="ui-resizable-handle">
95   </div>
96 </div>
97 <script type="text/javascript">
98 $(document).ready(function(){initNavTree('namespacearm__compute_1_1support_1_1cpp14.xhtml','');});
99 </script>
100 <div id="doc-content">
101 <!-- window showing the filter options -->
102 <div id="MSearchSelectWindow"
103      onmouseover="return searchBox.OnSearchSelectShow()"
104      onmouseout="return searchBox.OnSearchSelectHide()"
105      onkeydown="return searchBox.OnSearchSelectKey(event)">
106 </div>
107
108 <!-- iframe showing the search results (closed by default) -->
109 <div id="MSearchResultsWindow">
110 <iframe src="javascript:void(0)" frameborder="0" 
111         name="MSearchResults" id="MSearchResults">
112 </iframe>
113 </div>
114
115 <div class="header">
116   <div class="summary">
117 <a href="#nested-classes">Data Structures</a> &#124;
118 <a href="#func-members">Functions</a>  </div>
119   <div class="headertitle">
120 <div class="title">arm_compute::support::cpp14 Namespace Reference</div>  </div>
121 </div><!--header-->
122 <div class="contents">
123 <table class="memberdecls">
124 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
125 Data Structures</h2></td></tr>
126 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__compute_1_1support_1_1cpp14_1_1___unique__if.xhtml">_Unique_if</a></td></tr>
127 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">make_unique is missing in CPP11.  <a href="structarm__compute_1_1support_1_1cpp14_1_1___unique__if.xhtml#details">More...</a><br /></td></tr>
128 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
129 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__compute_1_1support_1_1cpp14_1_1___unique__if_3_01_t[]_4.xhtml">_Unique_if&lt; T[]&gt;</a></td></tr>
130 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Template for array.  <a href="structarm__compute_1_1support_1_1cpp14_1_1___unique__if_3_01_t[]_4.xhtml#details">More...</a><br /></td></tr>
131 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
132 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__compute_1_1support_1_1cpp14_1_1___unique__if_3_01_t[_n]_4.xhtml">_Unique_if&lt; T[N]&gt;</a></td></tr>
133 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Template for array with known bounds (to throw an error).  <a href="structarm__compute_1_1support_1_1cpp14_1_1___unique__if_3_01_t[_n]_4.xhtml#details">More...</a><br /></td></tr>
134 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
135 </table><table class="memberdecls">
136 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
137 Functions</h2></td></tr>
138 <tr class="memitem:a94d8ad03db9ccb2005b06858856d0a4c"><td class="memTemplParams" colspan="2">template&lt;class T , class... Args&gt; </td></tr>
139 <tr class="memitem:a94d8ad03db9ccb2005b06858856d0a4c"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structarm__compute_1_1support_1_1cpp14_1_1___unique__if.xhtml">_Unique_if</a>&lt; T &gt;::_Single_object&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1support_1_1cpp14.xhtml#a94d8ad03db9ccb2005b06858856d0a4c">make_unique</a> (Args &amp;&amp;...args)</td></tr>
140 <tr class="memdesc:a94d8ad03db9ccb2005b06858856d0a4c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a single object and return a unique pointer to it.  <a href="#a94d8ad03db9ccb2005b06858856d0a4c">More...</a><br /></td></tr>
141 <tr class="separator:a94d8ad03db9ccb2005b06858856d0a4c"><td class="memSeparator" colspan="2">&#160;</td></tr>
142 <tr class="memitem:a9497f049c3bfd9fcebdec84397fff2b9"><td class="memTemplParams" colspan="2">template&lt;class T &gt; </td></tr>
143 <tr class="memitem:a9497f049c3bfd9fcebdec84397fff2b9"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structarm__compute_1_1support_1_1cpp14_1_1___unique__if.xhtml">_Unique_if</a>&lt; T &gt;::_Unknown_bound&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1support_1_1cpp14.xhtml#a9497f049c3bfd9fcebdec84397fff2b9">make_unique</a> (size_t n)</td></tr>
144 <tr class="memdesc:a9497f049c3bfd9fcebdec84397fff2b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct an array of objects and return a unique pointer to it.  <a href="#a9497f049c3bfd9fcebdec84397fff2b9">More...</a><br /></td></tr>
145 <tr class="separator:a9497f049c3bfd9fcebdec84397fff2b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
146 <tr class="memitem:a2ccfba86a91625f5bc79156f2a598a6d"><td class="memTemplParams" colspan="2">template&lt;class T , class... Args&gt; </td></tr>
147 <tr class="memitem:a2ccfba86a91625f5bc79156f2a598a6d"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structarm__compute_1_1support_1_1cpp14_1_1___unique__if.xhtml">_Unique_if</a>&lt; T &gt;::_Known_bound&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1support_1_1cpp14.xhtml#a2ccfba86a91625f5bc79156f2a598a6d">make_unique</a> (Args &amp;&amp;...)=delete</td></tr>
148 <tr class="memdesc:a2ccfba86a91625f5bc79156f2a598a6d"><td class="mdescLeft">&#160;</td><td class="mdescRight">It is invalid to attempt to make_unique an array with known bounds.  <a href="#a2ccfba86a91625f5bc79156f2a598a6d">More...</a><br /></td></tr>
149 <tr class="separator:a2ccfba86a91625f5bc79156f2a598a6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
150 </table>
151 <h2 class="groupheader">Function Documentation</h2>
152 <a class="anchor" id="a94d8ad03db9ccb2005b06858856d0a4c"></a>
153 <div class="memitem">
154 <div class="memproto">
155       <table class="memname">
156         <tr>
157           <td class="memname"><a class="el" href="structarm__compute_1_1support_1_1cpp14_1_1___unique__if.xhtml">_Unique_if</a>&lt;T&gt;::_Single_object arm_compute::support::cpp14::make_unique </td>
158           <td>(</td>
159           <td class="paramtype">Args &amp;&amp;...&#160;</td>
160           <td class="paramname"><em>args</em></td><td>)</td>
161           <td></td>
162         </tr>
163       </table>
164 </div><div class="memdoc">
165
166 <p>Construct a single object and return a unique pointer to it. </p>
167 <dl class="params"><dt>Parameters</dt><dd>
168   <table class="params">
169     <tr><td class="paramdir">[in]</td><td class="paramname">args</td><td>Constructor arguments.</td></tr>
170   </table>
171   </dd>
172 </dl>
173 <dl class="section return"><dt>Returns</dt><dd>a unique pointer to the new object. </dd></dl>
174
175 <p>Definition at line <a class="el" href="_toolchain_support_8h_source.xhtml#l00385">385</a> of file <a class="el" href="_toolchain_support_8h_source.xhtml">ToolchainSupport.h</a>.</p>
176
177 <p>Referenced by <a class="el" href="_framework_8h_source.xhtml#l00342">Framework::add_test_case()</a>.</p>
178 <div class="fragment"><div class="line"><a name="l00386"></a><span class="lineno">  386</span>&#160;{</div><div class="line"><a name="l00387"></a><span class="lineno">  387</span>&#160;    <span class="keywordflow">return</span> std::unique_ptr&lt;T&gt;(<span class="keyword">new</span> T(std::forward&lt;Args&gt;(args)...));</div><div class="line"><a name="l00388"></a><span class="lineno">  388</span>&#160;}</div></div><!-- fragment -->
179 </div>
180 </div>
181 <a class="anchor" id="a9497f049c3bfd9fcebdec84397fff2b9"></a>
182 <div class="memitem">
183 <div class="memproto">
184       <table class="memname">
185         <tr>
186           <td class="memname"><a class="el" href="structarm__compute_1_1support_1_1cpp14_1_1___unique__if.xhtml">_Unique_if</a>&lt;T&gt;::_Unknown_bound arm_compute::support::cpp14::make_unique </td>
187           <td>(</td>
188           <td class="paramtype">size_t&#160;</td>
189           <td class="paramname"><em>n</em></td><td>)</td>
190           <td></td>
191         </tr>
192       </table>
193 </div><div class="memdoc">
194
195 <p>Construct an array of objects and return a unique pointer to it. </p>
196 <dl class="params"><dt>Parameters</dt><dd>
197   <table class="params">
198     <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td><a class="el" href="classarm__compute_1_1_array.xhtml" title="Basic implementation of the IArray interface which allocates a static number of T values...">Array</a> size</td></tr>
199   </table>
200   </dd>
201 </dl>
202 <dl class="section return"><dt>Returns</dt><dd>a unique pointer to the new array. </dd></dl>
203
204 <p>Definition at line <a class="el" href="_toolchain_support_8h_source.xhtml#l00398">398</a> of file <a class="el" href="_toolchain_support_8h_source.xhtml">ToolchainSupport.h</a>.</p>
205
206 <p>References <a class="el" href="namespacearm__compute_1_1support_1_1cpp14.xhtml#a2ccfba86a91625f5bc79156f2a598a6d">make_unique()</a>, and <a class="el" href="namespacearm__compute.xhtml#a1ce9b523fd4f3b5bbcadcd796183455aa4c614360da93c0a041b22e537de151eb">arm_compute::U</a>.</p>
207 <div class="fragment"><div class="line"><a name="l00399"></a><span class="lineno">  399</span>&#160;{</div><div class="line"><a name="l00400"></a><span class="lineno">  400</span>&#160;    <span class="keyword">typedef</span> <span class="keyword">typename</span> std::remove_extent&lt;T&gt;::type <a class="code" href="namespacearm__compute.xhtml#a1ce9b523fd4f3b5bbcadcd796183455aa4c614360da93c0a041b22e537de151eb">U</a>;</div><div class="line"><a name="l00401"></a><span class="lineno">  401</span>&#160;    <span class="keywordflow">return</span> std::unique_ptr&lt;T&gt;(<span class="keyword">new</span> U[n]());</div><div class="line"><a name="l00402"></a><span class="lineno">  402</span>&#160;}</div><div class="ttc" id="namespacearm__compute_xhtml_a1ce9b523fd4f3b5bbcadcd796183455aa4c614360da93c0a041b22e537de151eb"><div class="ttname"><a href="namespacearm__compute.xhtml#a1ce9b523fd4f3b5bbcadcd796183455aa4c614360da93c0a041b22e537de151eb">arm_compute::Channel::U</a></div><div class="ttdoc">Cb/U channel. </div></div>
208 </div><!-- fragment -->
209 </div>
210 </div>
211 <a class="anchor" id="a2ccfba86a91625f5bc79156f2a598a6d"></a>
212 <div class="memitem">
213 <div class="memproto">
214 <table class="mlabels">
215   <tr>
216   <td class="mlabels-left">
217       <table class="memname">
218         <tr>
219           <td class="memname"><a class="el" href="structarm__compute_1_1support_1_1cpp14_1_1___unique__if.xhtml">_Unique_if</a>&lt;T&gt;::_Known_bound arm_compute::support::cpp14::make_unique </td>
220           <td>(</td>
221           <td class="paramtype">Args &amp;&amp;&#160;</td>
222           <td class="paramname"><em>...</em></td><td>)</td>
223           <td></td>
224         </tr>
225       </table>
226   </td>
227   <td class="mlabels-right">
228 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
229   </tr>
230 </table>
231 </div><div class="memdoc">
232
233 <p>It is invalid to attempt to make_unique an array with known bounds. </p>
234
235 <p>Referenced by <a class="el" href="_toolchain_support_8h_source.xhtml#l00398">make_unique()</a>.</p>
236
237 </div>
238 </div>
239 </div><!-- contents -->
240 </div><!-- doc-content -->
241 <!-- start footer part -->
242 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
243   <ul>
244     <li class="navelem"><a class="el" href="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="namespacearm__compute_1_1support.xhtml">support</a></li><li class="navelem"><a class="el" href="namespacearm__compute_1_1support_1_1cpp14.xhtml">cpp14</a></li>
245     <li class="footer">Generated on Wed May 23 2018 11:36:43 for Compute Library by
246     <a href="http://www.doxygen.org/index.html">
247     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
248   </ul>
249 </div>
250 </body>
251 </html>