diff options
author | Jim Flynn <jim.flynn@arm.com> | 2020-03-19 17:03:14 +0000 |
---|---|---|
committer | Jim Flynn <jim.flynn@arm.com> | 2020-03-19 17:03:14 +0000 |
commit | 0e2bab81442ee6cc2b94e4f7881ed0c5c6af65e7 (patch) | |
tree | b0af08b5a0b74149fca422151127ac6310385399 /Documentation/_subgraph_view_selector_8hpp_source.xhtml | |
parent | 8c3259fa007d43fcc5ea56fe6928526dbe79f3c0 (diff) | |
download | armnn-0e2bab81442ee6cc2b94e4f7881ed0c5c6af65e7.tar.gz |
Creating gh-pages documentation for ArmNN
Signed-off-by: Jim Flynn <jim.flynn@arm.com>
Diffstat (limited to 'Documentation/_subgraph_view_selector_8hpp_source.xhtml')
-rw-r--r-- | Documentation/_subgraph_view_selector_8hpp_source.xhtml | 122 |
1 files changed, 122 insertions, 0 deletions
diff --git a/Documentation/_subgraph_view_selector_8hpp_source.xhtml b/Documentation/_subgraph_view_selector_8hpp_source.xhtml new file mode 100644 index 0000000000..6901b031d8 --- /dev/null +++ b/Documentation/_subgraph_view_selector_8hpp_source.xhtml @@ -0,0 +1,122 @@ +<!-- Copyright (c) 2020 ARM Limited. --> +<!-- --> +<!-- SPDX-License-Identifier: MIT --> +<!-- --> +<!-- HTML header for doxygen 1.8.13--> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.13"/> +<meta name="robots" content="NOINDEX, NOFOLLOW" /> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>ArmNN: src/armnn/SubgraphViewSelector.hpp Source File</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtreedata.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); +</script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/x-mathjax-config"> + MathJax.Hub.Config({ + extensions: ["tex2jax.js"], + jax: ["input/TeX","output/HTML-CSS"], +}); +</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +<link href="stylesheet.css" rel="stylesheet" type="text/css"/> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 10rem; margin-top: .5rem; margin-left 10px"/> + <td style="padding-left: 0.5em;"> + <div id="projectname"> +  <span id="projectnumber">20.02</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.13 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +</script> +<div id="main-nav"></div> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('_subgraph_view_selector_8hpp_source.xhtml','');}); +</script> +<div id="doc-content"> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div class="header"> + <div class="headertitle"> +<div class="title">SubgraphViewSelector.hpp</div> </div> +</div><!--header--> +<div class="contents"> +<a href="_subgraph_view_selector_8hpp.xhtml">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// Copyright © 2017 Arm Ltd. All rights reserved.</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// SPDX-License-Identifier: MIT</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">//</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> </div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include "<a class="code" href="_subgraph_view_8hpp.xhtml">SubgraphView.hpp</a>"</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include <functional></span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="keyword">namespace </span><a class="code" href="namespacearmnn.xhtml">armnn</a></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> {</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> </div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="keyword">class </span>Layer;</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="keyword">class </span>Graph;</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"></span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">/// Algorithm that splits a Graph into Subgraphs based on a filtering of layers (e.g. which layers are appropriate for</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">/// a certain backend). The resulting subgraphs are guaranteed to be form a DAG (i.e. there are no dependency loops).</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">///</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">/// The algorithm aims to produce as few subgraphs as possible.</span></div><div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="classarmnn_1_1_subgraph_view_selector.xhtml"> 21</a></span> <span class="comment"></span><span class="keyword">class </span><a class="code" href="classarmnn_1_1_subgraph_view_selector.xhtml">SubgraphViewSelector</a> final</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> {</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="classarmnn_1_1_subgraph_view_selector.xhtml#a4684a457c7786484375f06e9ab2d2265"> 24</a></span>  <span class="keyword">using</span> <a class="code" href="classarmnn_1_1_subgraph_view_selector.xhtml#a4684a457c7786484375f06e9ab2d2265">SubgraphViewPtr</a> = std::unique_ptr<SubgraphView>;</div><div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="classarmnn_1_1_subgraph_view_selector.xhtml#aaf71a63dbbc776f8961b0f4fdb9da021"> 25</a></span>  <span class="keyword">using</span> <a class="code" href="classarmnn_1_1_subgraph_view_selector.xhtml#aaf71a63dbbc776f8961b0f4fdb9da021">Subgraphs</a> = std::vector<SubgraphViewPtr>;</div><div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="classarmnn_1_1_subgraph_view_selector.xhtml#a341a1b47a5f71edaebf81f3a5f0f4c55"> 26</a></span>  <span class="keyword">using</span> <a class="code" href="classarmnn_1_1_subgraph_view_selector.xhtml#a341a1b47a5f71edaebf81f3a5f0f4c55">LayerSelectorFunction</a> = std::function<bool(const Layer&)>;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"></span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> /// Selects subgraphs from a graph based on the selector function and the algorithm.</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> /// Since the Subgraphs object returns modifiable pointers to the input and output slots of the graph:</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> /// 1) the graph/sub-graph cannot be const</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> /// 2) the caller needs to make sure that the Subgraphs lifetime is shorter than the parent graph's</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"></span> <span class="keyword">static</span> <a class="code" href="classarmnn_1_1_subgraph_view_selector.xhtml#aaf71a63dbbc776f8961b0f4fdb9da021">Subgraphs</a> <a class="code" href="classarmnn_1_1_subgraph_view_selector.xhtml#a3730b0a6006f0d87f894a44e01869d90">SelectSubgraphs</a>(<a class="code" href="classarmnn_1_1_graph.xhtml">Graph</a>& graph, <span class="keyword">const</span> <a class="code" href="classarmnn_1_1_subgraph_view_selector.xhtml#a341a1b47a5f71edaebf81f3a5f0f4c55">LayerSelectorFunction</a>& selector);</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keyword">static</span> <a class="code" href="classarmnn_1_1_subgraph_view_selector.xhtml#aaf71a63dbbc776f8961b0f4fdb9da021">Subgraphs</a> <a class="code" href="classarmnn_1_1_subgraph_view_selector.xhtml#a3730b0a6006f0d87f894a44e01869d90">SelectSubgraphs</a>(<a class="code" href="classarmnn_1_1_subgraph_view.xhtml">SubgraphView</a>& subgraph, <span class="keyword">const</span> <a class="code" href="classarmnn_1_1_subgraph_view_selector.xhtml#a341a1b47a5f71edaebf81f3a5f0f4c55">LayerSelectorFunction</a>& selector);</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="comment">// this is a utility class, don't construct or copy</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <a class="code" href="classarmnn_1_1_subgraph_view_selector.xhtml">SubgraphViewSelector</a>() = <span class="keyword">delete</span>;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <a class="code" href="classarmnn_1_1_subgraph_view_selector.xhtml">SubgraphViewSelector</a>(<span class="keyword">const</span> <a class="code" href="classarmnn_1_1_subgraph_view_selector.xhtml">SubgraphViewSelector</a>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <a class="code" href="classarmnn_1_1_subgraph_view_selector.xhtml">SubgraphViewSelector</a> & operator=(<span class="keyword">const</span> <a class="code" href="classarmnn_1_1_subgraph_view_selector.xhtml">SubgraphViewSelector</a>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> };</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> } <span class="comment">// namespace armnn</span></div><div class="ttc" id="classarmnn_1_1_subgraph_view_selector_xhtml_a341a1b47a5f71edaebf81f3a5f0f4c55"><div class="ttname"><a href="classarmnn_1_1_subgraph_view_selector.xhtml#a341a1b47a5f71edaebf81f3a5f0f4c55">armnn::SubgraphViewSelector::LayerSelectorFunction</a></div><div class="ttdeci">std::function< bool(const Layer &)> LayerSelectorFunction</div><div class="ttdef"><b>Definition:</b> <a href="_subgraph_view_selector_8hpp_source.xhtml#l00026">SubgraphViewSelector.hpp:26</a></div></div> +<div class="ttc" id="_subgraph_view_8hpp_xhtml"><div class="ttname"><a href="_subgraph_view_8hpp.xhtml">SubgraphView.hpp</a></div></div> +<div class="ttc" id="namespacearmnn_xhtml"><div class="ttname"><a href="namespacearmnn.xhtml">armnn</a></div><div class="ttdoc">Copyright (c) 2020 ARM Limited. </div><div class="ttdef"><b>Definition:</b> <a href="00__introduction_8dox_source.xhtml#l00025">00_introduction.dox:25</a></div></div> +<div class="ttc" id="classarmnn_1_1_subgraph_view_xhtml"><div class="ttname"><a href="classarmnn_1_1_subgraph_view.xhtml">armnn::SubgraphView</a></div><div class="ttdoc">The SubgraphView class represents a subgraph of a Graph. </div><div class="ttdef"><b>Definition:</b> <a href="_subgraph_view_8hpp_source.xhtml#l00023">SubgraphView.hpp:23</a></div></div> +<div class="ttc" id="classarmnn_1_1_subgraph_view_selector_xhtml"><div class="ttname"><a href="classarmnn_1_1_subgraph_view_selector.xhtml">armnn::SubgraphViewSelector</a></div><div class="ttdoc">Algorithm that splits a Graph into Subgraphs based on a filtering of layers (e.g. ...</div><div class="ttdef"><b>Definition:</b> <a href="_subgraph_view_selector_8hpp_source.xhtml#l00021">SubgraphViewSelector.hpp:21</a></div></div> +<div class="ttc" id="classarmnn_1_1_subgraph_view_selector_xhtml_aaf71a63dbbc776f8961b0f4fdb9da021"><div class="ttname"><a href="classarmnn_1_1_subgraph_view_selector.xhtml#aaf71a63dbbc776f8961b0f4fdb9da021">armnn::SubgraphViewSelector::Subgraphs</a></div><div class="ttdeci">std::vector< SubgraphViewPtr > Subgraphs</div><div class="ttdef"><b>Definition:</b> <a href="_subgraph_view_selector_8hpp_source.xhtml#l00025">SubgraphViewSelector.hpp:25</a></div></div> +<div class="ttc" id="classarmnn_1_1_graph_xhtml"><div class="ttname"><a href="classarmnn_1_1_graph.xhtml">armnn::Graph</a></div><div class="ttdef"><b>Definition:</b> <a href="_graph_8hpp_source.xhtml#l00029">Graph.hpp:29</a></div></div> +<div class="ttc" id="classarmnn_1_1_subgraph_view_selector_xhtml_a4684a457c7786484375f06e9ab2d2265"><div class="ttname"><a href="classarmnn_1_1_subgraph_view_selector.xhtml#a4684a457c7786484375f06e9ab2d2265">armnn::SubgraphViewSelector::SubgraphViewPtr</a></div><div class="ttdeci">std::unique_ptr< SubgraphView > SubgraphViewPtr</div><div class="ttdef"><b>Definition:</b> <a href="_subgraph_view_selector_8hpp_source.xhtml#l00024">SubgraphViewSelector.hpp:24</a></div></div> +<div class="ttc" id="classarmnn_1_1_subgraph_view_selector_xhtml_a3730b0a6006f0d87f894a44e01869d90"><div class="ttname"><a href="classarmnn_1_1_subgraph_view_selector.xhtml#a3730b0a6006f0d87f894a44e01869d90">armnn::SubgraphViewSelector::SelectSubgraphs</a></div><div class="ttdeci">static Subgraphs SelectSubgraphs(Graph &graph, const LayerSelectorFunction &selector)</div><div class="ttdoc">Selects subgraphs from a graph based on the selector function and the algorithm. </div><div class="ttdef"><b>Definition:</b> <a href="_subgraph_view_selector_8cpp_source.xhtml#l00254">SubgraphViewSelector.cpp:254</a></div></div> +</div><!-- fragment --></div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.xhtml">src</a></li><li class="navelem"><a class="el" href="dir_e0a84d05c80a2ef4231141dcbbeac5c8.xhtml">armnn</a></li><li class="navelem"><a class="el" href="_subgraph_view_selector_8hpp.xhtml">SubgraphViewSelector.hpp</a></li> + <li class="footer">Generated on Fri Mar 13 2020 16:09:08 for ArmNN by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> + </ul> +</div> +</body> +</html> |