documentation/classarm__compute_1_1graph_1_1_i_tensor_accessor.xhtml

   1 <!-- HTML header for doxygen 1.8.9.1-->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   7 <meta name="generator" content="Doxygen 1.8.11"/>
   8 <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
   9 <title>Compute Library: ITensorAccessor 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">Compute Library
  43    &#160;<span id="projectnumber">18.05</span>
  44    </div>
  45   </td>
  46  </tr>
  47  </tbody>
  48 </table>
  49 </div>
  50 <!-- end header part -->
  51 <!-- Generated by Doxygen 1.8.11 -->
  52 <script type="text/javascript">
  53 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  54 </script>
  55   <div id="navrow1" class="tabs">
  56     <ul class="tablist">
  57       <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
  58       <li><a href="pages.xhtml"><span>Related&#160;Pages</span></a></li>
  59       <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
  60       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  61       <li><a href="files.xhtml"><span>Files</span></a></li>
  62       <li>
  63         <div id="MSearchBox" class="MSearchBoxInactive">
  64         <span class="left">
  65           <img id="MSearchSelect" src="search/mag_sel.png"
  66                onmouseover="return searchBox.OnSearchSelectShow()"
  67                onmouseout="return searchBox.OnSearchSelectHide()"
  68                alt=""/>
  69           <input type="text" id="MSearchField" value="Search" accesskey="S"
  70                onfocus="searchBox.OnSearchFieldFocus(true)"
  71                onblur="searchBox.OnSearchFieldFocus(false)"
  72                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  73           </span><span class="right">
  74             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  75           </span>
  76         </div>
  77       </li>
  78     </ul>
  79   </div>
  80   <div id="navrow2" class="tabs2">
  81     <ul class="tablist">
  82       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  83       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
  84       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
  85       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
  86     </ul>
  87   </div>
  88 </div><!-- top -->
  89 <div id="side-nav" class="ui-resizable side-nav-resizable">
  90   <div id="nav-tree">
  91     <div id="nav-tree-contents">
  92       <div id="nav-sync" class="sync"></div>
  93     </div>
  94   </div>
  95   <div id="splitbar" style="-moz-user-select:none;"
  96        class="ui-resizable-handle">
  97   </div>
  98 </div>
  99 <script type="text/javascript">
 100 $(document).ready(function(){initNavTree('classarm__compute_1_1graph_1_1_i_tensor_accessor.xhtml','');});
 101 </script>
 102 <div id="doc-content">
 103 <!-- window showing the filter options -->
 104 <div id="MSearchSelectWindow"
 105      onmouseover="return searchBox.OnSearchSelectShow()"
 106      onmouseout="return searchBox.OnSearchSelectHide()"
 107      onkeydown="return searchBox.OnSearchSelectKey(event)">
 108 </div>
 109
 110 <!-- iframe showing the search results (closed by default) -->
 111 <div id="MSearchResultsWindow">
 112 <iframe src="javascript:void(0)" frameborder="0"
 113         name="MSearchResults" id="MSearchResults">
 114 </iframe>
 115 </div>
 116
 117 <div class="header">
 118   <div class="summary">
 119 <a href="#pub-methods">Public Member Functions</a>  </div>
 120   <div class="headertitle">
 121 <div class="title">ITensorAccessor Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
 122 </div><!--header-->
 123 <div class="contents">
 124
 125 <p><a class="el" href="classarm__compute_1_1graph_1_1_tensor.xhtml" title="Tensor object. ">Tensor</a> accessor interface.
 126  <a href="classarm__compute_1_1graph_1_1_i_tensor_accessor.xhtml#details">More...</a></p>
 127
 128 <p><code>#include &lt;<a class="el" href="_i_tensor_accessor_8h_source.xhtml">ITensorAccessor.h</a>&gt;</code></p>
 129 <table class="memberdecls">
 130 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 131 Public Member Functions</h2></td></tr>
 132 <tr class="memitem:a3c7f21c2eb00ab7ae1c18b1418c0d9c6"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1graph_1_1_i_tensor_accessor.xhtml#a3c7f21c2eb00ab7ae1c18b1418c0d9c6">~ITensorAccessor</a> ()=default</td></tr>
 133 <tr class="memdesc:a3c7f21c2eb00ab7ae1c18b1418c0d9c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default virtual destructor.  <a href="#a3c7f21c2eb00ab7ae1c18b1418c0d9c6">More...</a><br /></td></tr>
 134 <tr class="separator:a3c7f21c2eb00ab7ae1c18b1418c0d9c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 135 <tr class="memitem:a497873c25847d7b4f60f37a1a3aa7665"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1graph_1_1_i_tensor_accessor.xhtml#a497873c25847d7b4f60f37a1a3aa7665">access_tensor</a> (<a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> &amp;tensor)=0</td></tr>
 136 <tr class="memdesc:a497873c25847d7b4f60f37a1a3aa7665"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interface to be implemented to access a given tensor.  <a href="#a497873c25847d7b4f60f37a1a3aa7665">More...</a><br /></td></tr>
 137 <tr class="separator:a497873c25847d7b4f60f37a1a3aa7665"><td class="memSeparator" colspan="2">&#160;</td></tr>
 138 </table>
 139 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 140 <div class="textblock"><p><a class="el" href="classarm__compute_1_1graph_1_1_tensor.xhtml" title="Tensor object. ">Tensor</a> accessor interface. </p>
 141
 142 <p>Definition at line <a class="el" href="_i_tensor_accessor_8h_source.xhtml#l00036">36</a> of file <a class="el" href="_i_tensor_accessor_8h_source.xhtml">ITensorAccessor.h</a>.</p>
 143 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 144 <a class="anchor" id="a3c7f21c2eb00ab7ae1c18b1418c0d9c6"></a>
 145 <div class="memitem">
 146 <div class="memproto">
 147 <table class="mlabels">
 148   <tr>
 149   <td class="mlabels-left">
 150       <table class="memname">
 151         <tr>
 152           <td class="memname">virtual ~<a class="el" href="classarm__compute_1_1graph_1_1_i_tensor_accessor.xhtml">ITensorAccessor</a> </td>
 153           <td>(</td>
 154           <td class="paramname"></td><td>)</td>
 155           <td></td>
 156         </tr>
 157       </table>
 158   </td>
 159   <td class="mlabels-right">
 160 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span>  </td>
 161   </tr>
 162 </table>
 163 </div><div class="memdoc">
 164
 165 <p>Default virtual destructor. </p>
 166
 167 </div>
 168 </div>
 169 <h2 class="groupheader">Member Function Documentation</h2>
 170 <a class="anchor" id="a497873c25847d7b4f60f37a1a3aa7665"></a>
 171 <div class="memitem">
 172 <div class="memproto">
 173 <table class="mlabels">
 174   <tr>
 175   <td class="mlabels-left">
 176       <table class="memname">
 177         <tr>
 178           <td class="memname">virtual bool access_tensor </td>
 179           <td>(</td>
 180           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> &amp;&#160;</td>
 181           <td class="paramname"><em>tensor</em></td><td>)</td>
 182           <td></td>
 183         </tr>
 184       </table>
 185   </td>
 186   <td class="mlabels-right">
 187 <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
 188   </tr>
 189 </table>
 190 </div><div class="memdoc">
 191
 192 <p>Interface to be implemented to access a given tensor. </p>
 193 <dl class="params"><dt>Parameters</dt><dd>
 194   <table class="params">
 195     <tr><td class="paramdir">[in]</td><td class="paramname">tensor</td><td><a class="el" href="classarm__compute_1_1graph_1_1_tensor.xhtml" title="Tensor object. ">Tensor</a> to be accessed</td></tr>
 196   </table>
 197   </dd>
 198 </dl>
 199 <dl class="section return"><dt>Returns</dt><dd>True if access is successful else false </dd></dl>
 200
 201 <p>Implemented in <a class="el" href="classarm__compute_1_1graph__utils_1_1_num_py_bin_loader.xhtml#ab469d593b4bc92e1d1132a03de0aedca">NumPyBinLoader</a>, <a class="el" href="classarm__compute_1_1graph__utils_1_1_random_accessor.xhtml#ab469d593b4bc92e1d1132a03de0aedca">RandomAccessor</a>, <a class="el" href="classarm__compute_1_1graph__utils_1_1_top_n_predictions_accessor.xhtml#ab469d593b4bc92e1d1132a03de0aedca">TopNPredictionsAccessor</a>, <a class="el" href="classarm__compute_1_1graph__utils_1_1_p_p_m_accessor.xhtml#ab469d593b4bc92e1d1132a03de0aedca">PPMAccessor</a>, <a class="el" href="classarm__compute_1_1graph__utils_1_1_num_py_accessor.xhtml#ab469d593b4bc92e1d1132a03de0aedca">NumPyAccessor</a>, <a class="el" href="classarm__compute_1_1graph__utils_1_1_dummy_accessor.xhtml#ab469d593b4bc92e1d1132a03de0aedca">DummyAccessor</a>, and <a class="el" href="classarm__compute_1_1graph__utils_1_1_p_p_m_writer.xhtml#ab469d593b4bc92e1d1132a03de0aedca">PPMWriter</a>.</p>
 202
 203 </div>
 204 </div>
 205 <hr/>The documentation for this class was generated from the following file:<ul>
 206 <li>arm_compute/graph/<a class="el" href="_i_tensor_accessor_8h_source.xhtml">ITensorAccessor.h</a></li>
 207 </ul>
 208 </div><!-- contents -->
 209 </div><!-- doc-content -->
 210 <!-- start footer part -->
 211 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 212   <ul>
 213     <li class="navelem"><a class="el" href="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="namespacearm__compute_1_1graph.xhtml">graph</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1graph_1_1_i_tensor_accessor.xhtml">ITensorAccessor</a></li>
 214     <li class="footer">Generated on Wed May 23 2018 11:36:43 for Compute Library by
 215     <a href="http://www.doxygen.org/index.html">
 216     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
 217   </ul>
 218 </div>
 219 </body>
 220 </html>