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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>Faiss: /data/users/matthijs/github_faiss/faiss/gpu/GpuIndexFlat.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Faiss
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Friends</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_6b3ae6988449b0834e9596fad5d75199.html">gpu</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">GpuIndexFlat.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (c) 2015-present, Facebook, Inc.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * All rights reserved.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * This source code is licensed under the BSD+Patents license found in the</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * LICENSE file in the root directory of this source tree.</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// Copyright 2004-present Facebook. All Rights Reserved.</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include "GpuIndex.h"</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="keyword">namespace </span>faiss {</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">struct </span>IndexFlat;</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">struct </span>IndexFlatL2;</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">struct </span>IndexFlatIP;</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> }</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">namespace </span>faiss { <span class="keyword">namespace </span>gpu {</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">struct </span>FlatIndex;</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="structfaiss_1_1gpu_1_1GpuIndexFlatConfig.html"> 27</a></span> <span class="keyword">struct </span><a class="code" href="structfaiss_1_1gpu_1_1GpuIndexFlatConfig.html">GpuIndexFlatConfig</a> : <span class="keyword">public</span> <a class="code" href="structfaiss_1_1gpu_1_1GpuIndexConfig.html">GpuIndexConfig</a> {</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="keyword">inline</span> <a class="code" href="structfaiss_1_1gpu_1_1GpuIndexFlatConfig.html">GpuIndexFlatConfig</a>()</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  : <a class="code" href="structfaiss_1_1gpu_1_1GpuIndexFlatConfig.html#afd694186c87751937a646f3db2c8ba3d">useFloat16</a>(<span class="keyword">false</span>),</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <a class="code" href="structfaiss_1_1gpu_1_1GpuIndexFlatConfig.html#a5a2d8737f4277e55fc1a99ef4fc4c630">useFloat16Accumulator</a>(<span class="keyword">false</span>),</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <a class="code" href="structfaiss_1_1gpu_1_1GpuIndexFlatConfig.html#a0342a26f5e59563bfe04f3f80e3b27f0">storeTransposed</a>(<span class="keyword">false</span>) {</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  }</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"></span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> /// Whether or not data is stored as float16</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="structfaiss_1_1gpu_1_1GpuIndexFlatConfig.html#afd694186c87751937a646f3db2c8ba3d"> 35</a></span> <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="structfaiss_1_1gpu_1_1GpuIndexFlatConfig.html#afd694186c87751937a646f3db2c8ba3d">useFloat16</a>;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"></span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> /// Whether or not all math is performed in float16, if useFloat16 is</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> /// specified. If true, we use cublasHgemm, supported only on CC</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> /// 5.3+. Otherwise, we use cublasSgemmEx.</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="structfaiss_1_1gpu_1_1GpuIndexFlatConfig.html#a5a2d8737f4277e55fc1a99ef4fc4c630"> 40</a></span> <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="structfaiss_1_1gpu_1_1GpuIndexFlatConfig.html#a5a2d8737f4277e55fc1a99ef4fc4c630">useFloat16Accumulator</a>;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"></span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> /// Whether or not data is stored (transparently) in a transposed</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> /// layout, enabling use of the NN GEMM call, which is ~10% faster.</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> /// This will improve the speed of the flat index, but will</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> /// substantially slow down any add() calls made, as all data must</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> /// be transposed, and will increase storage requirements (we store</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> /// data in both transposed and non-transposed layouts).</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="structfaiss_1_1gpu_1_1GpuIndexFlatConfig.html#a0342a26f5e59563bfe04f3f80e3b27f0"> 48</a></span> <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="structfaiss_1_1gpu_1_1GpuIndexFlatConfig.html#a0342a26f5e59563bfe04f3f80e3b27f0">storeTransposed</a>;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> };</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"></span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment">/// Wrapper around the GPU implementation that looks like</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment">/// faiss::IndexFlat; copies over centroid data from a given</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">/// faiss::IndexFlat</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1GpuIndexFlat.html"> 54</a></span> <span class="comment"></span><span class="keyword">class </span><a class="code" href="classfaiss_1_1gpu_1_1GpuIndexFlat.html">GpuIndexFlat</a> : <span class="keyword">public</span> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndex.html">GpuIndex</a> {</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">public</span>:<span class="comment"></span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> /// Construct from a pre-existing faiss::IndexFlat instance, copying</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> /// data over to the given GPU</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"></span> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexFlat.html#af8a1626e4c54a451d0b9f82df3a6687e">GpuIndexFlat</a>(<a class="code" href="classfaiss_1_1gpu_1_1GpuResources.html">GpuResources</a>* resources,</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keyword">const</span> <a class="code" href="structfaiss_1_1IndexFlat.html">faiss::IndexFlat</a>* index,</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <a class="code" href="structfaiss_1_1gpu_1_1GpuIndexFlatConfig.html">GpuIndexFlatConfig</a> config = <a class="code" href="structfaiss_1_1gpu_1_1GpuIndexFlatConfig.html">GpuIndexFlatConfig</a>());</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"></span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> /// Construct an empty instance that can be added to</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"></span> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexFlat.html#af8a1626e4c54a451d0b9f82df3a6687e">GpuIndexFlat</a>(<a class="code" href="classfaiss_1_1gpu_1_1GpuResources.html">GpuResources</a>* resources,</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordtype">int</span> dims,</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <a class="code" href="namespacefaiss.html#afd12191c638da74760ff397cf319752c">faiss::MetricType</a> metric,</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <a class="code" href="structfaiss_1_1gpu_1_1GpuIndexFlatConfig.html">GpuIndexFlatConfig</a> config = <a class="code" href="structfaiss_1_1gpu_1_1GpuIndexFlatConfig.html">GpuIndexFlatConfig</a>());</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  ~<a class="code" href="classfaiss_1_1gpu_1_1GpuIndexFlat.html">GpuIndexFlat</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"></span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> /// Set the minimum data size for searches (in MiB) for which we use</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> /// CPU -> GPU paging</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexFlat.html#a752f8129ccb94fa0c6f346ae03ff536d">setMinPagingSize</a>(<span class="keywordtype">size_t</span> size);</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"></span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> /// Returns the current minimum data size for paged searches</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"></span> <span class="keywordtype">size_t</span> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexFlat.html#a44532c7e5165d36e5da57272d37544ae">getMinPagingSize</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"></span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> /// Initialize ourselves from the given CPU index; will overwrite</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> /// all data in ourselves</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexFlat.html#abb964875e0893de1d8334ca5ad0f62dc">copyFrom</a>(<span class="keyword">const</span> <a class="code" href="structfaiss_1_1IndexFlat.html">faiss::IndexFlat</a>* index);</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"></span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> /// Copy ourselves to the given CPU index; will overwrite all data</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> /// in the index instance</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexFlat.html#a046007ff2fafcafc6ae328769c700e39">copyTo</a>(<a class="code" href="structfaiss_1_1IndexFlat.html">faiss::IndexFlat</a>* index) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"></span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"> /// Returns the number of vectors we contain</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"></span> <span class="keywordtype">size_t</span> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexFlat.html#a51b5aa0d68670ec7ccb32b0353c7387f">getNumVecs</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"></span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> /// Clears all vectors from this index</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexFlat.html#a67161796f274a7171a67c36bdf1ef1db">reset</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"></span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> /// This index is not trained, so this does nothing</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexFlat.html#a0e74fad76628ddfb5ae3dc1d1c69f7e8">train</a>(<a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">Index::idx_t</a> n, <span class="keyword">const</span> <span class="keywordtype">float</span>* x) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"></span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> /// Overrides to avoid excessive copies</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexFlat.html#a35d31b6b5ea89629b369655fd03bd505">add</a>(<a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">faiss::Index::idx_t</a>, <span class="keyword">const</span> <span class="keywordtype">float</span>* x) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"></span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> /// `x`, `distances` and `labels` can be resident on the CPU or any</span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> /// GPU; copies are performed as needed</span></div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> /// We have our own implementation here which handles CPU async</span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> /// copies; searchImpl_ is not called</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> /// FIXME: move paged impl into GpuIndex</span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexFlat.html#ac0f0301829363f920e619f673a4d97f3">search</a>(</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">faiss::Index::idx_t</a> n,</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keyword">const</span> <span class="keywordtype">float</span>* x,</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">faiss::Index::idx_t</a> k,</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keywordtype">float</span>* distances,</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">faiss::Index::idx_t</a>* labels) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"></span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> /// Reconstruction methods; prefer the batch reconstruct as it will</span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> /// be more efficient</span></div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexFlat.html#a7f1cdf03d3545a43fc91bb5cace3b6fd">reconstruct</a>(<a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">faiss::Index::idx_t</a> key, <span class="keywordtype">float</span>* out) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"></span></div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> /// Batch reconstruction method</span></div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexFlat.html#a472732e9bd8ffb1aa4c3abc31063dd28">reconstruct_n</a>(</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">faiss::Index::idx_t</a> i0,</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">faiss::Index::idx_t</a> num,</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keywordtype">float</span>* out) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"></span></div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> /// For internal access</span></div>
<div class="line"><a name="l00120"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1GpuIndexFlat.html#a310b00d4443920a855b11276d488c9a7"> 120</a></span> <span class="comment"></span> <span class="keyword">inline</span> <a class="code" href="classfaiss_1_1gpu_1_1FlatIndex.html">FlatIndex</a>* <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexFlat.html#a310b00d4443920a855b11276d488c9a7">getGpuData</a>() { <span class="keywordflow">return</span> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexFlat.html#ae393840fc80403369452c25c9155e067">data_</a>; }</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> </div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keyword">protected</span>:<span class="comment"></span></div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> /// Called from GpuIndex for add</span></div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexFlat.html#ae0c916b911eda2f1a09a55f42ebc729c">addImpl_</a>(</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">faiss::Index::idx_t</a> n,</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keyword">const</span> <span class="keywordtype">float</span>* x,</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="keyword">const</span> <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">faiss::Index::idx_t</a>* ids) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"></span></div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"> /// Should not be called (we have our own implementation)</span></div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexFlat.html#ac99bfd11ff5150f29cf054ea55fc8fe4">searchImpl_</a>(</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">faiss::Index::idx_t</a> n,</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="keyword">const</span> <span class="keywordtype">float</span>* x,</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">faiss::Index::idx_t</a> k,</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <span class="keywordtype">float</span>* distances,</div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">faiss::Index::idx_t</a>* labels) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment"></span></div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment"> /// Called from search when the input data is on the CPU;</span></div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment"> /// potentially allows for pinned memory usage</span></div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexFlat.html#afedeff5442b6ed94f856cecb8d8e598d">searchFromCpuPaged_</a>(<span class="keywordtype">int</span> n,</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <span class="keyword">const</span> <span class="keywordtype">float</span>* x,</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <span class="keywordtype">int</span> k,</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <span class="keywordtype">float</span>* outDistancesData,</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="keywordtype">int</span>* outIndicesData) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> </div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <span class="keywordtype">void</span> searchNonPaged_(<span class="keywordtype">int</span> n,</div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  <span class="keyword">const</span> <span class="keywordtype">float</span>* x,</div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  <span class="keywordtype">int</span> k,</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <span class="keywordtype">float</span>* outDistancesData,</div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <span class="keywordtype">int</span>* outIndicesData) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> </div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  <span class="keyword">private</span>:<span class="comment"></span></div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment"> /// Checks user settings for consistency</span></div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"></span> <span class="keywordtype">void</span> verifySettings_() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> </div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  <span class="keyword">protected</span>:<span class="comment"></span></div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"> /// Our config object</span></div>
<div class="line"><a name="l00157"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1GpuIndexFlat.html#a9efdc92bf03d2d6820fb989cf77e8067"> 157</a></span> <span class="comment"></span> <span class="keyword">const</span> <a class="code" href="structfaiss_1_1gpu_1_1GpuIndexFlatConfig.html">GpuIndexFlatConfig</a> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexFlat.html#a9efdc92bf03d2d6820fb989cf77e8067">config_</a>;</div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment"></span></div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment"> /// Size above which we page copies from the CPU to GPU</span></div>
<div class="line"><a name="l00160"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1GpuIndexFlat.html#aad665a7b5888b4aafd47ae0f8d0e6c40"> 160</a></span> <span class="comment"></span> <span class="keywordtype">size_t</span> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexFlat.html#aad665a7b5888b4aafd47ae0f8d0e6c40">minPagedSize_</a>;</div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment"></span></div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment"> /// Holds our GPU data containing the list of vectors</span></div>
<div class="line"><a name="l00163"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1GpuIndexFlat.html#ae393840fc80403369452c25c9155e067"> 163</a></span> <span class="comment"></span> <a class="code" href="classfaiss_1_1gpu_1_1FlatIndex.html">FlatIndex</a>* <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexFlat.html#ae393840fc80403369452c25c9155e067">data_</a>;</div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span> };</div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment"></span></div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment">/// Wrapper around the GPU implementation that looks like</span></div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment">/// faiss::IndexFlatL2; copies over centroid data from a given</span></div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment">/// faiss::IndexFlat</span></div>
<div class="line"><a name="l00169"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1GpuIndexFlatL2.html"> 169</a></span> <span class="comment"></span><span class="keyword">class </span><a class="code" href="classfaiss_1_1gpu_1_1GpuIndexFlatL2.html">GpuIndexFlatL2</a> : <span class="keyword">public</span> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexFlat.html">GpuIndexFlat</a> {</div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  <span class="keyword">public</span>:<span class="comment"></span></div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment"> /// Construct from a pre-existing faiss::IndexFlatL2 instance, copying</span></div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment"> /// data over to the given GPU</span></div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment"></span> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexFlatL2.html#aed22de4a439fa0b2f560e3c716a7c626">GpuIndexFlatL2</a>(<a class="code" href="classfaiss_1_1gpu_1_1GpuResources.html">GpuResources</a>* resources,</div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  <a class="code" href="structfaiss_1_1IndexFlatL2.html">faiss::IndexFlatL2</a>* index,</div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  <a class="code" href="structfaiss_1_1gpu_1_1GpuIndexFlatConfig.html">GpuIndexFlatConfig</a> config = <a class="code" href="structfaiss_1_1gpu_1_1GpuIndexFlatConfig.html">GpuIndexFlatConfig</a>());</div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment"></span></div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment"> /// Construct an empty instance that can be added to</span></div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment"></span> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexFlatL2.html#aed22de4a439fa0b2f560e3c716a7c626">GpuIndexFlatL2</a>(<a class="code" href="classfaiss_1_1gpu_1_1GpuResources.html">GpuResources</a>* resources,</div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  <span class="keywordtype">int</span> dims,</div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  <a class="code" href="structfaiss_1_1gpu_1_1GpuIndexFlatConfig.html">GpuIndexFlatConfig</a> config = <a class="code" href="structfaiss_1_1gpu_1_1GpuIndexFlatConfig.html">GpuIndexFlatConfig</a>());</div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment"></span></div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment"> /// Initialize ourselves from the given CPU index; will overwrite</span></div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="comment"> /// all data in ourselves</span></div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexFlatL2.html#a9a9de859274bb73e6d8ea02cae5ca9a6">copyFrom</a>(<a class="code" href="structfaiss_1_1IndexFlatL2.html">faiss::IndexFlatL2</a>* index);</div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="comment"></span></div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="comment"> /// Copy ourselves to the given CPU index; will overwrite all data</span></div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment"> /// in the index instance</span></div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexFlatL2.html#ab21960d379190b98aaa05ae3877dea09">copyTo</a>(<a class="code" href="structfaiss_1_1IndexFlatL2.html">faiss::IndexFlatL2</a>* index);</div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span> };</div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="comment"></span></div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="comment">/// Wrapper around the GPU implementation that looks like</span></div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="comment">/// faiss::IndexFlatIP; copies over centroid data from a given</span></div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="comment">/// faiss::IndexFlat</span></div>
<div class="line"><a name="l00194"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1GpuIndexFlatIP.html"> 194</a></span> <span class="comment"></span><span class="keyword">class </span><a class="code" href="classfaiss_1_1gpu_1_1GpuIndexFlatIP.html">GpuIndexFlatIP</a> : <span class="keyword">public</span> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexFlat.html">GpuIndexFlat</a> {</div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  <span class="keyword">public</span>:<span class="comment"></span></div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment"> /// Construct from a pre-existing faiss::IndexFlatIP instance, copying</span></div>
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment"> /// data over to the given GPU</span></div>
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="comment"></span> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexFlatIP.html#a5f8c6e1a31cae06f6a5bcd1828307304">GpuIndexFlatIP</a>(<a class="code" href="classfaiss_1_1gpu_1_1GpuResources.html">GpuResources</a>* resources,</div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  <a class="code" href="structfaiss_1_1IndexFlatIP.html">faiss::IndexFlatIP</a>* index,</div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  <a class="code" href="structfaiss_1_1gpu_1_1GpuIndexFlatConfig.html">GpuIndexFlatConfig</a> config = <a class="code" href="structfaiss_1_1gpu_1_1GpuIndexFlatConfig.html">GpuIndexFlatConfig</a>());</div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="comment"></span></div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="comment"> /// Construct an empty instance that can be added to</span></div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="comment"></span> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexFlatIP.html#a5f8c6e1a31cae06f6a5bcd1828307304">GpuIndexFlatIP</a>(<a class="code" href="classfaiss_1_1gpu_1_1GpuResources.html">GpuResources</a>* resources,</div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  <span class="keywordtype">int</span> dims,</div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  <a class="code" href="structfaiss_1_1gpu_1_1GpuIndexFlatConfig.html">GpuIndexFlatConfig</a> config = <a class="code" href="structfaiss_1_1gpu_1_1GpuIndexFlatConfig.html">GpuIndexFlatConfig</a>());</div>
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="comment"></span></div>
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span> <span class="comment"> /// Initialize ourselves from the given CPU index; will overwrite</span></div>
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="comment"> /// all data in ourselves</span></div>
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexFlatIP.html#aa181b1778a8dca81ac5cf6cd6a3d5f1d">copyFrom</a>(<a class="code" href="structfaiss_1_1IndexFlatIP.html">faiss::IndexFlatIP</a>* index);</div>
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="comment"></span></div>
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="comment"> /// Copy ourselves to the given CPU index; will overwrite all data</span></div>
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="comment"> /// in the index instance</span></div>
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexFlatIP.html#af70d0fe80cf3bf16ffffd8b16ed64f08">copyTo</a>(<a class="code" href="structfaiss_1_1IndexFlatIP.html">faiss::IndexFlatIP</a>* index);</div>
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span> };</div>
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span> </div>
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span> } } <span class="comment">// namespace</span></div>
<div class="ttc" id="structfaiss_1_1IndexFlat_html"><div class="ttname"><a href="structfaiss_1_1IndexFlat.html">faiss::IndexFlat</a></div><div class="ttdef"><b>Definition:</b> <a href="IndexFlat_8h_source.html#l00023">IndexFlat.h:23</a></div></div>
<div class="ttc" id="structfaiss_1_1gpu_1_1GpuIndexFlatConfig_html_a5a2d8737f4277e55fc1a99ef4fc4c630"><div class="ttname"><a href="structfaiss_1_1gpu_1_1GpuIndexFlatConfig.html#a5a2d8737f4277e55fc1a99ef4fc4c630">faiss::gpu::GpuIndexFlatConfig::useFloat16Accumulator</a></div><div class="ttdeci">bool useFloat16Accumulator</div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexFlat_8h_source.html#l00040">GpuIndexFlat.h:40</a></div></div>
<div class="ttc" id="structfaiss_1_1gpu_1_1GpuIndexFlatConfig_html_a0342a26f5e59563bfe04f3f80e3b27f0"><div class="ttname"><a href="structfaiss_1_1gpu_1_1GpuIndexFlatConfig.html#a0342a26f5e59563bfe04f3f80e3b27f0">faiss::gpu::GpuIndexFlatConfig::storeTransposed</a></div><div class="ttdeci">bool storeTransposed</div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexFlat_8h_source.html#l00048">GpuIndexFlat.h:48</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndexFlatL2_html_a9a9de859274bb73e6d8ea02cae5ca9a6"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndexFlatL2.html#a9a9de859274bb73e6d8ea02cae5ca9a6">faiss::gpu::GpuIndexFlatL2::copyFrom</a></div><div class="ttdeci">void copyFrom(faiss::IndexFlatL2 *index)</div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexFlat_8cu_source.html#l00562">GpuIndexFlat.cu:562</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndexFlat_html_a046007ff2fafcafc6ae328769c700e39"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndexFlat.html#a046007ff2fafcafc6ae328769c700e39">faiss::gpu::GpuIndexFlat::copyTo</a></div><div class="ttdeci">void copyTo(faiss::IndexFlat *index) const </div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexFlat_8cu_source.html#l00120">GpuIndexFlat.cu:120</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndexFlat_html_a472732e9bd8ffb1aa4c3abc31063dd28"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndexFlat.html#a472732e9bd8ffb1aa4c3abc31063dd28">faiss::gpu::GpuIndexFlat::reconstruct_n</a></div><div class="ttdeci">void reconstruct_n(faiss::Index::idx_t i0, faiss::Index::idx_t num, float *out) const override</div><div class="ttdoc">Batch reconstruction method. </div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexFlat_8cu_source.html#l00508">GpuIndexFlat.cu:508</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndexFlat_html_a44532c7e5165d36e5da57272d37544ae"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndexFlat.html#a44532c7e5165d36e5da57272d37544ae">faiss::gpu::GpuIndexFlat::getMinPagingSize</a></div><div class="ttdeci">size_t getMinPagingSize() const </div><div class="ttdoc">Returns the current minimum data size for paged searches. </div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexFlat_8cu_source.html#l00082">GpuIndexFlat.cu:82</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1FlatIndex_html"><div class="ttname"><a href="classfaiss_1_1gpu_1_1FlatIndex.html">faiss::gpu::FlatIndex</a></div><div class="ttdoc">Holder of GPU resources for a particular flat index. </div><div class="ttdef"><b>Definition:</b> <a href="FlatIndex_8cuh_source.html#l00023">FlatIndex.cuh:23</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndexFlat_html_a310b00d4443920a855b11276d488c9a7"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndexFlat.html#a310b00d4443920a855b11276d488c9a7">faiss::gpu::GpuIndexFlat::getGpuData</a></div><div class="ttdeci">FlatIndex * getGpuData()</div><div class="ttdoc">For internal access. </div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexFlat_8h_source.html#l00120">GpuIndexFlat.h:120</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndexFlatL2_html_ab21960d379190b98aaa05ae3877dea09"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndexFlatL2.html#ab21960d379190b98aaa05ae3877dea09">faiss::gpu::GpuIndexFlatL2::copyTo</a></div><div class="ttdeci">void copyTo(faiss::IndexFlatL2 *index)</div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexFlat_8cu_source.html#l00567">GpuIndexFlat.cu:567</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexFlatL2_html"><div class="ttname"><a href="structfaiss_1_1IndexFlatL2.html">faiss::IndexFlatL2</a></div><div class="ttdef"><b>Definition:</b> <a href="IndexFlat_8h_source.html#l00079">IndexFlat.h:79</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndexFlat_html_afedeff5442b6ed94f856cecb8d8e598d"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndexFlat.html#afedeff5442b6ed94f856cecb8d8e598d">faiss::gpu::GpuIndexFlat::searchFromCpuPaged_</a></div><div class="ttdeci">void searchFromCpuPaged_(int n, const float *x, int k, float *outDistancesData, int *outIndicesData) const </div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexFlat_8cu_source.html#l00319">GpuIndexFlat.cu:319</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndexFlat_html_ae0c916b911eda2f1a09a55f42ebc729c"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndexFlat.html#ae0c916b911eda2f1a09a55f42ebc729c">faiss::gpu::GpuIndexFlat::addImpl_</a></div><div class="ttdeci">void addImpl_(faiss::Index::idx_t n, const float *x, const faiss::Index::idx_t *ids) override</div><div class="ttdoc">Called from GpuIndex for add. </div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexFlat_8cu_source.html#l00180">GpuIndexFlat.cu:180</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndexFlat_html_ac99bfd11ff5150f29cf054ea55fc8fe4"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndexFlat.html#ac99bfd11ff5150f29cf054ea55fc8fe4">faiss::gpu::GpuIndexFlat::searchImpl_</a></div><div class="ttdeci">void searchImpl_(faiss::Index::idx_t n, const float *x, faiss::Index::idx_t k, float *distances, faiss::Index::idx_t *labels) const override</div><div class="ttdoc">Should not be called (we have our own implementation) </div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexFlat_8cu_source.html#l00288">GpuIndexFlat.cu:288</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndexFlat_html_a51b5aa0d68670ec7ccb32b0353c7387f"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndexFlat.html#a51b5aa0d68670ec7ccb32b0353c7387f">faiss::gpu::GpuIndexFlat::getNumVecs</a></div><div class="ttdeci">size_t getNumVecs() const </div><div class="ttdoc">Returns the number of vectors we contain. </div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexFlat_8cu_source.html#l00143">GpuIndexFlat.cu:143</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuResources_html"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuResources.html">faiss::gpu::GpuResources</a></div><div class="ttdef"><b>Definition:</b> <a href="GpuResources_8h_source.html#l00023">GpuResources.h:23</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndexFlat_html_af8a1626e4c54a451d0b9f82df3a6687e"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndexFlat.html#af8a1626e4c54a451d0b9f82df3a6687e">faiss::gpu::GpuIndexFlat::GpuIndexFlat</a></div><div class="ttdeci">GpuIndexFlat(GpuResources *resources, const faiss::IndexFlat *index, GpuIndexFlatConfig config=GpuIndexFlatConfig())</div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexFlat_8cu_source.html#l00033">GpuIndexFlat.cu:33</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexFlatIP_html"><div class="ttname"><a href="structfaiss_1_1IndexFlatIP.html">faiss::IndexFlatIP</a></div><div class="ttdef"><b>Definition:</b> <a href="IndexFlat_8h_source.html#l00073">IndexFlat.h:73</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndexFlat_html_a752f8129ccb94fa0c6f346ae03ff536d"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndexFlat.html#a752f8129ccb94fa0c6f346ae03ff536d">faiss::gpu::GpuIndexFlat::setMinPagingSize</a></div><div class="ttdeci">void setMinPagingSize(size_t size)</div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexFlat_8cu_source.html#l00077">GpuIndexFlat.cu:77</a></div></div>
<div class="ttc" id="structfaiss_1_1gpu_1_1GpuIndexFlatConfig_html_afd694186c87751937a646f3db2c8ba3d"><div class="ttname"><a href="structfaiss_1_1gpu_1_1GpuIndexFlatConfig.html#afd694186c87751937a646f3db2c8ba3d">faiss::gpu::GpuIndexFlatConfig::useFloat16</a></div><div class="ttdeci">bool useFloat16</div><div class="ttdoc">Whether or not data is stored as float16. </div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexFlat_8h_source.html#l00035">GpuIndexFlat.h:35</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndex_html"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndex.html">faiss::gpu::GpuIndex</a></div><div class="ttdef"><b>Definition:</b> <a href="GpuIndex_8h_source.html#l00035">GpuIndex.h:35</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndexFlatL2_html_aed22de4a439fa0b2f560e3c716a7c626"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndexFlatL2.html#aed22de4a439fa0b2f560e3c716a7c626">faiss::gpu::GpuIndexFlatL2::GpuIndexFlatL2</a></div><div class="ttdeci">GpuIndexFlatL2(GpuResources *resources, faiss::IndexFlatL2 *index, GpuIndexFlatConfig config=GpuIndexFlatConfig())</div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexFlat_8cu_source.html#l00549">GpuIndexFlat.cu:549</a></div></div>
<div class="ttc" id="structfaiss_1_1gpu_1_1GpuIndexFlatConfig_html"><div class="ttname"><a href="structfaiss_1_1gpu_1_1GpuIndexFlatConfig.html">faiss::gpu::GpuIndexFlatConfig</a></div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexFlat_8h_source.html#l00027">GpuIndexFlat.h:27</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndexFlat_html_a7f1cdf03d3545a43fc91bb5cace3b6fd"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndexFlat.html#a7f1cdf03d3545a43fc91bb5cace3b6fd">faiss::gpu::GpuIndexFlat::reconstruct</a></div><div class="ttdeci">void reconstruct(faiss::Index::idx_t key, float *out) const override</div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexFlat_8cu_source.html#l00491">GpuIndexFlat.cu:491</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndexFlatIP_html_af70d0fe80cf3bf16ffffd8b16ed64f08"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndexFlatIP.html#af70d0fe80cf3bf16ffffd8b16ed64f08">faiss::gpu::GpuIndexFlatIP::copyTo</a></div><div class="ttdeci">void copyTo(faiss::IndexFlatIP *index)</div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexFlat_8cu_source.html#l00593">GpuIndexFlat.cu:593</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndexFlatIP_html_a5f8c6e1a31cae06f6a5bcd1828307304"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndexFlatIP.html#a5f8c6e1a31cae06f6a5bcd1828307304">faiss::gpu::GpuIndexFlatIP::GpuIndexFlatIP</a></div><div class="ttdeci">GpuIndexFlatIP(GpuResources *resources, faiss::IndexFlatIP *index, GpuIndexFlatConfig config=GpuIndexFlatConfig())</div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexFlat_8cu_source.html#l00575">GpuIndexFlat.cu:575</a></div></div>
<div class="ttc" id="structfaiss_1_1Index_html_a040c6aed1f224f3ea7bf58eebc0c31a4"><div class="ttname"><a href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">faiss::Index::idx_t</a></div><div class="ttdeci">long idx_t</div><div class="ttdoc">all indices are this type </div><div class="ttdef"><b>Definition:</b> <a href="Index_8h_source.html#l00062">Index.h:62</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndexFlatIP_html"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndexFlatIP.html">faiss::gpu::GpuIndexFlatIP</a></div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexFlat_8h_source.html#l00194">GpuIndexFlat.h:194</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndexFlat_html_abb964875e0893de1d8334ca5ad0f62dc"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndexFlat.html#abb964875e0893de1d8334ca5ad0f62dc">faiss::gpu::GpuIndexFlat::copyFrom</a></div><div class="ttdeci">void copyFrom(const faiss::IndexFlat *index)</div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexFlat_8cu_source.html#l00087">GpuIndexFlat.cu:87</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndexFlat_html_aad665a7b5888b4aafd47ae0f8d0e6c40"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndexFlat.html#aad665a7b5888b4aafd47ae0f8d0e6c40">faiss::gpu::GpuIndexFlat::minPagedSize_</a></div><div class="ttdeci">size_t minPagedSize_</div><div class="ttdoc">Size above which we page copies from the CPU to GPU. </div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexFlat_8h_source.html#l00160">GpuIndexFlat.h:160</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndexFlat_html_a9efdc92bf03d2d6820fb989cf77e8067"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndexFlat.html#a9efdc92bf03d2d6820fb989cf77e8067">faiss::gpu::GpuIndexFlat::config_</a></div><div class="ttdeci">const GpuIndexFlatConfig config_</div><div class="ttdoc">Our config object. </div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexFlat_8h_source.html#l00157">GpuIndexFlat.h:157</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndexFlatL2_html"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndexFlatL2.html">faiss::gpu::GpuIndexFlatL2</a></div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexFlat_8h_source.html#l00169">GpuIndexFlat.h:169</a></div></div>
<div class="ttc" id="structfaiss_1_1gpu_1_1GpuIndexConfig_html"><div class="ttname"><a href="structfaiss_1_1gpu_1_1GpuIndexConfig.html">faiss::gpu::GpuIndexConfig</a></div><div class="ttdef"><b>Definition:</b> <a href="GpuIndex_8h_source.html#l00020">GpuIndex.h:20</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndexFlat_html_a35d31b6b5ea89629b369655fd03bd505"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndexFlat.html#a35d31b6b5ea89629b369655fd03bd505">faiss::gpu::GpuIndexFlat::add</a></div><div class="ttdeci">void add(faiss::Index::idx_t, const float *x) override</div><div class="ttdoc">Overrides to avoid excessive copies. </div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexFlat_8cu_source.html#l00162">GpuIndexFlat.cu:162</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndexFlat_html"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndexFlat.html">faiss::gpu::GpuIndexFlat</a></div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexFlat_8h_source.html#l00054">GpuIndexFlat.h:54</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndexFlat_html_a67161796f274a7171a67c36bdf1ef1db"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndexFlat.html#a67161796f274a7171a67c36bdf1ef1db">faiss::gpu::GpuIndexFlat::reset</a></div><div class="ttdeci">void reset() override</div><div class="ttdoc">Clears all vectors from this index. </div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexFlat_8cu_source.html#l00148">GpuIndexFlat.cu:148</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndexFlatIP_html_aa181b1778a8dca81ac5cf6cd6a3d5f1d"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndexFlatIP.html#aa181b1778a8dca81ac5cf6cd6a3d5f1d">faiss::gpu::GpuIndexFlatIP::copyFrom</a></div><div class="ttdeci">void copyFrom(faiss::IndexFlatIP *index)</div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexFlat_8cu_source.html#l00588">GpuIndexFlat.cu:588</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndexFlat_html_ac0f0301829363f920e619f673a4d97f3"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndexFlat.html#ac0f0301829363f920e619f673a4d97f3">faiss::gpu::GpuIndexFlat::search</a></div><div class="ttdeci">void search(faiss::Index::idx_t n, const float *x, faiss::Index::idx_t k, float *distances, faiss::Index::idx_t *labels) const override</div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexFlat_8cu_source.html#l00205">GpuIndexFlat.cu:205</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndexFlat_html_a0e74fad76628ddfb5ae3dc1d1c69f7e8"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndexFlat.html#a0e74fad76628ddfb5ae3dc1d1c69f7e8">faiss::gpu::GpuIndexFlat::train</a></div><div class="ttdeci">void train(Index::idx_t n, const float *x) override</div><div class="ttdoc">This index is not trained, so this does nothing. </div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexFlat_8cu_source.html#l00157">GpuIndexFlat.cu:157</a></div></div>
<div class="ttc" id="namespacefaiss_html_afd12191c638da74760ff397cf319752c"><div class="ttname"><a href="namespacefaiss.html#afd12191c638da74760ff397cf319752c">faiss::MetricType</a></div><div class="ttdeci">MetricType</div><div class="ttdoc">Some algorithms support both an inner product version and a L2 search version. </div><div class="ttdef"><b>Definition:</b> <a href="Index_8h_source.html#l00043">Index.h:43</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndexFlat_html_ae393840fc80403369452c25c9155e067"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndexFlat.html#ae393840fc80403369452c25c9155e067">faiss::gpu::GpuIndexFlat::data_</a></div><div class="ttdeci">FlatIndex * data_</div><div class="ttdoc">Holds our GPU data containing the list of vectors. </div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexFlat_8h_source.html#l00163">GpuIndexFlat.h:163</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>