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
<!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/impl/IVFBase.cuh 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><li class="navelem"><a class="el" href="dir_49d1182a3b8dfb62757c53ae905481ad.html">impl</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">IVFBase.cuh</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 "../GpuIndicesOptions.h"</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include "../utils/DeviceVector.cuh"</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include "../utils/DeviceTensor.cuh"</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include "../utils/MemorySpace.h"</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <memory></span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include <thrust/device_vector.h></span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include <vector></span></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> <span class="keyword">namespace </span>faiss { <span class="keyword">namespace </span>gpu {</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">class </span>GpuResources;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">struct </span>FlatIndex;</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"></span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">/// Base inverted list functionality for IVFFlat and IVFPQ</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1IVFBase.html"> 27</a></span> <span class="comment"></span><span class="keyword">class </span><a class="code" href="classfaiss_1_1gpu_1_1IVFBase.html">IVFBase</a> {</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <a class="code" href="classfaiss_1_1gpu_1_1IVFBase.html#a80130acfe0a2a4d387a5c9ee4c386b9c">IVFBase</a>(<a class="code" href="classfaiss_1_1gpu_1_1GpuResources.html">GpuResources</a>* resources,<span class="comment"></span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> /// We do not own this reference</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"></span> <a class="code" href="classfaiss_1_1gpu_1_1FlatIndex.html">FlatIndex</a>* quantizer,</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keywordtype">int</span> bytesPerVector,</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  IndicesOptions indicesOptions,</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  MemorySpace space);</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keyword">virtual</span> ~<a class="code" href="classfaiss_1_1gpu_1_1IVFBase.html">IVFBase</a>();</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"></span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> /// Reserve GPU memory in our inverted lists for this number of vectors</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classfaiss_1_1gpu_1_1IVFBase.html#a02e1e2d080ee31bf7835f89b9f2a13a9">reserveMemory</a>(<span class="keywordtype">size_t</span> numVecs);</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"></span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> /// Clear out all inverted lists, but retain the coarse quantizer</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> /// and the product quantizer info</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classfaiss_1_1gpu_1_1IVFBase.html#a7ea671876443c93436499ad581f16997">reset</a>();</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"></span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> /// Return the number of dimensions we are indexing</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="classfaiss_1_1gpu_1_1IVFBase.html#a4d44e8aebc380b7c846a8d8e6e835540">getDim</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"></span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> /// After adding vectors, one can call this to reclaim device memory</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> /// to exactly the amount needed. Returns space reclaimed in bytes</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"></span> <span class="keywordtype">size_t</span> <a class="code" href="classfaiss_1_1gpu_1_1IVFBase.html#ac9b69e1b2582cb2c064b5fff60d31cc8">reclaimMemory</a>();</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"></span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> /// Returns the number of inverted lists</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"></span> <span class="keywordtype">size_t</span> <a class="code" href="classfaiss_1_1gpu_1_1IVFBase.html#abd66dc9d32e6150b930d78f74d7dd2d7">getNumLists</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"></span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> /// For debugging purposes, return the list length of a particular</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> /// list</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="classfaiss_1_1gpu_1_1IVFBase.html#a7b1ee21f9919fb077db5e48e91943582">getListLength</a>(<span class="keywordtype">int</span> listId) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"></span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> /// Return the list indices of a particular list back to the CPU</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"></span> std::vector<long> <a class="code" href="classfaiss_1_1gpu_1_1IVFBase.html#a4a4ed220b9433aa788ed32db8f20a9db">getListIndices</a>(<span class="keywordtype">int</span> listId) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">protected</span>:<span class="comment"></span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> /// Reclaim memory consumed on the device for our inverted lists</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> /// `exact` means we trim exactly to the memory needed</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"></span> <span class="keywordtype">size_t</span> <a class="code" href="classfaiss_1_1gpu_1_1IVFBase.html#aa02d69306544294521e79be7f81a21cb">reclaimMemory_</a>(<span class="keywordtype">bool</span> exact);</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"></span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> /// Update all device-side list pointer and size information</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classfaiss_1_1gpu_1_1IVFBase.html#acc695610c9513952b8d234dc0db78e5c">updateDeviceListInfo_</a>(cudaStream_t stream);</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"> /// For a set of list IDs, update device-side list pointer and size</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> /// information</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_1IVFBase.html#acc695610c9513952b8d234dc0db78e5c">updateDeviceListInfo_</a>(<span class="keyword">const</span> std::vector<int>& listIds,</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  cudaStream_t stream);</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"></span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> /// Shared function to copy indices from CPU to GPU</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classfaiss_1_1gpu_1_1IVFBase.html#a5027720549de98f4e609d6339099df35">addIndicesFromCpu_</a>(<span class="keywordtype">int</span> listId,</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keyword">const</span> <span class="keywordtype">long</span>* indices,</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordtype">size_t</span> numVecs);</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keyword">protected</span>:<span class="comment"></span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> /// Collection of GPU resources that we use</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1IVFBase.html#a05e6400358ec1f529a67209d3f24cc63"> 82</a></span> <span class="comment"></span> <a class="code" href="classfaiss_1_1gpu_1_1GpuResources.html">GpuResources</a>* <a class="code" href="classfaiss_1_1gpu_1_1IVFBase.html#a05e6400358ec1f529a67209d3f24cc63">resources_</a>;</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"></span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"> /// Quantizer object</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1IVFBase.html#a878114abdba07c9cf7735f9c0ed594c3"> 85</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_1IVFBase.html#a878114abdba07c9cf7735f9c0ed594c3">quantizer_</a>;</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"></span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> /// Expected dimensionality of the vectors</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1IVFBase.html#aba3e3cfa469e5187f2d553fff10e0250"> 88</a></span> <span class="comment"></span> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="classfaiss_1_1gpu_1_1IVFBase.html#aba3e3cfa469e5187f2d553fff10e0250">dim_</a>;</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"></span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> /// Number of inverted lists we maintain</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1IVFBase.html#accc4d96c14643e5f471220cb1e92ac70"> 91</a></span> <span class="comment"></span> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="classfaiss_1_1gpu_1_1IVFBase.html#accc4d96c14643e5f471220cb1e92ac70">numLists_</a>;</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"></span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> /// Number of bytes per vector in the list</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1IVFBase.html#a319568b832518392fed33ea4f8bfc613"> 94</a></span> <span class="comment"></span> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="classfaiss_1_1gpu_1_1IVFBase.html#a319568b832518392fed33ea4f8bfc613">bytesPerVector_</a>;</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"></span></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"> /// How are user indices stored on the GPU?</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1IVFBase.html#afb6d10e23d6448c10f472b9234e0bcab"> 97</a></span> <span class="comment"></span> <span class="keyword">const</span> IndicesOptions <a class="code" href="classfaiss_1_1gpu_1_1IVFBase.html#afb6d10e23d6448c10f472b9234e0bcab">indicesOptions_</a>;</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"></span></div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> /// What memory space our inverted list storage is in</span></div>
<div class="line"><a name="l00100"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1IVFBase.html#a30499eb61763df72cab25ea9d1235251"> 100</a></span> <span class="comment"></span> <span class="keyword">const</span> MemorySpace <a class="code" href="classfaiss_1_1gpu_1_1IVFBase.html#a30499eb61763df72cab25ea9d1235251">space_</a>;</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"></span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> /// Device representation of all inverted list data</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> /// id -> data</span></div>
<div class="line"><a name="l00104"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1IVFBase.html#a96240a08b42bd1913e2286d7d514fc56"> 104</a></span> <span class="comment"></span> thrust::device_vector<void*> <a class="code" href="classfaiss_1_1gpu_1_1IVFBase.html#a96240a08b42bd1913e2286d7d514fc56">deviceListDataPointers_</a>;</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"></span></div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> /// Device representation of all inverted list index pointers</span></div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> /// id -> data</span></div>
<div class="line"><a name="l00108"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1IVFBase.html#a9aedcf0e6a20b908980ae96d73461f4c"> 108</a></span> <span class="comment"></span> thrust::device_vector<void*> <a class="code" href="classfaiss_1_1gpu_1_1IVFBase.html#a9aedcf0e6a20b908980ae96d73461f4c">deviceListIndexPointers_</a>;</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"></span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> /// Device representation of all inverted list lengths</span></div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> /// id -> length</span></div>
<div class="line"><a name="l00112"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1IVFBase.html#a3a1c2031a4763f7d55bc8a400c63af66"> 112</a></span> <span class="comment"></span> thrust::device_vector<int> <a class="code" href="classfaiss_1_1gpu_1_1IVFBase.html#a3a1c2031a4763f7d55bc8a400c63af66">deviceListLengths_</a>;</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"></span></div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment"> /// Maximum list length seen</span></div>
<div class="line"><a name="l00115"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1IVFBase.html#ae25ea0901fb628844868413f51c85bda"> 115</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="classfaiss_1_1gpu_1_1IVFBase.html#ae25ea0901fb628844868413f51c85bda">maxListLength_</a>;</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"></span></div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> /// Device memory for each separate list, as managed by the host.</span></div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> /// Device memory as stored in DeviceVector is stored as unique_ptr</span></div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> /// since deviceListSummary_ pointers must remain valid despite</span></div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> /// resizing of deviceLists_</span></div>
<div class="line"><a name="l00121"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1IVFBase.html#a2facc7285107de1f24d3471cbcf15f26"> 121</a></span> <span class="comment"></span> std::vector<std::unique_ptr<DeviceVector<unsigned char>>> <a class="code" href="classfaiss_1_1gpu_1_1IVFBase.html#a2facc7285107de1f24d3471cbcf15f26">deviceListData_</a>;</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  std::vector<std::unique_ptr<DeviceVector<unsigned char>>> deviceListIndices_;</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"></span></div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> /// If we are storing indices on the CPU (indicesOptions_ is</span></div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> /// INDICES_CPU), then this maintains a CPU-side map of what</span></div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> /// (inverted list id, offset) maps to which user index</span></div>
<div class="line"><a name="l00127"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1IVFBase.html#a53f3c382a79b7f89630a85dfbc3a1fed"> 127</a></span> <span class="comment"></span> std::vector<std::vector<long>> <a class="code" href="classfaiss_1_1gpu_1_1IVFBase.html#a53f3c382a79b7f89630a85dfbc3a1fed">listOffsetToUserIndex_</a>;</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> };</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> } } <span class="comment">// namespace</span></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1IVFBase_html_accc4d96c14643e5f471220cb1e92ac70"><div class="ttname"><a href="classfaiss_1_1gpu_1_1IVFBase.html#accc4d96c14643e5f471220cb1e92ac70">faiss::gpu::IVFBase::numLists_</a></div><div class="ttdeci">const int numLists_</div><div class="ttdoc">Number of inverted lists we maintain. </div><div class="ttdef"><b>Definition:</b> <a href="IVFBase_8cuh_source.html#l00091">IVFBase.cuh:91</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1IVFBase_html_ae25ea0901fb628844868413f51c85bda"><div class="ttname"><a href="classfaiss_1_1gpu_1_1IVFBase.html#ae25ea0901fb628844868413f51c85bda">faiss::gpu::IVFBase::maxListLength_</a></div><div class="ttdeci">int maxListLength_</div><div class="ttdoc">Maximum list length seen. </div><div class="ttdef"><b>Definition:</b> <a href="IVFBase_8cuh_source.html#l00115">IVFBase.cuh:115</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1IVFBase_html_a80130acfe0a2a4d387a5c9ee4c386b9c"><div class="ttname"><a href="classfaiss_1_1gpu_1_1IVFBase.html#a80130acfe0a2a4d387a5c9ee4c386b9c">faiss::gpu::IVFBase::IVFBase</a></div><div class="ttdeci">IVFBase(GpuResources *resources, FlatIndex *quantizer, int bytesPerVector, IndicesOptions indicesOptions, MemorySpace space)</div><div class="ttdef"><b>Definition:</b> <a href="IVFBase_8cu_source.html#l00025">IVFBase.cu:25</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1IVFBase_html_a53f3c382a79b7f89630a85dfbc3a1fed"><div class="ttname"><a href="classfaiss_1_1gpu_1_1IVFBase.html#a53f3c382a79b7f89630a85dfbc3a1fed">faiss::gpu::IVFBase::listOffsetToUserIndex_</a></div><div class="ttdeci">std::vector< std::vector< long > > listOffsetToUserIndex_</div><div class="ttdef"><b>Definition:</b> <a href="IVFBase_8cuh_source.html#l00127">IVFBase.cuh:127</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_1IVFBase_html_a4d44e8aebc380b7c846a8d8e6e835540"><div class="ttname"><a href="classfaiss_1_1gpu_1_1IVFBase.html#a4d44e8aebc380b7c846a8d8e6e835540">faiss::gpu::IVFBase::getDim</a></div><div class="ttdeci">int getDim() const </div><div class="ttdoc">Return the number of dimensions we are indexing. </div><div class="ttdef"><b>Definition:</b> <a href="IVFBase_8cu_source.html#l00100">IVFBase.cu:100</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1IVFBase_html_a7b1ee21f9919fb077db5e48e91943582"><div class="ttname"><a href="classfaiss_1_1gpu_1_1IVFBase.html#a7b1ee21f9919fb077db5e48e91943582">faiss::gpu::IVFBase::getListLength</a></div><div class="ttdeci">int getListLength(int listId) const </div><div class="ttdef"><b>Definition:</b> <a href="IVFBase_8cu_source.html#l00200">IVFBase.cu:200</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1IVFBase_html_a02e1e2d080ee31bf7835f89b9f2a13a9"><div class="ttname"><a href="classfaiss_1_1gpu_1_1IVFBase.html#a02e1e2d080ee31bf7835f89b9f2a13a9">faiss::gpu::IVFBase::reserveMemory</a></div><div class="ttdeci">void reserveMemory(size_t numVecs)</div><div class="ttdoc">Reserve GPU memory in our inverted lists for this number of vectors. </div><div class="ttdef"><b>Definition:</b> <a href="IVFBase_8cu_source.html#l00045">IVFBase.cu:45</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1IVFBase_html_aa02d69306544294521e79be7f81a21cb"><div class="ttname"><a href="classfaiss_1_1gpu_1_1IVFBase.html#aa02d69306544294521e79be7f81a21cb">faiss::gpu::IVFBase::reclaimMemory_</a></div><div class="ttdeci">size_t reclaimMemory_(bool exact)</div><div class="ttdef"><b>Definition:</b> <a href="IVFBase_8cu_source.html#l00111">IVFBase.cu:111</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1IVFBase_html"><div class="ttname"><a href="classfaiss_1_1gpu_1_1IVFBase.html">faiss::gpu::IVFBase</a></div><div class="ttdoc">Base inverted list functionality for IVFFlat and IVFPQ. </div><div class="ttdef"><b>Definition:</b> <a href="IVFBase_8cuh_source.html#l00027">IVFBase.cuh:27</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_1IVFBase_html_a3a1c2031a4763f7d55bc8a400c63af66"><div class="ttname"><a href="classfaiss_1_1gpu_1_1IVFBase.html#a3a1c2031a4763f7d55bc8a400c63af66">faiss::gpu::IVFBase::deviceListLengths_</a></div><div class="ttdeci">thrust::device_vector< int > deviceListLengths_</div><div class="ttdef"><b>Definition:</b> <a href="IVFBase_8cuh_source.html#l00112">IVFBase.cuh:112</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1IVFBase_html_a9aedcf0e6a20b908980ae96d73461f4c"><div class="ttname"><a href="classfaiss_1_1gpu_1_1IVFBase.html#a9aedcf0e6a20b908980ae96d73461f4c">faiss::gpu::IVFBase::deviceListIndexPointers_</a></div><div class="ttdeci">thrust::device_vector< void * > deviceListIndexPointers_</div><div class="ttdef"><b>Definition:</b> <a href="IVFBase_8cuh_source.html#l00108">IVFBase.cuh:108</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1IVFBase_html_a878114abdba07c9cf7735f9c0ed594c3"><div class="ttname"><a href="classfaiss_1_1gpu_1_1IVFBase.html#a878114abdba07c9cf7735f9c0ed594c3">faiss::gpu::IVFBase::quantizer_</a></div><div class="ttdeci">FlatIndex * quantizer_</div><div class="ttdoc">Quantizer object. </div><div class="ttdef"><b>Definition:</b> <a href="IVFBase_8cuh_source.html#l00085">IVFBase.cuh:85</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1IVFBase_html_a96240a08b42bd1913e2286d7d514fc56"><div class="ttname"><a href="classfaiss_1_1gpu_1_1IVFBase.html#a96240a08b42bd1913e2286d7d514fc56">faiss::gpu::IVFBase::deviceListDataPointers_</a></div><div class="ttdeci">thrust::device_vector< void * > deviceListDataPointers_</div><div class="ttdef"><b>Definition:</b> <a href="IVFBase_8cuh_source.html#l00104">IVFBase.cuh:104</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1IVFBase_html_a7ea671876443c93436499ad581f16997"><div class="ttname"><a href="classfaiss_1_1gpu_1_1IVFBase.html#a7ea671876443c93436499ad581f16997">faiss::gpu::IVFBase::reset</a></div><div class="ttdeci">void reset()</div><div class="ttdef"><b>Definition:</b> <a href="IVFBase_8cu_source.html#l00075">IVFBase.cu:75</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1IVFBase_html_a05e6400358ec1f529a67209d3f24cc63"><div class="ttname"><a href="classfaiss_1_1gpu_1_1IVFBase.html#a05e6400358ec1f529a67209d3f24cc63">faiss::gpu::IVFBase::resources_</a></div><div class="ttdeci">GpuResources * resources_</div><div class="ttdoc">Collection of GPU resources that we use. </div><div class="ttdef"><b>Definition:</b> <a href="IVFBase_8cuh_source.html#l00082">IVFBase.cuh:82</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1IVFBase_html_a319568b832518392fed33ea4f8bfc613"><div class="ttname"><a href="classfaiss_1_1gpu_1_1IVFBase.html#a319568b832518392fed33ea4f8bfc613">faiss::gpu::IVFBase::bytesPerVector_</a></div><div class="ttdeci">const int bytesPerVector_</div><div class="ttdoc">Number of bytes per vector in the list. </div><div class="ttdef"><b>Definition:</b> <a href="IVFBase_8cuh_source.html#l00094">IVFBase.cuh:94</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1IVFBase_html_acc695610c9513952b8d234dc0db78e5c"><div class="ttname"><a href="classfaiss_1_1gpu_1_1IVFBase.html#acc695610c9513952b8d234dc0db78e5c">faiss::gpu::IVFBase::updateDeviceListInfo_</a></div><div class="ttdeci">void updateDeviceListInfo_(cudaStream_t stream)</div><div class="ttdoc">Update all device-side list pointer and size information. </div><div class="ttdef"><b>Definition:</b> <a href="IVFBase_8cu_source.html#l00138">IVFBase.cu:138</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1IVFBase_html_a4a4ed220b9433aa788ed32db8f20a9db"><div class="ttname"><a href="classfaiss_1_1gpu_1_1IVFBase.html#a4a4ed220b9433aa788ed32db8f20a9db">faiss::gpu::IVFBase::getListIndices</a></div><div class="ttdeci">std::vector< long > getListIndices(int listId) const </div><div class="ttdoc">Return the list indices of a particular list back to the CPU. </div><div class="ttdef"><b>Definition:</b> <a href="IVFBase_8cu_source.html#l00207">IVFBase.cu:207</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1IVFBase_html_afb6d10e23d6448c10f472b9234e0bcab"><div class="ttname"><a href="classfaiss_1_1gpu_1_1IVFBase.html#afb6d10e23d6448c10f472b9234e0bcab">faiss::gpu::IVFBase::indicesOptions_</a></div><div class="ttdeci">const IndicesOptions indicesOptions_</div><div class="ttdoc">How are user indices stored on the GPU? </div><div class="ttdef"><b>Definition:</b> <a href="IVFBase_8cuh_source.html#l00097">IVFBase.cuh:97</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1IVFBase_html_a30499eb61763df72cab25ea9d1235251"><div class="ttname"><a href="classfaiss_1_1gpu_1_1IVFBase.html#a30499eb61763df72cab25ea9d1235251">faiss::gpu::IVFBase::space_</a></div><div class="ttdeci">const MemorySpace space_</div><div class="ttdoc">What memory space our inverted list storage is in. </div><div class="ttdef"><b>Definition:</b> <a href="IVFBase_8cuh_source.html#l00100">IVFBase.cuh:100</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1IVFBase_html_a2facc7285107de1f24d3471cbcf15f26"><div class="ttname"><a href="classfaiss_1_1gpu_1_1IVFBase.html#a2facc7285107de1f24d3471cbcf15f26">faiss::gpu::IVFBase::deviceListData_</a></div><div class="ttdeci">std::vector< std::unique_ptr< DeviceVector< unsigned char > > > deviceListData_</div><div class="ttdef"><b>Definition:</b> <a href="IVFBase_8cuh_source.html#l00121">IVFBase.cuh:121</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1IVFBase_html_aba3e3cfa469e5187f2d553fff10e0250"><div class="ttname"><a href="classfaiss_1_1gpu_1_1IVFBase.html#aba3e3cfa469e5187f2d553fff10e0250">faiss::gpu::IVFBase::dim_</a></div><div class="ttdeci">const int dim_</div><div class="ttdoc">Expected dimensionality of the vectors. </div><div class="ttdef"><b>Definition:</b> <a href="IVFBase_8cuh_source.html#l00088">IVFBase.cuh:88</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1IVFBase_html_a5027720549de98f4e609d6339099df35"><div class="ttname"><a href="classfaiss_1_1gpu_1_1IVFBase.html#a5027720549de98f4e609d6339099df35">faiss::gpu::IVFBase::addIndicesFromCpu_</a></div><div class="ttdeci">void addIndicesFromCpu_(int listId, const long *indices, size_t numVecs)</div><div class="ttdoc">Shared function to copy indices from CPU to GPU. </div><div class="ttdef"><b>Definition:</b> <a href="IVFBase_8cu_source.html#l00245">IVFBase.cu:245</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1IVFBase_html_ac9b69e1b2582cb2c064b5fff60d31cc8"><div class="ttname"><a href="classfaiss_1_1gpu_1_1IVFBase.html#ac9b69e1b2582cb2c064b5fff60d31cc8">faiss::gpu::IVFBase::reclaimMemory</a></div><div class="ttdeci">size_t reclaimMemory()</div><div class="ttdef"><b>Definition:</b> <a href="IVFBase_8cu_source.html#l00105">IVFBase.cu:105</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1IVFBase_html_abd66dc9d32e6150b930d78f74d7dd2d7"><div class="ttname"><a href="classfaiss_1_1gpu_1_1IVFBase.html#abd66dc9d32e6150b930d78f74d7dd2d7">faiss::gpu::IVFBase::getNumLists</a></div><div class="ttdeci">size_t getNumLists() const </div><div class="ttdoc">Returns the number of inverted lists. </div><div class="ttdef"><b>Definition:</b> <a href="IVFBase_8cu_source.html#l00195">IVFBase.cu:195</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>