diff options
author | Jan Eilers <jan.eilers@arm.com> | 2021-02-25 17:44:00 +0000 |
---|---|---|
committer | Jan Eilers <jan.eilers@arm.com> | 2021-02-25 18:27:49 +0000 |
commit | fd627ffaec8fd8801d980b4c91ee7c0607ab6aaf (patch) | |
tree | eb4bc8f9b411f30c7655616142b5a4bdd3a1acd0 /21.02/_comparison_layer_8hpp_source.xhtml | |
parent | fb14ebbd68e04876809145296af96f6f41857418 (diff) | |
download | armnn-fd627ffaec8fd8801d980b4c91ee7c0607ab6aaf.tar.gz |
IVGCVSW-5687 Update Doxygen Docu
* Update Doxygen Documentation for 21.02 release
Signed-off-by: Jan Eilers <jan.eilers@arm.com>
Change-Id: I9ed2f9caab038836ea99d7b378d7899fe431a4e5
Diffstat (limited to '21.02/_comparison_layer_8hpp_source.xhtml')
-rw-r--r-- | 21.02/_comparison_layer_8hpp_source.xhtml | 128 |
1 files changed, 128 insertions, 0 deletions
diff --git a/21.02/_comparison_layer_8hpp_source.xhtml b/21.02/_comparison_layer_8hpp_source.xhtml new file mode 100644 index 0000000000..bdfa94f048 --- /dev/null +++ b/21.02/_comparison_layer_8hpp_source.xhtml @@ -0,0 +1,128 @@ +<!-- 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/layers/ComparisonLayer.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">21.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('_comparison_layer_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">ComparisonLayer.hpp</div> </div> +</div><!--header--> +<div class="contents"> +<a href="_comparison_layer_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 © 2019 Arm Ltd and Contributors. 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> </div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> </div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include "<a class="code" href="_layer_with_parameters_8hpp.xhtml">LayerWithParameters.hpp</a>"</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="keyword">namespace </span><a class="code" href="namespacearmnn.xhtml">armnn</a></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> {</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"></span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">/// This layer represents a comparison operation.</span></div><div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="classarmnn_1_1_comparison_layer.xhtml"> 14</a></span> <span class="comment"></span><span class="keyword">class </span><a class="code" href="classarmnn_1_1_comparison_layer.xhtml">ComparisonLayer</a> : <span class="keyword">public</span> <a class="code" href="classarmnn_1_1_layer_with_parameters.xhtml">LayerWithParameters</a><ComparisonDescriptor></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> {</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="keyword">public</span>:<span class="comment"></span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> /// Makes a workload for the Comparison type</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> /// @param [in] graph The graph where this layer can be found</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> /// @param [in] factory The workload factory which will create the workload</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> /// @return A pointer to the created workload, or nullptr if not created</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"></span> <span class="keyword">virtual</span> std::unique_ptr<IWorkload> <a class="code" href="classarmnn_1_1_comparison_layer.xhtml#adfa912d0c4c6c00f1af2cbfa799572b7">CreateWorkload</a>(<span class="keyword">const</span> <a class="code" href="classarmnn_1_1_i_workload_factory.xhtml">IWorkloadFactory</a>& factory) <span class="keyword">const override</span>;</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"></span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> /// Creates a dynamically-allocated copy of this layer</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> /// @param [in] graph The graph into which this layer is being cloned</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"></span> <a class="code" href="classarmnn_1_1_comparison_layer.xhtml">ComparisonLayer</a>* <a class="code" href="classarmnn_1_1_comparison_layer.xhtml#abbb77b1ee8b485ccd194db4c983a6b07">Clone</a>(<a class="code" href="classarmnn_1_1_graph.xhtml">Graph</a>& graph) <span class="keyword">const override</span>;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"></span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> /// By default returns inputShapes if the number of inputs are equal to number of outputs,</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> /// otherwise infers the output shapes from given input shapes and layer properties.</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> /// @param [in] inputShapes The input shapes layer has.</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> /// @return A vector to the inferred output shape.</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"></span> std::vector<TensorShape> <a class="code" href="classarmnn_1_1_comparison_layer.xhtml#a65ca562c882ad619684445a1402f415a">InferOutputShapes</a>(<span class="keyword">const</span> std::vector<TensorShape>& inputShapes) <span class="keyword">const override</span>;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"></span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> /// Check if the input tensor shape(s) will lead to a valid configuration</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> /// of @ref ComparisonLayer</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> /// @param [in] shapeInferenceMethod Indicates if output shape shall be overwritten or just validated.</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1_comparison_layer.xhtml#a8c8f543d7e9729362c266d12ec169966">ValidateTensorShapesFromInputs</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1_comparison_layer.xhtml#a75a50f464326fefa605ea84ae2c9be85">Accept</a>(<a class="code" href="classarmnn_1_1_i_layer_visitor.xhtml">ILayerVisitor</a>& visitor) <span class="keyword">const override</span>;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">protected</span>:<span class="comment"></span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> /// Constructor to create a ComparisonLayer</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> /// @param [in] param ComparisonDescriptor to configure the ComparisonLayer</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> /// @param [in] name Optional name for the layer</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"></span> <a class="code" href="classarmnn_1_1_comparison_layer.xhtml#a529ef9add04880e3eaf7cb13da5ee4d8">ComparisonLayer</a>(<span class="keyword">const</span> <a class="code" href="structarmnn_1_1_comparison_descriptor.xhtml">ComparisonDescriptor</a>& param, <span class="keyword">const</span> <span class="keywordtype">char</span>* name);</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"></span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> /// Default destructor</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"></span> <a class="code" href="classarmnn_1_1_comparison_layer.xhtml#a1866ea0335e6b4e09bff8c36732ecfa3">~ComparisonLayer</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> };</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> } <span class="comment">// namespace armnn</span></div><div class="ttc" id="_layer_with_parameters_8hpp_xhtml"><div class="ttname"><a href="_layer_with_parameters_8hpp.xhtml">LayerWithParameters.hpp</a></div></div> +<div class="ttc" id="classarmnn_1_1_comparison_layer_xhtml_a8c8f543d7e9729362c266d12ec169966"><div class="ttname"><a href="classarmnn_1_1_comparison_layer.xhtml#a8c8f543d7e9729362c266d12ec169966">armnn::ComparisonLayer::ValidateTensorShapesFromInputs</a></div><div class="ttdeci">void ValidateTensorShapesFromInputs() override</div><div class="ttdoc">Check if the input tensor shape(s) will lead to a valid configuration of ComparisonLayer. </div><div class="ttdef"><b>Definition:</b> <a href="_comparison_layer_8cpp_source.xhtml#l00060">ComparisonLayer.cpp:60</a></div></div> +<div class="ttc" id="classarmnn_1_1_comparison_layer_xhtml_a65ca562c882ad619684445a1402f415a"><div class="ttname"><a href="classarmnn_1_1_comparison_layer.xhtml#a65ca562c882ad619684445a1402f415a">armnn::ComparisonLayer::InferOutputShapes</a></div><div class="ttdeci">std::vector< TensorShape > InferOutputShapes(const std::vector< TensorShape > &inputShapes) const override</div><div class="ttdoc">By default returns inputShapes if the number of inputs are equal to number of outputs, otherwise infers the output shapes from given input shapes and layer properties. </div><div class="ttdef"><b>Definition:</b> <a href="_comparison_layer_8cpp_source.xhtml#l00036">ComparisonLayer.cpp:36</a></div></div> +<div class="ttc" id="classarmnn_1_1_i_workload_factory_xhtml"><div class="ttname"><a href="classarmnn_1_1_i_workload_factory.xhtml">armnn::IWorkloadFactory</a></div><div class="ttdef"><b>Definition:</b> <a href="_workload_factory_8hpp_source.xhtml#l00022">WorkloadFactory.hpp:22</a></div></div> +<div class="ttc" id="structarmnn_1_1_comparison_descriptor_xhtml"><div class="ttname"><a href="structarmnn_1_1_comparison_descriptor.xhtml">armnn::ComparisonDescriptor</a></div><div class="ttdoc">A ComparisonDescriptor for the ComparisonLayer. </div><div class="ttdef"><b>Definition:</b> <a href="_descriptors_8hpp_source.xhtml#l00078">Descriptors.hpp:78</a></div></div> +<div class="ttc" id="classarmnn_1_1_comparison_layer_xhtml_a1866ea0335e6b4e09bff8c36732ecfa3"><div class="ttname"><a href="classarmnn_1_1_comparison_layer.xhtml#a1866ea0335e6b4e09bff8c36732ecfa3">armnn::ComparisonLayer::~ComparisonLayer</a></div><div class="ttdeci">~ComparisonLayer()=default</div><div class="ttdoc">Default destructor. </div></div> +<div class="ttc" id="namespacearmnn_xhtml"><div class="ttname"><a href="namespacearmnn.xhtml">armnn</a></div><div class="ttdoc">Copyright (c) 2021 ARM Limited and Contributors. </div><div class="ttdef"><b>Definition:</b> <a href="01__00__software__tools_8dox_source.xhtml#l00006">01_00_software_tools.dox:6</a></div></div> +<div class="ttc" id="classarmnn_1_1_comparison_layer_xhtml_abbb77b1ee8b485ccd194db4c983a6b07"><div class="ttname"><a href="classarmnn_1_1_comparison_layer.xhtml#abbb77b1ee8b485ccd194db4c983a6b07">armnn::ComparisonLayer::Clone</a></div><div class="ttdeci">ComparisonLayer * Clone(Graph &graph) const override</div><div class="ttdoc">Creates a dynamically-allocated copy of this layer. </div><div class="ttdef"><b>Definition:</b> <a href="_comparison_layer_8cpp_source.xhtml#l00031">ComparisonLayer.cpp:31</a></div></div> +<div class="ttc" id="classarmnn_1_1_comparison_layer_xhtml_a529ef9add04880e3eaf7cb13da5ee4d8"><div class="ttname"><a href="classarmnn_1_1_comparison_layer.xhtml#a529ef9add04880e3eaf7cb13da5ee4d8">armnn::ComparisonLayer::ComparisonLayer</a></div><div class="ttdeci">ComparisonLayer(const ComparisonDescriptor &param, const char *name)</div><div class="ttdoc">Constructor to create a ComparisonLayer. </div><div class="ttdef"><b>Definition:</b> <a href="_comparison_layer_8cpp_source.xhtml#l00018">ComparisonLayer.cpp:18</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_comparison_layer_xhtml_a75a50f464326fefa605ea84ae2c9be85"><div class="ttname"><a href="classarmnn_1_1_comparison_layer.xhtml#a75a50f464326fefa605ea84ae2c9be85">armnn::ComparisonLayer::Accept</a></div><div class="ttdeci">void Accept(ILayerVisitor &visitor) const override</div><div class="ttdoc">Apply a visitor to this layer. </div><div class="ttdef"><b>Definition:</b> <a href="_comparison_layer_8cpp_source.xhtml#l00077">ComparisonLayer.cpp:77</a></div></div> +<div class="ttc" id="classarmnn_1_1_comparison_layer_xhtml_adfa912d0c4c6c00f1af2cbfa799572b7"><div class="ttname"><a href="classarmnn_1_1_comparison_layer.xhtml#adfa912d0c4c6c00f1af2cbfa799572b7">armnn::ComparisonLayer::CreateWorkload</a></div><div class="ttdeci">virtual std::unique_ptr< IWorkload > CreateWorkload(const IWorkloadFactory &factory) const override</div><div class="ttdoc">Makes a workload for the Comparison type. </div><div class="ttdef"><b>Definition:</b> <a href="_comparison_layer_8cpp_source.xhtml#l00023">ComparisonLayer.cpp:23</a></div></div> +<div class="ttc" id="classarmnn_1_1_i_layer_visitor_xhtml"><div class="ttname"><a href="classarmnn_1_1_i_layer_visitor.xhtml">armnn::ILayerVisitor</a></div><div class="ttdef"><b>Definition:</b> <a href="_i_layer_visitor_8hpp_source.xhtml#l00016">ILayerVisitor.hpp:16</a></div></div> +<div class="ttc" id="classarmnn_1_1_comparison_layer_xhtml"><div class="ttname"><a href="classarmnn_1_1_comparison_layer.xhtml">armnn::ComparisonLayer</a></div><div class="ttdoc">This layer represents a comparison operation. </div><div class="ttdef"><b>Definition:</b> <a href="_comparison_layer_8hpp_source.xhtml#l00014">ComparisonLayer.hpp:14</a></div></div> +<div class="ttc" id="classarmnn_1_1_layer_with_parameters_xhtml"><div class="ttname"><a href="classarmnn_1_1_layer_with_parameters.xhtml">armnn::LayerWithParameters</a></div><div class="ttdef"><b>Definition:</b> <a href="_layer_with_parameters_8hpp_source.xhtml#l00013">LayerWithParameters.hpp:13</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="dir_9da6642ce0fd5a8c83524f1b621275be.xhtml">layers</a></li><li class="navelem"><a class="el" href="_comparison_layer_8hpp.xhtml">ComparisonLayer.hpp</a></li> + <li class="footer">Generated on Thu Feb 25 2021 17:27:28 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> |