Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ComputeLibrary / 8a3da6f91f90c566b844d568f4ec43b946915af8 / . / documentation / gemm__common_8hpp_source.xhtml
blob: 7e5c12ff56b4ea09c58797c745469ab27f8145c0 [file] [log] [blame]
Kaizen8938bd32017-09-28 14:38:23 +0100[diff] [blame]1<!-- HTML header for doxygen 1.8.9.1-->
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml">
4<head>
5<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6<meta http-equiv="X-UA-Compatible" content="IE=9"/>
7<meta name="generator" content="Doxygen 1.8.6"/>
8<meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
9<title>Compute Library: arm_compute/core/NEON/kernels/assembly/gemm_common.hpp Source File</title>
10<link href="tabs.css" rel="stylesheet" type="text/css"/>
11<script type="text/javascript" src="jquery.js"></script>
12<script type="text/javascript" src="dynsections.js"></script>
13<link href="navtree.css" rel="stylesheet" type="text/css"/>
14<script type="text/javascript" src="resize.js"></script>
15<script type="text/javascript" src="navtree.js"></script>
16<script type="text/javascript">
17 $(document).ready(initResizable);
18 $(window).load(resizeHeight);
19</script>
20<link href="search/search.css" rel="stylesheet" type="text/css"/>
21<script type="text/javascript" src="search/search.js"></script>
22<script type="text/javascript">
23 $(document).ready(function() { searchBox.OnSelectItem(0); });
24</script>
25<script type="text/x-mathjax-config">
26 MathJax.Hub.Config({
27 extensions: ["tex2jax.js"],
28 jax: ["input/TeX","output/HTML-CSS"],
29});
30</script><script src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
31<link href="doxygen.css" rel="stylesheet" type="text/css" />
32</head>
33<body>
34<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
35<div id="titlearea">
36<table cellspacing="0" cellpadding="0">
37 <tbody>
38 <tr style="height: 56px;">
39 <td style="padding-left: 0.5em;">
40 <div id="projectname">Compute Library
Kaizenbf8b01d2017-10-12 14:26:51 +0100[diff] [blame]41 &#160;<span id="projectnumber">17.10</span>
Kaizen8938bd32017-09-28 14:38:23 +0100[diff] [blame]42 </div>
43 </td>
44 </tr>
45 </tbody>
46</table>
47</div>
48<!-- end header part -->
49<!-- Generated by Doxygen 1.8.6 -->
50<script type="text/javascript">
51var searchBox = new SearchBox("searchBox", "search",false,'Search');
52</script>
53 <div id="navrow1" class="tabs">
54 <ul class="tablist">
55 <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
56 <li><a href="pages.xhtml"><span>Related&#160;Pages</span></a></li>
57 <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
58 <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
59 <li class="current"><a href="files.xhtml"><span>Files</span></a></li>
60 <li>
61 <div id="MSearchBox" class="MSearchBoxInactive">
62 <span class="left">
63 <img id="MSearchSelect" src="search/mag_sel.png"
64 onmouseover="return searchBox.OnSearchSelectShow()"
65 onmouseout="return searchBox.OnSearchSelectHide()"
66 alt=""/>
67 <input type="text" id="MSearchField" value="Search" accesskey="S"
68 onfocus="searchBox.OnSearchFieldFocus(true)"
69 onblur="searchBox.OnSearchFieldFocus(false)"
70 onkeyup="searchBox.OnSearchFieldChange(event)"/>
71 </span><span class="right">
72 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
73 </span>
74 </div>
75 </li>
76 </ul>
77 </div>
78 <div id="navrow2" class="tabs2">
79 <ul class="tablist">
80 <li><a href="files.xhtml"><span>File&#160;List</span></a></li>
81 <li><a href="globals.xhtml"><span>Globals</span></a></li>
82 </ul>
83 </div>
84</div><!-- top -->
85<div id="side-nav" class="ui-resizable side-nav-resizable">
86 <div id="nav-tree">
87 <div id="nav-tree-contents">
88 <div id="nav-sync" class="sync"></div>
89 </div>
90 </div>
91 <div id="splitbar" style="-moz-user-select:none;"
92 class="ui-resizable-handle">
93 </div>
94</div>
95<script type="text/javascript">
96$(document).ready(function(){initNavTree('gemm__common_8hpp_source.xhtml','');});
97</script>
98<div id="doc-content">
99<!-- window showing the filter options -->
100<div id="MSearchSelectWindow"
101 onmouseover="return searchBox.OnSearchSelectShow()"
102 onmouseout="return searchBox.OnSearchSelectHide()"
103 onkeydown="return searchBox.OnSearchSelectKey(event)">
104<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Pages</a></div>
105
106<!-- iframe showing the search results (closed by default) -->
107<div id="MSearchResultsWindow">
108<iframe src="javascript:void(0)" frameborder="0"
109 name="MSearchResults" id="MSearchResults">
110</iframe>
111</div>
112
113<div class="header">
114 <div class="headertitle">
115<div class="title">gemm_common.hpp</div> </div>
116</div><!--header-->
117<div class="contents">
118<a href="gemm__common_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>
119<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Copyright (c) 2017 ARM Limited.</span></div>
120<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *</span></div>
121<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * SPDX-License-Identifier: MIT</span></div>
122<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> *</span></div>
123<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a copy</span></div>
124<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * of this software and associated documentation files (the &quot;Software&quot;), to</span></div>
125<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * deal in the Software without restriction, including without limitation the</span></div>
126<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or</span></div>
127<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * sell copies of the Software, and to permit persons to whom the Software is</span></div>
128<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * furnished to do so, subject to the following conditions:</span></div>
129<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> *</span></div>
130<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * The above copyright notice and this permission notice shall be included in all</span></div>
131<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * copies or substantial portions of the Software.</span></div>
132<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> *</span></div>
133<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> * THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div>
134<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div>
135<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div>
136<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div>
137<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span></div>
138<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment"> * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE</span></div>
139<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment"> * SOFTWARE.</span></div>
140<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment"> */</span></div>
141<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#pragma once</span></div>
142<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor"></span></div>
143<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="comment">// Abstract class for a GEMM function</span></div>
144<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> To, <span class="keyword">typename</span> Tr&gt;</div>
145<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="class_gemm_common.xhtml"> 28</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_gemm_common.xhtml">GemmCommon</a> {</div>
146<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="keyword">public</span>:</div>
147<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="class_gemm_common.xhtml#a190aa5a4547b7d8d8cbf7b7dc46ca32d">get_working_size</a>() <span class="keyword">const</span> = 0;</div>
148<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_gemm_common.xhtml#aabcb2e5ff8597dda52969feeba3d7ae0">execute</a>(<span class="keyword">const</span> To *, <span class="keyword">const</span> <span class="keywordtype">int</span>, <span class="keyword">const</span> To *, <span class="keyword">const</span> <span class="keywordtype">int</span>, Tr *, <span class="keyword">const</span> <span class="keywordtype">int</span>, <span class="keyword">const</span> Tr, <span class="keyword">const</span> Tr, <span class="keywordtype">void</span> *working_space = NULL) <span class="keyword">const</span> = 0;</div>
149<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="class_gemm_common.xhtml#a431c4e53fa05a1e8ba127441e8baeed2"> 32</a></span>&#160; <span class="keyword">virtual</span> <a class="code" href="class_gemm_common.xhtml#a431c4e53fa05a1e8ba127441e8baeed2">~GemmCommon</a>() { }</div>
150<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;};</div>
151<div class="ttc" id="class_gemm_common_xhtml_a190aa5a4547b7d8d8cbf7b7dc46ca32d"><div class="ttname"><a href="class_gemm_common.xhtml#a190aa5a4547b7d8d8cbf7b7dc46ca32d">GemmCommon::get_working_size</a></div><div class="ttdeci">virtual size_t get_working_size() const =0</div></div>
152<div class="ttc" id="class_gemm_common_xhtml_aabcb2e5ff8597dda52969feeba3d7ae0"><div class="ttname"><a href="class_gemm_common.xhtml#aabcb2e5ff8597dda52969feeba3d7ae0">GemmCommon::execute</a></div><div class="ttdeci">virtual void execute(const To *, const int, const To *, const int, Tr *, const int, const Tr, const Tr, void *working_space=NULL) const =0</div></div>
153<div class="ttc" id="class_gemm_common_xhtml"><div class="ttname"><a href="class_gemm_common.xhtml">GemmCommon</a></div><div class="ttdef"><b>Definition:</b> <a href="gemm__common_8hpp_source.xhtml#l00028">gemm_common.hpp:28</a></div></div>
154<div class="ttc" id="class_gemm_common_xhtml_a431c4e53fa05a1e8ba127441e8baeed2"><div class="ttname"><a href="class_gemm_common.xhtml#a431c4e53fa05a1e8ba127441e8baeed2">GemmCommon::~GemmCommon</a></div><div class="ttdeci">virtual ~GemmCommon()</div><div class="ttdef"><b>Definition:</b> <a href="gemm__common_8hpp_source.xhtml#l00032">gemm_common.hpp:32</a></div></div>
155</div><!-- fragment --></div><!-- contents -->
156</div><!-- doc-content -->
157<!-- start footer part -->
158<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
159 <ul>
160 <li class="navelem"><a class="el" href="dir_d4d363c0979c7ffda4833df3f93b5668.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="dir_62e76289bb143101bef0ade0babfd908.xhtml">core</a></li><li class="navelem"><a class="el" href="dir_d8c3c94d7afca7dbbf0a57378fc2eb81.xhtml">NEON</a></li><li class="navelem"><a class="el" href="dir_fe359af270243e26066d9edb7147ece2.xhtml">kernels</a></li><li class="navelem"><a class="el" href="dir_de5c25a0a26af4ac1cdfe0fae1db6671.xhtml">assembly</a></li><li class="navelem"><a class="el" href="gemm__common_8hpp.xhtml">gemm_common.hpp</a></li>
Kaizenbf8b01d2017-10-12 14:26:51 +0100[diff] [blame]161 <li class="footer">Generated on Thu Oct 12 2017 14:26:32 for Compute Library by
Kaizen8938bd32017-09-28 14:38:23 +0100[diff] [blame]162 <a href="http://www.doxygen.org/index.html">
163 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
164 </ul>
165</div>
166</body>
167</html>