arm_compute v17.12
[platform/upstream/armcl.git] / 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.11"/>
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="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">17.12</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_node.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">INode Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
122 </div><!--header-->
123 <div class="contents">
124
125 <p>Node interface.  
126  <a href="classarm__compute_1_1graph_1_1_i_node.xhtml#details">More...</a></p>
127
128 <p><code>#include &lt;<a class="el" href="_i_node_8h_source.xhtml">INode.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: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>
133 <tr class="memdesc:a1356f0d04912be3ec8d8ce7a2b0cddd2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual Destructor.  <a href="#a1356f0d04912be3ec8d8ce7a2b0cddd2">More...</a><br /></td></tr>
134 <tr class="separator:a1356f0d04912be3ec8d8ce7a2b0cddd2"><td class="memSeparator" colspan="2">&#160;</td></tr>
135 <tr class="memitem:aff59544b2bab30c9a3ce1876515e48df"><td class="memItemLeft" align="right" valign="top">virtual std::unique_ptr&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#aff59544b2bab30c9a3ce1876515e48df">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_1graph_1_1_i_tensor_object.xhtml">ITensorObject</a> *input, <a class="el" href="classarm__compute_1_1graph_1_1_i_tensor_object.xhtml">ITensorObject</a> *output)=0</td></tr>
136 <tr class="memdesc:aff59544b2bab30c9a3ce1876515e48df"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interface to be implemented that instantiates the node.  <a href="#aff59544b2bab30c9a3ce1876515e48df">More...</a><br /></td></tr>
137 <tr class="separator:aff59544b2bab30c9a3ce1876515e48df"><td class="memSeparator" colspan="2">&#160;</td></tr>
138 <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>
139 <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>
140 <tr class="separator:a4f94409d100ac0a28961a82a5cc31d30"><td class="memSeparator" colspan="2">&#160;</td></tr>
141 </table>
142 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
143 <div class="textblock"><p>Node interface. </p>
144
145 <p>Definition at line <a class="el" href="_i_node_8h_source.xhtml#l00039">39</a> of file <a class="el" href="_i_node_8h_source.xhtml">INode.h</a>.</p>
146 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
147 <a class="anchor" id="a1356f0d04912be3ec8d8ce7a2b0cddd2"></a>
148 <div class="memitem">
149 <div class="memproto">
150 <table class="mlabels">
151   <tr>
152   <td class="mlabels-left">
153       <table class="memname">
154         <tr>
155           <td class="memname">virtual ~<a class="el" href="classarm__compute_1_1graph_1_1_i_node.xhtml">INode</a> </td>
156           <td>(</td>
157           <td class="paramname"></td><td>)</td>
158           <td></td>
159         </tr>
160       </table>
161   </td>
162   <td class="mlabels-right">
163 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span>  </td>
164   </tr>
165 </table>
166 </div><div class="memdoc">
167
168 <p>Virtual Destructor. </p>
169
170 </div>
171 </div>
172 <h2 class="groupheader">Member Function Documentation</h2>
173 <a class="anchor" id="aff59544b2bab30c9a3ce1876515e48df"></a>
174 <div class="memitem">
175 <div class="memproto">
176 <table class="mlabels">
177   <tr>
178   <td class="mlabels-left">
179       <table class="memname">
180         <tr>
181           <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>
182           <td>(</td>
183           <td class="paramtype"><a class="el" href="classarm__compute_1_1graph_1_1_graph_context.xhtml">GraphContext</a> &amp;&#160;</td>
184           <td class="paramname"><em>ctx</em>, </td>
185         </tr>
186         <tr>
187           <td class="paramkey"></td>
188           <td></td>
189           <td class="paramtype"><a class="el" href="classarm__compute_1_1graph_1_1_i_tensor_object.xhtml">ITensorObject</a> *&#160;</td>
190           <td class="paramname"><em>input</em>, </td>
191         </tr>
192         <tr>
193           <td class="paramkey"></td>
194           <td></td>
195           <td class="paramtype"><a class="el" href="classarm__compute_1_1graph_1_1_i_tensor_object.xhtml">ITensorObject</a> *&#160;</td>
196           <td class="paramname"><em>output</em>&#160;</td>
197         </tr>
198         <tr>
199           <td></td>
200           <td>)</td>
201           <td></td><td></td>
202         </tr>
203       </table>
204   </td>
205   <td class="mlabels-right">
206 <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
207   </tr>
208 </table>
209 </div><div class="memdoc">
210
211 <p>Interface to be implemented that instantiates the node. </p>
212 <dl class="params"><dt>Parameters</dt><dd>
213   <table class="params">
214     <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>
215     <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>Input tensor of the node </td></tr>
216     <tr><td class="paramdir">[in]</td><td class="paramname">output</td><td>Output tensor of the node </td></tr>
217   </table>
218   </dd>
219 </dl>
220
221 <p>Implemented in <a class="el" href="classarm__compute_1_1graph_1_1_convolution_layer.xhtml#aefee70b3377d4ece56de05e1dff00dd8">ConvolutionLayer</a>, <a class="el" href="classarm__compute_1_1graph_1_1_branch_layer.xhtml#aefee70b3377d4ece56de05e1dff00dd8">BranchLayer</a>, <a class="el" href="classarm__compute_1_1graph_1_1_depthwise_convolution_layer.xhtml#aefee70b3377d4ece56de05e1dff00dd8">DepthwiseConvolutionLayer</a>, <a class="el" href="classarm__compute_1_1graph_1_1_batch_normalization_layer.xhtml#aefee70b3377d4ece56de05e1dff00dd8">BatchNormalizationLayer</a>, <a class="el" href="classarm__compute_1_1graph_1_1_fully_connected_layer.xhtml#aefee70b3377d4ece56de05e1dff00dd8">FullyConnectedLayer</a>, <a class="el" href="classarm__compute_1_1graph_1_1_dequantization_layer.xhtml#aefee70b3377d4ece56de05e1dff00dd8">DequantizationLayer</a>, <a class="el" href="classarm__compute_1_1graph_1_1_depth_convert_layer.xhtml#aefee70b3377d4ece56de05e1dff00dd8">DepthConvertLayer</a>, <a class="el" href="classarm__compute_1_1graph_1_1_l2_normalize_layer.xhtml#aefee70b3377d4ece56de05e1dff00dd8">L2NormalizeLayer</a>, <a class="el" href="classarm__compute_1_1graph_1_1_activation_layer.xhtml#aefee70b3377d4ece56de05e1dff00dd8">ActivationLayer</a>, <a class="el" href="classarm__compute_1_1graph_1_1_normalization_layer.xhtml#aefee70b3377d4ece56de05e1dff00dd8">NormalizationLayer</a>, <a class="el" href="classarm__compute_1_1graph_1_1_pooling_layer.xhtml#aefee70b3377d4ece56de05e1dff00dd8">PoolingLayer</a>, <a class="el" href="classarm__compute_1_1graph_1_1_reshape_layer.xhtml#aefee70b3377d4ece56de05e1dff00dd8">ReshapeLayer</a>, <a class="el" href="classarm__compute_1_1graph_1_1_flatten_layer.xhtml#aefee70b3377d4ece56de05e1dff00dd8">FlattenLayer</a>, <a class="el" href="classarm__compute_1_1graph_1_1_quantization_layer.xhtml#aefee70b3377d4ece56de05e1dff00dd8">QuantizationLayer</a>, <a class="el" href="classarm__compute_1_1graph_1_1_floor_layer.xhtml#aefee70b3377d4ece56de05e1dff00dd8">FloorLayer</a>, and <a class="el" href="classarm__compute_1_1graph_1_1_softmax_layer.xhtml#aefee70b3377d4ece56de05e1dff00dd8">SoftmaxLayer</a>.</p>
222
223 </div>
224 </div>
225 <a class="anchor" id="a4f94409d100ac0a28961a82a5cc31d30"></a>
226 <div class="memitem">
227 <div class="memproto">
228       <table class="memname">
229         <tr>
230           <td class="memname"><a class="el" href="namespacearm__compute_1_1graph.xhtml#a8d5e69e9a697c2007e241eb413c9833b">TargetHint</a> override_target_hint </td>
231           <td>(</td>
232           <td class="paramtype"><a class="el" href="namespacearm__compute_1_1graph.xhtml#a8d5e69e9a697c2007e241eb413c9833b">TargetHint</a>&#160;</td>
233           <td class="paramname"><em>target_hint</em></td><td>)</td>
234           <td> const</td>
235         </tr>
236       </table>
237 </div><div class="memdoc">
238
239 <p>Override the existing target hint. </p>
240 <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>
241 <dl class="params"><dt>Parameters</dt><dd>
242   <table class="params">
243     <tr><td class="paramdir">[in]</td><td class="paramname">target_hint</td><td>Target hint to be considered</td></tr>
244   </table>
245   </dd>
246 </dl>
247 <dl class="section return"><dt>Returns</dt><dd>The updated target hint </dd></dl>
248
249 </div>
250 </div>
251 <hr/>The documentation for this class was generated from the following file:<ul>
252 <li>arm_compute/graph/<a class="el" href="_i_node_8h_source.xhtml">INode.h</a></li>
253 </ul>
254 </div><!-- contents -->
255 </div><!-- doc-content -->
256 <!-- start footer part -->
257 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
258   <ul>
259     <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>
260     <li class="footer">Generated on Thu Dec 14 2017 23:48:37 for Compute Library by
261     <a href="http://www.doxygen.org/index.html">
262     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
263   </ul>
264 </div>
265 </body>
266 </html>