documentation/classarm__compute_1_1graph_1_1_i_node.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.6"/>
   8 <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
   9 <title>Compute Library: INode 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="navtree.js"></script>
  16 <script type="text/javascript">
  17   $(document).ready(initResizable);
  18   $(window).load(resizeHeight);
  19 </script>
  20 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  21 <script type="text/javascript" src="search/search.js"></script>
  22 <script type="text/javascript">
  23   $(document).ready(function() { searchBox.OnSelectItem(0); });
  24 </script>
  25 <script type="text/x-mathjax-config">
  26   MathJax.Hub.Config({
  27     extensions: ["tex2jax.js"],
  28     jax: ["input/TeX","output/HTML-CSS"],
  29 });
  30 </script><script src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
  31 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  32 </head>
  33 <body>
  34 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  35 <div id="titlearea">
  36 <table cellspacing="0" cellpadding="0">
  37  <tbody>
  38  <tr style="height: 56px;">
  39   <td style="padding-left: 0.5em;">
  40    <div id="projectname">Compute Library
  41    &#160;<span id="projectnumber">17.10</span>
  42    </div>
  43   </td>
  44  </tr>
  45  </tbody>
  46 </table>
  47 </div>
  48 <!-- end header part -->
  49 <!-- Generated by Doxygen 1.8.6 -->
  50 <script type="text/javascript">
  51 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  52 </script>
  53   <div id="navrow1" class="tabs">
  54     <ul class="tablist">
  55       <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
  56       <li><a href="pages.xhtml"><span>Related&#160;Pages</span></a></li>
  57       <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
  58       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  59       <li><a href="files.xhtml"><span>Files</span></a></li>
  60       <li>
  61         <div id="MSearchBox" class="MSearchBoxInactive">
  62         <span class="left">
  63           <img id="MSearchSelect" src="search/mag_sel.png"
  64                onmouseover="return searchBox.OnSearchSelectShow()"
  65                onmouseout="return searchBox.OnSearchSelectHide()"
  66                alt=""/>
  67           <input type="text" id="MSearchField" value="Search" accesskey="S"
  68                onfocus="searchBox.OnSearchFieldFocus(true)"
  69                onblur="searchBox.OnSearchFieldFocus(false)"
  70                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  71           </span><span class="right">
  72             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  73           </span>
  74         </div>
  75       </li>
  76     </ul>
  77   </div>
  78   <div id="navrow2" class="tabs2">
  79     <ul class="tablist">
  80       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  81       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
  82       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
  83       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
  84     </ul>
  85   </div>
  86 </div><!-- top -->
  87 <div id="side-nav" class="ui-resizable side-nav-resizable">
  88   <div id="nav-tree">
  89     <div id="nav-tree-contents">
  90       <div id="nav-sync" class="sync"></div>
  91     </div>
  92   </div>
  93   <div id="splitbar" style="-moz-user-select:none;"
  94        class="ui-resizable-handle">
  95   </div>
  96 </div>
  97 <script type="text/javascript">
  98 $(document).ready(function(){initNavTree('classarm__compute_1_1graph_1_1_i_node.xhtml','');});
  99 </script>
 100 <div id="doc-content">
 101 <!-- window showing the filter options -->
 102 <div id="MSearchSelectWindow"
 103      onmouseover="return searchBox.OnSearchSelectShow()"
 104      onmouseout="return searchBox.OnSearchSelectHide()"
 105      onkeydown="return searchBox.OnSearchSelectKey(event)">
 106 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Pages</a></div>
 107
 108 <!-- iframe showing the search results (closed by default) -->
 109 <div id="MSearchResultsWindow">
 110 <iframe src="javascript:void(0)" frameborder="0"
 111         name="MSearchResults" id="MSearchResults">
 112 </iframe>
 113 </div>
 114
 115 <div class="header">
 116   <div class="summary">
 117 <a href="#pub-methods">Public Member Functions</a>  </div>
 118   <div class="headertitle">
 119 <div class="title">INode Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
 120 </div><!--header-->
 121 <div class="contents">
 122
 123 <p>Node interface.
 124  <a href="classarm__compute_1_1graph_1_1_i_node.xhtml#details">More...</a></p>
 125
 126 <p><code>#include &lt;<a class="el" href="_i_node_8h_source.xhtml">INode.h</a>&gt;</code></p>
 127 <table class="memberdecls">
 128 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 129 Public Member Functions</h2></td></tr>
 130 <tr class="memitem:a1356f0d04912be3ec8d8ce7a2b0cddd2"><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_node.xhtml#a1356f0d04912be3ec8d8ce7a2b0cddd2">~INode</a> ()=default</td></tr>
 131 <tr class="memdesc:a1356f0d04912be3ec8d8ce7a2b0cddd2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual Destructor.  <a href="#a1356f0d04912be3ec8d8ce7a2b0cddd2">More...</a><br/></td></tr>
 132 <tr class="separator:a1356f0d04912be3ec8d8ce7a2b0cddd2"><td class="memSeparator" colspan="2">&#160;</td></tr>
 133 <tr class="memitem:a7f783ed63208c75dc6be8af01c956419"><td class="memItemLeft" align="right" valign="top">virtual std::unique_ptr<br class="typebreak"/>
 134 &lt; <a class="el" href="classarm__compute_1_1_i_function.xhtml">arm_compute::IFunction</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1graph_1_1_i_node.xhtml#a7f783ed63208c75dc6be8af01c956419">instantiate_node</a> (<a class="el" href="classarm__compute_1_1graph_1_1_graph_context.xhtml">GraphContext</a> &amp;ctx, <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)=0</td></tr>
 135 <tr class="memdesc:a7f783ed63208c75dc6be8af01c956419"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interface to be implemented that instantiates the node.  <a href="#a7f783ed63208c75dc6be8af01c956419">More...</a><br/></td></tr>
 136 <tr class="separator:a7f783ed63208c75dc6be8af01c956419"><td class="memSeparator" colspan="2">&#160;</td></tr>
 137 <tr class="memitem:a4f94409d100ac0a28961a82a5cc31d30"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacearm__compute_1_1graph.xhtml#a8d5e69e9a697c2007e241eb413c9833b">TargetHint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1graph_1_1_i_node.xhtml#a4f94409d100ac0a28961a82a5cc31d30">override_target_hint</a> (<a class="el" href="namespacearm__compute_1_1graph.xhtml#a8d5e69e9a697c2007e241eb413c9833b">TargetHint</a> target_hint) const </td></tr>
 138 <tr class="memdesc:a4f94409d100ac0a28961a82a5cc31d30"><td class="mdescLeft">&#160;</td><td class="mdescRight">Override the existing target hint.  <a href="#a4f94409d100ac0a28961a82a5cc31d30">More...</a><br/></td></tr>
 139 <tr class="separator:a4f94409d100ac0a28961a82a5cc31d30"><td class="memSeparator" colspan="2">&#160;</td></tr>
 140 </table>
 141 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 142 <div class="textblock"><p>Node interface. </p>
 143
 144 <p>Definition at line <a class="el" href="_i_node_8h_source.xhtml#l00038">38</a> of file <a class="el" href="_i_node_8h_source.xhtml">INode.h</a>.</p>
 145 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 146 <a class="anchor" id="a1356f0d04912be3ec8d8ce7a2b0cddd2"></a>
 147 <div class="memitem">
 148 <div class="memproto">
 149 <table class="mlabels">
 150   <tr>
 151   <td class="mlabels-left">
 152       <table class="memname">
 153         <tr>
 154           <td class="memname">virtual ~<a class="el" href="classarm__compute_1_1graph_1_1_i_node.xhtml">INode</a> </td>
 155           <td>(</td>
 156           <td class="paramname"></td><td>)</td>
 157           <td></td>
 158         </tr>
 159       </table>
 160   </td>
 161   <td class="mlabels-right">
 162 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span>  </td>
 163   </tr>
 164 </table>
 165 </div><div class="memdoc">
 166
 167 <p>Virtual Destructor. </p>
 168
 169 </div>
 170 </div>
 171 <h2 class="groupheader">Member Function Documentation</h2>
 172 <a class="anchor" id="a7f783ed63208c75dc6be8af01c956419"></a>
 173 <div class="memitem">
 174 <div class="memproto">
 175 <table class="mlabels">
 176   <tr>
 177   <td class="mlabels-left">
 178       <table class="memname">
 179         <tr>
 180           <td class="memname">virtual std::unique_ptr&lt;<a class="el" href="classarm__compute_1_1_i_function.xhtml">arm_compute::IFunction</a>&gt; instantiate_node </td>
 181           <td>(</td>
 182           <td class="paramtype"><a class="el" href="classarm__compute_1_1graph_1_1_graph_context.xhtml">GraphContext</a> &amp;&#160;</td>
 183           <td class="paramname"><em>ctx</em>, </td>
 184         </tr>
 185         <tr>
 186           <td class="paramkey"></td>
 187           <td></td>
 188           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
 189           <td class="paramname"><em>input</em>, </td>
 190         </tr>
 191         <tr>
 192           <td class="paramkey"></td>
 193           <td></td>
 194           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
 195           <td class="paramname"><em>output</em>&#160;</td>
 196         </tr>
 197         <tr>
 198           <td></td>
 199           <td>)</td>
 200           <td></td><td></td>
 201         </tr>
 202       </table>
 203   </td>
 204   <td class="mlabels-right">
 205 <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
 206   </tr>
 207 </table>
 208 </div><div class="memdoc">
 209
 210 <p>Interface to be implemented that instantiates the node. </p>
 211 <dl class="params"><dt>Parameters</dt><dd>
 212   <table class="params">
 213     <tr><td class="paramdir">[in]</td><td class="paramname">ctx</td><td><a class="el" href="classarm__compute_1_1graph_1_1_graph.xhtml" title="Graph class. ">Graph</a> context to be used </td></tr>
 214     <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>Input tensor of the node </td></tr>
 215     <tr><td class="paramdir">[in]</td><td class="paramname">output</td><td>Output tensor of the node </td></tr>
 216   </table>
 217   </dd>
 218 </dl>
 219
 220 <p>Implemented in <a class="el" href="classarm__compute_1_1graph_1_1_convolution_layer.xhtml#a6715346967f76b53aea4e31cacbe75de">ConvolutionLayer</a>, <a class="el" href="classarm__compute_1_1graph_1_1_batch_normalization_layer.xhtml#a6715346967f76b53aea4e31cacbe75de">BatchNormalizationLayer</a>, <a class="el" href="classarm__compute_1_1graph_1_1_fully_connected_layer.xhtml#a6715346967f76b53aea4e31cacbe75de">FullyConnectedLayer</a>, <a class="el" href="classarm__compute_1_1graph_1_1_l2_normalize_layer.xhtml#a6715346967f76b53aea4e31cacbe75de">L2NormalizeLayer</a>, <a class="el" href="classarm__compute_1_1graph_1_1_activation_layer.xhtml#a6715346967f76b53aea4e31cacbe75de">ActivationLayer</a>, <a class="el" href="classarm__compute_1_1graph_1_1_pooling_layer.xhtml#a6715346967f76b53aea4e31cacbe75de">PoolingLayer</a>, <a class="el" href="classarm__compute_1_1graph_1_1_normalization_layer.xhtml#a6715346967f76b53aea4e31cacbe75de">NormalizationLayer</a>, <a class="el" href="classarm__compute_1_1graph_1_1_floor_layer.xhtml#a6715346967f76b53aea4e31cacbe75de">FloorLayer</a>, and <a class="el" href="classarm__compute_1_1graph_1_1_softmax_layer.xhtml#a6715346967f76b53aea4e31cacbe75de">SoftmaxLayer</a>.</p>
 221
 222 </div>
 223 </div>
 224 <a class="anchor" id="a4f94409d100ac0a28961a82a5cc31d30"></a>
 225 <div class="memitem">
 226 <div class="memproto">
 227       <table class="memname">
 228         <tr>
 229           <td class="memname"><a class="el" href="namespacearm__compute_1_1graph.xhtml#a8d5e69e9a697c2007e241eb413c9833b">TargetHint</a> override_target_hint </td>
 230           <td>(</td>
 231           <td class="paramtype"><a class="el" href="namespacearm__compute_1_1graph.xhtml#a8d5e69e9a697c2007e241eb413c9833b">TargetHint</a>&#160;</td>
 232           <td class="paramname"><em>target_hint</em></td><td>)</td>
 233           <td> const</td>
 234         </tr>
 235       </table>
 236 </div><div class="memdoc">
 237
 238 <p>Override the existing target hint. </p>
 239 <dl class="section note"><dt>Note</dt><dd>If the input is DONT_CARE then the method has to pick a technology, else it can accept the hint or override it (But not with DONT_CARE)</dd></dl>
 240 <dl class="params"><dt>Parameters</dt><dd>
 241   <table class="params">
 242     <tr><td class="paramdir">[in]</td><td class="paramname">target_hint</td><td>Target hint to be considered</td></tr>
 243   </table>
 244   </dd>
 245 </dl>
 246 <dl class="section return"><dt>Returns</dt><dd>The updated target hint </dd></dl>
 247
 248 </div>
 249 </div>
 250 <hr/>The documentation for this class was generated from the following file:<ul>
 251 <li>arm_compute/graph/<a class="el" href="_i_node_8h_source.xhtml">INode.h</a></li>
 252 </ul>
 253 </div><!-- contents -->
 254 </div><!-- doc-content -->
 255 <!-- start footer part -->
 256 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 257   <ul>
 258     <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_node.xhtml">INode</a></li>
 259     <li class="footer">Generated on Thu Oct 12 2017 14:26:38 for Compute Library by
 260     <a href="http://www.doxygen.org/index.html">
 261     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
 262   </ul>
 263 </div>
 264 </body>
 265 </html>