documentation/classarm__compute_1_1_n_e_depth_convert.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>ARM Compute Library: NEDepthConvert Class 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">ARM Compute Library
  43    &#160;<span id="projectnumber">17.04</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="namespaces.xhtml"><span>Namespaces</span></a></li>
  59       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  60       <li><a href="files.xhtml"><span>Files</span></a></li>
  61       <li>
  62         <div id="MSearchBox" class="MSearchBoxInactive">
  63         <span class="left">
  64           <img id="MSearchSelect" src="search/mag_sel.png"
  65                onmouseover="return searchBox.OnSearchSelectShow()"
  66                onmouseout="return searchBox.OnSearchSelectHide()"
  67                alt=""/>
  68           <input type="text" id="MSearchField" value="Search" accesskey="S"
  69                onfocus="searchBox.OnSearchFieldFocus(true)"
  70                onblur="searchBox.OnSearchFieldFocus(false)"
  71                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  72           </span><span class="right">
  73             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  74           </span>
  75         </div>
  76       </li>
  77     </ul>
  78   </div>
  79   <div id="navrow2" class="tabs2">
  80     <ul class="tablist">
  81       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  82       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
  83       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
  84       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
  85     </ul>
  86   </div>
  87 </div><!-- top -->
  88 <div id="side-nav" class="ui-resizable side-nav-resizable">
  89   <div id="nav-tree">
  90     <div id="nav-tree-contents">
  91       <div id="nav-sync" class="sync"></div>
  92     </div>
  93   </div>
  94   <div id="splitbar" style="-moz-user-select:none;"
  95        class="ui-resizable-handle">
  96   </div>
  97 </div>
  98 <script type="text/javascript">
  99 $(document).ready(function(){initNavTree('classarm__compute_1_1_n_e_depth_convert.xhtml','');});
 100 </script>
 101 <div id="doc-content">
 102 <!-- window showing the filter options -->
 103 <div id="MSearchSelectWindow"
 104      onmouseover="return searchBox.OnSearchSelectShow()"
 105      onmouseout="return searchBox.OnSearchSelectHide()"
 106      onkeydown="return searchBox.OnSearchSelectKey(event)">
 107 </div>
 108
 109 <!-- iframe showing the search results (closed by default) -->
 110 <div id="MSearchResultsWindow">
 111 <iframe src="javascript:void(0)" frameborder="0"
 112         name="MSearchResults" id="MSearchResults">
 113 </iframe>
 114 </div>
 115
 116 <div class="header">
 117   <div class="summary">
 118 <a href="#pub-methods">Public Member Functions</a>  </div>
 119   <div class="headertitle">
 120 <div class="title">NEDepthConvert Class Reference</div>  </div>
 121 </div><!--header-->
 122 <div class="contents">
 123
 124 <p>Basic function to run <a class="el" href="classarm__compute_1_1_n_e_depth_convert_kernel.xhtml">NEDepthConvertKernel</a>.
 125  <a href="classarm__compute_1_1_n_e_depth_convert.xhtml#details">More...</a></p>
 126
 127 <p><code>#include &lt;<a class="el" href="_n_e_depth_convert_8h_source.xhtml">NEDepthConvert.h</a>&gt;</code></p>
 128 <div class="dynheader">
 129 Collaboration diagram for NEDepthConvert:</div>
 130 <div class="dyncontent">
 131 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_n_e_depth_convert__coll__graph.svg" width="146" height="187"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
 132 </div>
 133 <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
 134 <table class="memberdecls">
 135 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 136 Public Member Functions</h2></td></tr>
 137 <tr class="memitem:a04fc944cc2e562f29c8b1099566cc07e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_depth_convert.xhtml#a04fc944cc2e562f29c8b1099566cc07e">NEDepthConvert</a> ()=default</td></tr>
 138 <tr class="separator:a04fc944cc2e562f29c8b1099566cc07e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 139 <tr class="memitem:a427cceb3eef556108ed71484273d5cd6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_depth_convert.xhtml#a427cceb3eef556108ed71484273d5cd6">NEDepthConvert</a> (const <a class="el" href="classarm__compute_1_1_n_e_depth_convert.xhtml">NEDepthConvert</a> &amp;)=delete</td></tr>
 140 <tr class="memdesc:a427cceb3eef556108ed71484273d5cd6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#a427cceb3eef556108ed71484273d5cd6">More...</a><br /></td></tr>
 141 <tr class="separator:a427cceb3eef556108ed71484273d5cd6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 142 <tr class="memitem:a7ed98008d6fd4e74c243c3ade3c17ee2"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classarm__compute_1_1_n_e_depth_convert.xhtml">NEDepthConvert</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_depth_convert.xhtml#a7ed98008d6fd4e74c243c3ade3c17ee2">operator=</a> (const <a class="el" href="classarm__compute_1_1_n_e_depth_convert.xhtml">NEDepthConvert</a> &amp;)=delete</td></tr>
 143 <tr class="memdesc:a7ed98008d6fd4e74c243c3ade3c17ee2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#a7ed98008d6fd4e74c243c3ade3c17ee2">More...</a><br /></td></tr>
 144 <tr class="separator:a7ed98008d6fd4e74c243c3ade3c17ee2"><td class="memSeparator" colspan="2">&#160;</td></tr>
 145 <tr class="memitem:a82f04f3f0f6eac5128a336016d898e8f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_depth_convert.xhtml#a82f04f3f0f6eac5128a336016d898e8f">configure</a> (const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *input, <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *output, <a class="el" href="namespacearm__compute.xhtml#a82b8ac759c804bc1fb4e2d21e178fb6f">ConvertPolicy</a> policy, uint32_t shift)</td></tr>
 146 <tr class="memdesc:a82f04f3f0f6eac5128a336016d898e8f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the function's source, destination.  <a href="#a82f04f3f0f6eac5128a336016d898e8f">More...</a><br /></td></tr>
 147 <tr class="separator:a82f04f3f0f6eac5128a336016d898e8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 148 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_n_e_simple_function"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_n_e_simple_function')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_n_e_simple_function.xhtml">INESimpleFunction</a></td></tr>
 149 <tr class="memitem:a4a6528d71f063140db37cdf5cf272960 inherit pub_methods_classarm__compute_1_1_i_n_e_simple_function"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_n_e_simple_function.xhtml#a4a6528d71f063140db37cdf5cf272960">INESimpleFunction</a> ()</td></tr>
 150 <tr class="memdesc:a4a6528d71f063140db37cdf5cf272960 inherit pub_methods_classarm__compute_1_1_i_n_e_simple_function"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a4a6528d71f063140db37cdf5cf272960">More...</a><br /></td></tr>
 151 <tr class="separator:a4a6528d71f063140db37cdf5cf272960 inherit pub_methods_classarm__compute_1_1_i_n_e_simple_function"><td class="memSeparator" colspan="2">&#160;</td></tr>
 152 <tr class="memitem:ab5fd6e96c07aaaed2747c7e16ed5951e inherit pub_methods_classarm__compute_1_1_i_n_e_simple_function"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_n_e_simple_function.xhtml#ab5fd6e96c07aaaed2747c7e16ed5951e">run</a> () overridefinal</td></tr>
 153 <tr class="memdesc:ab5fd6e96c07aaaed2747c7e16ed5951e inherit pub_methods_classarm__compute_1_1_i_n_e_simple_function"><td class="mdescLeft">&#160;</td><td class="mdescRight">Run the kernels contained in the function.  <a href="#ab5fd6e96c07aaaed2747c7e16ed5951e">More...</a><br /></td></tr>
 154 <tr class="separator:ab5fd6e96c07aaaed2747c7e16ed5951e inherit pub_methods_classarm__compute_1_1_i_n_e_simple_function"><td class="memSeparator" colspan="2">&#160;</td></tr>
 155 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_function"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_function')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_function.xhtml">IFunction</a></td></tr>
 156 <tr class="memitem:ab921ecc3f3f6ae2b4bd61f3e1998d8c4 inherit pub_methods_classarm__compute_1_1_i_function"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_function.xhtml#ab921ecc3f3f6ae2b4bd61f3e1998d8c4">~IFunction</a> ()=default</td></tr>
 157 <tr class="memdesc:ab921ecc3f3f6ae2b4bd61f3e1998d8c4 inherit pub_methods_classarm__compute_1_1_i_function"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#ab921ecc3f3f6ae2b4bd61f3e1998d8c4">More...</a><br /></td></tr>
 158 <tr class="separator:ab921ecc3f3f6ae2b4bd61f3e1998d8c4 inherit pub_methods_classarm__compute_1_1_i_function"><td class="memSeparator" colspan="2">&#160;</td></tr>
 159 </table>
 160 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 161 <div class="textblock"><p>Basic function to run <a class="el" href="classarm__compute_1_1_n_e_depth_convert_kernel.xhtml">NEDepthConvertKernel</a>. </p>
 162
 163 <p>Definition at line <a class="el" href="_n_e_depth_convert_8h_source.xhtml#l00037">37</a> of file <a class="el" href="_n_e_depth_convert_8h_source.xhtml">NEDepthConvert.h</a>.</p>
 164 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 165 <a class="anchor" id="a04fc944cc2e562f29c8b1099566cc07e"></a>
 166 <div class="memitem">
 167 <div class="memproto">
 168 <table class="mlabels">
 169   <tr>
 170   <td class="mlabels-left">
 171       <table class="memname">
 172         <tr>
 173           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_depth_convert.xhtml">NEDepthConvert</a> </td>
 174           <td>(</td>
 175           <td class="paramname"></td><td>)</td>
 176           <td></td>
 177         </tr>
 178       </table>
 179   </td>
 180   <td class="mlabels-right">
 181 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 182   </tr>
 183 </table>
 184 </div><div class="memdoc">
 185
 186 </div>
 187 </div>
 188 <a class="anchor" id="a427cceb3eef556108ed71484273d5cd6"></a>
 189 <div class="memitem">
 190 <div class="memproto">
 191 <table class="mlabels">
 192   <tr>
 193   <td class="mlabels-left">
 194       <table class="memname">
 195         <tr>
 196           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_depth_convert.xhtml">NEDepthConvert</a> </td>
 197           <td>(</td>
 198           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_n_e_depth_convert.xhtml">NEDepthConvert</a> &amp;&#160;</td>
 199           <td class="paramname"></td><td>)</td>
 200           <td></td>
 201         </tr>
 202       </table>
 203   </td>
 204   <td class="mlabels-right">
 205 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
 206   </tr>
 207 </table>
 208 </div><div class="memdoc">
 209
 210 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
 211
 212 </div>
 213 </div>
 214 <h2 class="groupheader">Member Function Documentation</h2>
 215 <a class="anchor" id="a82f04f3f0f6eac5128a336016d898e8f"></a>
 216 <div class="memitem">
 217 <div class="memproto">
 218       <table class="memname">
 219         <tr>
 220           <td class="memname">void configure </td>
 221           <td>(</td>
 222           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
 223           <td class="paramname"><em>input</em>, </td>
 224         </tr>
 225         <tr>
 226           <td class="paramkey"></td>
 227           <td></td>
 228           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
 229           <td class="paramname"><em>output</em>, </td>
 230         </tr>
 231         <tr>
 232           <td class="paramkey"></td>
 233           <td></td>
 234           <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#a82b8ac759c804bc1fb4e2d21e178fb6f">ConvertPolicy</a>&#160;</td>
 235           <td class="paramname"><em>policy</em>, </td>
 236         </tr>
 237         <tr>
 238           <td class="paramkey"></td>
 239           <td></td>
 240           <td class="paramtype">uint32_t&#160;</td>
 241           <td class="paramname"><em>shift</em>&#160;</td>
 242         </tr>
 243         <tr>
 244           <td></td>
 245           <td>)</td>
 246           <td></td><td></td>
 247         </tr>
 248       </table>
 249 </div><div class="memdoc">
 250
 251 <p>Initialize the function's source, destination. </p>
 252 <p>Input format must be different than output format.</p>
 253 <p>Valid conversions Input -&gt; Output : U8 -&gt; U16, S16, U32, S32 U16 -&gt; U8, U32, S32 S16 -&gt; U8, U32, S32 U32 -&gt; U8, U16, S16 S32 -&gt; U8, U16, S16</p>
 254 <dl class="params"><dt>Parameters</dt><dd>
 255   <table class="params">
 256     <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>The input tensor to convert. Data type supported: U8, U16, S16, U32 or S32. </td></tr>
 257     <tr><td class="paramdir">[out]</td><td class="paramname">output</td><td>The output tensor. Data type supported: U8, U16, S16, U32 or S32. </td></tr>
 258     <tr><td class="paramdir">[in]</td><td class="paramname">policy</td><td>Conversion policy. </td></tr>
 259     <tr><td class="paramdir">[in]</td><td class="paramname">shift</td><td>Value for down/up conversions. Must be 0 &lt;= shift &lt; 8. </td></tr>
 260   </table>
 261   </dd>
 262 </dl>
 263
 264 </div>
 265 </div>
 266 <a class="anchor" id="a7ed98008d6fd4e74c243c3ade3c17ee2"></a>
 267 <div class="memitem">
 268 <div class="memproto">
 269 <table class="mlabels">
 270   <tr>
 271   <td class="mlabels-left">
 272       <table class="memname">
 273         <tr>
 274           <td class="memname">const <a class="el" href="classarm__compute_1_1_n_e_depth_convert.xhtml">NEDepthConvert</a>&amp; operator= </td>
 275           <td>(</td>
 276           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_n_e_depth_convert.xhtml">NEDepthConvert</a> &amp;&#160;</td>
 277           <td class="paramname"></td><td>)</td>
 278           <td></td>
 279         </tr>
 280       </table>
 281   </td>
 282   <td class="mlabels-right">
 283 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
 284   </tr>
 285 </table>
 286 </div><div class="memdoc">
 287
 288 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
 289
 290 </div>
 291 </div>
 292 <hr/>The documentation for this class was generated from the following file:<ul>
 293 <li>arm_compute/runtime/NEON/functions/<a class="el" href="_n_e_depth_convert_8h_source.xhtml">NEDepthConvert.h</a></li>
 294 </ul>
 295 </div><!-- contents -->
 296 </div><!-- doc-content -->
 297 <!-- start footer part -->
 298 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 299   <ul>
 300     <li class="navelem"><a class="el" href="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1_n_e_depth_convert.xhtml">NEDepthConvert</a></li>
 301     <li class="footer">Generated on Wed Apr 12 2017 14:26:06 for ARM Compute Library by
 302     <a href="http://www.doxygen.org/index.html">
 303     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
 304   </ul>
 305 </div>
 306 </body>
 307 </html>