blob: 2570d1083515ade30f69553e0892ba9976d63640 [file] [log] [blame]
Nikhil Raj549b9602022-05-24 11:32:07 +01001<!-- Copyright (c) 2020 ARM Limited. -->
2<!-- -->
3<!-- SPDX-License-Identifier: MIT -->
4<!-- -->
5<!-- HTML header for doxygen 1.8.13-->
6<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
7<html xmlns="http://www.w3.org/1999/xhtml">
8<head>
9<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
10<meta http-equiv="X-UA-Compatible" content="IE=9"/>
11<meta name="generator" content="Doxygen 1.8.13"/>
12<meta name="robots" content="NOINDEX, NOFOLLOW" />
13<meta name="viewport" content="width=device-width, initial-scale=1"/>
14<title>ArmNN: src/armnn/layers/LogSoftmaxLayer.hpp Source File</title>
15<link href="tabs.css" rel="stylesheet" type="text/css"/>
16<script type="text/javascript" src="jquery.js"></script>
17<script type="text/javascript" src="dynsections.js"></script>
18<link href="navtree.css" rel="stylesheet" type="text/css"/>
19<script type="text/javascript" src="resize.js"></script>
20<script type="text/javascript" src="navtreedata.js"></script>
21<script type="text/javascript" src="navtree.js"></script>
22<script type="text/javascript">
23 $(document).ready(initResizable);
24</script>
25<link href="search/search.css" rel="stylesheet" type="text/css"/>
26<script type="text/javascript" src="search/searchdata.js"></script>
27<script type="text/javascript" src="search/search.js"></script>
28<script type="text/x-mathjax-config">
29 MathJax.Hub.Config({
30 extensions: ["tex2jax.js"],
31 jax: ["input/TeX","output/HTML-CSS"],
32});
33</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
34<link href="doxygen.css" rel="stylesheet" type="text/css" />
35<link href="stylesheet.css" rel="stylesheet" type="text/css"/>
36</head>
37<body>
38<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
39<div id="titlearea">
40<table cellspacing="0" cellpadding="0">
41 <tbody>
42 <tr style="height: 56px;">
43 <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 10rem; margin-top: .5rem; margin-left 10px"/>
44 <td style="padding-left: 0.5em;">
45 <div id="projectname">
46 &#160;<span id="projectnumber">22.05</span>
47 </div>
48 </td>
49 </tr>
50 </tbody>
51</table>
52</div>
53<!-- end header part -->
54<!-- Generated by Doxygen 1.8.13 -->
55<script type="text/javascript">
56var searchBox = new SearchBox("searchBox", "search",false,'Search');
57</script>
58<script type="text/javascript" src="menudata.js"></script>
59<script type="text/javascript" src="menu.js"></script>
60<script type="text/javascript">
61$(function() {
62 initMenu('',true,false,'search.php','Search');
63 $(document).ready(function() { init_search(); });
64});
65</script>
66<div id="main-nav"></div>
67</div><!-- top -->
68<div id="side-nav" class="ui-resizable side-nav-resizable">
69 <div id="nav-tree">
70 <div id="nav-tree-contents">
71 <div id="nav-sync" class="sync"></div>
72 </div>
73 </div>
74 <div id="splitbar" style="-moz-user-select:none;"
75 class="ui-resizable-handle">
76 </div>
77</div>
78<script type="text/javascript">
79$(document).ready(function(){initNavTree('_log_softmax_layer_8hpp_source.xhtml','');});
80</script>
81<div id="doc-content">
82<!-- window showing the filter options -->
83<div id="MSearchSelectWindow"
84 onmouseover="return searchBox.OnSearchSelectShow()"
85 onmouseout="return searchBox.OnSearchSelectHide()"
86 onkeydown="return searchBox.OnSearchSelectKey(event)">
87</div>
88
89<!-- iframe showing the search results (closed by default) -->
90<div id="MSearchResultsWindow">
91<iframe src="javascript:void(0)" frameborder="0"
92 name="MSearchResults" id="MSearchResults">
93</iframe>
94</div>
95
96<div class="header">
97 <div class="headertitle">
98<div class="title">LogSoftmaxLayer.hpp</div> </div>
99</div><!--header-->
100<div class="contents">
101<a href="_log_softmax_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>&#160;<span class="comment">//</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<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>&#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;</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;</div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_layer_with_parameters_8hpp.xhtml">LayerWithParameters.hpp</a>&quot;</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;</div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<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>&#160;{</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">/// This layer represents a log softmax operation.</span></div><div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="classarmnn_1_1_log_softmax_layer.xhtml"> 14</a></span>&#160;<span class="comment"></span><span class="keyword">class </span><a class="code" href="classarmnn_1_1_log_softmax_layer.xhtml">LogSoftmaxLayer</a> : <span class="keyword">public</span> <a class="code" href="classarmnn_1_1_layer_with_parameters.xhtml">LayerWithParameters</a>&lt;LogSoftmaxDescriptor&gt;</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;{</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="keyword">public</span>:<span class="comment"></span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> /// Makes a workload for the LogSoftmax type.</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<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>&#160;<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>&#160;<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>&#160;<span class="comment"></span> <span class="keyword">virtual</span> std::unique_ptr&lt;IWorkload&gt; <a class="code" href="classarmnn_1_1_log_softmax_layer.xhtml#adfa912d0c4c6c00f1af2cbfa799572b7">CreateWorkload</a>(<span class="keyword">const</span> <a class="code" href="classarmnn_1_1_i_workload_factory.xhtml">IWorkloadFactory</a>&amp; factory) <span class="keyword">const override</span>;</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<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>&#160;<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>&#160;<span class="comment"></span> <a class="code" href="classarmnn_1_1_log_softmax_layer.xhtml">LogSoftmaxLayer</a>* <a class="code" href="classarmnn_1_1_log_softmax_layer.xhtml#a1ee115ea0c7522119fe3fa919094d856">Clone</a>(<a class="code" href="classarmnn_1_1_graph.xhtml">Graph</a>&amp; graph) <span class="keyword">const override</span>;</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"> /// Check if the input tensor shape(s)</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="comment"> /// will lead to a valid configuration of @ref LogSoftmaxLayer.</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="comment"> /// @param [in] shapeInferenceMethod Indicates if output shape shall be overwritten or just validated.</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1_log_softmax_layer.xhtml#a8c8f543d7e9729362c266d12ec169966">ValidateTensorShapesFromInputs</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <a class="code" href="_deprecated_8hpp.xhtml#ab66a241a0ed3ee89c866e777b035d0ed">ARMNN_NO_DEPRECATE_WARN_BEGIN</a></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1_log_softmax_layer.xhtml#a5c0289829d87ee65f7bba2a8c3839370">Accept</a>(ILayerVisitor&amp; visitor) <span class="keyword">const override</span>;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <a class="code" href="_deprecated_8hpp.xhtml#ad762b11b48e5c1d1c1743f529485728a">ARMNN_NO_DEPRECATE_WARN_END</a></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="keyword">protected</span>:<span class="comment"></span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="comment"> /// Constructor to create a LogSoftmaxLayer.</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="comment"> /// @param [in] param LogSoftmaxDescriptor to configure the log softmax operation.</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="comment"> /// @param [in] name Optional name for the layer.</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="comment"></span> <a class="code" href="classarmnn_1_1_log_softmax_layer.xhtml#a91ece56e0ffa4bb9e71d664202991187">LogSoftmaxLayer</a>(<span class="keyword">const</span> <a class="code" href="structarmnn_1_1_softmax_descriptor.xhtml">LogSoftmaxDescriptor</a>&amp; param, <span class="keyword">const</span> <span class="keywordtype">char</span>* name);</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="comment"> /// Default destructor</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="comment"></span> <a class="code" href="classarmnn_1_1_log_softmax_layer.xhtml#ab6811d61d02a91eb2329d4754dfb8300">~LogSoftmaxLayer</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;};</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;} <span class="comment">// namespace</span></div><div class="ttc" id="classarmnn_1_1_log_softmax_layer_xhtml_a8c8f543d7e9729362c266d12ec169966"><div class="ttname"><a href="classarmnn_1_1_log_softmax_layer.xhtml#a8c8f543d7e9729362c266d12ec169966">armnn::LogSoftmaxLayer::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 LogSoftmaxLayer. </div><div class="ttdef"><b>Definition:</b> <a href="_log_softmax_layer_8cpp_source.xhtml#l00034">LogSoftmaxLayer.cpp:34</a></div></div>
102<div class="ttc" id="_layer_with_parameters_8hpp_xhtml"><div class="ttname"><a href="_layer_with_parameters_8hpp.xhtml">LayerWithParameters.hpp</a></div></div>
103<div class="ttc" id="classarmnn_1_1_log_softmax_layer_xhtml_adfa912d0c4c6c00f1af2cbfa799572b7"><div class="ttname"><a href="classarmnn_1_1_log_softmax_layer.xhtml#adfa912d0c4c6c00f1af2cbfa799572b7">armnn::LogSoftmaxLayer::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 LogSoftmax type. </div><div class="ttdef"><b>Definition:</b> <a href="_log_softmax_layer_8cpp_source.xhtml#l00021">LogSoftmaxLayer.cpp:21</a></div></div>
104<div class="ttc" id="classarmnn_1_1_log_softmax_layer_xhtml_ab6811d61d02a91eb2329d4754dfb8300"><div class="ttname"><a href="classarmnn_1_1_log_softmax_layer.xhtml#ab6811d61d02a91eb2329d4754dfb8300">armnn::LogSoftmaxLayer::~LogSoftmaxLayer</a></div><div class="ttdeci">~LogSoftmaxLayer()=default</div><div class="ttdoc">Default destructor. </div></div>
105<div class="ttc" id="_deprecated_8hpp_xhtml_ab66a241a0ed3ee89c866e777b035d0ed"><div class="ttname"><a href="_deprecated_8hpp.xhtml#ab66a241a0ed3ee89c866e777b035d0ed">ARMNN_NO_DEPRECATE_WARN_BEGIN</a></div><div class="ttdeci">#define ARMNN_NO_DEPRECATE_WARN_BEGIN</div><div class="ttdef"><b>Definition:</b> <a href="_deprecated_8hpp_source.xhtml#l00033">Deprecated.hpp:33</a></div></div>
106<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="include_2armnn_2backends_2_workload_factory_8hpp_source.xhtml#l00022">WorkloadFactory.hpp:22</a></div></div>
107<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__quick__start_8dox_source.xhtml#l00006">01_00_quick_start.dox:6</a></div></div>
108<div class="ttc" id="classarmnn_1_1_log_softmax_layer_xhtml_a5c0289829d87ee65f7bba2a8c3839370"><div class="ttname"><a href="classarmnn_1_1_log_softmax_layer.xhtml#a5c0289829d87ee65f7bba2a8c3839370">armnn::LogSoftmaxLayer::Accept</a></div><div class="ttdeci">ARMNN_NO_DEPRECATE_WARN_BEGIN void Accept(ILayerVisitor &amp;visitor) const override</div><div class="ttdef"><b>Definition:</b> <a href="_log_softmax_layer_8cpp_source.xhtml#l00049">LogSoftmaxLayer.cpp:49</a></div></div>
109<div class="ttc" id="_deprecated_8hpp_xhtml_ad762b11b48e5c1d1c1743f529485728a"><div class="ttname"><a href="_deprecated_8hpp.xhtml#ad762b11b48e5c1d1c1743f529485728a">ARMNN_NO_DEPRECATE_WARN_END</a></div><div class="ttdeci">#define ARMNN_NO_DEPRECATE_WARN_END</div><div class="ttdef"><b>Definition:</b> <a href="_deprecated_8hpp_source.xhtml#l00034">Deprecated.hpp:34</a></div></div>
110<div class="ttc" id="classarmnn_1_1_log_softmax_layer_xhtml"><div class="ttname"><a href="classarmnn_1_1_log_softmax_layer.xhtml">armnn::LogSoftmaxLayer</a></div><div class="ttdoc">This layer represents a log softmax operation. </div><div class="ttdef"><b>Definition:</b> <a href="_log_softmax_layer_8hpp_source.xhtml#l00014">LogSoftmaxLayer.hpp:14</a></div></div>
111<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#l00030">Graph.hpp:30</a></div></div>
112<div class="ttc" id="classarmnn_1_1_log_softmax_layer_xhtml_a91ece56e0ffa4bb9e71d664202991187"><div class="ttname"><a href="classarmnn_1_1_log_softmax_layer.xhtml#a91ece56e0ffa4bb9e71d664202991187">armnn::LogSoftmaxLayer::LogSoftmaxLayer</a></div><div class="ttdeci">LogSoftmaxLayer(const LogSoftmaxDescriptor &amp;param, const char *name)</div><div class="ttdoc">Constructor to create a LogSoftmaxLayer. </div><div class="ttdef"><b>Definition:</b> <a href="_log_softmax_layer_8cpp_source.xhtml#l00018">LogSoftmaxLayer.cpp:18</a></div></div>
113<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>
114<div class="ttc" id="structarmnn_1_1_softmax_descriptor_xhtml"><div class="ttname"><a href="structarmnn_1_1_softmax_descriptor.xhtml">armnn::SoftmaxDescriptor</a></div><div class="ttdoc">A SoftmaxDescriptor for the SoftmaxLayer. </div><div class="ttdef"><b>Definition:</b> <a href="_descriptors_8hpp_source.xhtml#l00150">Descriptors.hpp:150</a></div></div>
115<div class="ttc" id="classarmnn_1_1_log_softmax_layer_xhtml_a1ee115ea0c7522119fe3fa919094d856"><div class="ttname"><a href="classarmnn_1_1_log_softmax_layer.xhtml#a1ee115ea0c7522119fe3fa919094d856">armnn::LogSoftmaxLayer::Clone</a></div><div class="ttdeci">LogSoftmaxLayer * Clone(Graph &amp;graph) const override</div><div class="ttdoc">Creates a dynamically-allocated copy of this layer. </div><div class="ttdef"><b>Definition:</b> <a href="_log_softmax_layer_8cpp_source.xhtml#l00029">LogSoftmaxLayer.cpp:29</a></div></div>
116</div><!-- fragment --></div><!-- contents -->
117</div><!-- doc-content -->
118<!-- start footer part -->
119<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
120 <ul>
121 <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="_log_softmax_layer_8hpp.xhtml">LogSoftmaxLayer.hpp</a></li>
122 <li class="footer">Generated on Tue May 24 2022 11:26:32 for ArmNN by
123 <a href="http://www.doxygen.org/index.html">
124 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
125 </ul>
126</div>
127</body>
128</html>