blob: c114841f0033f60f8a6df969fd8e036df0695fd1 [file] [log] [blame]
<!-- HTML header for doxygen 1.8.17-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Arm NN: 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>
<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" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="customdoxygen.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: 15rem; margin-top: .5rem; margin-left 13px"/>
<td id="projectalign" style="padding-left: 0.9em;">
<div id="projectname">
&#160;<span id="projectnumber">24.02</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_subgraph_view_selector_8hpp_source.html',''); initResizable(); });
/* @license-end */
</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.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// Copyright © 2017, 2023 Arm Ltd and Contributors. All rights reserved.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// SPDX-License-Identifier: MIT</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160; </div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="_subgraph_view_8hpp.html">armnn/backends/SubgraphView.hpp</a>&gt;</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &lt;functional&gt;</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &lt;memory&gt;</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160; </div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacearmnn.html">armnn</a></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;{</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; </div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="keyword">class </span>Layer;</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="keyword">class </span>Graph;</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<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>&#160;<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>&#160;<span class="comment">///</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<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.html"> 21</a></span>&#160;<span class="comment"></span><span class="keyword">class </span><a class="code" href="classarmnn_1_1_subgraph_view_selector.html">SubgraphViewSelector</a> final</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;{</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<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.html#ab9e8c2ce720efe33c8a20b8f74bb9d5f"> 24</a></span>&#160; <span class="keyword">using</span> <a class="code" href="classarmnn_1_1_subgraph_view_selector.html#ab9e8c2ce720efe33c8a20b8f74bb9d5f">Subgraphs</a> = std::vector&lt;SubgraphView::SubgraphViewPtr&gt;;</div>
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="classarmnn_1_1_subgraph_view_selector.html#a341a1b47a5f71edaebf81f3a5f0f4c55"> 25</a></span>&#160; <span class="keyword">using</span> <a class="code" href="classarmnn_1_1_subgraph_view_selector.html#a341a1b47a5f71edaebf81f3a5f0f4c55">LayerSelectorFunction</a> = std::function&lt;bool(<span class="keyword">const</span> <a class="code" href="classarmnn_1_1_layer.html">Layer</a>&amp;)&gt;;</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="comment"> /// Selects subgraphs from a graph based on the selector function and the algorithm.</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<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="l00029"></a><span class="lineno"> 29</span>&#160;<span class="comment"> /// 1) the graph/sub-graph cannot be const</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="comment"> /// 2) the caller needs to make sure that the Subgraphs lifetime is shorter than the parent graph&#39;s</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="comment"></span> <span class="keyword">static</span> <a class="code" href="classarmnn_1_1_subgraph_view_selector.html#ab9e8c2ce720efe33c8a20b8f74bb9d5f">Subgraphs</a> <a class="code" href="classarmnn_1_1_subgraph_view_selector.html#a3730b0a6006f0d87f894a44e01869d90">SelectSubgraphs</a>(<a class="code" href="classarmnn_1_1_graph.html">Graph</a>&amp; graph, <span class="keyword">const</span> <a class="code" href="classarmnn_1_1_subgraph_view_selector.html#a341a1b47a5f71edaebf81f3a5f0f4c55">LayerSelectorFunction</a>&amp; selector);</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keyword">static</span> <a class="code" href="classarmnn_1_1_subgraph_view_selector.html#ab9e8c2ce720efe33c8a20b8f74bb9d5f">Subgraphs</a> <a class="code" href="classarmnn_1_1_subgraph_view_selector.html#a3730b0a6006f0d87f894a44e01869d90">SelectSubgraphs</a>(<a class="code" href="classarmnn_1_1_subgraph_view.html">SubgraphView</a>&amp; subgraph, <span class="keyword">const</span> <a class="code" href="classarmnn_1_1_subgraph_view_selector.html#a341a1b47a5f71edaebf81f3a5f0f4c55">LayerSelectorFunction</a>&amp; selector);</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="comment">// this is a utility class, don&#39;t construct or copy</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <a class="code" href="classarmnn_1_1_subgraph_view_selector.html">SubgraphViewSelector</a>() = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <a class="code" href="classarmnn_1_1_subgraph_view_selector.html">SubgraphViewSelector</a>(<span class="keyword">const</span> <a class="code" href="classarmnn_1_1_subgraph_view_selector.html">SubgraphViewSelector</a>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <a class="code" href="classarmnn_1_1_subgraph_view_selector.html">SubgraphViewSelector</a> &amp; operator=(<span class="keyword">const</span> <a class="code" href="classarmnn_1_1_subgraph_view_selector.html">SubgraphViewSelector</a>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;};</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; </div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;} <span class="comment">// namespace armnn</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="aclassarmnn_1_1_layer_html"><div class="ttname"><a href="classarmnn_1_1_layer.html">armnn::Layer</a></div><div class="ttdef"><b>Definition:</b> <a href="_layer_8hpp_source.html#l00230">Layer.hpp:230</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_subgraph_view_selector_html"><div class="ttname"><a href="classarmnn_1_1_subgraph_view_selector.html">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.html#l00021">SubgraphViewSelector.hpp:21</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_subgraph_view_selector_html_a3730b0a6006f0d87f894a44e01869d90"><div class="ttname"><a href="classarmnn_1_1_subgraph_view_selector.html#a3730b0a6006f0d87f894a44e01869d90">armnn::SubgraphViewSelector::SelectSubgraphs</a></div><div class="ttdeci">static Subgraphs SelectSubgraphs(Graph &amp;graph, const LayerSelectorFunction &amp;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.html#l00259">SubgraphViewSelector.cpp:259</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_subgraph_view_selector_html_a341a1b47a5f71edaebf81f3a5f0f4c55"><div class="ttname"><a href="classarmnn_1_1_subgraph_view_selector.html#a341a1b47a5f71edaebf81f3a5f0f4c55">armnn::SubgraphViewSelector::LayerSelectorFunction</a></div><div class="ttdeci">std::function&lt; bool(const Layer &amp;)&gt; LayerSelectorFunction</div><div class="ttdef"><b>Definition:</b> <a href="_subgraph_view_selector_8hpp_source.html#l00025">SubgraphViewSelector.hpp:25</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_subgraph_view_html"><div class="ttname"><a href="classarmnn_1_1_subgraph_view.html">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.html#l00031">SubgraphView.hpp:31</a></div></div>
<div class="ttc" id="a_subgraph_view_8hpp_html"><div class="ttname"><a href="_subgraph_view_8hpp.html">SubgraphView.hpp</a></div></div>
<div class="ttc" id="anamespacearmnn_html"><div class="ttname"><a href="namespacearmnn.html">armnn</a></div><div class="ttdoc">Copyright (c) 2021 ARM Limited and Contributors.</div><div class="ttdef"><b>Definition:</b> <a href="01__00__quick__start_8dox_source.html#l00006">01_00_quick_start.dox:6</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_subgraph_view_selector_html_ab9e8c2ce720efe33c8a20b8f74bb9d5f"><div class="ttname"><a href="classarmnn_1_1_subgraph_view_selector.html#ab9e8c2ce720efe33c8a20b8f74bb9d5f">armnn::SubgraphViewSelector::Subgraphs</a></div><div class="ttdeci">std::vector&lt; SubgraphView::SubgraphViewPtr &gt; Subgraphs</div><div class="ttdef"><b>Definition:</b> <a href="_subgraph_view_selector_8hpp_source.html#l00024">SubgraphViewSelector.hpp:24</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_graph_html"><div class="ttname"><a href="classarmnn_1_1_graph.html">armnn::Graph</a></div><div class="ttdef"><b>Definition:</b> <a href="_graph_8hpp_source.html#l00030">Graph.hpp:30</a></div></div>
<!-- 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.html">src</a></li><li class="navelem"><a class="el" href="dir_e0a84d05c80a2ef4231141dcbbeac5c8.html">armnn</a></li><li class="navelem"><a class="el" href="_subgraph_view_selector_8hpp.html">SubgraphViewSelector.hpp</a></li>
<li class="footer">Generated on Wed Feb 14 2024 16:36:14 for Arm NN by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
</ul>
</div>
</body>
</html>