| <!-- HTML header for doxygen 1.8.15--> |
| <!-- Remember to use version doxygen 1.8.15 +--> |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.15"/> |
| <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines --> |
| <title>Compute Library: arm_compute/core/IArray.h Source File</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="navtree.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="resize.js"></script> |
| <script type="text/javascript" src="navtreedata.js"></script> |
| <script type="text/javascript" src="navtree.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(initResizable); |
| /* @license-end */</script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <script type="text/x-mathjax-config"> |
| MathJax.Hub.Config({ |
| extensions: ["tex2jax.js"], |
| jax: ["input/TeX","output/HTML-CSS"], |
| }); |
| </script><script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| <link href="stylesheet.css" rel="stylesheet" type="text/css"/> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <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"/> |
| <td style="padding-left: 0.5em;"> |
| <div id="projectname"> |
|  <span id="projectnumber">20.02.1</span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.15 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</script> |
| <div id="main-nav"></div> |
| </div><!-- top --> |
| <div id="side-nav" class="ui-resizable side-nav-resizable"> |
| <div id="nav-tree"> |
| <div id="nav-tree-contents"> |
| <div id="nav-sync" class="sync"></div> |
| </div> |
| </div> |
| <div id="splitbar" style="-moz-user-select:none;" |
| class="ui-resizable-handle"> |
| </div> |
| </div> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('_i_array_8h_source.xhtml','');}); |
| /* @license-end */ |
| </script> |
| <div id="doc-content"> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">IArray.h</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="_i_array_8h.xhtml">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (c) 2016-2019 ARM Limited.</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * SPDX-License-Identifier: MIT</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a copy</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * of this software and associated documentation files (the "Software"), to</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * deal in the Software without restriction, including without limitation the</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * sell copies of the Software, and to permit persons to whom the Software is</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * furnished to do so, subject to the following conditions:</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> *</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * The above copyright notice and this permission notice shall be included in all</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * copies or substantial portions of the Software.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> *</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * SOFTWARE.</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> */</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#ifndef ARM_COMPUTE_IARRAY_H</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#define ARM_COMPUTE_IARRAY_H</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "<a class="code" href="_error_8h.xhtml">arm_compute/core/Error.h</a>"</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <cstddef></span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include <cstdint></span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">namespace </span><a class="code" href="namespacearm__compute.xhtml">arm_compute</a></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">struct </span>KeyPoint;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">struct </span><a class="code" href="struct_coordinates2_d.xhtml">Coordinates2D</a>;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">struct </span><a class="code" href="struct_detection_window.xhtml">DetectionWindow</a>;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">class </span>Size2D;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"></span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment">/** Array of type T */</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">template</span> <<span class="keyword">class</span> T></div><div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="classarm__compute_1_1_i_array.xhtml"> 40</a></span> <span class="keyword">class </span><a class="code" href="classarm__compute_1_1_i_array.xhtml">IArray</a></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> {</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">public</span>:<span class="comment"></span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> /** Default constructor */</span></div><div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classarm__compute_1_1_i_array.xhtml#a409cec620a7e56a535b079a0fe37695a"> 44</a></span>  <a class="code" href="classarm__compute_1_1_i_array.xhtml#a409cec620a7e56a535b079a0fe37695a">IArray</a>()</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  : _num_values(0), _max_size(0) {};<span class="comment"></span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> /** Constructor: initializes an array which can contain up to max_num_points values</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> *</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * @param[in] max_num_values Maximum number of values the array will be able to stored</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> */</span></div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classarm__compute_1_1_i_array.xhtml#a7ddd3791f151a0ad74b270776ff3726c"> 50</a></span>  <a class="code" href="classarm__compute_1_1_i_array.xhtml#a7ddd3791f151a0ad74b270776ff3726c">IArray</a>(<span class="keywordtype">size_t</span> <a class="code" href="classarm__compute_1_1_i_array.xhtml#ad4d0d4b95cde1aa24a381859d3b80a5e">max_num_values</a>)</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  : _num_values(0), _max_size(<a class="code" href="classarm__compute_1_1_i_array.xhtml#ad4d0d4b95cde1aa24a381859d3b80a5e">max_num_values</a>)</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  {</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  }<span class="comment"></span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> /** Maximum number of values which can be stored in this array</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> *</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> * @return Maximum number of values</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> */</span></div><div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="classarm__compute_1_1_i_array.xhtml#ad4d0d4b95cde1aa24a381859d3b80a5e"> 58</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="classarm__compute_1_1_i_array.xhtml#ad4d0d4b95cde1aa24a381859d3b80a5e">max_num_values</a>()<span class="keyword"> const</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="keyword"> </span>{</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordflow">return</span> _max_size;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  }<span class="comment"></span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> /** Default virtual destructor */</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">virtual</span> <a class="code" href="classarm__compute_1_1_i_array.xhtml#acaeb87c4bcccaf15bb25bd2c8e44658a">~IArray</a>() = <span class="keywordflow">default</span>;<span class="comment"></span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> /** Number of values currently stored in the array</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> *</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> * @return Number of values currently stored in the array or max_num_values + 1 if the array is overflowed.</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> */</span></div><div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="classarm__compute_1_1_i_array.xhtml#aac8e28a698cd201286d75eb3f5ad3e1c"> 68</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="classarm__compute_1_1_i_array.xhtml#aac8e28a698cd201286d75eb3f5ad3e1c">num_values</a>()<span class="keyword"> const</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="keyword"> </span>{</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordflow">return</span> _num_values;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  }<span class="comment"></span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> /** Append the passed argument to the end of the array if there is room.</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> *</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> * @param[in] val Value to add to the array.</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> *</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> * @return True if the point was successfully added to the array. False if the array is full and the point couldn't be added.</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> */</span></div><div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="classarm__compute_1_1_i_array.xhtml#a9031bfcabdaae3ac3e6e349446e282ff"> 78</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classarm__compute_1_1_i_array.xhtml#a9031bfcabdaae3ac3e6e349446e282ff">push_back</a>(<span class="keyword">const</span> T &val)</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  {</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <a class="code" href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a>(0 == _max_size);</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordflow">if</span>(_num_values >= <a class="code" href="classarm__compute_1_1_i_array.xhtml#ad4d0d4b95cde1aa24a381859d3b80a5e">max_num_values</a>())</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  {</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  _num_values = <a class="code" href="classarm__compute_1_1_i_array.xhtml#ad4d0d4b95cde1aa24a381859d3b80a5e">max_num_values</a>() + 1;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  }</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <a class="code" href="classarm__compute_1_1_i_array.xhtml#a9deaea40b2409ee68d354bdb9d3f8443">at</a>(_num_values) = val;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  _num_values++;</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordflow">return</span> <span class="keyword">true</span>;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  }<span class="comment"></span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> /** Clear all the points from the array. */</span></div><div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="classarm__compute_1_1_i_array.xhtml#ac8bb3912a3ce86b15842e79d0b421204"> 91</a></span>  <span class="keywordtype">void</span> <a class="code" href="classarm__compute_1_1_i_array.xhtml#ac8bb3912a3ce86b15842e79d0b421204">clear</a>()</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  {</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  _num_values = 0;</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  }<span class="comment"></span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> /** Did we lose some values because the array is too small?</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"> *</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> * @return True if we tried to add a value using push_back() but there wasn't any room left to store it.</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> * False if all the values were successfully added to the array.</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> */</span></div><div class="line"><a name="l00100"></a><span class="lineno"><a class="line" href="classarm__compute_1_1_i_array.xhtml#aaac8982c6c162d3dc4acf356426684dc"> 100</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classarm__compute_1_1_i_array.xhtml#aaac8982c6c162d3dc4acf356426684dc">overflow</a>()<span class="keyword"> const</span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="keyword"> </span>{</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keywordflow">return</span> _num_values > <a class="code" href="classarm__compute_1_1_i_array.xhtml#ad4d0d4b95cde1aa24a381859d3b80a5e">max_num_values</a>();</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  }<span class="comment"></span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> /** Pointer to the first element of the array</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> *</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> * Other elements of the array can be accessed using buffer()[idx] for 0 <= idx < num_poins().</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> *</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> * @return A pointer to the first element of the array</span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> */</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keyword">virtual</span> T *<a class="code" href="classarm__compute_1_1_i_array.xhtml#a4b55468220c2029e7ee1594e34b2b21f">buffer</a>() <span class="keyword">const</span> = 0;<span class="comment"></span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> /** Reference to the element of the array located at the given index</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> *</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> * @param[in] index Index of the element</span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment"> *</span></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"> * @return A reference to the element of the array located at the given index.</span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"> */</span></div><div class="line"><a name="l00117"></a><span class="lineno"><a class="line" href="classarm__compute_1_1_i_array.xhtml#a9deaea40b2409ee68d354bdb9d3f8443"> 117</a></span>  <span class="keyword">virtual</span> T &<a class="code" href="classarm__compute_1_1_i_array.xhtml#a9deaea40b2409ee68d354bdb9d3f8443">at</a>(<span class="keywordtype">size_t</span> index)<span class="keyword"> const</span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="keyword"> </span>{</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <a class="code" href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a>(<a class="code" href="classarm__compute_1_1_i_array.xhtml#a4b55468220c2029e7ee1594e34b2b21f">buffer</a>() == <span class="keyword">nullptr</span>);</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <a class="code" href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a>(index >= <a class="code" href="classarm__compute_1_1_i_array.xhtml#ad4d0d4b95cde1aa24a381859d3b80a5e">max_num_values</a>());</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keywordflow">return</span> <a class="code" href="classarm__compute_1_1_i_array.xhtml#a4b55468220c2029e7ee1594e34b2b21f">buffer</a>()[index];</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  }<span class="comment"></span></div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> /** Resizes the array to contain "num" elements. If "num" is smaller than the maximum array size, the content is reduced to its first "num" elements,</span></div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> * "num" elements can't be bigger than the maximum number of values which can be stored in this array.</span></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> *</span></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> * @param[in] num The new array size in number of elements</span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"> */</span></div><div class="line"><a name="l00128"></a><span class="lineno"><a class="line" href="classarm__compute_1_1_i_array.xhtml#ae21b0e95ded2dcfb5e62848ea0193828"> 128</a></span>  <span class="keywordtype">void</span> <a class="code" href="classarm__compute_1_1_i_array.xhtml#ae21b0e95ded2dcfb5e62848ea0193828">resize</a>(<span class="keywordtype">size_t</span> num)</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  {</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  <a class="code" href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a>(num > <a class="code" href="classarm__compute_1_1_i_array.xhtml#ad4d0d4b95cde1aa24a381859d3b80a5e">max_num_values</a>());</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  _num_values = num;</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  };</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> </div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <span class="keywordtype">size_t</span> _num_values;</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <span class="keywordtype">size_t</span> _max_size;</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> };<span class="comment"></span></div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment">/** Interface for Array of Key Points. */</span></div><div class="line"><a name="l00139"></a><span class="lineno"><a class="line" href="namespacearm__compute.xhtml#ab56a557a5fdf97819f23c35c24f0b0d2"> 139</a></span> <span class="keyword">using</span> <a class="code" href="classarm__compute_1_1_i_array.xhtml">IKeyPointArray</a> = <a class="code" href="classarm__compute_1_1_i_array.xhtml">IArray<KeyPoint></a>;<span class="comment"></span></div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment">/** Interface for Array of 2D Coordinates. */</span></div><div class="line"><a name="l00141"></a><span class="lineno"><a class="line" href="namespacearm__compute.xhtml#aac9efd49d3bbbd53779713e5fb37de62"> 141</a></span> <span class="keyword">using</span> <a class="code" href="classarm__compute_1_1_i_array.xhtml">ICoordinates2DArray</a> = <a class="code" href="classarm__compute_1_1_i_array.xhtml">IArray<Coordinates2D></a>;<span class="comment"></span></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment">/** Interface for Array of Detection Windows. */</span></div><div class="line"><a name="l00143"></a><span class="lineno"><a class="line" href="namespacearm__compute.xhtml#a52b3b9de6092ae37321159c4c2f1bf40"> 143</a></span> <span class="keyword">using</span> <a class="code" href="classarm__compute_1_1_i_array.xhtml">IDetectionWindowArray</a> = <a class="code" href="classarm__compute_1_1_i_array.xhtml">IArray<DetectionWindow></a>;<span class="comment"></span></div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment">/** Interface for Array of 2D Sizes. */</span></div><div class="line"><a name="l00145"></a><span class="lineno"><a class="line" href="namespacearm__compute.xhtml#a32e4b9083329486a06960006af89a84c"> 145</a></span> <span class="keyword">using</span> <a class="code" href="classarm__compute_1_1_i_array.xhtml">ISize2DArray</a> = <a class="code" href="classarm__compute_1_1_i_array.xhtml">IArray<Size2D></a>;<span class="comment"></span></div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment">/** Interface for Array of uint8s. */</span></div><div class="line"><a name="l00147"></a><span class="lineno"><a class="line" href="namespacearm__compute.xhtml#a276401fd5651e75431d3e1cc90601caa"> 147</a></span> <span class="keyword">using</span> <a class="code" href="classarm__compute_1_1_i_array.xhtml">IUInt8Array</a> = <a class="code" href="classarm__compute_1_1_i_array.xhtml">IArray<uint8_t></a>;<span class="comment"></span></div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment">/** Interface for Array of uint16s. */</span></div><div class="line"><a name="l00149"></a><span class="lineno"><a class="line" href="namespacearm__compute.xhtml#a1ffe8af91a934c926d102938db8d3ce1"> 149</a></span> <span class="keyword">using</span> <a class="code" href="classarm__compute_1_1_i_array.xhtml">IUInt16Array</a> = <a class="code" href="classarm__compute_1_1_i_array.xhtml">IArray<uint16_t></a>;<span class="comment"></span></div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment">/** Interface for Array of uint32s. */</span></div><div class="line"><a name="l00151"></a><span class="lineno"><a class="line" href="namespacearm__compute.xhtml#ac9b2a6fa6e146437bfc8c0bee96e4760"> 151</a></span> <span class="keyword">using</span> <a class="code" href="classarm__compute_1_1_i_array.xhtml">IUInt32Array</a> = <a class="code" href="classarm__compute_1_1_i_array.xhtml">IArray<uint32_t></a>;<span class="comment"></span></div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment">/** Interface for Array of int16s. */</span></div><div class="line"><a name="l00153"></a><span class="lineno"><a class="line" href="namespacearm__compute.xhtml#a1dd5e04cea002eae658fa2a899848ad7"> 153</a></span> <span class="keyword">using</span> <a class="code" href="classarm__compute_1_1_i_array.xhtml">IInt16Array</a> = <a class="code" href="classarm__compute_1_1_i_array.xhtml">IArray<int16_t></a>;<span class="comment"></span></div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment">/** Interface for Array of int32s. */</span></div><div class="line"><a name="l00155"></a><span class="lineno"><a class="line" href="namespacearm__compute.xhtml#a51fdf34dfc5c60b6f4f455f0a9cac457"> 155</a></span> <span class="keyword">using</span> <a class="code" href="classarm__compute_1_1_i_array.xhtml">IInt32Array</a> = <a class="code" href="classarm__compute_1_1_i_array.xhtml">IArray<int32_t></a>;<span class="comment"></span></div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment">/** Interface for Array of floats. */</span></div><div class="line"><a name="l00157"></a><span class="lineno"><a class="line" href="namespacearm__compute.xhtml#a8a82a1928159e86b0778c3c14e8842be"> 157</a></span> <span class="keyword">using</span> <a class="code" href="classarm__compute_1_1_i_array.xhtml">IFloatArray</a> = <a class="code" href="classarm__compute_1_1_i_array.xhtml">IArray<float></a>;</div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> }</div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="preprocessor">#endif </span><span class="comment">/* ARM_COMPUTE_IARRAY_H */</span><span class="preprocessor"></span></div><div class="ttc" id="classarm__compute_1_1_i_array_xhtml_ac8bb3912a3ce86b15842e79d0b421204"><div class="ttname"><a href="classarm__compute_1_1_i_array.xhtml#ac8bb3912a3ce86b15842e79d0b421204">arm_compute::IArray::clear</a></div><div class="ttdeci">void clear()</div><div class="ttdoc">Clear all the points from the array.</div><div class="ttdef"><b>Definition:</b> <a href="_i_array_8h_source.xhtml#l00091">IArray.h:91</a></div></div> |
| <div class="ttc" id="struct_detection_window_xhtml"><div class="ttname"><a href="struct_detection_window.xhtml">DetectionWindow</a></div><div class="ttdoc">Detection window struct.</div><div class="ttdef"><b>Definition:</b> <a href="src_2core_2_c_l_2cl__kernels_2_types_8h_source.xhtml#l00047">types.h:47</a></div></div> |
| <div class="ttc" id="struct_coordinates2_d_xhtml"><div class="ttname"><a href="struct_coordinates2_d.xhtml">Coordinates2D</a></div><div class="ttdoc">2D Coordinates structure</div><div class="ttdef"><b>Definition:</b> <a href="src_2core_2_c_l_2cl__kernels_2_types_8h_source.xhtml#l00028">types.h:28</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_i_array_xhtml"><div class="ttname"><a href="classarm__compute_1_1_i_array.xhtml">arm_compute::IArray</a></div><div class="ttdoc">Array of type T.</div><div class="ttdef"><b>Definition:</b> <a href="_i_array_8h_source.xhtml#l00040">IArray.h:40</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_i_array_xhtml_aaac8982c6c162d3dc4acf356426684dc"><div class="ttname"><a href="classarm__compute_1_1_i_array.xhtml#aaac8982c6c162d3dc4acf356426684dc">arm_compute::IArray::overflow</a></div><div class="ttdeci">bool overflow() const</div><div class="ttdoc">Did we lose some values because the array is too small?</div><div class="ttdef"><b>Definition:</b> <a href="_i_array_8h_source.xhtml#l00100">IArray.h:100</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_i_array_xhtml_ae21b0e95ded2dcfb5e62848ea0193828"><div class="ttname"><a href="classarm__compute_1_1_i_array.xhtml#ae21b0e95ded2dcfb5e62848ea0193828">arm_compute::IArray::resize</a></div><div class="ttdeci">void resize(size_t num)</div><div class="ttdoc">Resizes the array to contain "num" elements.</div><div class="ttdef"><b>Definition:</b> <a href="_i_array_8h_source.xhtml#l00128">IArray.h:128</a></div></div> |
| <div class="ttc" id="_error_8h_xhtml_a54a6080c9f4df1f908e57a9bbb46f5da"><div class="ttname"><a href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a></div><div class="ttdeci">#define ARM_COMPUTE_ERROR_ON(cond)</div><div class="ttdoc">If the condition is true then an error message is printed and an exception thrown.</div><div class="ttdef"><b>Definition:</b> <a href="_error_8h_source.xhtml#l00466">Error.h:466</a></div></div> |
| <div class="ttc" id="namespacearm__compute_xhtml"><div class="ttname"><a href="namespacearm__compute.xhtml">arm_compute</a></div><div class="ttdoc">Copyright (c) 2017-2020 ARM Limited.</div><div class="ttdef"><b>Definition:</b> <a href="00__introduction_8dox_source.xhtml#l00024">00_introduction.dox:24</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_i_array_xhtml_a409cec620a7e56a535b079a0fe37695a"><div class="ttname"><a href="classarm__compute_1_1_i_array.xhtml#a409cec620a7e56a535b079a0fe37695a">arm_compute::IArray::IArray</a></div><div class="ttdeci">IArray()</div><div class="ttdoc">Default constructor.</div><div class="ttdef"><b>Definition:</b> <a href="_i_array_8h_source.xhtml#l00044">IArray.h:44</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_i_array_xhtml_a4b55468220c2029e7ee1594e34b2b21f"><div class="ttname"><a href="classarm__compute_1_1_i_array.xhtml#a4b55468220c2029e7ee1594e34b2b21f">arm_compute::IArray::buffer</a></div><div class="ttdeci">virtual T * buffer() const =0</div><div class="ttdoc">Pointer to the first element of the array.</div></div> |
| <div class="ttc" id="classarm__compute_1_1_i_array_xhtml_aac8e28a698cd201286d75eb3f5ad3e1c"><div class="ttname"><a href="classarm__compute_1_1_i_array.xhtml#aac8e28a698cd201286d75eb3f5ad3e1c">arm_compute::IArray::num_values</a></div><div class="ttdeci">size_t num_values() const</div><div class="ttdoc">Number of values currently stored in the array.</div><div class="ttdef"><b>Definition:</b> <a href="_i_array_8h_source.xhtml#l00068">IArray.h:68</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_i_array_xhtml_a7ddd3791f151a0ad74b270776ff3726c"><div class="ttname"><a href="classarm__compute_1_1_i_array.xhtml#a7ddd3791f151a0ad74b270776ff3726c">arm_compute::IArray::IArray</a></div><div class="ttdeci">IArray(size_t max_num_values)</div><div class="ttdoc">Constructor: initializes an array which can contain up to max_num_points values.</div><div class="ttdef"><b>Definition:</b> <a href="_i_array_8h_source.xhtml#l00050">IArray.h:50</a></div></div> |
| <div class="ttc" id="_error_8h_xhtml"><div class="ttname"><a href="_error_8h.xhtml">Error.h</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_i_array_xhtml_ad4d0d4b95cde1aa24a381859d3b80a5e"><div class="ttname"><a href="classarm__compute_1_1_i_array.xhtml#ad4d0d4b95cde1aa24a381859d3b80a5e">arm_compute::IArray::max_num_values</a></div><div class="ttdeci">size_t max_num_values() const</div><div class="ttdoc">Maximum number of values which can be stored in this array.</div><div class="ttdef"><b>Definition:</b> <a href="_i_array_8h_source.xhtml#l00058">IArray.h:58</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_i_array_xhtml_a9031bfcabdaae3ac3e6e349446e282ff"><div class="ttname"><a href="classarm__compute_1_1_i_array.xhtml#a9031bfcabdaae3ac3e6e349446e282ff">arm_compute::IArray::push_back</a></div><div class="ttdeci">bool push_back(const T &val)</div><div class="ttdoc">Append the passed argument to the end of the array if there is room.</div><div class="ttdef"><b>Definition:</b> <a href="_i_array_8h_source.xhtml#l00078">IArray.h:78</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_i_array_xhtml_acaeb87c4bcccaf15bb25bd2c8e44658a"><div class="ttname"><a href="classarm__compute_1_1_i_array.xhtml#acaeb87c4bcccaf15bb25bd2c8e44658a">arm_compute::IArray::~IArray</a></div><div class="ttdeci">virtual ~IArray()=default</div><div class="ttdoc">Default virtual destructor.</div></div> |
| <div class="ttc" id="classarm__compute_1_1_i_array_xhtml_a9deaea40b2409ee68d354bdb9d3f8443"><div class="ttname"><a href="classarm__compute_1_1_i_array.xhtml#a9deaea40b2409ee68d354bdb9d3f8443">arm_compute::IArray::at</a></div><div class="ttdeci">virtual T & at(size_t index) const</div><div class="ttdoc">Reference to the element of the array located at the given index.</div><div class="ttdef"><b>Definition:</b> <a href="_i_array_8h_source.xhtml#l00117">IArray.h:117</a></div></div> |
| </div><!-- fragment --></div><!-- contents --> |
| </div><!-- doc-content --> |
| <!-- start footer part --> |
| <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| <ul> |
| <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="_i_array_8h.xhtml">IArray.h</a></li> |
| <li class="footer">Generated on Thu Mar 5 2020 16:06:54 for Compute Library by |
| <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li> |
| </ul> |
| </div> |
| </body> |
| </html> |
