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
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
<!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/IndexIVF.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>
</div><!-- top -->
<!-- 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 class="header">
<div class="headertitle">
<div class="title">/data/users/matthijs/github_faiss/faiss/IndexIVF.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> <span class="comment">// -*- c++ -*-</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> </div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#ifndef FAISS_INDEX_IVF_H</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor"></span><span class="preprocessor">#define FAISS_INDEX_IVF_H</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <vector></span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include "Index.h"</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include "Clustering.h"</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include "Heap.h"</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> </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">namespace </span>faiss {</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"></span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">/** Encapsulates a quantizer object for the IndexIVF</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * The class isolates the fields that are independent of the storage</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> * of the lists (especially training)</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="structfaiss_1_1Level1Quantizer.html"> 32</a></span> <span class="keyword">struct </span><a class="code" href="structfaiss_1_1Level1Quantizer.html">Level1Quantizer</a> {</div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="structfaiss_1_1Level1Quantizer.html#a3cf99e2ee92b8558a066f821efab95d5"> 33</a></span>  <a class="code" href="structfaiss_1_1Index.html">Index</a> * <a class="code" href="structfaiss_1_1Level1Quantizer.html#a3cf99e2ee92b8558a066f821efab95d5">quantizer</a>; <span class="comment">///< quantizer that maps vectors to inverted lists</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="structfaiss_1_1Level1Quantizer.html#a1c4fc9d874d9492ee0ea27a5be388fa7"> 34</a></span> <span class="comment"></span> <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1Level1Quantizer.html#a1c4fc9d874d9492ee0ea27a5be388fa7">nlist</a>; <span class="comment">///< number of possible key values</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"></span><span class="comment"></span></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"> * = 0: use the quantizer as index in a kmeans training</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> * = 1: just pass on the training set to the train() of the quantizer</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> * = 2: kmeans training on a flat index + add the centroids to the quantizer</span></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"><a class="line" href="structfaiss_1_1Level1Quantizer.html#a1dcea762fc322fdcffe64f78994edea0"> 41</a></span>  <span class="keywordtype">char</span> <a class="code" href="structfaiss_1_1Level1Quantizer.html#a1dcea762fc322fdcffe64f78994edea0">quantizer_trains_alone</a>;</div>
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="structfaiss_1_1Level1Quantizer.html#ab688c629cd42122d73517078b87f483d"> 42</a></span>  <span class="keywordtype">bool</span> <a class="code" href="structfaiss_1_1Level1Quantizer.html#ab688c629cd42122d73517078b87f483d">own_fields</a>; <span class="comment">///< whether object owns the quantizer</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"></span></div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="structfaiss_1_1Level1Quantizer.html#abb7097ed40b15ba0af08af6d03608f72"> 44</a></span>  <a class="code" href="structfaiss_1_1ClusteringParameters.html">ClusteringParameters</a> <a class="code" href="structfaiss_1_1Level1Quantizer.html#abb7097ed40b15ba0af08af6d03608f72">cp</a>; <span class="comment">///< to override default clustering params</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="structfaiss_1_1Level1Quantizer.html#a45d29dd6a5c53789c08e5ceb3f63d989"> 45</a></span> <span class="comment"></span> <a class="code" href="structfaiss_1_1Index.html">Index</a> *<a class="code" href="structfaiss_1_1Level1Quantizer.html#a45d29dd6a5c53789c08e5ceb3f63d989">clustering_index</a>; <span class="comment">///< to override index used during clustering</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"></span><span class="comment"></span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> /// Trains the quantizer and calls train_residual to train sub-quantizers</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1Level1Quantizer.html#a0069a6ee1e32c2e0c1c7df9a95740dd4">train_q1</a> (<span class="keywordtype">size_t</span> n, <span class="keyword">const</span> <span class="keywordtype">float</span> *x, <span class="keywordtype">bool</span> verbose,</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="namespacefaiss.html#afd12191c638da74760ff397cf319752c">MetricType</a> metric_type);</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <a class="code" href="structfaiss_1_1Level1Quantizer.html">Level1Quantizer</a> (<a class="code" href="structfaiss_1_1Index.html">Index</a> * <a class="code" href="structfaiss_1_1Level1Quantizer.html#a3cf99e2ee92b8558a066f821efab95d5">quantizer</a>, <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1Level1Quantizer.html#a1c4fc9d874d9492ee0ea27a5be388fa7">nlist</a>);</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <a class="code" href="structfaiss_1_1Level1Quantizer.html">Level1Quantizer</a> ();</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  ~<a class="code" href="structfaiss_1_1Level1Quantizer.html">Level1Quantizer</a> ();</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> };</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"></span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment">/** Table of inverted lists</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> * multithreading rules:</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> * - concurrent read accesses are allowed</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> * - concurrent update accesses are allowed</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> * - for resize and add_entries, only concurrent access to different lists</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> * are allowed</span></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"><a class="line" href="structfaiss_1_1InvertedLists.html"> 67</a></span> <span class="keyword">struct </span><a class="code" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> {</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keyword">typedef</span> <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">Index::idx_t</a> idx_t;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="structfaiss_1_1InvertedLists.html#afaf8b7aa3e846aa4553f6aae67827ec8"> 70</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1InvertedLists.html#afaf8b7aa3e846aa4553f6aae67827ec8">nlist</a>; <span class="comment">///< number of possible key values</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="structfaiss_1_1InvertedLists.html#ae06049e4259edb47d443ef87bdedc744"> 71</a></span> <span class="comment"></span> <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1InvertedLists.html#ae06049e4259edb47d443ef87bdedc744">code_size</a>; <span class="comment">///< code size per vector in bytes</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"></span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <a class="code" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> (<span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1InvertedLists.html#afaf8b7aa3e846aa4553f6aae67827ec8">nlist</a>, <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1InvertedLists.html#ae06049e4259edb47d443ef87bdedc744">code_size</a>);</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="comment">/*************************</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> * Read only functions */</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"></span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> /// get the size of a list</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1InvertedLists.html#a9bd256053ee360473842105460fe285f">list_size</a>(<span class="keywordtype">size_t</span> list_no) <span class="keyword">const</span> = 0;</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"> /// @return codes size list_size * code_size</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keyword">const</span> uint8_t * <a class="code" href="structfaiss_1_1InvertedLists.html#a60b12f9efe940b617a8380adceef4032">get_codes</a> (<span class="keywordtype">size_t</span> list_no) <span class="keyword">const</span> = 0;</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"> /// @return ids size list_size</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keyword">const</span> idx_t * <a class="code" href="structfaiss_1_1InvertedLists.html#a3ab6b389d8d85c5fbf23889064df7e95">get_ids</a> (<span class="keywordtype">size_t</span> list_no) <span class="keyword">const</span> = 0;</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"> /// @return a single id in an inverted list</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"></span> <span class="keyword">virtual</span> idx_t <a class="code" href="structfaiss_1_1InvertedLists.html#a21b52cdb0601cd225bd7924932310876">get_single_id</a> (<span class="keywordtype">size_t</span> list_no, <span class="keywordtype">size_t</span> offset) <span class="keyword">const</span>;</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"> /// @return a single code in an inverted list</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keyword">const</span> uint8_t * <a class="code" href="structfaiss_1_1InvertedLists.html#afc2760bed7c210f2fad9b03109f561ee">get_single_code</a> (</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keywordtype">size_t</span> list_no, <span class="keywordtype">size_t</span> offset) <span class="keyword">const</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"> /// prepare the following lists (default does nothing)</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> /// a list can be -1 hence the signed long</span></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1InvertedLists.html#a4e62994e54a0834f130bb4ba09c16a9c">prefetch_lists</a> (<span class="keyword">const</span> <span class="keywordtype">long</span> *list_nos, <span class="keywordtype">int</span> <a class="code" href="structfaiss_1_1InvertedLists.html#afaf8b7aa3e846aa4553f6aae67827ec8">nlist</a>) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </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"> * writing functions */</span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"></span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> /// add one entry to an inverted list</span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1InvertedLists.html#acd3e36cc06fc49e02773e403a84dba95">add_entry</a> (<span class="keywordtype">size_t</span> list_no, idx_t theid,</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keyword">const</span> uint8_t *code);</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> add_entries (</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keywordtype">size_t</span> list_no, <span class="keywordtype">size_t</span> n_entry,</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="keyword">const</span> idx_t* ids, <span class="keyword">const</span> uint8_t *code) = 0;</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> </div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> update_entry (<span class="keywordtype">size_t</span> list_no, <span class="keywordtype">size_t</span> offset,</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  idx_t <span class="keywordtype">id</span>, <span class="keyword">const</span> uint8_t *code);</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> update_entries (<span class="keywordtype">size_t</span> list_no, <span class="keywordtype">size_t</span> offset, <span class="keywordtype">size_t</span> n_entry,</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keyword">const</span> idx_t *ids, <span class="keyword">const</span> uint8_t *code) = 0;</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> resize (<span class="keywordtype">size_t</span> list_no, <span class="keywordtype">size_t</span> new_size) = 0;</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> reset ();</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> </div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keyword">virtual</span> ~<a class="code" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> ();</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> };</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> </div>
<div class="line"><a name="l00123"></a><span class="lineno"><a class="line" href="structfaiss_1_1ArrayInvertedLists.html"> 123</a></span> <span class="keyword">struct </span><a class="code" href="structfaiss_1_1ArrayInvertedLists.html">ArrayInvertedLists</a>: <a class="code" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> {</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  std::vector < std::vector<uint8_t> > codes; <span class="comment">// binary codes, size nlist</span></div>
<div class="line"><a name="l00125"></a><span class="lineno"><a class="line" href="structfaiss_1_1ArrayInvertedLists.html#a48563a58d3bbfbb4334f3afdf2c9ba7a"> 125</a></span>  std::vector < std::vector<idx_t> > <a class="code" href="structfaiss_1_1ArrayInvertedLists.html#a48563a58d3bbfbb4334f3afdf2c9ba7a">ids</a>; <span class="comment">///< Inverted lists for indexes</span></div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"></span></div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <a class="code" href="structfaiss_1_1ArrayInvertedLists.html">ArrayInvertedLists</a> (<span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1InvertedLists.html#afaf8b7aa3e846aa4553f6aae67827ec8">nlist</a>, <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1InvertedLists.html#ae06049e4259edb47d443ef87bdedc744">code_size</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>  <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1ArrayInvertedLists.html#af43d3f5c5bd897205853b289603fb42b">list_size</a>(<span class="keywordtype">size_t</span> list_no) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  <span class="keyword">const</span> uint8_t * <a class="code" href="structfaiss_1_1ArrayInvertedLists.html#abf4ab66d09d8a1b707dddc77d0c2e8fc">get_codes</a> (<span class="keywordtype">size_t</span> list_no) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <span class="keyword">const</span> idx_t * <a class="code" href="structfaiss_1_1ArrayInvertedLists.html#abd59f7cf340d9c17eb6b402579e4010b">get_ids</a> (<span class="keywordtype">size_t</span> list_no) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <span class="keywordtype">size_t</span> add_entries (</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <span class="keywordtype">size_t</span> list_no, <span class="keywordtype">size_t</span> n_entry,</div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <span class="keyword">const</span> idx_t* <a class="code" href="structfaiss_1_1ArrayInvertedLists.html#a48563a58d3bbfbb4334f3afdf2c9ba7a">ids</a>, <span class="keyword">const</span> uint8_t *code) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> </div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="keywordtype">void</span> update_entries (<span class="keywordtype">size_t</span> list_no, <span class="keywordtype">size_t</span> offset, <span class="keywordtype">size_t</span> n_entry,</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  <span class="keyword">const</span> idx_t *<a class="code" href="structfaiss_1_1ArrayInvertedLists.html#a48563a58d3bbfbb4334f3afdf2c9ba7a">ids</a>, <span class="keyword">const</span> uint8_t *code) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> </div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <span class="keywordtype">void</span> resize (<span class="keywordtype">size_t</span> list_no, <span class="keywordtype">size_t</span> new_size) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> </div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <span class="keyword">virtual</span> ~<a class="code" href="structfaiss_1_1ArrayInvertedLists.html">ArrayInvertedLists</a> ();</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</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="comment"></span></div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment">/** Index based on a inverted file (IVF)</span></div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"> * In the inverted file, the quantizer (an Index instance) provides a</span></div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"> * quantization index for each vector to be added. The quantization</span></div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"> * index maps to a list (aka inverted list or posting list), where the</span></div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"> * id of the vector is stored.</span></div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"> * The inverted list object is required only after trainng. If none is</span></div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment"> * set externally, an ArrayInvertedLists is used automatically.</span></div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"> * At search time, the vector to be searched is also quantized, and</span></div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"> * only the list corresponding to the quantization index is</span></div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment"> * searched. This speeds up the search by making it</span></div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment"> * non-exhaustive. This can be relaxed using multi-probe search: a few</span></div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment"> * (nprobe) quantization indices are selected and several inverted</span></div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment"> * lists are visited.</span></div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment"> * Sub-classes implement a post-filtering of the index that refines</span></div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment"> * the distance estimation from the query to databse vectors.</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"><a class="line" href="structfaiss_1_1IndexIVF.html"> 166</a></span> <span class="keyword">struct </span><a class="code" href="structfaiss_1_1IndexIVF.html">IndexIVF</a>: <a class="code" href="structfaiss_1_1Index.html">Index</a>, <a class="code" href="structfaiss_1_1Level1Quantizer.html">Level1Quantizer</a> {<span class="comment"></span></div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment"> /// Acess to the actual data</span></div>
<div class="line"><a name="l00168"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexIVF.html#aa0e8fc5e04cbd8e0dde61f98bc7dd0bc"> 168</a></span> <span class="comment"></span> <a class="code" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> *<a class="code" href="structfaiss_1_1IndexIVF.html#aa0e8fc5e04cbd8e0dde61f98bc7dd0bc">invlists</a>;</div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  <span class="keywordtype">bool</span> own_invlists;</div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span> </div>
<div class="line"><a name="l00171"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexIVF.html#a46d1aeddb60643c5b3f096147c3e028f"> 171</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1IndexIVF.html#a46d1aeddb60643c5b3f096147c3e028f">code_size</a>; <span class="comment">///< code size per vector in bytes</span></div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment"></span></div>
<div class="line"><a name="l00173"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexIVF.html#affed235eadf27a13d753ee4d33a1dc58"> 173</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1IndexIVF.html#affed235eadf27a13d753ee4d33a1dc58">nprobe</a>; <span class="comment">///< number of probes at query time</span></div>
<div class="line"><a name="l00174"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexIVF.html#a7f2dd34f66f8770acba74a0a591fa4a8"> 174</a></span> <span class="comment"></span> <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1IndexIVF.html#a7f2dd34f66f8770acba74a0a591fa4a8">max_codes</a>; <span class="comment">///< max nb of codes to visit to do a query</span></div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment"></span><span class="comment"></span></div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment"> /// map for direct access to the elements. Enables reconstruct().</span></div>
<div class="line"><a name="l00177"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexIVF.html#aedd0c14b5654295b291638ec7f9f9517"> 177</a></span> <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="structfaiss_1_1IndexIVF.html#aedd0c14b5654295b291638ec7f9f9517">maintain_direct_map</a>;</div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  std::vector <long> direct_map;</div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="comment"></span></div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="comment"> /** The Inverted file takes a quantizer (an Index) on input,</span></div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment"> * which implements the function mapping a vector to a list</span></div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment"> * identifier. The pointer is borrowed: the quantizer should not</span></div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="comment"> * be deleted while the IndexIVF is in use.</span></div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  <a class="code" href="structfaiss_1_1IndexIVF.html">IndexIVF</a> (<a class="code" href="structfaiss_1_1Index.html">Index</a> * <a class="code" href="structfaiss_1_1Level1Quantizer.html#a3cf99e2ee92b8558a066f821efab95d5">quantizer</a>, <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1Index.html#a2a002388d2c081c2dbab8508dcefe73d">d</a>,</div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1Level1Quantizer.html#a1c4fc9d874d9492ee0ea27a5be388fa7">nlist</a>, <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1IndexIVF.html#a46d1aeddb60643c5b3f096147c3e028f">code_size</a>,</div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  <a class="code" href="namespacefaiss.html#afd12191c638da74760ff397cf319752c">MetricType</a> metric = METRIC_L2);</div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span> </div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVF.html#a47a3b7665e9d2be41c6d3b2e9144b73f">reset</a>() <span class="keyword">override</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"> /// Trains the quantizer and calls train_residual to train sub-quantizers</span></div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVF.html#a7a1d5eec194db0977b2318c6ed6a2b86">train</a>(<a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">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="l00193"></a><span class="lineno"> 193</span> <span class="comment"></span></div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="comment"> /// Quantizes x and calls add_with_key</span></div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVF.html#a821002a9d3a1a74dc8d6f6072eca4075">add</a>(<a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">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="l00196"></a><span class="lineno"> 196</span> <span class="comment"></span></div>
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment"> /// Sub-classes that encode the residuals can train their encoders here</span></div>
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="comment"> /// does nothing by default</span></div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVF.html#a567ef760fd09d09ce2ee4f4e6c2d7280">train_residual</a> (<a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> n, <span class="keyword">const</span> <span class="keywordtype">float</span> *x);</div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="comment"></span></div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="comment"> /** search a set of vectors, that are pre-quantized by the IVF</span></div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="comment"> * quantizer. Fill in the corresponding heaps with the query</span></div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="comment"> * results. search() calls this.</span></div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="comment"> * @param n nb of vectors to query</span></div>
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="comment"> * @param x query vectors, size nx * d</span></div>
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span> <span class="comment"> * @param assign coarse quantization indices, size nx * nprobe</span></div>
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="comment"> * @param centroid_dis</span></div>
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="comment"> * distances to coarse centroids, size nx * nprobe</span></div>
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="comment"> * @param distance</span></div>
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="comment"> * output distances, size n * k</span></div>
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="comment"> * @param labels output labels, size n * k</span></div>
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="comment"> * @param store_pairs store inv list index + inv list offset</span></div>
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="comment"> * instead in upper/lower 32 bit of result,</span></div>
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="comment"> * instead of ids (used for reranking).</span></div>
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVF.html#ae13fe9ff54a870ded3487c5c282ca566">search_preassigned</a> (<a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> n, <span class="keyword">const</span> <span class="keywordtype">float</span> *x, <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> k,</div>
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span>  <span class="keyword">const</span> <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> *<a class="code" href="structfaiss_1_1Index.html#a8bc5d8d1cd0dd7b34b3c98a9f76b4a9c">assign</a>,</div>
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span>  <span class="keyword">const</span> <span class="keywordtype">float</span> *centroid_dis,</div>
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span>  <span class="keywordtype">float</span> *distances, <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> *labels,</div>
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span>  <span class="keywordtype">bool</span> store_pairs) <span class="keyword">const</span> = 0;</div>
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="comment"></span></div>
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="comment"> /** assign the vectors, then call search_preassign */</span></div>
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVF.html#ae2fd47b7d52603659e269aa8f6abb613">search</a> (<a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> n, <span class="keyword">const</span> <span class="keywordtype">float</span> *x, <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> k,</div>
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span>  <span class="keywordtype">float</span> *distances, <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> *labels) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span> </div>
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span>  <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVF.html#a3b3270dcfa248dc30117644382a54e39">reconstruct</a> (<a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> key, <span class="keywordtype">float</span>* recons) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <span class="comment"></span></div>
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span> <span class="comment"> /** Reconstruct a subset of the indexed vectors.</span></div>
<div class="line"><a name="l00230"></a><span class="lineno"> 230</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <span class="comment"> * Overrides default implementation to bypass reconstruct() which requires</span></div>
<div class="line"><a name="l00232"></a><span class="lineno"> 232</span> <span class="comment"> * direct_map to be maintained.</span></div>
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="comment"> * @param i0 first vector to reconstruct</span></div>
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="comment"> * @param ni nb of vectors to reconstruct</span></div>
<div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="comment"> * @param recons output array of reconstructed vectors, size ni * d</span></div>
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span>  <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVF.html#a7cc286dfbd8bfd43ea4b22173e28231c">reconstruct_n</a>(<a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> i0, <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> ni, <span class="keywordtype">float</span>* recons) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span> <span class="comment"></span></div>
<div class="line"><a name="l00240"></a><span class="lineno"> 240</span> <span class="comment"> /** Similar to search, but also reconstructs the stored vectors (or an</span></div>
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="comment"> * approximation in the case of lossy coding) for the search results.</span></div>
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span> <span class="comment"> * Overrides default implementation to avoid having to maintain direct_map</span></div>
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span> <span class="comment"> * and instead fetch the code offsets through the `store_pairs` flag in</span></div>
<div class="line"><a name="l00245"></a><span class="lineno"> 245</span> <span class="comment"> * search_preassigned().</span></div>
<div class="line"><a name="l00246"></a><span class="lineno"> 246</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00247"></a><span class="lineno"> 247</span> <span class="comment"> * @param recons reconstructed vectors size (n, k, d)</span></div>
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00249"></a><span class="lineno"> 249</span>  <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVF.html#a77aec24920024a09f7661790d9534c10">search_and_reconstruct</a> (<a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> n, <span class="keyword">const</span> <span class="keywordtype">float</span> *x, <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> k,</div>
<div class="line"><a name="l00250"></a><span class="lineno"> 250</span>  <span class="keywordtype">float</span> *distances, <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> *labels,</div>
<div class="line"><a name="l00251"></a><span class="lineno"> 251</span>  <span class="keywordtype">float</span> *recons) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00252"></a><span class="lineno"> 252</span> <span class="comment"></span></div>
<div class="line"><a name="l00253"></a><span class="lineno"> 253</span> <span class="comment"> /** Reconstruct a vector given the location in terms of (inv list index +</span></div>
<div class="line"><a name="l00254"></a><span class="lineno"> 254</span> <span class="comment"> * inv list offset) instead of the id.</span></div>
<div class="line"><a name="l00255"></a><span class="lineno"> 255</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00256"></a><span class="lineno"> 256</span> <span class="comment"> * Useful for reconstructing when the direct_map is not maintained and</span></div>
<div class="line"><a name="l00257"></a><span class="lineno"> 257</span> <span class="comment"> * the inv list offset is computed by search_preassigned() with</span></div>
<div class="line"><a name="l00258"></a><span class="lineno"> 258</span> <span class="comment"> * `store_pairs` set.</span></div>
<div class="line"><a name="l00259"></a><span class="lineno"> 259</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00260"></a><span class="lineno"> 260</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVF.html#aac87273dafff2027d4bcf706e1c7d83f">reconstruct_from_offset</a> (<span class="keywordtype">long</span> list_no, <span class="keywordtype">long</span> offset,</div>
<div class="line"><a name="l00261"></a><span class="lineno"> 261</span>  <span class="keywordtype">float</span>* recons) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00262"></a><span class="lineno"> 262</span> </div>
<div class="line"><a name="l00263"></a><span class="lineno"> 263</span> <span class="comment"></span></div>
<div class="line"><a name="l00264"></a><span class="lineno"> 264</span> <span class="comment"> /// Dataset manipulation functions</span></div>
<div class="line"><a name="l00265"></a><span class="lineno"> 265</span> <span class="comment"></span></div>
<div class="line"><a name="l00266"></a><span class="lineno"> 266</span>  <span class="keywordtype">long</span> <a class="code" href="structfaiss_1_1IndexIVF.html#a545c275690fac76be8c1a4685b3c7b8e">remove_ids</a>(<span class="keyword">const</span> <a class="code" href="structfaiss_1_1IDSelector.html">IDSelector</a>& sel) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00267"></a><span class="lineno"> 267</span> <span class="comment"></span></div>
<div class="line"><a name="l00268"></a><span class="lineno"> 268</span> <span class="comment"> /** moves the entries from another dataset to self. On output,</span></div>
<div class="line"><a name="l00269"></a><span class="lineno"> 269</span> <span class="comment"> * other is empty. add_id is added to all moved ids (for</span></div>
<div class="line"><a name="l00270"></a><span class="lineno"> 270</span> <span class="comment"> * sequential ids, this would be this->ntotal */</span></div>
<div class="line"><a name="l00271"></a><span class="lineno"> 271</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVF.html#a0f22cc237c30c935df5b6560aecf8f01">merge_from</a> (<a class="code" href="structfaiss_1_1IndexIVF.html">IndexIVF</a> &other, <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> add_id);</div>
<div class="line"><a name="l00272"></a><span class="lineno"> 272</span> <span class="comment"></span></div>
<div class="line"><a name="l00273"></a><span class="lineno"> 273</span> <span class="comment"> /** copy a subset of the entries index to the other index</span></div>
<div class="line"><a name="l00274"></a><span class="lineno"> 274</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00275"></a><span class="lineno"> 275</span> <span class="comment"> * if subset_type == 0: copies ids in [a1, a2)</span></div>
<div class="line"><a name="l00276"></a><span class="lineno"> 276</span> <span class="comment"> * if subset_type == 1: copies ids if id % a1 == a2</span></div>
<div class="line"><a name="l00277"></a><span class="lineno"> 277</span> <span class="comment"> * if subset_type == 2: copies inverted lists such that a1</span></div>
<div class="line"><a name="l00278"></a><span class="lineno"> 278</span> <span class="comment"> * elements are left before and a2 elements are after</span></div>
<div class="line"><a name="l00279"></a><span class="lineno"> 279</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00280"></a><span class="lineno"> 280</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVF.html#a2fc63f9bbfe64e05106366465ece2187">copy_subset_to</a> (<a class="code" href="structfaiss_1_1IndexIVF.html">IndexIVF</a> & other, <span class="keywordtype">int</span> subset_type,</div>
<div class="line"><a name="l00281"></a><span class="lineno"> 281</span>  <span class="keywordtype">long</span> a1, <span class="keywordtype">long</span> a2) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00282"></a><span class="lineno"> 282</span> </div>
<div class="line"><a name="l00283"></a><span class="lineno"> 283</span>  ~<a class="code" href="structfaiss_1_1IndexIVF.html">IndexIVF</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00284"></a><span class="lineno"> 284</span> </div>
<div class="line"><a name="l00285"></a><span class="lineno"> 285</span>  <span class="keywordtype">size_t</span> get_list_size (<span class="keywordtype">size_t</span> list_no)<span class="keyword"> const</span></div>
<div class="line"><a name="l00286"></a><span class="lineno"> 286</span> <span class="keyword"> </span>{ <span class="keywordflow">return</span> <a class="code" href="structfaiss_1_1IndexIVF.html#aa0e8fc5e04cbd8e0dde61f98bc7dd0bc">invlists</a>-><a class="code" href="structfaiss_1_1InvertedLists.html#a9bd256053ee360473842105460fe285f">list_size</a>(list_no); }</div>
<div class="line"><a name="l00287"></a><span class="lineno"> 287</span> <span class="comment"></span></div>
<div class="line"><a name="l00288"></a><span class="lineno"> 288</span> <span class="comment"> /** intialize a direct map</span></div>
<div class="line"><a name="l00289"></a><span class="lineno"> 289</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00290"></a><span class="lineno"> 290</span> <span class="comment"> * @param new_maintain_direct_map if true, create a direct map,</span></div>
<div class="line"><a name="l00291"></a><span class="lineno"> 291</span> <span class="comment"> * else clear it</span></div>
<div class="line"><a name="l00292"></a><span class="lineno"> 292</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00293"></a><span class="lineno"> 293</span>  <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVF.html#a1c11ce77f459e2ab3e5d9a4c2263ad89">make_direct_map</a> (<span class="keywordtype">bool</span> new_maintain_direct_map=<span class="keyword">true</span>);</div>
<div class="line"><a name="l00294"></a><span class="lineno"> 294</span> <span class="comment"></span></div>
<div class="line"><a name="l00295"></a><span class="lineno"> 295</span> <span class="comment"> /// 1= perfectly balanced, >1: imbalanced</span></div>
<div class="line"><a name="l00296"></a><span class="lineno"> 296</span> <span class="comment"></span> <span class="keywordtype">double</span> <a class="code" href="structfaiss_1_1IndexIVF.html#aeab84d4edf2cf9747c923e1a8395d9f3">imbalance_factor</a> () <span class="keyword">const</span>;</div>
<div class="line"><a name="l00297"></a><span class="lineno"> 297</span> <span class="comment"></span></div>
<div class="line"><a name="l00298"></a><span class="lineno"> 298</span> <span class="comment"> /// display some stats about the inverted lists</span></div>
<div class="line"><a name="l00299"></a><span class="lineno"> 299</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVF.html#a513dfec3a250f08a9fdd18a24178e6bb">print_stats</a> () <span class="keyword">const</span>;</div>
<div class="line"><a name="l00300"></a><span class="lineno"> 300</span> </div>
<div class="line"><a name="l00301"></a><span class="lineno"> 301</span>  <span class="keywordtype">void</span> replace_invlists (<a class="code" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> *il, <span class="keywordtype">bool</span> own=<span class="keyword">false</span>);</div>
<div class="line"><a name="l00302"></a><span class="lineno"> 302</span> </div>
<div class="line"><a name="l00303"></a><span class="lineno"> 303</span>  <a class="code" href="structfaiss_1_1IndexIVF.html">IndexIVF</a> ();</div>
<div class="line"><a name="l00304"></a><span class="lineno"> 304</span> };</div>
<div class="line"><a name="l00305"></a><span class="lineno"> 305</span> </div>
<div class="line"><a name="l00306"></a><span class="lineno"> 306</span> </div>
<div class="line"><a name="l00307"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexIVFStats.html"> 307</a></span> <span class="keyword">struct </span><a class="code" href="structfaiss_1_1IndexIVFStats.html">IndexIVFStats</a> {</div>
<div class="line"><a name="l00308"></a><span class="lineno"> 308</span>  <span class="keywordtype">size_t</span> nq; <span class="comment">// nb of queries run</span></div>
<div class="line"><a name="l00309"></a><span class="lineno"> 309</span>  <span class="keywordtype">size_t</span> nlist; <span class="comment">// nb of inverted lists scanned</span></div>
<div class="line"><a name="l00310"></a><span class="lineno"> 310</span>  <span class="keywordtype">size_t</span> ndis; <span class="comment">// nb of distancs computed</span></div>
<div class="line"><a name="l00311"></a><span class="lineno"> 311</span> </div>
<div class="line"><a name="l00312"></a><span class="lineno"> 312</span>  <a class="code" href="structfaiss_1_1IndexIVFStats.html">IndexIVFStats</a> () {reset (); }</div>
<div class="line"><a name="l00313"></a><span class="lineno"> 313</span>  <span class="keywordtype">void</span> reset ();</div>
<div class="line"><a name="l00314"></a><span class="lineno"> 314</span> };</div>
<div class="line"><a name="l00315"></a><span class="lineno"> 315</span> </div>
<div class="line"><a name="l00316"></a><span class="lineno"> 316</span> <span class="comment">// global var that collects them all</span></div>
<div class="line"><a name="l00317"></a><span class="lineno"> 317</span> <span class="keyword">extern</span> <a class="code" href="structfaiss_1_1IndexIVFStats.html">IndexIVFStats</a> indexIVF_stats;</div>
<div class="line"><a name="l00318"></a><span class="lineno"> 318</span> </div>
<div class="line"><a name="l00319"></a><span class="lineno"> 319</span> </div>
<div class="line"><a name="l00320"></a><span class="lineno"> 320</span> </div>
<div class="line"><a name="l00321"></a><span class="lineno"> 321</span> } <span class="comment">// namespace faiss</span></div>
<div class="line"><a name="l00322"></a><span class="lineno"> 322</span> </div>
<div class="line"><a name="l00323"></a><span class="lineno"> 323</span> </div>
<div class="line"><a name="l00324"></a><span class="lineno"> 324</span> </div>
<div class="line"><a name="l00325"></a><span class="lineno"> 325</span> </div>
<div class="line"><a name="l00326"></a><span class="lineno"> 326</span> </div>
<div class="line"><a name="l00327"></a><span class="lineno"> 327</span> <span class="preprocessor">#endif</span></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_ae13fe9ff54a870ded3487c5c282ca566"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#ae13fe9ff54a870ded3487c5c282ca566">faiss::IndexIVF::search_preassigned</a></div><div class="ttdeci">virtual void search_preassigned(idx_t n, const float *x, idx_t k, const idx_t *assign, const float *centroid_dis, float *distances, idx_t *labels, bool store_pairs) const =0</div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html">faiss::IndexIVF</a></div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00166">IndexIVF.h:166</a></div></div>
<div class="ttc" id="structfaiss_1_1ArrayInvertedLists_html_abf4ab66d09d8a1b707dddc77d0c2e8fc"><div class="ttname"><a href="structfaiss_1_1ArrayInvertedLists.html#abf4ab66d09d8a1b707dddc77d0c2e8fc">faiss::ArrayInvertedLists::get_codes</a></div><div class="ttdeci">const uint8_t * get_codes(size_t list_no) const override</div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8cpp_source.html#l00185">IndexIVF.cpp:185</a></div></div>
<div class="ttc" id="structfaiss_1_1Level1Quantizer_html"><div class="ttname"><a href="structfaiss_1_1Level1Quantizer.html">faiss::Level1Quantizer</a></div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00032">IndexIVF.h:32</a></div></div>
<div class="ttc" id="structfaiss_1_1ArrayInvertedLists_html"><div class="ttname"><a href="structfaiss_1_1ArrayInvertedLists.html">faiss::ArrayInvertedLists</a></div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00123">IndexIVF.h:123</a></div></div>
<div class="ttc" id="structfaiss_1_1ArrayInvertedLists_html_abd59f7cf340d9c17eb6b402579e4010b"><div class="ttname"><a href="structfaiss_1_1ArrayInvertedLists.html#abd59f7cf340d9c17eb6b402579e4010b">faiss::ArrayInvertedLists::get_ids</a></div><div class="ttdeci">const idx_t * get_ids(size_t list_no) const override</div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8cpp_source.html#l00191">IndexIVF.cpp:191</a></div></div>
<div class="ttc" id="structfaiss_1_1InvertedLists_html_a3ab6b389d8d85c5fbf23889064df7e95"><div class="ttname"><a href="structfaiss_1_1InvertedLists.html#a3ab6b389d8d85c5fbf23889064df7e95">faiss::InvertedLists::get_ids</a></div><div class="ttdeci">virtual const idx_t * get_ids(size_t list_no) const =0</div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_aeab84d4edf2cf9747c923e1a8395d9f3"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#aeab84d4edf2cf9747c923e1a8395d9f3">faiss::IndexIVF::imbalance_factor</a></div><div class="ttdeci">double imbalance_factor() const </div><div class="ttdoc">1= perfectly balanced, &gt;1: imbalanced </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8cpp_source.html#l00447">IndexIVF.cpp:447</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_a77aec24920024a09f7661790d9534c10"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#a77aec24920024a09f7661790d9534c10">faiss::IndexIVF::search_and_reconstruct</a></div><div class="ttdeci">void search_and_reconstruct(idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons) const override</div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8cpp_source.html#l00332">IndexIVF.cpp:332</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_a2fc63f9bbfe64e05106366465ece2187"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#a2fc63f9bbfe64e05106366465ece2187">faiss::IndexIVF::copy_subset_to</a></div><div class="ttdeci">virtual void copy_subset_to(IndexIVF &other, int subset_type, long a1, long a2) const </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8cpp_source.html#l00527">IndexIVF.cpp:527</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_aac87273dafff2027d4bcf706e1c7d83f"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#aac87273dafff2027d4bcf706e1c7d83f">faiss::IndexIVF::reconstruct_from_offset</a></div><div class="ttdeci">virtual void reconstruct_from_offset(long list_no, long offset, float *recons) const </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8cpp_source.html#l00370">IndexIVF.cpp:370</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_affed235eadf27a13d753ee4d33a1dc58"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#affed235eadf27a13d753ee4d33a1dc58">faiss::IndexIVF::nprobe</a></div><div class="ttdeci">size_t nprobe</div><div class="ttdoc">number of probes at query time </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00173">IndexIVF.h:173</a></div></div>
<div class="ttc" id="structfaiss_1_1Index_html_a8bc5d8d1cd0dd7b34b3c98a9f76b4a9c"><div class="ttname"><a href="structfaiss_1_1Index.html#a8bc5d8d1cd0dd7b34b3c98a9f76b4a9c">faiss::Index::assign</a></div><div class="ttdeci">void assign(idx_t n, const float *x, idx_t *labels, idx_t k=1)</div><div class="ttdef"><b>Definition:</b> <a href="Index_8cpp_source.html#l00034">Index.cpp:34</a></div></div>
<div class="ttc" id="structfaiss_1_1IDSelector_html"><div class="ttname"><a href="structfaiss_1_1IDSelector.html">faiss::IDSelector</a></div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8h_source.html#l00052">AuxIndexStructures.h:52</a></div></div>
<div class="ttc" id="structfaiss_1_1InvertedLists_html_a9bd256053ee360473842105460fe285f"><div class="ttname"><a href="structfaiss_1_1InvertedLists.html#a9bd256053ee360473842105460fe285f">faiss::InvertedLists::list_size</a></div><div class="ttdeci">virtual size_t list_size(size_t list_no) const =0</div><div class="ttdoc">get the size of a list </div></div>
<div class="ttc" id="structfaiss_1_1IndexIVFStats_html"><div class="ttname"><a href="structfaiss_1_1IndexIVFStats.html">faiss::IndexIVFStats</a></div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00307">IndexIVF.h:307</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_a3b3270dcfa248dc30117644382a54e39"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#a3b3270dcfa248dc30117644382a54e39">faiss::IndexIVF::reconstruct</a></div><div class="ttdeci">void reconstruct(idx_t key, float *recons) const override</div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8cpp_source.html#l00301">IndexIVF.cpp:301</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_a567ef760fd09d09ce2ee4f4e6c2d7280"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#a567ef760fd09d09ce2ee4f4e6c2d7280">faiss::IndexIVF::train_residual</a></div><div class="ttdeci">virtual void train_residual(idx_t n, const float *x)</div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8cpp_source.html#l00439">IndexIVF.cpp:439</a></div></div>
<div class="ttc" id="structfaiss_1_1InvertedLists_html"><div class="ttname"><a href="structfaiss_1_1InvertedLists.html">faiss::InvertedLists</a></div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00067">IndexIVF.h:67</a></div></div>
<div class="ttc" id="structfaiss_1_1InvertedLists_html_a21b52cdb0601cd225bd7924932310876"><div class="ttname"><a href="structfaiss_1_1InvertedLists.html#a21b52cdb0601cd225bd7924932310876">faiss::InvertedLists::get_single_id</a></div><div class="ttdeci">virtual idx_t get_single_id(size_t list_no, size_t offset) const </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8cpp_source.html#l00118">IndexIVF.cpp:118</a></div></div>
<div class="ttc" id="structfaiss_1_1Index_html_a2a002388d2c081c2dbab8508dcefe73d"><div class="ttname"><a href="structfaiss_1_1Index.html#a2a002388d2c081c2dbab8508dcefe73d">faiss::Index::d</a></div><div class="ttdeci">int d</div><div class="ttdoc">vector dimension </div><div class="ttdef"><b>Definition:</b> <a href="Index_8h_source.html#l00064">Index.h:64</a></div></div>
<div class="ttc" id="structfaiss_1_1InvertedLists_html_ae06049e4259edb47d443ef87bdedc744"><div class="ttname"><a href="structfaiss_1_1InvertedLists.html#ae06049e4259edb47d443ef87bdedc744">faiss::InvertedLists::code_size</a></div><div class="ttdeci">size_t code_size</div><div class="ttdoc">code size per vector in bytes </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00071">IndexIVF.h:71</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_a7a1d5eec194db0977b2318c6ed6a2b86"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#a7a1d5eec194db0977b2318c6ed6a2b86">faiss::IndexIVF::train</a></div><div class="ttdeci">void train(idx_t n, const float *x) override</div><div class="ttdoc">Trains the quantizer and calls train_residual to train sub-quantizers. </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8cpp_source.html#l00424">IndexIVF.cpp:424</a></div></div>
<div class="ttc" id="structfaiss_1_1InvertedLists_html_afc2760bed7c210f2fad9b03109f561ee"><div class="ttname"><a href="structfaiss_1_1InvertedLists.html#afc2760bed7c210f2fad9b03109f561ee">faiss::InvertedLists::get_single_code</a></div><div class="ttdeci">virtual const uint8_t * get_single_code(size_t list_no, size_t offset) const </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8cpp_source.html#l00129">IndexIVF.cpp:129</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_a7cc286dfbd8bfd43ea4b22173e28231c"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#a7cc286dfbd8bfd43ea4b22173e28231c">faiss::IndexIVF::reconstruct_n</a></div><div class="ttdeci">void reconstruct_n(idx_t i0, idx_t ni, float *recons) const override</div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8cpp_source.html#l00311">IndexIVF.cpp:311</a></div></div>
<div class="ttc" id="structfaiss_1_1Level1Quantizer_html_a1dcea762fc322fdcffe64f78994edea0"><div class="ttname"><a href="structfaiss_1_1Level1Quantizer.html#a1dcea762fc322fdcffe64f78994edea0">faiss::Level1Quantizer::quantizer_trains_alone</a></div><div class="ttdeci">char quantizer_trains_alone</div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00041">IndexIVF.h:41</a></div></div>
<div class="ttc" id="structfaiss_1_1InvertedLists_html_acd3e36cc06fc49e02773e403a84dba95"><div class="ttname"><a href="structfaiss_1_1InvertedLists.html#acd3e36cc06fc49e02773e403a84dba95">faiss::InvertedLists::add_entry</a></div><div class="ttdeci">virtual size_t add_entry(size_t list_no, idx_t theid, const uint8_t *code)</div><div class="ttdoc">add one entry to an inverted list </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8cpp_source.html#l00136">IndexIVF.cpp:136</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="structfaiss_1_1Level1Quantizer_html_abb7097ed40b15ba0af08af6d03608f72"><div class="ttname"><a href="structfaiss_1_1Level1Quantizer.html#abb7097ed40b15ba0af08af6d03608f72">faiss::Level1Quantizer::cp</a></div><div class="ttdeci">ClusteringParameters cp</div><div class="ttdoc">to override default clustering params </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00044">IndexIVF.h:44</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_a47a3b7665e9d2be41c6d3b2e9144b73f"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#a47a3b7665e9d2be41c6d3b2e9144b73f">faiss::IndexIVF::reset</a></div><div class="ttdeci">void reset() override</div><div class="ttdoc">removes all elements from the database. </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8cpp_source.html#l00376">IndexIVF.cpp:376</a></div></div>
<div class="ttc" id="structfaiss_1_1InvertedLists_html_a4e62994e54a0834f130bb4ba09c16a9c"><div class="ttname"><a href="structfaiss_1_1InvertedLists.html#a4e62994e54a0834f130bb4ba09c16a9c">faiss::InvertedLists::prefetch_lists</a></div><div class="ttdeci">virtual void prefetch_lists(const long *list_nos, int nlist) const </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8cpp_source.html#l00126">IndexIVF.cpp:126</a></div></div>
<div class="ttc" id="structfaiss_1_1Level1Quantizer_html_a45d29dd6a5c53789c08e5ceb3f63d989"><div class="ttname"><a href="structfaiss_1_1Level1Quantizer.html#a45d29dd6a5c53789c08e5ceb3f63d989">faiss::Level1Quantizer::clustering_index</a></div><div class="ttdeci">Index * clustering_index</div><div class="ttdoc">to override index used during clustering </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00045">IndexIVF.h:45</a></div></div>
<div class="ttc" id="structfaiss_1_1Level1Quantizer_html_a0069a6ee1e32c2e0c1c7df9a95740dd4"><div class="ttname"><a href="structfaiss_1_1Level1Quantizer.html#a0069a6ee1e32c2e0c1c7df9a95740dd4">faiss::Level1Quantizer::train_q1</a></div><div class="ttdeci">void train_q1(size_t n, const float *x, bool verbose, MetricType metric_type)</div><div class="ttdoc">Trains the quantizer and calls train_residual to train sub-quantizers. </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8cpp_source.html#l00056">IndexIVF.cpp:56</a></div></div>
<div class="ttc" id="structfaiss_1_1InvertedLists_html_afaf8b7aa3e846aa4553f6aae67827ec8"><div class="ttname"><a href="structfaiss_1_1InvertedLists.html#afaf8b7aa3e846aa4553f6aae67827ec8">faiss::InvertedLists::nlist</a></div><div class="ttdeci">size_t nlist</div><div class="ttdoc">number of possible key values </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00070">IndexIVF.h:70</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_a1c11ce77f459e2ab3e5d9a4c2263ad89"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#a1c11ce77f459e2ab3e5d9a4c2263ad89">faiss::IndexIVF::make_direct_map</a></div><div class="ttdeci">void make_direct_map(bool new_maintain_direct_map=true)</div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8cpp_source.html#l00257">IndexIVF.cpp:257</a></div></div>
<div class="ttc" id="structfaiss_1_1ClusteringParameters_html"><div class="ttname"><a href="structfaiss_1_1ClusteringParameters.html">faiss::ClusteringParameters</a></div><div class="ttdef"><b>Definition:</b> <a href="Clustering_8h_source.html#l00024">Clustering.h:24</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_a513dfec3a250f08a9fdd18a24178e6bb"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#a513dfec3a250f08a9fdd18a24178e6bb">faiss::IndexIVF::print_stats</a></div><div class="ttdeci">void print_stats() const </div><div class="ttdoc">display some stats about the inverted lists </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8cpp_source.html#l00456">IndexIVF.cpp:456</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_aa0e8fc5e04cbd8e0dde61f98bc7dd0bc"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#aa0e8fc5e04cbd8e0dde61f98bc7dd0bc">faiss::IndexIVF::invlists</a></div><div class="ttdeci">InvertedLists * invlists</div><div class="ttdoc">Acess to the actual data. </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00168">IndexIVF.h:168</a></div></div>
<div class="ttc" id="structfaiss_1_1ArrayInvertedLists_html_a48563a58d3bbfbb4334f3afdf2c9ba7a"><div class="ttname"><a href="structfaiss_1_1ArrayInvertedLists.html#a48563a58d3bbfbb4334f3afdf2c9ba7a">faiss::ArrayInvertedLists::ids</a></div><div class="ttdeci">std::vector< std::vector< idx_t > > ids</div><div class="ttdoc">Inverted lists for indexes. </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00125">IndexIVF.h:125</a></div></div>
<div class="ttc" id="structfaiss_1_1Index_html"><div class="ttname"><a href="structfaiss_1_1Index.html">faiss::Index</a></div><div class="ttdef"><b>Definition:</b> <a href="Index_8h_source.html#l00060">Index.h:60</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_a821002a9d3a1a74dc8d6f6072eca4075"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#a821002a9d3a1a74dc8d6f6072eca4075">faiss::IndexIVF::add</a></div><div class="ttdeci">void add(idx_t n, const float *x) override</div><div class="ttdoc">Quantizes x and calls add_with_key. </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8cpp_source.html#l00252">IndexIVF.cpp:252</a></div></div>
<div class="ttc" id="structfaiss_1_1InvertedLists_html_a60b12f9efe940b617a8380adceef4032"><div class="ttname"><a href="structfaiss_1_1InvertedLists.html#a60b12f9efe940b617a8380adceef4032">faiss::InvertedLists::get_codes</a></div><div class="ttdeci">virtual const uint8_t * get_codes(size_t list_no) const =0</div></div>
<div class="ttc" id="structfaiss_1_1Level1Quantizer_html_a3cf99e2ee92b8558a066f821efab95d5"><div class="ttname"><a href="structfaiss_1_1Level1Quantizer.html#a3cf99e2ee92b8558a066f821efab95d5">faiss::Level1Quantizer::quantizer</a></div><div class="ttdeci">Index * quantizer</div><div class="ttdoc">quantizer that maps vectors to inverted lists </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00033">IndexIVF.h:33</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_a545c275690fac76be8c1a4685b3c7b8e"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#a545c275690fac76be8c1a4685b3c7b8e">faiss::IndexIVF::remove_ids</a></div><div class="ttdeci">long remove_ids(const IDSelector &sel) override</div><div class="ttdoc">Dataset manipulation functions. </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8cpp_source.html#l00384">IndexIVF.cpp:384</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_a7f2dd34f66f8770acba74a0a591fa4a8"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#a7f2dd34f66f8770acba74a0a591fa4a8">faiss::IndexIVF::max_codes</a></div><div class="ttdeci">size_t max_codes</div><div class="ttdoc">max nb of codes to visit to do a query </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00174">IndexIVF.h:174</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_aedd0c14b5654295b291638ec7f9f9517"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#aedd0c14b5654295b291638ec7f9f9517">faiss::IndexIVF::maintain_direct_map</a></div><div class="ttdeci">bool maintain_direct_map</div><div class="ttdoc">map for direct access to the elements. Enables reconstruct(). </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00177">IndexIVF.h:177</a></div></div>
<div class="ttc" id="structfaiss_1_1Level1Quantizer_html_ab688c629cd42122d73517078b87f483d"><div class="ttname"><a href="structfaiss_1_1Level1Quantizer.html#ab688c629cd42122d73517078b87f483d">faiss::Level1Quantizer::own_fields</a></div><div class="ttdeci">bool own_fields</div><div class="ttdoc">whether object owns the quantizer </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00042">IndexIVF.h:42</a></div></div>
<div class="ttc" id="structfaiss_1_1ArrayInvertedLists_html_af43d3f5c5bd897205853b289603fb42b"><div class="ttname"><a href="structfaiss_1_1ArrayInvertedLists.html#af43d3f5c5bd897205853b289603fb42b">faiss::ArrayInvertedLists::list_size</a></div><div class="ttdeci">size_t list_size(size_t list_no) const override</div><div class="ttdoc">get the size of a list </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8cpp_source.html#l00179">IndexIVF.cpp:179</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_ae2fd47b7d52603659e269aa8f6abb613"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#ae2fd47b7d52603659e269aa8f6abb613">faiss::IndexIVF::search</a></div><div class="ttdeci">virtual void search(idx_t n, const float *x, idx_t k, float *distances, idx_t *labels) const override</div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8cpp_source.html#l00283">IndexIVF.cpp:283</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_a0f22cc237c30c935df5b6560aecf8f01"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#a0f22cc237c30c935df5b6560aecf8f01">faiss::IndexIVF::merge_from</a></div><div class="ttdeci">virtual void merge_from(IndexIVF &other, idx_t add_id)</div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8cpp_source.html#l00476">IndexIVF.cpp:476</a></div></div>
<div class="ttc" id="structfaiss_1_1Level1Quantizer_html_a1c4fc9d874d9492ee0ea27a5be388fa7"><div class="ttname"><a href="structfaiss_1_1Level1Quantizer.html#a1c4fc9d874d9492ee0ea27a5be388fa7">faiss::Level1Quantizer::nlist</a></div><div class="ttdeci">size_t nlist</div><div class="ttdoc">number of possible key values </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00034">IndexIVF.h:34</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_a46d1aeddb60643c5b3f096147c3e028f"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#a46d1aeddb60643c5b3f096147c3e028f">faiss::IndexIVF::code_size</a></div><div class="ttdeci">size_t code_size</div><div class="ttdoc">code size per vector in bytes </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00171">IndexIVF.h:171</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><!-- 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>