forked from pola-rs/polars
-
Notifications
You must be signed in to change notification settings - Fork 0
/
bit_util.rs.html
211 lines (199 loc) · 17.4 KB
/
bit_util.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
202
203
204
205
206
207
208
209
210
211
<!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 `polars/polars-arrow/src/bit_util.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>bit_util.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='../../polars_arrow/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>
<span id="98"> 98</span>
<span id="99"> 99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
</pre><div class="example-wrap"><pre class="rust ">
<span class="doccomment">/// Forked from Arrow until their API stabilizes.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Note that the bound checks are optimized away.</span>
<span class="doccomment">///</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"simd"</span>)]</span>
<span class="kw">use</span> <span class="ident">packed_simd</span>::<span class="ident">u8x64</span>;
<span class="kw">const</span> <span class="ident">BIT_MASK</span>: [<span class="ident">u8</span>; <span class="number">8</span>] <span class="op">=</span> [<span class="number">1</span>, <span class="number">2</span>, <span class="number">4</span>, <span class="number">8</span>, <span class="number">16</span>, <span class="number">32</span>, <span class="number">64</span>, <span class="number">128</span>];
<span class="doccomment">/// Returns the nearest number that is `>=` than `num` and is a multiple of 64</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">round_upto_multiple_of_64</span>(<span class="ident">num</span>: <span class="ident">usize</span>) <span class="op">-</span><span class="op">></span> <span class="ident">usize</span> {
<span class="ident">round_upto_power_of_2</span>(<span class="ident">num</span>, <span class="number">64</span>)
}
<span class="doccomment">/// Returns the nearest multiple of `factor` that is `>=` than `num`. Here `factor` must</span>
<span class="doccomment">/// be a power of 2.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">round_upto_power_of_2</span>(<span class="ident">num</span>: <span class="ident">usize</span>, <span class="ident">factor</span>: <span class="ident">usize</span>) <span class="op">-</span><span class="op">></span> <span class="ident">usize</span> {
<span class="macro">debug_assert</span><span class="macro">!</span>(<span class="ident">factor</span> <span class="op">></span> <span class="number">0</span> <span class="op">&&</span> (<span class="ident">factor</span> <span class="op">&</span> (<span class="ident">factor</span> <span class="op">-</span> <span class="number">1</span>)) <span class="op">=</span><span class="op">=</span> <span class="number">0</span>);
(<span class="ident">num</span> <span class="op">+</span> (<span class="ident">factor</span> <span class="op">-</span> <span class="number">1</span>)) <span class="op">&</span> <span class="op">!</span>(<span class="ident">factor</span> <span class="op">-</span> <span class="number">1</span>)
}
<span class="doccomment">/// Returns whether bit at position `i` in `data` is set or not</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_bit</span>(<span class="ident">data</span>: <span class="kw-2">&</span>[<span class="ident">u8</span>], <span class="ident">i</span>: <span class="ident">usize</span>) <span class="op">-</span><span class="op">></span> <span class="ident">bool</span> {
(<span class="ident">data</span>[<span class="ident">i</span> <span class="op">></span><span class="op">></span> <span class="number">3</span>] <span class="op">&</span> <span class="ident">BIT_MASK</span>[<span class="ident">i</span> <span class="op">&</span> <span class="number">7</span>]) <span class="op">!</span><span class="op">=</span> <span class="number">0</span>
}
<span class="doccomment">/// Returns whether bit at position `i` in `data` is set or not.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Safety</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Note this doesn't do any bound checking, for performance reason. The caller is</span>
<span class="doccomment">/// responsible to guarantee that `i` is within bounds.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">get_bit_raw</span>(<span class="ident">data</span>: <span class="kw-2">*</span><span class="kw">const</span> <span class="ident">u8</span>, <span class="ident">i</span>: <span class="ident">usize</span>) <span class="op">-</span><span class="op">></span> <span class="ident">bool</span> {
(<span class="kw-2">*</span><span class="ident">data</span>.<span class="ident">add</span>(<span class="ident">i</span> <span class="op">></span><span class="op">></span> <span class="number">3</span>) <span class="op">&</span> <span class="ident">BIT_MASK</span>[<span class="ident">i</span> <span class="op">&</span> <span class="number">7</span>]) <span class="op">!</span><span class="op">=</span> <span class="number">0</span>
}
<span class="doccomment">/// Sets bit at position `i` for `data`</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_bit</span>(<span class="ident">data</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> [<span class="ident">u8</span>], <span class="ident">i</span>: <span class="ident">usize</span>) {
<span class="ident">data</span>[<span class="ident">i</span> <span class="op">></span><span class="op">></span> <span class="number">3</span>] <span class="op">|</span><span class="op">=</span> <span class="ident">BIT_MASK</span>[<span class="ident">i</span> <span class="op">&</span> <span class="number">7</span>];
}
<span class="doccomment">/// Sets bit at position `i` for `data`</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Safety</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Note this doesn't do any bound checking, for performance reason. The caller is</span>
<span class="doccomment">/// responsible to guarantee that `i` is within bounds.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">set_bit_raw</span>(<span class="ident">data</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">u8</span>, <span class="ident">i</span>: <span class="ident">usize</span>) {
<span class="kw-2">*</span><span class="ident">data</span>.<span class="ident">add</span>(<span class="ident">i</span> <span class="op">></span><span class="op">></span> <span class="number">3</span>) <span class="op">|</span><span class="op">=</span> <span class="ident">BIT_MASK</span>[<span class="ident">i</span> <span class="op">&</span> <span class="number">7</span>];
}
<span class="doccomment">/// Sets bit at position `i` for `data` to 0</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">unset_bit</span>(<span class="ident">data</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> [<span class="ident">u8</span>], <span class="ident">i</span>: <span class="ident">usize</span>) {
<span class="ident">data</span>[<span class="ident">i</span> <span class="op">></span><span class="op">></span> <span class="number">3</span>] <span class="op">^</span><span class="op">=</span> <span class="ident">BIT_MASK</span>[<span class="ident">i</span> <span class="op">&</span> <span class="number">7</span>];
}
<span class="doccomment">/// Sets bit at position `i` for `data` to 0</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Safety</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Note this doesn't do any bound checking, for performance reason. The caller is</span>
<span class="doccomment">/// responsible to guarantee that `i` is within bounds.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">unset_bit_raw</span>(<span class="ident">data</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">u8</span>, <span class="ident">i</span>: <span class="ident">usize</span>) {
<span class="kw-2">*</span><span class="ident">data</span>.<span class="ident">add</span>(<span class="ident">i</span> <span class="op">></span><span class="op">></span> <span class="number">3</span>) <span class="op">^</span><span class="op">=</span> <span class="ident">BIT_MASK</span>[<span class="ident">i</span> <span class="op">&</span> <span class="number">7</span>];
}
<span class="doccomment">/// Returns the ceil of `value`/`divisor`</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">ceil</span>(<span class="ident">value</span>: <span class="ident">usize</span>, <span class="ident">divisor</span>: <span class="ident">usize</span>) <span class="op">-</span><span class="op">></span> <span class="ident">usize</span> {
<span class="kw">let</span> (<span class="ident">quot</span>, <span class="ident">rem</span>) <span class="op">=</span> (<span class="ident">value</span> <span class="op">/</span> <span class="ident">divisor</span>, <span class="ident">value</span> <span class="op">%</span> <span class="ident">divisor</span>);
<span class="kw">if</span> <span class="ident">rem</span> <span class="op">></span> <span class="number">0</span> <span class="op">&&</span> <span class="ident">divisor</span> <span class="op">></span> <span class="number">0</span> {
<span class="ident">quot</span> <span class="op">+</span> <span class="number">1</span>
} <span class="kw">else</span> {
<span class="ident">quot</span>
}
}
<span class="doccomment">/// Performs SIMD bitwise binary operations.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Safety</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Note that each slice should be 64 bytes and it is the callers responsibility to ensure</span>
<span class="doccomment">/// that this is the case. If passed slices larger than 64 bytes the operation will only</span>
<span class="doccomment">/// be performed on the first 64 bytes. Slices less than 64 bytes will panic.</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">simd</span>)]</span>
<span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">bitwise_bin_op_simd</span><span class="op"><</span><span class="ident">F</span><span class="op">></span>(<span class="ident">left</span>: <span class="kw-2">&</span>[<span class="ident">u8</span>], <span class="ident">right</span>: <span class="kw-2">&</span>[<span class="ident">u8</span>], <span class="ident">result</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> [<span class="ident">u8</span>], <span class="ident">op</span>: <span class="ident">F</span>)
<span class="kw">where</span>
<span class="ident">F</span>: <span class="ident">Fn</span>(<span class="ident">u8x64</span>, <span class="ident">u8x64</span>) <span class="op">-</span><span class="op">></span> <span class="ident">u8x64</span>,
{
<span class="kw">let</span> <span class="ident">left_simd</span> <span class="op">=</span> <span class="ident">u8x64</span>::<span class="ident">from_slice_unaligned_unchecked</span>(<span class="ident">left</span>);
<span class="kw">let</span> <span class="ident">right_simd</span> <span class="op">=</span> <span class="ident">u8x64</span>::<span class="ident">from_slice_unaligned_unchecked</span>(<span class="ident">right</span>);
<span class="kw">let</span> <span class="ident">simd_result</span> <span class="op">=</span> <span class="ident">op</span>(<span class="ident">left_simd</span>, <span class="ident">right_simd</span>);
<span class="ident">simd_result</span>.<span class="ident">write_to_slice_unaligned_unchecked</span>(<span class="ident">result</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="polars_arrow" 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>