diff options
author | Ryan OShea <Ryan.OShea2@arm.com> | 2020-03-13 16:26:19 +0000 |
---|---|---|
committer | Ryan OShea <Ryan.OShea2@arm.com> | 2020-03-13 16:26:19 +0000 |
commit | de36e4a9c299028e792c3a5bd99ad0816d806077 (patch) | |
tree | 6c71d89db68da1033bb422253cee2970580ed692 /Documentation/structarmnn_1_1_permute_descriptor.xhtml | |
parent | 78b26f024641e763c7252198339c83bad8c0982f (diff) | |
download | armnn-de36e4a9c299028e792c3a5bd99ad0816d806077.tar.gz |
IVGCVSW-3726 Upload ArmNN Doxygen files
* Upload current ArmNN Doxygen files
Signed-off-by: Ryan OShea <Ryan.OShea2@arm.com>
Change-Id: I8989ed16ee40a99a4495b100bd009cf3e24a7285
Diffstat (limited to 'Documentation/structarmnn_1_1_permute_descriptor.xhtml')
-rw-r--r-- | Documentation/structarmnn_1_1_permute_descriptor.xhtml | 258 |
1 files changed, 258 insertions, 0 deletions
diff --git a/Documentation/structarmnn_1_1_permute_descriptor.xhtml b/Documentation/structarmnn_1_1_permute_descriptor.xhtml new file mode 100644 index 0000000000..472863fe7b --- /dev/null +++ b/Documentation/structarmnn_1_1_permute_descriptor.xhtml @@ -0,0 +1,258 @@ +<!-- 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: PermuteDescriptor Struct Reference</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('structarmnn_1_1_permute_descriptor.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="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="#pub-attribs">Public Attributes</a> | +<a href="structarmnn_1_1_permute_descriptor-members.xhtml">List of all members</a> </div> + <div class="headertitle"> +<div class="title">PermuteDescriptor Struct Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>A <a class="el" href="structarmnn_1_1_permute_descriptor.xhtml" title="A PermuteDescriptor for the PermuteLayer. ">PermuteDescriptor</a> for the <a class="el" href="classarmnn_1_1_permute_layer.xhtml" title="This layer represents a permutation operation. ">PermuteLayer</a>. + <a href="structarmnn_1_1_permute_descriptor.xhtml#details">More...</a></p> + +<p><code>#include <<a class="el" href="_descriptors_8hpp_source.xhtml">Descriptors.hpp</a>></code></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:a89323bcff3f2fad728ddb0ba2673049f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_permute_descriptor.xhtml#a89323bcff3f2fad728ddb0ba2673049f">PermuteDescriptor</a> ()</td></tr> +<tr class="separator:a89323bcff3f2fad728ddb0ba2673049f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abaafe52396509f67f8cde6578c75df01"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_permute_descriptor.xhtml#abaafe52396509f67f8cde6578c75df01">PermuteDescriptor</a> (const <a class="el" href="classarmnn_1_1_permutation_vector.xhtml">PermutationVector</a> &dimMappings)</td></tr> +<tr class="separator:abaafe52396509f67f8cde6578c75df01"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a515ce4ad34d652a553e685ff9abecb33"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_permute_descriptor.xhtml#a515ce4ad34d652a553e685ff9abecb33">operator==</a> (const <a class="el" href="structarmnn_1_1_permute_descriptor.xhtml">PermuteDescriptor</a> &rhs) const</td></tr> +<tr class="separator:a515ce4ad34d652a553e685ff9abecb33"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> +Public Attributes</h2></td></tr> +<tr class="memitem:a14433af2b223695b40d8c8f8ba2ebb8f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarmnn_1_1_permutation_vector.xhtml">PermutationVector</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_permute_descriptor.xhtml#a14433af2b223695b40d8c8f8ba2ebb8f">m_DimMappings</a></td></tr> +<tr class="memdesc:a14433af2b223695b40d8c8f8ba2ebb8f"><td class="mdescLeft"> </td><td class="mdescRight">Indicates how to translate tensor elements from a given source into the target destination, when source and target potentially have different memory layouts e.g. <a href="#a14433af2b223695b40d8c8f8ba2ebb8f">More...</a><br /></td></tr> +<tr class="separator:a14433af2b223695b40d8c8f8ba2ebb8f"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>A <a class="el" href="structarmnn_1_1_permute_descriptor.xhtml" title="A PermuteDescriptor for the PermuteLayer. ">PermuteDescriptor</a> for the <a class="el" href="classarmnn_1_1_permute_layer.xhtml" title="This layer represents a permutation operation. ">PermuteLayer</a>. </p> + +<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.xhtml#l00102">102</a> of file <a class="el" href="_descriptors_8hpp_source.xhtml">Descriptors.hpp</a>.</p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="a89323bcff3f2fad728ddb0ba2673049f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a89323bcff3f2fad728ddb0ba2673049f">◆ </a></span>PermuteDescriptor() <span class="overload">[1/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structarmnn_1_1_permute_descriptor.xhtml">PermuteDescriptor</a> </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.xhtml#l00104">104</a> of file <a class="el" href="_descriptors_8hpp_source.xhtml">Descriptors.hpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  : <a class="code" href="structarmnn_1_1_permute_descriptor.xhtml#a14433af2b223695b40d8c8f8ba2ebb8f">m_DimMappings</a>{}</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  {}</div><div class="ttc" id="structarmnn_1_1_permute_descriptor_xhtml_a14433af2b223695b40d8c8f8ba2ebb8f"><div class="ttname"><a href="structarmnn_1_1_permute_descriptor.xhtml#a14433af2b223695b40d8c8f8ba2ebb8f">armnn::PermuteDescriptor::m_DimMappings</a></div><div class="ttdeci">PermutationVector m_DimMappings</div><div class="ttdoc">Indicates how to translate tensor elements from a given source into the target destination, when source and target potentially have different memory layouts e.g. </div><div class="ttdef"><b>Definition:</b> <a href="_descriptors_8hpp_source.xhtml#l00119">Descriptors.hpp:119</a></div></div> +</div><!-- fragment --> +</div> +</div> +<a id="abaafe52396509f67f8cde6578c75df01"></a> +<h2 class="memtitle"><span class="permalink"><a href="#abaafe52396509f67f8cde6578c75df01">◆ </a></span>PermuteDescriptor() <span class="overload">[2/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structarmnn_1_1_permute_descriptor.xhtml">PermuteDescriptor</a> </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classarmnn_1_1_permutation_vector.xhtml">PermutationVector</a> & </td> + <td class="paramname"><em>dimMappings</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.xhtml#l00108">108</a> of file <a class="el" href="_descriptors_8hpp_source.xhtml">Descriptors.hpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  : <a class="code" href="structarmnn_1_1_permute_descriptor.xhtml#a14433af2b223695b40d8c8f8ba2ebb8f">m_DimMappings</a>(dimMappings)</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  {}</div><div class="ttc" id="structarmnn_1_1_permute_descriptor_xhtml_a14433af2b223695b40d8c8f8ba2ebb8f"><div class="ttname"><a href="structarmnn_1_1_permute_descriptor.xhtml#a14433af2b223695b40d8c8f8ba2ebb8f">armnn::PermuteDescriptor::m_DimMappings</a></div><div class="ttdeci">PermutationVector m_DimMappings</div><div class="ttdoc">Indicates how to translate tensor elements from a given source into the target destination, when source and target potentially have different memory layouts e.g. </div><div class="ttdef"><b>Definition:</b> <a href="_descriptors_8hpp_source.xhtml#l00119">Descriptors.hpp:119</a></div></div> +</div><!-- fragment --> +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="a515ce4ad34d652a553e685ff9abecb33"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a515ce4ad34d652a553e685ff9abecb33">◆ </a></span>operator==()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">bool operator== </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="structarmnn_1_1_permute_descriptor.xhtml">PermuteDescriptor</a> & </td> + <td class="paramname"><em>rhs</em></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.xhtml#l00112">112</a> of file <a class="el" href="_descriptors_8hpp_source.xhtml">Descriptors.hpp</a>.</p> + +<p class="reference">References <a class="el" href="_descriptors_8hpp_source.xhtml#l00119">PermuteDescriptor::m_DimMappings</a>.</p> +<div class="fragment"><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  {</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="keywordflow">return</span> <a class="code" href="structarmnn_1_1_permute_descriptor.xhtml#a14433af2b223695b40d8c8f8ba2ebb8f">m_DimMappings</a>.<a class="code" href="classarmnn_1_1_permutation_vector.xhtml#aae44e4154aa80fba7616747450ff69d5">IsEqual</a>(rhs.m_DimMappings);</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  }</div><div class="ttc" id="structarmnn_1_1_permute_descriptor_xhtml_a14433af2b223695b40d8c8f8ba2ebb8f"><div class="ttname"><a href="structarmnn_1_1_permute_descriptor.xhtml#a14433af2b223695b40d8c8f8ba2ebb8f">armnn::PermuteDescriptor::m_DimMappings</a></div><div class="ttdeci">PermutationVector m_DimMappings</div><div class="ttdoc">Indicates how to translate tensor elements from a given source into the target destination, when source and target potentially have different memory layouts e.g. </div><div class="ttdef"><b>Definition:</b> <a href="_descriptors_8hpp_source.xhtml#l00119">Descriptors.hpp:119</a></div></div> +<div class="ttc" id="classarmnn_1_1_permutation_vector_xhtml_aae44e4154aa80fba7616747450ff69d5"><div class="ttname"><a href="classarmnn_1_1_permutation_vector.xhtml#aae44e4154aa80fba7616747450ff69d5">armnn::PermutationVector::IsEqual</a></div><div class="ttdeci">bool IsEqual(const PermutationVector &other) const</div><div class="ttdef"><b>Definition:</b> <a href="_types_8hpp_source.xhtml#l00207">Types.hpp:207</a></div></div> +</div><!-- fragment --> +</div> +</div> +<h2 class="groupheader">Member Data Documentation</h2> +<a id="a14433af2b223695b40d8c8f8ba2ebb8f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a14433af2b223695b40d8c8f8ba2ebb8f">◆ </a></span>m_DimMappings</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classarmnn_1_1_permutation_vector.xhtml">PermutationVector</a> m_DimMappings</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Indicates how to translate tensor elements from a given source into the target destination, when source and target potentially have different memory layouts e.g. </p> +<p>{0U, 3U, 1U, 2U}. </p> + +<p class="definition">Definition at line <a class="el" href="_descriptors_8hpp_source.xhtml#l00119">119</a> of file <a class="el" href="_descriptors_8hpp_source.xhtml">Descriptors.hpp</a>.</p> + +<p class="reference">Referenced by <a class="el" href="_permute_layer_8hpp_source.xhtml#l00037">PermuteLayer::GetPermutation()</a>, <a class="el" href="_permute_layer_8cpp_source.xhtml#l00036">PermuteLayer::InferOutputShapes()</a>, <a class="el" href="_descriptors_8hpp_source.xhtml#l00112">PermuteDescriptor::operator==()</a>, <a class="el" href="_permute_test_impl_8hpp_source.xhtml#l00107">PermuteValueSet1Test()</a>, <a class="el" href="_permute_test_impl_8hpp_source.xhtml#l00157">PermuteValueSet2Test()</a>, <a class="el" href="_permute_test_impl_8hpp_source.xhtml#l00207">PermuteValueSet3Test()</a>, <a class="el" href="_serialize_layer_parameters_8cpp_source.xhtml#l00014">StringifyLayerParameters< PermuteDescriptor >::Serialize()</a>, <a class="el" href="_permute_test_impl_8hpp_source.xhtml#l00058">SimplePermuteTest()</a>, and <a class="el" href="_serializer_8cpp_source.xhtml#l00801">SerializerVisitor::VisitPermuteLayer()</a>.</p> + +</div> +</div> +<hr/>The documentation for this struct was generated from the following file:<ul> +<li>include/armnn/<a class="el" href="_descriptors_8hpp_source.xhtml">Descriptors.hpp</a></li> +</ul> +</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="namespacearmnn.xhtml">armnn</a></li><li class="navelem"><a class="el" href="structarmnn_1_1_permute_descriptor.xhtml">PermuteDescriptor</a></li> + <li class="footer">Generated on Fri Mar 13 2020 16:09:19 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> |