Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ComputeLibrary / 575c81f38edecaa662f3ee45d04ad8efded4fa81 / . / documentation / _utility_8h.xhtml
blob: bacddc172191194156f2435feaa46e05b5c971bd [file] [log] [blame]
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame]1<!-- HTML header for doxygen 1.8.15-->
2<!-- Remember to use version doxygen 1.8.15 +-->
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml">
5<head>
6<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
7<meta http-equiv="X-UA-Compatible" content="IE=9"/>
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame]8<meta name="generator" content="Doxygen 1.8.15"/>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]9<meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
10<title>Compute Library: arm_compute/core/utils/misc/Utility.h File Reference</title>
11<link href="tabs.css" rel="stylesheet" type="text/css"/>
12<script type="text/javascript" src="jquery.js"></script>
13<script type="text/javascript" src="dynsections.js"></script>
14<link href="navtree.css" rel="stylesheet" type="text/css"/>
15<script type="text/javascript" src="resize.js"></script>
16<script type="text/javascript" src="navtreedata.js"></script>
17<script type="text/javascript" src="navtree.js"></script>
18<script type="text/javascript">
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame]19/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]20 $(document).ready(initResizable);
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame]21/* @license-end */</script>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]22<link href="search/search.css" rel="stylesheet" type="text/css"/>
23<script type="text/javascript" src="search/searchdata.js"></script>
24<script type="text/javascript" src="search/search.js"></script>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]25<script type="text/x-mathjax-config">
26 MathJax.Hub.Config({
27 extensions: ["tex2jax.js"],
28 jax: ["input/TeX","output/HTML-CSS"],
29});
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame]30</script><script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]31<link href="doxygen.css" rel="stylesheet" type="text/css" />
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame]32<link href="stylesheet.css" rel="stylesheet" type="text/css"/>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]33</head>
34<body>
35<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
36<div id="titlearea">
37<table cellspacing="0" cellpadding="0">
38 <tbody>
39 <tr style="height: 56px;">
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame]40 <img alt="Compute Library" src="https://raw.githubusercontent.com/ARM-software/ComputeLibrary/gh-pages/ACL_logo.png" style="max-width: 100%;margin-top: 15px;margin-left: 10px"/>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]41 <td style="padding-left: 0.5em;">
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame]42 <div id="projectname">
Jenkins575c81f2020-03-05 16:07:35 +0000[diff] [blame^]43 &#160;<span id="projectnumber">20.02.1</span>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]44 </div>
45 </td>
46 </tr>
47 </tbody>
48</table>
49</div>
50<!-- end header part -->
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame]51<!-- Generated by Doxygen 1.8.15 -->
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]52<script type="text/javascript">
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame]53/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]54var searchBox = new SearchBox("searchBox", "search",false,'Search');
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame]55/* @license-end */
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]56</script>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]57<script type="text/javascript" src="menudata.js"></script>
58<script type="text/javascript" src="menu.js"></script>
59<script type="text/javascript">
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame]60/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]61$(function() {
62 initMenu('',true,false,'search.php','Search');
63 $(document).ready(function() { init_search(); });
64});
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame]65/* @license-end */</script>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]66<div id="main-nav"></div>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]67</div><!-- top -->
68<div id="side-nav" class="ui-resizable side-nav-resizable">
69 <div id="nav-tree">
70 <div id="nav-tree-contents">
71 <div id="nav-sync" class="sync"></div>
72 </div>
73 </div>
74 <div id="splitbar" style="-moz-user-select:none;"
75 class="ui-resizable-handle">
76 </div>
77</div>
78<script type="text/javascript">
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame]79/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]80$(document).ready(function(){initNavTree('_utility_8h.xhtml','');});
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame]81/* @license-end */
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]82</script>
83<div id="doc-content">
84<!-- window showing the filter options -->
85<div id="MSearchSelectWindow"
86 onmouseover="return searchBox.OnSearchSelectShow()"
87 onmouseout="return searchBox.OnSearchSelectHide()"
88 onkeydown="return searchBox.OnSearchSelectKey(event)">
89</div>
90
91<!-- iframe showing the search results (closed by default) -->
92<div id="MSearchResultsWindow">
93<iframe src="javascript:void(0)" frameborder="0"
94 name="MSearchResults" id="MSearchResults">
95</iframe>
96</div>
97
98<div class="header">
99 <div class="summary">
100<a href="#namespaces">Namespaces</a> &#124;
101<a href="#func-members">Functions</a> </div>
102 <div class="headertitle">
103<div class="title">Utility.h File Reference</div> </div>
104</div><!--header-->
105<div class="contents">
106<div class="textblock"><code>#include &lt;algorithm&gt;</code><br />
107<code>#include &lt;array&gt;</code><br />
108<code>#include &lt;limits&gt;</code><br />
109<code>#include &lt;numeric&gt;</code><br />
110<code>#include &lt;vector&gt;</code><br />
111</div>
112<p><a href="_utility_8h_source.xhtml">Go to the source code of this file.</a></p>
113<table class="memberdecls">
114<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
115Namespaces</h2></td></tr>
116<tr class="memitem:namespacearm__compute"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearm__compute.xhtml">arm_compute</a></td></tr>
Jenkins36ccc902020-02-21 11:10:48 +0000[diff] [blame]117<tr class="memdesc:namespacearm__compute"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copyright (c) 2017-2020 ARM Limited. <br /></td></tr>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]118<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
119<tr class="memitem:namespacearm__compute_1_1utility"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utility.xhtml">arm_compute::utility</a></td></tr>
120<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
121<tr class="memitem:namespacearm__compute_1_1utility_1_1detail"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utility_1_1detail.xhtml">arm_compute::utility::detail</a></td></tr>
122<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
123</table><table class="memberdecls">
124<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
125Functions</h2></td></tr>
126<tr class="memitem:aae92fd77ef96d27bc5b5a10258da66cc"><td class="memTemplParams" colspan="2">template&lt;std::size_t... S, typename Iterator , typename T = std::array&lt;typename std::iterator_traits&lt;Iterator&gt;::value_type, sizeof...(S)&gt;&gt; </td></tr>
127<tr class="memitem:aae92fd77ef96d27bc5b5a10258da66cc"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utility_1_1detail.xhtml#aae92fd77ef96d27bc5b5a10258da66cc">make_array</a> (Iterator first, index_sequence&lt; S... &gt;)</td></tr>
128<tr class="separator:aae92fd77ef96d27bc5b5a10258da66cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
129<tr class="memitem:ab7c665e19081aef1a68ec0090b4c7be6"><td class="memTemplParams" colspan="2">template&lt;std::size_t N, typename Iterator &gt; </td></tr>
130<tr class="memitem:ab7c665e19081aef1a68ec0090b4c7be6"><td class="memTemplItemLeft" align="right" valign="top">std::array&lt; typename std::iterator_traits&lt; Iterator &gt;::value_type, N &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utility.xhtml#ab7c665e19081aef1a68ec0090b4c7be6">make_array</a> (Iterator first, Iterator last)</td></tr>
131<tr class="separator:ab7c665e19081aef1a68ec0090b4c7be6"><td class="memSeparator" colspan="2">&#160;</td></tr>
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame]132<tr class="memitem:a96efecf997f13a914609ddf1eb67f624"><td class="memTemplParams" colspan="2">template&lt;typename DataType , typename RangeType = DataType&gt; </td></tr>
133<tr class="memitem:a96efecf997f13a914609ddf1eb67f624"><td class="memTemplItemLeft" align="right" valign="top">DataType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utility.xhtml#a96efecf997f13a914609ddf1eb67f624">clamp</a> (const DataType &amp;n, const DataType &amp;lower=std::numeric_limits&lt; RangeType &gt;::lowest(), const DataType &amp;upper=std::numeric_limits&lt; RangeType &gt;::max())</td></tr>
134<tr class="memdesc:a96efecf997f13a914609ddf1eb67f624"><td class="mdescLeft">&#160;</td><td class="mdescRight">Performs clamping among a lower and upper value. <a href="namespacearm__compute_1_1utility.xhtml#a96efecf997f13a914609ddf1eb67f624">More...</a><br /></td></tr>
135<tr class="separator:a96efecf997f13a914609ddf1eb67f624"><td class="memSeparator" colspan="2">&#160;</td></tr>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]136<tr class="memitem:a067ebd28103d827b6ec17032e2344064"><td class="memTemplParams" colspan="2">template&lt;typename F &gt; </td></tr>
137<tr class="memitem:a067ebd28103d827b6ec17032e2344064"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utility.xhtml#a067ebd28103d827b6ec17032e2344064">for_each</a> (F &amp;&amp;)</td></tr>
138<tr class="memdesc:a067ebd28103d827b6ec17032e2344064"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base case of for_each. <a href="namespacearm__compute_1_1utility.xhtml#a067ebd28103d827b6ec17032e2344064">More...</a><br /></td></tr>
139<tr class="separator:a067ebd28103d827b6ec17032e2344064"><td class="memSeparator" colspan="2">&#160;</td></tr>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]140<tr class="memitem:a1e384f81bb641de61df2800a432c51fe"><td class="memTemplParams" colspan="2">template&lt;typename F , typename T , typename... Ts&gt; </td></tr>
141<tr class="memitem:a1e384f81bb641de61df2800a432c51fe"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utility.xhtml#a1e384f81bb641de61df2800a432c51fe">for_each</a> (F &amp;&amp;func, T &amp;&amp;arg, Ts &amp;&amp;... args)</td></tr>
142<tr class="memdesc:a1e384f81bb641de61df2800a432c51fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Call the function for each of the arguments. <a href="namespacearm__compute_1_1utility.xhtml#a1e384f81bb641de61df2800a432c51fe">More...</a><br /></td></tr>
143<tr class="separator:a1e384f81bb641de61df2800a432c51fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]144<tr class="memitem:a043270c1f50c73bf9f91fcc4570ccf0c"><td class="memTemplParams" colspan="2">template&lt;typename F , typename T &gt; </td></tr>
145<tr class="memitem:a043270c1f50c73bf9f91fcc4570ccf0c"><td class="memTemplItemLeft" align="right" valign="top">T &amp;&amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utility.xhtml#a043270c1f50c73bf9f91fcc4570ccf0c">foldl</a> (F &amp;&amp;, T &amp;&amp;value)</td></tr>
146<tr class="memdesc:a043270c1f50c73bf9f91fcc4570ccf0c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base case of foldl. <a href="namespacearm__compute_1_1utility.xhtml#a043270c1f50c73bf9f91fcc4570ccf0c">More...</a><br /></td></tr>
147<tr class="separator:a043270c1f50c73bf9f91fcc4570ccf0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame]148<tr class="memitem:a9a9639bdb9769d758f0a582ba27c4e63"><td class="memTemplParams" colspan="2">template&lt;typename F , typename T , typename U , typename... Us&gt; </td></tr>
149<tr class="memitem:a9a9639bdb9769d758f0a582ba27c4e63"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utility.xhtml#a9a9639bdb9769d758f0a582ba27c4e63">foldl</a> (F &amp;&amp;func, T &amp;&amp;initial, U &amp;&amp;value, Us &amp;&amp;... values) -&gt; decltype(func(std::forward&lt; T &gt;(initial), std::forward&lt; U &gt;(value)))</td></tr>
150<tr class="memdesc:a9a9639bdb9769d758f0a582ba27c4e63"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fold left. <a href="namespacearm__compute_1_1utility.xhtml#a9a9639bdb9769d758f0a582ba27c4e63">More...</a><br /></td></tr>
151<tr class="separator:a9a9639bdb9769d758f0a582ba27c4e63"><td class="memSeparator" colspan="2">&#160;</td></tr>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]152<tr class="memitem:a0c1a72cd100958036bb59f0625f0613f"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
153<tr class="memitem:a0c1a72cd100958036bb59f0625f0613f"><td class="memTemplItemLeft" align="right" valign="top">std::vector&lt; size_t &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utility.xhtml#a0c1a72cd100958036bb59f0625f0613f">sort_indices</a> (const std::vector&lt; T &gt; &amp;v)</td></tr>
154<tr class="memdesc:a0c1a72cd100958036bb59f0625f0613f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Perform an index sort of a given vector. <a href="namespacearm__compute_1_1utility.xhtml#a0c1a72cd100958036bb59f0625f0613f">More...</a><br /></td></tr>
155<tr class="separator:a0c1a72cd100958036bb59f0625f0613f"><td class="memSeparator" colspan="2">&#160;</td></tr>
Jenkins52ba29e2018-08-29 15:32:11 +0000[diff] [blame]156<tr class="memitem:af8cd4923f17276faa2f7a1a60e7acb17"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utility.xhtml#af8cd4923f17276faa2f7a1a60e7acb17">endswith</a> (const std::string &amp;str, const std::string &amp;suffix)</td></tr>
157<tr class="memdesc:af8cd4923f17276faa2f7a1a60e7acb17"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if a string contains a given suffix. <a href="namespacearm__compute_1_1utility.xhtml#af8cd4923f17276faa2f7a1a60e7acb17">More...</a><br /></td></tr>
158<tr class="separator:af8cd4923f17276faa2f7a1a60e7acb17"><td class="memSeparator" colspan="2">&#160;</td></tr>
159<tr class="memitem:a9eed476cf46a22a3ce6ebd8ba22e8945"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utility.xhtml#a9eed476cf46a22a3ce6ebd8ba22e8945">check_aligned</a> (void *ptr, const size_t alignment)</td></tr>
160<tr class="memdesc:a9eed476cf46a22a3ce6ebd8ba22e8945"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if a pointer complies with a given alignment. <a href="namespacearm__compute_1_1utility.xhtml#a9eed476cf46a22a3ce6ebd8ba22e8945">More...</a><br /></td></tr>
161<tr class="separator:a9eed476cf46a22a3ce6ebd8ba22e8945"><td class="memSeparator" colspan="2">&#160;</td></tr>
162<tr class="memitem:abb96ad5c7071ec3a47ea5f07e817a636"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utility.xhtml#abb96ad5c7071ec3a47ea5f07e817a636">tolower</a> (std::string string)</td></tr>
163<tr class="memdesc:abb96ad5c7071ec3a47ea5f07e817a636"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert string to lower case. <a href="namespacearm__compute_1_1utility.xhtml#abb96ad5c7071ec3a47ea5f07e817a636">More...</a><br /></td></tr>
164<tr class="separator:abb96ad5c7071ec3a47ea5f07e817a636"><td class="memSeparator" colspan="2">&#160;</td></tr>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]165</table>
166</div><!-- contents -->
167</div><!-- doc-content -->
168<!-- start footer part -->
169<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
170 <ul>
171 <li class="navelem"><a class="el" href="dir_214608ef36d61442cb2b0c1c4e9a7def.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="dir_1fb090f0c6070330bfaccc4236d3ca0d.xhtml">core</a></li><li class="navelem"><a class="el" href="dir_7b0825b7536eda12b63e5d87347b1c7d.xhtml">utils</a></li><li class="navelem"><a class="el" href="dir_cab437ca4f6ec1fbc573ae83f91b2654.xhtml">misc</a></li><li class="navelem"><a class="el" href="_utility_8h.xhtml">Utility.h</a></li>
Jenkins575c81f2020-03-05 16:07:35 +0000[diff] [blame^]172 <li class="footer">Generated on Thu Mar 5 2020 16:07:06 for Compute Library by
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]173 <a href="http://www.doxygen.org/index.html">
Jenkins514be652019-02-28 12:25:18 +0000[diff] [blame]174 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]175 </ul>
176</div>
177</body>
178</html>