arm_compute v17.10
[platform/upstream/armcl.git] / documentation / _graph_8h_source.xhtml
index 64ad427..8423a19 100644 (file)
@@ -38,7 +38,7 @@
  <tr style="height: 56px;">
   <td style="padding-left: 0.5em;">
    <div id="projectname">Compute Library
-   &#160;<span id="projectnumber">17.09</span>
+   &#160;<span id="projectnumber">17.10</span>
    </div>
   </td>
  </tr>
@@ -166,19 +166,19 @@ $(document).ready(function(){initNavTree('_graph_8h_source.xhtml','');});
 <div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classarm__compute_1_1graph_1_1_graph.xhtml#a13a43e6d814de94978c515cb084873b1">run</a>();</div>
 <div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classarm__compute_1_1graph_1_1_graph.xhtml#a38ce1a1fc4dd3131a37225ae95c143ce">add_node</a>(std::unique_ptr&lt;INode&gt; node);</div>
 <div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classarm__compute_1_1graph_1_1_graph.xhtml#ad6aab51af350366d4844223107f54b33">add_tensor</a>(std::unique_ptr&lt;Tensor&gt; tensor);</div>
-<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classarm__compute_1_1graph_1_1_graph.xhtml#abcff5566e5609c884be1880d023c81af">set_hint</a>(<a class="code" href="namespacearm__compute_1_1graph.xhtml#a0e3ca6c9bf8d16363c1be8fddd2cfcae">Hint</a> hint);</div>
-<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classarm__compute_1_1graph_1_1_graph.xhtml#a3945abf22acb665acda99694b5478dd8">set_temp</a>(<a class="code" href="classarm__compute_1_1_tensor_info.xhtml">TensorInfo</a> &amp;&amp;tmp);</div>
-<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;</div>
-<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classarm__compute_1_1graph_1_1_graph.xhtml#afaff225242efe5b2c39c932cfdd0f459">set_info_enablement</a>(<span class="keywordtype">bool</span> is_enabled);</div>
-<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;</div>
-<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;<span class="keyword">private</span>:</div>
-<div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;    <span class="keyword">class </span>Private;</div>
-<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;    std::unique_ptr&lt;Private&gt; _pimpl; </div>
-<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;};</div>
-<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;</div>
-<div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;<a class="code" href="classarm__compute_1_1graph_1_1_graph.xhtml">Graph</a> &amp;<a class="code" href="namespacearm__compute_1_1graph.xhtml#a2efd084c3be5fb3d31d18dad2356adb2">operator&lt;&lt;</a>(<a class="code" href="classarm__compute_1_1graph_1_1_graph.xhtml">Graph</a> &amp;graph, <a class="code" href="classarm__compute_1_1_tensor_info.xhtml">TensorInfo</a> &amp;&amp;<a class="code" href="namespacearm__compute_1_1test_1_1validation.xhtml#a096668313a9a819d54a2e65ec21ff0cc">info</a>);</div>
-<div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;<a class="code" href="classarm__compute_1_1graph_1_1_graph.xhtml">Graph</a> &amp;<a class="code" href="namespacearm__compute_1_1graph.xhtml#a2efd084c3be5fb3d31d18dad2356adb2">operator&lt;&lt;</a>(<a class="code" href="classarm__compute_1_1graph_1_1_graph.xhtml">Graph</a> &amp;graph, <a class="code" href="classarm__compute_1_1graph_1_1_tensor.xhtml">Tensor</a> &amp;&amp;tensor);</div>
-<div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;<a class="code" href="classarm__compute_1_1graph_1_1_graph.xhtml">Graph</a> &amp;<a class="code" href="namespacearm__compute_1_1graph.xhtml#a2efd084c3be5fb3d31d18dad2356adb2">operator&lt;&lt;</a>(<a class="code" href="classarm__compute_1_1graph_1_1_graph.xhtml">Graph</a> &amp;graph, <a class="code" href="namespacearm__compute_1_1graph.xhtml#a0e3ca6c9bf8d16363c1be8fddd2cfcae">Hint</a> hint);</div>
+<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classarm__compute_1_1graph_1_1_graph.xhtml#a3945abf22acb665acda99694b5478dd8">set_temp</a>(<a class="code" href="classarm__compute_1_1_tensor_info.xhtml">TensorInfo</a> &amp;&amp;tmp);</div>
+<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;</div>
+<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;    <a class="code" href="classarm__compute_1_1graph_1_1_graph_hints.xhtml">GraphHints</a> &amp;<a class="code" href="classarm__compute_1_1graph_1_1_graph.xhtml#aa0dea194fb7dfe9413b77eb1d8960695">hints</a>();</div>
+<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;</div>
+<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;<span class="keyword">private</span>:</div>
+<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;    <span class="keyword">class </span>Private;</div>
+<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;    std::unique_ptr&lt;Private&gt; _pimpl; </div>
+<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;};</div>
+<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;</div>
+<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;<a class="code" href="classarm__compute_1_1graph_1_1_graph.xhtml">Graph</a> &amp;<a class="code" href="namespacearm__compute_1_1graph.xhtml#a2efd084c3be5fb3d31d18dad2356adb2">operator&lt;&lt;</a>(<a class="code" href="classarm__compute_1_1graph_1_1_graph.xhtml">Graph</a> &amp;graph, <a class="code" href="classarm__compute_1_1_tensor_info.xhtml">TensorInfo</a> &amp;&amp;<a class="code" href="namespacearm__compute_1_1test_1_1validation.xhtml#a096668313a9a819d54a2e65ec21ff0cc">info</a>);</div>
+<div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;<a class="code" href="classarm__compute_1_1graph_1_1_graph.xhtml">Graph</a> &amp;<a class="code" href="namespacearm__compute_1_1graph.xhtml#a2efd084c3be5fb3d31d18dad2356adb2">operator&lt;&lt;</a>(<a class="code" href="classarm__compute_1_1graph_1_1_graph.xhtml">Graph</a> &amp;graph, <a class="code" href="classarm__compute_1_1graph_1_1_tensor.xhtml">Tensor</a> &amp;&amp;tensor);</div>
+<div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;<a class="code" href="classarm__compute_1_1graph_1_1_graph.xhtml">Graph</a> &amp;<a class="code" href="namespacearm__compute_1_1graph.xhtml#a2efd084c3be5fb3d31d18dad2356adb2">operator&lt;&lt;</a>(<a class="code" href="classarm__compute_1_1graph_1_1_graph.xhtml">Graph</a> &amp;graph, <a class="code" href="namespacearm__compute_1_1graph.xhtml#a8d5e69e9a697c2007e241eb413c9833b">TargetHint</a> target_hint);</div>
+<div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;<a class="code" href="classarm__compute_1_1graph_1_1_graph.xhtml">Graph</a> &amp;<a class="code" href="namespacearm__compute_1_1graph.xhtml#a2efd084c3be5fb3d31d18dad2356adb2">operator&lt;&lt;</a>(<a class="code" href="classarm__compute_1_1graph_1_1_graph.xhtml">Graph</a> &amp;graph, <a class="code" href="namespacearm__compute_1_1graph.xhtml#a9a92cf6a83b4d54786334cc37a7391a2">ConvolutionMethodHint</a> conv_method_hint);</div>
 <div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> Node&gt;</div>
 <div class="line"><a name="l00125"></a><span class="lineno"><a class="line" href="namespacearm__compute_1_1graph.xhtml#abfc34f1a04c997ae804b16ed4173f36d">  125</a></span>&#160;<a class="code" href="classarm__compute_1_1graph_1_1_graph.xhtml">Graph</a> &amp;<a class="code" href="namespacearm__compute_1_1graph.xhtml#a2efd084c3be5fb3d31d18dad2356adb2">operator&lt;&lt;</a>(<a class="code" href="classarm__compute_1_1graph_1_1_graph.xhtml">Graph</a> &amp;graph, Node node)</div>
 <div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;{</div>
@@ -190,22 +190,23 @@ $(document).ready(function(){initNavTree('_graph_8h_source.xhtml','');});
 <div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* __ARM_COMPUTE_GRAPH_GRAPH_H__ */</span><span class="preprocessor"></span></div>
 <div class="ttc" id="_toolchain_support_8h_xhtml"><div class="ttname"><a href="_toolchain_support_8h.xhtml">ToolchainSupport.h</a></div></div>
 <div class="ttc" id="classarm__compute_1_1graph_1_1_graph_xhtml_a13a43e6d814de94978c515cb084873b1"><div class="ttname"><a href="classarm__compute_1_1graph_1_1_graph.xhtml#a13a43e6d814de94978c515cb084873b1">arm_compute::graph::Graph::run</a></div><div class="ttdeci">void run()</div><div class="ttdoc">Executes the graph. </div></div>
-<div class="ttc" id="classarm__compute_1_1graph_1_1_graph_xhtml_afaff225242efe5b2c39c932cfdd0f459"><div class="ttname"><a href="classarm__compute_1_1graph_1_1_graph.xhtml#afaff225242efe5b2c39c932cfdd0f459">arm_compute::graph::Graph::set_info_enablement</a></div><div class="ttdeci">void set_info_enablement(bool is_enabled)</div><div class="ttdoc">Sets whether to enable information print out. </div></div>
 <div class="ttc" id="arm__compute_2graph_2_types_8h_xhtml"><div class="ttname"><a href="arm__compute_2graph_2_types_8h.xhtml">Types.h</a></div></div>
 <div class="ttc" id="classarm__compute_1_1graph_1_1_graph_xhtml_afc5ef9d72cc2c509814200791eaef62c"><div class="ttname"><a href="classarm__compute_1_1graph_1_1_graph.xhtml#afc5ef9d72cc2c509814200791eaef62c">arm_compute::graph::Graph::Graph</a></div><div class="ttdeci">Graph()</div><div class="ttdoc">Constructor. </div></div>
+<div class="ttc" id="classarm__compute_1_1graph_1_1_graph_xhtml_aa0dea194fb7dfe9413b77eb1d8960695"><div class="ttname"><a href="classarm__compute_1_1graph_1_1_graph.xhtml#aa0dea194fb7dfe9413b77eb1d8960695">arm_compute::graph::Graph::hints</a></div><div class="ttdeci">GraphHints &amp; hints()</div><div class="ttdoc">Returns the graph hints that are currently used. </div></div>
 <div class="ttc" id="_i_node_8h_xhtml"><div class="ttname"><a href="_i_node_8h.xhtml">INode.h</a></div></div>
 <div class="ttc" id="namespacearm__compute_1_1test_1_1validation_xhtml_a096668313a9a819d54a2e65ec21ff0cc"><div class="ttname"><a href="namespacearm__compute_1_1test_1_1validation.xhtml#a096668313a9a819d54a2e65ec21ff0cc">arm_compute::test::validation::info</a></div><div class="ttdeci">src info() -&gt; set_format(Format::S16)</div></div>
 <div class="ttc" id="classarm__compute_1_1graph_1_1_graph_xhtml_a38ce1a1fc4dd3131a37225ae95c143ce"><div class="ttname"><a href="classarm__compute_1_1graph_1_1_graph.xhtml#a38ce1a1fc4dd3131a37225ae95c143ce">arm_compute::graph::Graph::add_node</a></div><div class="ttdeci">void add_node(std::unique_ptr&lt; INode &gt; node)</div><div class="ttdoc">Adds a node to the graph. </div></div>
 <div class="ttc" id="classarm__compute_1_1graph_1_1_graph_xhtml_a5555577e36369d44917b04534e1740e7"><div class="ttname"><a href="classarm__compute_1_1graph_1_1_graph.xhtml#a5555577e36369d44917b04534e1740e7">arm_compute::graph::Graph::operator=</a></div><div class="ttdeci">const Graph &amp; operator=(const Graph &amp;)=delete</div><div class="ttdoc">Prevent instances from being copy assigned. </div></div>
 <div class="ttc" id="classarm__compute_1_1graph_1_1_graph_xhtml_a3945abf22acb665acda99694b5478dd8"><div class="ttname"><a href="classarm__compute_1_1graph_1_1_graph.xhtml#a3945abf22acb665acda99694b5478dd8">arm_compute::graph::Graph::set_temp</a></div><div class="ttdeci">void set_temp(TensorInfo &amp;&amp;tmp)</div><div class="ttdoc">Manually sets the output of the current node. </div></div>
 <div class="ttc" id="namespacearm__compute_1_1graph_xhtml_a2efd084c3be5fb3d31d18dad2356adb2"><div class="ttname"><a href="namespacearm__compute_1_1graph.xhtml#a2efd084c3be5fb3d31d18dad2356adb2">arm_compute::graph::operator&lt;&lt;</a></div><div class="ttdeci">Graph &amp; operator&lt;&lt;(Graph &amp;graph, TensorInfo &amp;&amp;info)</div><div class="ttdoc">Overloaded stream operator to add a tensor through its tensor info to the graph. </div></div>
+<div class="ttc" id="namespacearm__compute_1_1graph_xhtml_a9a92cf6a83b4d54786334cc37a7391a2"><div class="ttname"><a href="namespacearm__compute_1_1graph.xhtml#a9a92cf6a83b4d54786334cc37a7391a2">arm_compute::graph::ConvolutionMethodHint</a></div><div class="ttdeci">ConvolutionMethodHint</div><div class="ttdef"><b>Definition:</b> <a href="arm__compute_2graph_2_types_8h_source.xhtml#l00058">Types.h:58</a></div></div>
 <div class="ttc" id="graph_2_tensor_8h_xhtml"><div class="ttname"><a href="graph_2_tensor_8h.xhtml">Tensor.h</a></div></div>
 <div class="ttc" id="classarm__compute_1_1graph_1_1_graph_xhtml"><div class="ttname"><a href="classarm__compute_1_1graph_1_1_graph.xhtml">arm_compute::graph::Graph</a></div><div class="ttdoc">Graph class. </div><div class="ttdef"><b>Definition:</b> <a href="_graph_8h_source.xhtml#l00041">Graph.h:41</a></div></div>
 <div class="ttc" id="classarm__compute_1_1graph_1_1_graph_xhtml_af5a604e5e9e4d68dbc10b312e59f678f"><div class="ttname"><a href="classarm__compute_1_1graph_1_1_graph.xhtml#af5a604e5e9e4d68dbc10b312e59f678f">arm_compute::graph::Graph::~Graph</a></div><div class="ttdeci">~Graph()</div><div class="ttdoc">Destructor. </div></div>
-<div class="ttc" id="classarm__compute_1_1graph_1_1_graph_xhtml_abcff5566e5609c884be1880d023c81af"><div class="ttname"><a href="classarm__compute_1_1graph_1_1_graph.xhtml#abcff5566e5609c884be1880d023c81af">arm_compute::graph::Graph::set_hint</a></div><div class="ttdeci">void set_hint(Hint hint)</div><div class="ttdoc">Sets an execution hint to the graph. </div></div>
+<div class="ttc" id="namespacearm__compute_1_1graph_xhtml_a8d5e69e9a697c2007e241eb413c9833b"><div class="ttname"><a href="namespacearm__compute_1_1graph.xhtml#a8d5e69e9a697c2007e241eb413c9833b">arm_compute::graph::TargetHint</a></div><div class="ttdeci">TargetHint</div><div class="ttdoc">&lt; Execution hint to the graph executor </div><div class="ttdef"><b>Definition:</b> <a href="arm__compute_2graph_2_types_8h_source.xhtml#l00050">Types.h:50</a></div></div>
 <div class="ttc" id="classarm__compute_1_1_tensor_info_xhtml"><div class="ttname"><a href="classarm__compute_1_1_tensor_info.xhtml">arm_compute::TensorInfo</a></div><div class="ttdoc">Store the tensor&#39;s metadata. </div><div class="ttdef"><b>Definition:</b> <a href="_tensor_info_8h_source.xhtml#l00042">TensorInfo.h:42</a></div></div>
+<div class="ttc" id="classarm__compute_1_1graph_1_1_graph_hints_xhtml"><div class="ttname"><a href="classarm__compute_1_1graph_1_1_graph_hints.xhtml">arm_compute::graph::GraphHints</a></div><div class="ttdoc">Hints that can be passed to the graph to expose parameterization. </div><div class="ttdef"><b>Definition:</b> <a href="_graph_context_8h_source.xhtml#l00034">GraphContext.h:34</a></div></div>
 <div class="ttc" id="classarm__compute_1_1graph_1_1_graph_xhtml_ad6aab51af350366d4844223107f54b33"><div class="ttname"><a href="classarm__compute_1_1graph_1_1_graph.xhtml#ad6aab51af350366d4844223107f54b33">arm_compute::graph::Graph::add_tensor</a></div><div class="ttdeci">void add_tensor(std::unique_ptr&lt; Tensor &gt; tensor)</div><div class="ttdoc">Adds a tensor to the graph. </div></div>
-<div class="ttc" id="namespacearm__compute_1_1graph_xhtml_a0e3ca6c9bf8d16363c1be8fddd2cfcae"><div class="ttname"><a href="namespacearm__compute_1_1graph.xhtml#a0e3ca6c9bf8d16363c1be8fddd2cfcae">arm_compute::graph::Hint</a></div><div class="ttdeci">Hint</div><div class="ttdoc">&lt; Execution hint to the graph executor </div><div class="ttdef"><b>Definition:</b> <a href="arm__compute_2graph_2_types_8h_source.xhtml#l00045">Types.h:45</a></div></div>
 <div class="ttc" id="classarm__compute_1_1graph_1_1_tensor_xhtml"><div class="ttname"><a href="classarm__compute_1_1graph_1_1_tensor.xhtml">arm_compute::graph::Tensor</a></div><div class="ttdoc">Tensor class. </div><div class="ttdef"><b>Definition:</b> <a href="graph_2_tensor_8h_source.xhtml#l00038">Tensor.h:38</a></div></div>
 </div><!-- fragment --></div><!-- contents -->
 </div><!-- doc-content -->
@@ -213,7 +214,7 @@ $(document).ready(function(){initNavTree('_graph_8h_source.xhtml','');});
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="dir_d4d363c0979c7ffda4833df3f93b5668.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="dir_d01487573ca59d0a224e6f631a1169e6.xhtml">graph</a></li><li class="navelem"><a class="el" href="_graph_8h.xhtml">Graph.h</a></li>
-    <li class="footer">Generated on Thu Sep 28 2017 14:37:50 for Compute Library by
+    <li class="footer">Generated on Thu Oct 12 2017 14:26:33 for Compute Library by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
   </ul>