forked from pola-rs/polars
-
Notifications
You must be signed in to change notification settings - Fork 0
/
kernel.rs.html
201 lines (186 loc) · 14.6 KB
/
kernel.rs.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/home/runner/.cargo/registry/src/github.com-1ecc6299db9ec823/matrixmultiply-0.2.4/src/kernel.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>kernel.rs - source</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><script src="../../crates.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc source"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a href='../../matrixmultiply/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><pre class="line-numbers"><span id="1"> 1</span>
<span id="2"> 2</span>
<span id="3"> 3</span>
<span id="4"> 4</span>
<span id="5"> 5</span>
<span id="6"> 6</span>
<span id="7"> 7</span>
<span id="8"> 8</span>
<span id="9"> 9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
</pre><div class="example-wrap"><pre class="rust ">
<span class="comment">// Copyright 2016 - 2018 Ulrik Sverdrup "bluss"</span>
<span class="comment">//</span>
<span class="comment">// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or</span>
<span class="comment">// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license</span>
<span class="comment">// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your</span>
<span class="comment">// option. This file may not be copied, modified, or distributed</span>
<span class="comment">// except according to those terms.</span>
<span class="kw">use</span> <span class="ident">core</span>::<span class="ident">ops</span>::{<span class="ident">AddAssign</span>, <span class="ident">MulAssign</span>};
<span class="doccomment">/// General matrix multiply kernel</span>
<span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">GemmKernel</span> {
<span class="kw">type</span> <span class="ident">Elem</span>: <span class="ident">Element</span>;
<span class="doccomment">/// Kernel rows</span>
<span class="kw">const</span> <span class="ident">MR</span>: <span class="ident">usize</span> <span class="op">=</span> <span class="self">Self</span>::<span class="ident">MRTy</span>::<span class="ident">VALUE</span>;
<span class="doccomment">/// Kernel cols</span>
<span class="kw">const</span> <span class="ident">NR</span>: <span class="ident">usize</span> <span class="op">=</span> <span class="self">Self</span>::<span class="ident">NRTy</span>::<span class="ident">VALUE</span>;
<span class="doccomment">/// Kernel rows as const num type</span>
<span class="kw">type</span> <span class="ident">MRTy</span>: <span class="ident">ConstNum</span>;
<span class="doccomment">/// Kernel cols as const num type</span>
<span class="kw">type</span> <span class="ident">NRTy</span>: <span class="ident">ConstNum</span>;
<span class="doccomment">/// align inputs to this</span>
<span class="kw">fn</span> <span class="ident">align_to</span>() <span class="op">-</span><span class="op">></span> <span class="ident">usize</span>;
<span class="doccomment">/// Whether to always use the masked wrapper around the kernel.</span>
<span class="kw">fn</span> <span class="ident">always_masked</span>() <span class="op">-</span><span class="op">></span> <span class="ident">bool</span>;
<span class="kw">fn</span> <span class="ident">nc</span>() <span class="op">-</span><span class="op">></span> <span class="ident">usize</span>;
<span class="kw">fn</span> <span class="ident">kc</span>() <span class="op">-</span><span class="op">></span> <span class="ident">usize</span>;
<span class="kw">fn</span> <span class="ident">mc</span>() <span class="op">-</span><span class="op">></span> <span class="ident">usize</span>;
<span class="doccomment">/// Matrix multiplication kernel</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This does the matrix multiplication:</span>
<span class="doccomment">///</span>
<span class="doccomment">/// C ← α A B + β C</span>
<span class="doccomment">///</span>
<span class="doccomment">/// + `k`: length of data in a, b</span>
<span class="doccomment">/// + a, b are packed</span>
<span class="doccomment">/// + c has general strides</span>
<span class="doccomment">/// + rsc: row stride of c</span>
<span class="doccomment">/// + csc: col stride of c</span>
<span class="doccomment">/// + `alpha`: scaling factor for A B product</span>
<span class="doccomment">/// + `beta`: scaling factor for c.</span>
<span class="doccomment">/// Note: if `beta` is `0.`, the kernel should not (and must not)</span>
<span class="doccomment">/// read from c, its value is to be treated as if it was zero.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// When masked, the kernel is always called with β=0 but α is passed</span>
<span class="doccomment">/// as usual. (This is only useful information if you return `true` from</span>
<span class="doccomment">/// `always_masked`.)</span>
<span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">kernel</span>(
<span class="ident">k</span>: <span class="ident">usize</span>,
<span class="ident">alpha</span>: <span class="self">Self</span>::<span class="ident">Elem</span>,
<span class="ident">a</span>: <span class="kw-2">*</span><span class="kw">const</span> <span class="self">Self</span>::<span class="ident">Elem</span>,
<span class="ident">b</span>: <span class="kw-2">*</span><span class="kw">const</span> <span class="self">Self</span>::<span class="ident">Elem</span>,
<span class="ident">beta</span>: <span class="self">Self</span>::<span class="ident">Elem</span>,
<span class="ident">c</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="self">Self</span>::<span class="ident">Elem</span>, <span class="ident">rsc</span>: <span class="ident">isize</span>, <span class="ident">csc</span>: <span class="ident">isize</span>);
}
<span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">Element</span> : <span class="ident">Copy</span> <span class="op">+</span> <span class="ident">AddAssign</span> <span class="op">+</span> <span class="ident">MulAssign</span> <span class="op">+</span> <span class="ident">Send</span> <span class="op">+</span> <span class="ident">Sync</span> {
<span class="kw">fn</span> <span class="ident">zero</span>() <span class="op">-</span><span class="op">></span> <span class="self">Self</span>;
<span class="kw">fn</span> <span class="ident">one</span>() <span class="op">-</span><span class="op">></span> <span class="self">Self</span>;
<span class="kw">fn</span> <span class="ident">is_zero</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">bool</span>;
}
<span class="kw">impl</span> <span class="ident">Element</span> <span class="kw">for</span> <span class="ident">f32</span> {
<span class="kw">fn</span> <span class="ident">zero</span>() <span class="op">-</span><span class="op">></span> <span class="self">Self</span> { <span class="number">0.</span> }
<span class="kw">fn</span> <span class="ident">one</span>() <span class="op">-</span><span class="op">></span> <span class="self">Self</span> { <span class="number">1.</span> }
<span class="kw">fn</span> <span class="ident">is_zero</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">bool</span> { <span class="kw-2">*</span><span class="self">self</span> <span class="op">=</span><span class="op">=</span> <span class="number">0.</span> }
}
<span class="kw">impl</span> <span class="ident">Element</span> <span class="kw">for</span> <span class="ident">f64</span> {
<span class="kw">fn</span> <span class="ident">zero</span>() <span class="op">-</span><span class="op">></span> <span class="self">Self</span> { <span class="number">0.</span> }
<span class="kw">fn</span> <span class="ident">one</span>() <span class="op">-</span><span class="op">></span> <span class="self">Self</span> { <span class="number">1.</span> }
<span class="kw">fn</span> <span class="ident">is_zero</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">bool</span> { <span class="kw-2">*</span><span class="self">self</span> <span class="op">=</span><span class="op">=</span> <span class="number">0.</span> }
}
<span class="doccomment">/// Kernel selector</span>
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">trait</span> <span class="ident">GemmSelect</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
<span class="doccomment">/// Call `select` with the selected kernel for this configuration</span>
<span class="kw">fn</span> <span class="ident">select</span><span class="op"><</span><span class="ident">K</span><span class="op">></span>(<span class="self">self</span>, <span class="ident">kernel</span>: <span class="ident">K</span>)
<span class="kw">where</span> <span class="ident">K</span>: <span class="ident">GemmKernel</span><span class="op"><</span><span class="ident">Elem</span><span class="op">=</span><span class="ident">T</span><span class="op">></span>,
<span class="ident">T</span>: <span class="ident">Element</span>;
}
<span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">ConstNum</span> {
<span class="kw">const</span> <span class="ident">VALUE</span>: <span class="ident">usize</span>;
}
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">U4</span>;
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">U8</span>;
<span class="kw">impl</span> <span class="ident">ConstNum</span> <span class="kw">for</span> <span class="ident">U4</span> { <span class="kw">const</span> <span class="ident">VALUE</span>: <span class="ident">usize</span> <span class="op">=</span> <span class="number">4</span>; }
<span class="kw">impl</span> <span class="ident">ConstNum</span> <span class="kw">for</span> <span class="ident">U8</span> { <span class="kw">const</span> <span class="ident">VALUE</span>: <span class="ident">usize</span> <span class="op">=</span> <span class="number">8</span>; }
</pre></div>
</section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="matrixmultiply" data-search-js="../../search-index.js"></div>
<script src="../../main.js"></script><script src="../../source-script.js"></script><script src="../../source-files.js"></script></body></html>