Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ComputeLibrary / b9abeae0897bef74553ba9800c4ff5f74131c5b4 / . / documentation / _utility_8h.xhtml
blob: 5242c01d269609caf98114a022fb015b34e87e43 [file] [log] [blame]
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]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"/>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame^]7<meta name="generator" content="Doxygen 1.8.13"/>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]8<meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
9<title>Compute Library: arm_compute/core/utils/misc/Utility.h File 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);
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]19</script>
20<link href="search/search.css" rel="stylesheet" type="text/css"/>
21<script type="text/javascript" src="search/searchdata.js"></script>
22<script type="text/javascript" src="search/search.js"></script>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]23<script type="text/x-mathjax-config">
24 MathJax.Hub.Config({
25 extensions: ["tex2jax.js"],
26 jax: ["input/TeX","output/HTML-CSS"],
27});
28</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
29<link href="doxygen.css" rel="stylesheet" type="text/css" />
30</head>
31<body>
32<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
33<div id="titlearea">
34<table cellspacing="0" cellpadding="0">
35 <tbody>
36 <tr style="height: 56px;">
37 <td style="padding-left: 0.5em;">
38 <div id="projectname">Compute Library
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame^]39 &#160;<span id="projectnumber">18.11</span>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]40 </div>
41 </td>
42 </tr>
43 </tbody>
44</table>
45</div>
46<!-- end header part -->
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame^]47<!-- Generated by Doxygen 1.8.13 -->
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]48<script type="text/javascript">
49var searchBox = new SearchBox("searchBox", "search",false,'Search');
50</script>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame^]51<script type="text/javascript" src="menudata.js"></script>
52<script type="text/javascript" src="menu.js"></script>
53<script type="text/javascript">
54$(function() {
55 initMenu('',true,false,'search.php','Search');
56 $(document).ready(function() { init_search(); });
57});
58</script>
59<div id="main-nav"></div>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]60</div><!-- top -->
61<div id="side-nav" class="ui-resizable side-nav-resizable">
62 <div id="nav-tree">
63 <div id="nav-tree-contents">
64 <div id="nav-sync" class="sync"></div>
65 </div>
66 </div>
67 <div id="splitbar" style="-moz-user-select:none;"
68 class="ui-resizable-handle">
69 </div>
70</div>
71<script type="text/javascript">
72$(document).ready(function(){initNavTree('_utility_8h.xhtml','');});
73</script>
74<div id="doc-content">
75<!-- window showing the filter options -->
76<div id="MSearchSelectWindow"
77 onmouseover="return searchBox.OnSearchSelectShow()"
78 onmouseout="return searchBox.OnSearchSelectHide()"
79 onkeydown="return searchBox.OnSearchSelectKey(event)">
80</div>
81
82<!-- iframe showing the search results (closed by default) -->
83<div id="MSearchResultsWindow">
84<iframe src="javascript:void(0)" frameborder="0"
85 name="MSearchResults" id="MSearchResults">
86</iframe>
87</div>
88
89<div class="header">
90 <div class="summary">
91<a href="#namespaces">Namespaces</a> &#124;
92<a href="#func-members">Functions</a> </div>
93 <div class="headertitle">
94<div class="title">Utility.h File Reference</div> </div>
95</div><!--header-->
96<div class="contents">
97<div class="textblock"><code>#include &lt;algorithm&gt;</code><br />
98<code>#include &lt;array&gt;</code><br />
99<code>#include &lt;limits&gt;</code><br />
100<code>#include &lt;numeric&gt;</code><br />
101<code>#include &lt;vector&gt;</code><br />
102</div>
103<p><a href="_utility_8h_source.xhtml">Go to the source code of this file.</a></p>
104<table class="memberdecls">
105<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
106Namespaces</h2></td></tr>
107<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>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame^]108<tr class="memdesc:namespacearm__compute"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copyright (c) 2017-2018 ARM Limited. <br /></td></tr>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]109<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
110<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>
111<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
112<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>
113<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
114</table><table class="memberdecls">
115<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
116Functions</h2></td></tr>
117<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>
118<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>
119<tr class="separator:aae92fd77ef96d27bc5b5a10258da66cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
120<tr class="memitem:ab7c665e19081aef1a68ec0090b4c7be6"><td class="memTemplParams" colspan="2">template&lt;std::size_t N, typename Iterator &gt; </td></tr>
121<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>
122<tr class="separator:ab7c665e19081aef1a68ec0090b4c7be6"><td class="memSeparator" colspan="2">&#160;</td></tr>
123<tr class="memitem:a12c3c62f510452805c289e180ec78bb7"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
124<tr class="memitem:a12c3c62f510452805c289e180ec78bb7"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utility.xhtml#a12c3c62f510452805c289e180ec78bb7">clamp</a> (const T &amp;n, const T &amp;lower, const T &amp;upper)</td></tr>
125<tr class="memdesc:a12c3c62f510452805c289e180ec78bb7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Performs clamping among a lower and upper value. <a href="namespacearm__compute_1_1utility.xhtml#a12c3c62f510452805c289e180ec78bb7">More...</a><br /></td></tr>
126<tr class="separator:a12c3c62f510452805c289e180ec78bb7"><td class="memSeparator" colspan="2">&#160;</td></tr>
127<tr class="memitem:a067ebd28103d827b6ec17032e2344064"><td class="memTemplParams" colspan="2">template&lt;typename F &gt; </td></tr>
128<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>
129<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>
130<tr class="separator:a067ebd28103d827b6ec17032e2344064"><td class="memSeparator" colspan="2">&#160;</td></tr>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame^]131<tr class="memitem:a1e384f81bb641de61df2800a432c51fe"><td class="memTemplParams" colspan="2">template&lt;typename F , typename T , typename... Ts&gt; </td></tr>
132<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>
133<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>
134<tr class="separator:a1e384f81bb641de61df2800a432c51fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]135<tr class="memitem:a043270c1f50c73bf9f91fcc4570ccf0c"><td class="memTemplParams" colspan="2">template&lt;typename F , typename T &gt; </td></tr>
136<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>
137<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>
138<tr class="separator:a043270c1f50c73bf9f91fcc4570ccf0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame^]139<tr class="memitem:a9a9639bdb9769d758f0a582ba27c4e63"><td class="memTemplParams" colspan="2">template&lt;typename F , typename T , typename U , typename... Us&gt; </td></tr>
140<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>
141<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>
142<tr class="separator:a9a9639bdb9769d758f0a582ba27c4e63"><td class="memSeparator" colspan="2">&#160;</td></tr>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]143<tr class="memitem:a26bf8243169fc3fd2299024c25b0aa0d"><td class="memTemplParams" colspan="2">template&lt;typename T , typename U &gt; </td></tr>
144<tr class="memitem:a26bf8243169fc3fd2299024c25b0aa0d"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1utility.xhtml#a26bf8243169fc3fd2299024c25b0aa0d">saturate_cast</a> (U val)</td></tr>
145<tr class="memdesc:a26bf8243169fc3fd2299024c25b0aa0d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type cast with saturation. <a href="namespacearm__compute_1_1utility.xhtml#a26bf8243169fc3fd2299024c25b0aa0d">More...</a><br /></td></tr>
146<tr class="separator:a26bf8243169fc3fd2299024c25b0aa0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
147<tr class="memitem:a0c1a72cd100958036bb59f0625f0613f"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
148<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>
149<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>
150<tr class="separator:a0c1a72cd100958036bb59f0625f0613f"><td class="memSeparator" colspan="2">&#160;</td></tr>
Jenkins52ba29e2018-08-29 15:32:11 +0000[diff] [blame]151<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>
152<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>
153<tr class="separator:af8cd4923f17276faa2f7a1a60e7acb17"><td class="memSeparator" colspan="2">&#160;</td></tr>
154<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>
155<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>
156<tr class="separator:a9eed476cf46a22a3ce6ebd8ba22e8945"><td class="memSeparator" colspan="2">&#160;</td></tr>
157<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>
158<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>
159<tr class="separator:abb96ad5c7071ec3a47ea5f07e817a636"><td class="memSeparator" colspan="2">&#160;</td></tr>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]160</table>
161</div><!-- contents -->
162</div><!-- doc-content -->
163<!-- start footer part -->
164<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
165 <ul>
166 <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>
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame^]167 <li class="footer">Generated on Thu Nov 22 2018 11:57:43 for Compute Library by
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]168 <a href="http://www.doxygen.org/index.html">
Jenkinsb9abeae2018-11-22 11:58:08 +0000[diff] [blame^]169 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
Jenkinsb3a371b2018-05-23 11:36:53 +0100[diff] [blame]170 </ul>
171</div>
172</body>
173</html>