aboutsummaryrefslogtreecommitdiff
path: root/latest/_map_layer_8cpp_source.html
diff options
context:
space:
mode:
authorNikhil Raj <nikhil.raj@arm.com>2024-05-16 09:47:51 +0100
committerNikhil Raj <nikhil.raj@arm.com>2024-05-16 09:47:51 +0100
commit1dc83febfb76d6a770bdf3ba16c4034a970c2320 (patch)
tree66d27e5587e9010f3db26a23a348df844c88f8e6 /latest/_map_layer_8cpp_source.html
parent38b600d8abb2c5f7a44511b5deddf441f975d51d (diff)
downloadarmnn-gh-pages.tar.gz
IVGCVSW-8260 Update Doxgen Docu for 24.05gh-pages
Signed-off-by: Nikhil Raj <nikhil.raj@arm.com> Change-Id: If4bc983bf2793a27ded8e26ac2b29523fc1e4711
Diffstat (limited to 'latest/_map_layer_8cpp_source.html')
-rw-r--r--latest/_map_layer_8cpp_source.html38
1 files changed, 21 insertions, 17 deletions
diff --git a/latest/_map_layer_8cpp_source.html b/latest/_map_layer_8cpp_source.html
index e5fa2e9324..29cb699879 100644
--- a/latest/_map_layer_8cpp_source.html
+++ b/latest/_map_layer_8cpp_source.html
@@ -36,7 +36,7 @@
<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>
+ &#160;<span id="projectnumber">24.05</span>
</div>
</td>
</tr>
@@ -97,7 +97,7 @@ $(document).ready(function(){initNavTree('_map_layer_8cpp_source.html',''); init
</div><!--header-->
<div class="contents">
<a href="_map_layer_8cpp.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 © 2020 Arm Ltd and Contributors. All rights reserved.</span></div>
+<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// Copyright © 2020,2024 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">#include &quot;<a class="code" href="_map_layer_8hpp.html">MapLayer.hpp</a>&quot;</span></div>
@@ -136,24 +136,27 @@ $(document).ready(function(){initNavTree('_map_layer_8cpp_source.html',''); init
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;{</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="comment">// validates that the input is connected.</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <a class="code" href="classarmnn_1_1_layer.html#a0607e36e88f38c34c71c663164b76776">VerifyLayerConnections</a>(1, <a class="code" href="_exceptions_8hpp.html#aa3be76aec4ce713822a5ea1ecbb7bc61">CHECK_LOCATION</a>());</div>
-<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <a class="code" href="_assert_8hpp.html#a5698be69cbd5dfe6c28fcd9867e8cbed">ARMNN_ASSERT</a>(<a class="code" href="classarmnn_1_1_layer.html#a1594bddc87d6477df300317658f566bb">GetNumOutputSlots</a>() == 0);</div>
-<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;}</div>
-<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; </div>
-<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classarmnn_1_1_map_layer.html#a46fc3fdd4b2a5dd6d184e57983cf20bc"> 44</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1_map_layer.html#a46fc3fdd4b2a5dd6d184e57983cf20bc">MapLayer::ExecuteStrategy</a>(<a class="code" href="classarmnn_1_1_i_strategy.html">IStrategy</a>&amp; strategy)<span class="keyword"> const</span></div>
-<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="keyword"></span>{</div>
-<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <a class="code" href="namespacearmnn.html#a44affeeb090c3c6a3062830562672e84">IgnoreUnused</a>(strategy);</div>
-<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keywordflow">throw</span> <a class="code" href="classarmnn_1_1_exception.html">armnn::Exception</a>(<span class="stringliteral">&quot;MapLayer should not appear in an input graph&quot;</span>);</div>
-<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;}</div>
-<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; </div>
-<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;} <span class="comment">// namespace armnn</span></div>
+<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keywordflow">if</span> (<a class="code" href="classarmnn_1_1_layer.html#a1594bddc87d6477df300317658f566bb">GetNumOutputSlots</a>() != 0)</div>
+<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; {</div>
+<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordflow">throw</span> <a class="code" href="classarmnn_1_1_layer_validation_exception.html">armnn::LayerValidationException</a>(<span class="stringliteral">&quot;Output slots must be \&quot;0\&quot; - currently \&quot;&quot;</span></div>
+<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; + std::to_string(<a class="code" href="classarmnn_1_1_layer.html#a1594bddc87d6477df300317658f566bb">GetNumOutputSlots</a>()) + <span class="stringliteral">&quot;\&quot;.&quot;</span>);</div>
+<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; }</div>
+<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;}</div>
+<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; </div>
+<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="classarmnn_1_1_map_layer.html#a46fc3fdd4b2a5dd6d184e57983cf20bc"> 48</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1_map_layer.html#a46fc3fdd4b2a5dd6d184e57983cf20bc">MapLayer::ExecuteStrategy</a>(<a class="code" href="classarmnn_1_1_i_strategy.html">IStrategy</a>&amp; strategy)<span class="keyword"> const</span></div>
+<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="keyword"></span>{</div>
+<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <a class="code" href="namespacearmnn.html#a44affeeb090c3c6a3062830562672e84">IgnoreUnused</a>(strategy);</div>
+<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keywordflow">throw</span> <a class="code" href="classarmnn_1_1_exception.html">armnn::Exception</a>(<span class="stringliteral">&quot;MapLayer should not appear in an input graph&quot;</span>);</div>
+<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;}</div>
+<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; </div>
+<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;} <span class="comment">// namespace armnn</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
-<div class="ttc" id="a_assert_8hpp_html_a5698be69cbd5dfe6c28fcd9867e8cbed"><div class="ttname"><a href="_assert_8hpp.html#a5698be69cbd5dfe6c28fcd9867e8cbed">ARMNN_ASSERT</a></div><div class="ttdeci">#define ARMNN_ASSERT(COND)</div><div class="ttdef"><b>Definition:</b> <a href="_assert_8hpp_source.html#l00014">Assert.hpp:14</a></div></div>
<div class="ttc" id="astructarmnn_1_1_map_queue_descriptor_html"><div class="ttname"><a href="structarmnn_1_1_map_queue_descriptor.html">armnn::MapQueueDescriptor</a></div><div class="ttdef"><b>Definition:</b> <a href="_workload_data_8hpp_source.html#l00076">WorkloadData.hpp:76</a></div></div>
<div class="ttc" id="a_workload_data_8hpp_html"><div class="ttname"><a href="_workload_data_8hpp.html">WorkloadData.hpp</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_map_layer_html_a282022809d6fec9d0df282c2ac3262f4"><div class="ttname"><a href="classarmnn_1_1_map_layer.html#a282022809d6fec9d0df282c2ac3262f4">armnn::MapLayer::MapLayer</a></div><div class="ttdeci">MapLayer(const char *name)</div><div class="ttdoc">Constructor to create a MapLayer.</div><div class="ttdef"><b>Definition:</b> <a href="_map_layer_8cpp_source.html#l00017">MapLayer.cpp:17</a></div></div>
<div class="ttc" id="a_types_utils_8hpp_html"><div class="ttname"><a href="_types_utils_8hpp.html">TypesUtils.hpp</a></div></div>
-<div class="ttc" id="aclassarmnn_1_1_map_layer_html_a46fc3fdd4b2a5dd6d184e57983cf20bc"><div class="ttname"><a href="classarmnn_1_1_map_layer.html#a46fc3fdd4b2a5dd6d184e57983cf20bc">armnn::MapLayer::ExecuteStrategy</a></div><div class="ttdeci">void ExecuteStrategy(IStrategy &amp;strategy) const override</div><div class="ttdoc">Apply a visitor to this layer.</div><div class="ttdef"><b>Definition:</b> <a href="_map_layer_8cpp_source.html#l00044">MapLayer.cpp:44</a></div></div>
+<div class="ttc" id="aclassarmnn_1_1_map_layer_html_a46fc3fdd4b2a5dd6d184e57983cf20bc"><div class="ttname"><a href="classarmnn_1_1_map_layer.html#a46fc3fdd4b2a5dd6d184e57983cf20bc">armnn::MapLayer::ExecuteStrategy</a></div><div class="ttdeci">void ExecuteStrategy(IStrategy &amp;strategy) const override</div><div class="ttdoc">Apply a visitor to this layer.</div><div class="ttdef"><b>Definition:</b> <a href="_map_layer_8cpp_source.html#l00048">MapLayer.cpp:48</a></div></div>
<div class="ttc" id="a_map_layer_8hpp_html"><div class="ttname"><a href="_map_layer_8hpp.html">MapLayer.hpp</a></div></div>
<div class="ttc" id="a_exceptions_8hpp_html_aa3be76aec4ce713822a5ea1ecbb7bc61"><div class="ttname"><a href="_exceptions_8hpp.html#aa3be76aec4ce713822a5ea1ecbb7bc61">CHECK_LOCATION</a></div><div class="ttdeci">#define CHECK_LOCATION()</div><div class="ttdef"><b>Definition:</b> <a href="_exceptions_8hpp_source.html#l00203">Exceptions.hpp:203</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_i_strategy_html"><div class="ttname"><a href="classarmnn_1_1_i_strategy.html">armnn::IStrategy</a></div><div class="ttdef"><b>Definition:</b> <a href="_i_strategy_8hpp_source.html#l00016">IStrategy.hpp:16</a></div></div>
@@ -162,16 +165,17 @@ $(document).ready(function(){initNavTree('_map_layer_8cpp_source.html',''); init
<div class="ttc" id="aclassarmnn_1_1_map_layer_html"><div class="ttname"><a href="classarmnn_1_1_map_layer.html">armnn::MapLayer</a></div><div class="ttdoc">This layer represents a memory copy operation.</div><div class="ttdef"><b>Definition:</b> <a href="_map_layer_8hpp_source.html#l00013">MapLayer.hpp:13</a></div></div>
<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_layer_html_a30a858b2b26d651a066537e499fbf40d"><div class="ttname"><a href="classarmnn_1_1_layer.html#a30a858b2b26d651a066537e499fbf40d">armnn::Layer::PrepInfoAndDesc</a></div><div class="ttdeci">WorkloadInfo PrepInfoAndDesc(QueueDescriptor &amp;descriptor) const</div><div class="ttdoc">Helper function to reduce duplication in *Layer::CreateWorkload.</div><div class="ttdef"><b>Definition:</b> <a href="_layer_8hpp_source.html#l00409">Layer.hpp:409</a></div></div>
+<div class="ttc" id="aclassarmnn_1_1_layer_validation_exception_html"><div class="ttname"><a href="classarmnn_1_1_layer_validation_exception.html">armnn::LayerValidationException</a></div><div class="ttdef"><b>Definition:</b> <a href="_exceptions_8hpp_source.html#l00105">Exceptions.hpp:105</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_i_workload_factory_html"><div class="ttname"><a href="classarmnn_1_1_i_workload_factory.html">armnn::IWorkloadFactory</a></div><div class="ttdef"><b>Definition:</b> <a href="_workload_factory_8hpp_source.html#l00022">WorkloadFactory.hpp:22</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_layer_html_a1594bddc87d6477df300317658f566bb"><div class="ttname"><a href="classarmnn_1_1_layer.html#a1594bddc87d6477df300317658f566bb">armnn::Layer::GetNumOutputSlots</a></div><div class="ttdeci">unsigned int GetNumOutputSlots() const override</div><div class="ttdoc">Returns the number of connectable output slots.</div><div class="ttdef"><b>Definition:</b> <a href="_layer_8hpp_source.html#l00335">Layer.hpp:335</a></div></div>
-<div class="ttc" id="aclassarmnn_1_1_layer_html_af7f0460d32511de0da525f1817d13e8c"><div class="ttname"><a href="classarmnn_1_1_layer.html#af7f0460d32511de0da525f1817d13e8c">armnn::Layer::SetAdditionalInfo</a></div><div class="ttdeci">void SetAdditionalInfo(QueueDescriptor &amp;descriptor) const</div><div class="ttdef"><b>Definition:</b> <a href="_layer_8cpp_source.html#l00287">Layer.cpp:287</a></div></div>
+<div class="ttc" id="aclassarmnn_1_1_layer_html_af7f0460d32511de0da525f1817d13e8c"><div class="ttname"><a href="classarmnn_1_1_layer.html#af7f0460d32511de0da525f1817d13e8c">armnn::Layer::SetAdditionalInfo</a></div><div class="ttdeci">void SetAdditionalInfo(QueueDescriptor &amp;descriptor) const</div><div class="ttdef"><b>Definition:</b> <a href="_layer_8cpp_source.html#l00303">Layer.cpp:303</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_exception_html"><div class="ttname"><a href="classarmnn_1_1_exception.html">armnn::Exception</a></div><div class="ttdoc">Base class for all ArmNN exceptions so that users can filter to just those.</div><div class="ttdef"><b>Definition:</b> <a href="_exceptions_8hpp_source.html#l00046">Exceptions.hpp:46</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_map_layer_html_adfa912d0c4c6c00f1af2cbfa799572b7"><div class="ttname"><a href="classarmnn_1_1_map_layer.html#adfa912d0c4c6c00f1af2cbfa799572b7">armnn::MapLayer::CreateWorkload</a></div><div class="ttdeci">virtual std::unique_ptr&lt; IWorkload &gt; CreateWorkload(const IWorkloadFactory &amp;factory) const override</div><div class="ttdoc">Makes a workload for the Map type.</div><div class="ttdef"><b>Definition:</b> <a href="_map_layer_8cpp_source.html#l00027">MapLayer.cpp:27</a></div></div>
<div class="ttc" id="anamespacearmnn_html_a44affeeb090c3c6a3062830562672e84"><div class="ttname"><a href="namespacearmnn.html#a44affeeb090c3c6a3062830562672e84">armnn::IgnoreUnused</a></div><div class="ttdeci">void IgnoreUnused(Ts &amp;&amp;...)</div><div class="ttdef"><b>Definition:</b> <a href="_ignore_unused_8hpp_source.html#l00014">IgnoreUnused.hpp:14</a></div></div>
<div class="ttc" id="aclassarmnn_1_1_map_layer_html_a8c8f543d7e9729362c266d12ec169966"><div class="ttname"><a href="classarmnn_1_1_map_layer.html#a8c8f543d7e9729362c266d12ec169966">armnn::MapLayer::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 MapLayer.</div><div class="ttdef"><b>Definition:</b> <a href="_map_layer_8cpp_source.html#l00037">MapLayer.cpp:37</a></div></div>
<div class="ttc" id="anamespacearmnn_html_a56943a0946e5f15e5e58054b8e7a04a4a46f3ea056caa3126b91f3f70beea068c"><div class="ttname"><a href="namespacearmnn.html#a56943a0946e5f15e5e58054b8e7a04a4a46f3ea056caa3126b91f3f70beea068c">armnn::LayerType::Map</a></div><div class="ttdeci">@ Map</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_layer_html_a0607e36e88f38c34c71c663164b76776"><div class="ttname"><a href="classarmnn_1_1_layer.html#a0607e36e88f38c34c71c663164b76776">armnn::Layer::VerifyLayerConnections</a></div><div class="ttdeci">void VerifyLayerConnections(unsigned int expectedConnections, const CheckLocation &amp;location) const</div><div class="ttdef"><b>Definition:</b> <a href="_layer_8cpp_source.html#l00391">Layer.cpp:391</a></div></div>
+<div class="ttc" id="aclassarmnn_1_1_layer_html_a0607e36e88f38c34c71c663164b76776"><div class="ttname"><a href="classarmnn_1_1_layer.html#a0607e36e88f38c34c71c663164b76776">armnn::Layer::VerifyLayerConnections</a></div><div class="ttdeci">void VerifyLayerConnections(unsigned int expectedConnections, const CheckLocation &amp;location) const</div><div class="ttdef"><b>Definition:</b> <a href="_layer_8cpp_source.html#l00410">Layer.cpp:410</a></div></div>
<div class="ttc" id="anamespacearmnn_html_a56943a0946e5f15e5e58054b8e7a04a4"><div class="ttname"><a href="namespacearmnn.html#a56943a0946e5f15e5e58054b8e7a04a4">armnn::LayerType</a></div><div class="ttdeci">LayerType</div><div class="ttdoc">When adding a new layer, adapt also the LastLayer enum value in the enum class LayerType below.</div><div class="ttdef"><b>Definition:</b> <a href="_types_8hpp_source.html#l00491">Types.hpp:491</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>
<div class="ttc" id="a_layer_clone_base_8hpp_html"><div class="ttname"><a href="_layer_clone_base_8hpp.html">LayerCloneBase.hpp</a></div></div>
@@ -181,7 +185,7 @@ $(document).ready(function(){initNavTree('_map_layer_8cpp_source.html',''); init
<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="dir_9da6642ce0fd5a8c83524f1b621275be.html">layers</a></li><li class="navelem"><a class="el" href="_map_layer_8cpp.html">MapLayer.cpp</a></li>
- <li class="footer">Generated on Wed Feb 14 2024 16:36:14 for Arm NN by
+ <li class="footer">Generated on Thu May 16 2024 09:31:44 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>