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
<!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: faiss::MaskedInvertedLists Struct Reference</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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><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="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</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="namespacefaiss.html">faiss</a></li><li class="navelem"><a class="el" href="structfaiss_1_1MaskedInvertedLists.html">MaskedInvertedLists</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="structfaiss_1_1MaskedInvertedLists-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">faiss::MaskedInvertedLists Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="InvertedLists_8h_source.html">InvertedLists.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for faiss::MaskedInvertedLists:</div>
<div class="dyncontent">
<div class="center">
<img src="structfaiss_1_1MaskedInvertedLists.png" usemap="#faiss::MaskedInvertedLists_map" alt=""/>
<map id="faiss::MaskedInvertedLists_map" name="faiss::MaskedInvertedLists_map">
<area href="structfaiss_1_1ReadOnlyInvertedLists.html" alt="faiss::ReadOnlyInvertedLists" shape="rect" coords="0,56,171,80"/>
<area href="structfaiss_1_1InvertedLists.html" alt="faiss::InvertedLists" shape="rect" coords="0,0,171,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a5652627d0f311598a76c5f9ceea461c1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5652627d0f311598a76c5f9ceea461c1"></a>
 </td><td class="memItemRight" valign="bottom"><b>MaskedInvertedLists</b> (const <a class="el" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> *il0, const <a class="el" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> *il1)</td></tr>
<tr class="separator:a5652627d0f311598a76c5f9ceea461c1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5c400887da892a68ce47eff56e30dffc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5c400887da892a68ce47eff56e30dffc"></a>
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1MaskedInvertedLists.html#a5c400887da892a68ce47eff56e30dffc">list_size</a> (size_t list_no) const override</td></tr>
<tr class="memdesc:a5c400887da892a68ce47eff56e30dffc"><td class="mdescLeft"> </td><td class="mdescRight">get the size of a list <br/></td></tr>
<tr class="separator:a5c400887da892a68ce47eff56e30dffc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4376b14cd4e349d51848995c102659af"><td class="memItemLeft" align="right" valign="top">const uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1MaskedInvertedLists.html#a4376b14cd4e349d51848995c102659af">get_codes</a> (size_t list_no) const override</td></tr>
<tr class="separator:a4376b14cd4e349d51848995c102659af"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a924d45d2ab3809c728e7b02ec569b2ba"><td class="memItemLeft" align="right" valign="top">const idx_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1MaskedInvertedLists.html#a924d45d2ab3809c728e7b02ec569b2ba">get_ids</a> (size_t list_no) const override</td></tr>
<tr class="separator:a924d45d2ab3809c728e7b02ec569b2ba"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a64e66ef4c7dc387091f533cc61d88273"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a64e66ef4c7dc387091f533cc61d88273"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1MaskedInvertedLists.html#a64e66ef4c7dc387091f533cc61d88273">release_codes</a> (size_t list_no, const uint8_t *codes) const override</td></tr>
<tr class="memdesc:a64e66ef4c7dc387091f533cc61d88273"><td class="mdescLeft"> </td><td class="mdescRight">release codes returned by get_codes (default implementation is nop <br/></td></tr>
<tr class="separator:a64e66ef4c7dc387091f533cc61d88273"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a86c8d8c022c79c32b3f776f2ad4f3b1e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a86c8d8c022c79c32b3f776f2ad4f3b1e"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1MaskedInvertedLists.html#a86c8d8c022c79c32b3f776f2ad4f3b1e">release_ids</a> (size_t list_no, const idx_t *ids) const override</td></tr>
<tr class="memdesc:a86c8d8c022c79c32b3f776f2ad4f3b1e"><td class="mdescLeft"> </td><td class="mdescRight">release ids returned by get_ids <br/></td></tr>
<tr class="separator:a86c8d8c022c79c32b3f776f2ad4f3b1e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af0d9f7b61caef91e30124b0f7a9d44b9"><td class="memItemLeft" align="right" valign="top">idx_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1MaskedInvertedLists.html#af0d9f7b61caef91e30124b0f7a9d44b9">get_single_id</a> (size_t list_no, size_t offset) const override</td></tr>
<tr class="separator:af0d9f7b61caef91e30124b0f7a9d44b9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a429657c4c203d472f59147f301de0ede"><td class="memItemLeft" align="right" valign="top">const uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1MaskedInvertedLists.html#a429657c4c203d472f59147f301de0ede">get_single_code</a> (size_t list_no, size_t offset) const override</td></tr>
<tr class="separator:a429657c4c203d472f59147f301de0ede"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5fbd34b4052c314148c44f14b4d3c2d3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1MaskedInvertedLists.html#a5fbd34b4052c314148c44f14b4d3c2d3">prefetch_lists</a> (const idx_t *list_nos, int <a class="el" href="structfaiss_1_1InvertedLists.html#afaf8b7aa3e846aa4553f6aae67827ec8">nlist</a>) const override</td></tr>
<tr class="separator:a5fbd34b4052c314148c44f14b4d3c2d3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_structfaiss_1_1ReadOnlyInvertedLists"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structfaiss_1_1ReadOnlyInvertedLists')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="structfaiss_1_1ReadOnlyInvertedLists.html">faiss::ReadOnlyInvertedLists</a></td></tr>
<tr class="memitem:a38b8814659bc9dd48a96191aa3f1b01c inherit pub_methods_structfaiss_1_1ReadOnlyInvertedLists"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a38b8814659bc9dd48a96191aa3f1b01c"></a>
 </td><td class="memItemRight" valign="bottom"><b>ReadOnlyInvertedLists</b> (size_t <a class="el" href="structfaiss_1_1InvertedLists.html#afaf8b7aa3e846aa4553f6aae67827ec8">nlist</a>, size_t <a class="el" href="structfaiss_1_1InvertedLists.html#ae06049e4259edb47d443ef87bdedc744">code_size</a>)</td></tr>
<tr class="separator:a38b8814659bc9dd48a96191aa3f1b01c inherit pub_methods_structfaiss_1_1ReadOnlyInvertedLists"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0734538244d8c5969e3e23e38faf1c0c inherit pub_methods_structfaiss_1_1ReadOnlyInvertedLists"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0734538244d8c5969e3e23e38faf1c0c"></a>
size_t </td><td class="memItemRight" valign="bottom"><b>add_entries</b> (size_t list_no, size_t n_entry, const idx_t *ids, const uint8_t *code) override</td></tr>
<tr class="separator:a0734538244d8c5969e3e23e38faf1c0c inherit pub_methods_structfaiss_1_1ReadOnlyInvertedLists"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a33c3a5174bcf6709dcefec8bdc4b9a52 inherit pub_methods_structfaiss_1_1ReadOnlyInvertedLists"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a33c3a5174bcf6709dcefec8bdc4b9a52"></a>
void </td><td class="memItemRight" valign="bottom"><b>update_entries</b> (size_t list_no, size_t offset, size_t n_entry, const idx_t *ids, const uint8_t *code) override</td></tr>
<tr class="separator:a33c3a5174bcf6709dcefec8bdc4b9a52 inherit pub_methods_structfaiss_1_1ReadOnlyInvertedLists"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7b65c76388ba2fbc17a7060f6cf87039 inherit pub_methods_structfaiss_1_1ReadOnlyInvertedLists"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7b65c76388ba2fbc17a7060f6cf87039"></a>
void </td><td class="memItemRight" valign="bottom"><b>resize</b> (size_t list_no, size_t new_size) override</td></tr>
<tr class="separator:a7b65c76388ba2fbc17a7060f6cf87039 inherit pub_methods_structfaiss_1_1ReadOnlyInvertedLists"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_structfaiss_1_1InvertedLists"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structfaiss_1_1InvertedLists')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="structfaiss_1_1InvertedLists.html">faiss::InvertedLists</a></td></tr>
<tr class="memitem:a83d053d03720d938dc4fc4e2f674619c inherit pub_methods_structfaiss_1_1InvertedLists"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a83d053d03720d938dc4fc4e2f674619c"></a>
 </td><td class="memItemRight" valign="bottom"><b>InvertedLists</b> (size_t <a class="el" href="structfaiss_1_1InvertedLists.html#afaf8b7aa3e846aa4553f6aae67827ec8">nlist</a>, size_t <a class="el" href="structfaiss_1_1InvertedLists.html#ae06049e4259edb47d443ef87bdedc744">code_size</a>)</td></tr>
<tr class="separator:a83d053d03720d938dc4fc4e2f674619c inherit pub_methods_structfaiss_1_1InvertedLists"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acd3e36cc06fc49e02773e403a84dba95 inherit pub_methods_structfaiss_1_1InvertedLists"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acd3e36cc06fc49e02773e403a84dba95"></a>
virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1InvertedLists.html#acd3e36cc06fc49e02773e403a84dba95">add_entry</a> (size_t list_no, idx_t theid, const uint8_t *code)</td></tr>
<tr class="memdesc:acd3e36cc06fc49e02773e403a84dba95 inherit pub_methods_structfaiss_1_1InvertedLists"><td class="mdescLeft"> </td><td class="mdescRight">add one entry to an inverted list <br/></td></tr>
<tr class="separator:acd3e36cc06fc49e02773e403a84dba95 inherit pub_methods_structfaiss_1_1InvertedLists"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a57e1382949b91f77acc46790b6431056 inherit pub_methods_structfaiss_1_1InvertedLists"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a57e1382949b91f77acc46790b6431056"></a>
virtual void </td><td class="memItemRight" valign="bottom"><b>update_entry</b> (size_t list_no, size_t offset, idx_t id, const uint8_t *code)</td></tr>
<tr class="separator:a57e1382949b91f77acc46790b6431056 inherit pub_methods_structfaiss_1_1InvertedLists"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a72e736253a669dad5f6e5188168e5c60 inherit pub_methods_structfaiss_1_1InvertedLists"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a72e736253a669dad5f6e5188168e5c60"></a>
virtual void </td><td class="memItemRight" valign="bottom"><b>reset</b> ()</td></tr>
<tr class="separator:a72e736253a669dad5f6e5188168e5c60 inherit pub_methods_structfaiss_1_1InvertedLists"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac2a0686121ef5bdd6eb70f7eb3cf9b3a inherit pub_methods_structfaiss_1_1InvertedLists"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac2a0686121ef5bdd6eb70f7eb3cf9b3a"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1InvertedLists.html#ac2a0686121ef5bdd6eb70f7eb3cf9b3a">merge_from</a> (<a class="el" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> *oivf, size_t add_id)</td></tr>
<tr class="memdesc:ac2a0686121ef5bdd6eb70f7eb3cf9b3a inherit pub_methods_structfaiss_1_1InvertedLists"><td class="mdescLeft"> </td><td class="mdescRight">move all entries from oivf (empty on output) <br/></td></tr>
<tr class="separator:ac2a0686121ef5bdd6eb70f7eb3cf9b3a inherit pub_methods_structfaiss_1_1InvertedLists"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aacf34f6cf392771fe2e68210cd4e009b inherit pub_methods_structfaiss_1_1InvertedLists"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aacf34f6cf392771fe2e68210cd4e009b"></a>
double </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1InvertedLists.html#aacf34f6cf392771fe2e68210cd4e009b">imbalance_factor</a> () const </td></tr>
<tr class="memdesc:aacf34f6cf392771fe2e68210cd4e009b inherit pub_methods_structfaiss_1_1InvertedLists"><td class="mdescLeft"> </td><td class="mdescRight">1= perfectly balanced, >1: imbalanced <br/></td></tr>
<tr class="separator:aacf34f6cf392771fe2e68210cd4e009b inherit pub_methods_structfaiss_1_1InvertedLists"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a156de8be4b21a0dfa9a48a3918a0b5c3 inherit pub_methods_structfaiss_1_1InvertedLists"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a156de8be4b21a0dfa9a48a3918a0b5c3"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1InvertedLists.html#a156de8be4b21a0dfa9a48a3918a0b5c3">print_stats</a> () const </td></tr>
<tr class="memdesc:a156de8be4b21a0dfa9a48a3918a0b5c3 inherit pub_methods_structfaiss_1_1InvertedLists"><td class="mdescLeft"> </td><td class="mdescRight">display some stats about the inverted lists <br/></td></tr>
<tr class="separator:a156de8be4b21a0dfa9a48a3918a0b5c3 inherit pub_methods_structfaiss_1_1InvertedLists"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a722eef5a0e5bf5dcf78228a903e16af9 inherit pub_methods_structfaiss_1_1InvertedLists"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a722eef5a0e5bf5dcf78228a903e16af9"></a>
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1InvertedLists.html#a722eef5a0e5bf5dcf78228a903e16af9">compute_ntotal</a> () const </td></tr>
<tr class="memdesc:a722eef5a0e5bf5dcf78228a903e16af9 inherit pub_methods_structfaiss_1_1InvertedLists"><td class="mdescLeft"> </td><td class="mdescRight">sum up list sizes <br/></td></tr>
<tr class="separator:a722eef5a0e5bf5dcf78228a903e16af9 inherit pub_methods_structfaiss_1_1InvertedLists"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a7937835c69804149d23d532364e344ae"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7937835c69804149d23d532364e344ae"></a>
const <a class="el" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> * </td><td class="memItemRight" valign="bottom"><b>il0</b></td></tr>
<tr class="separator:a7937835c69804149d23d532364e344ae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a22ff765ca2af7d001da3dbcc1605a4e2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a22ff765ca2af7d001da3dbcc1605a4e2"></a>
const <a class="el" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> * </td><td class="memItemRight" valign="bottom"><b>il1</b></td></tr>
<tr class="separator:a22ff765ca2af7d001da3dbcc1605a4e2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_attribs_structfaiss_1_1InvertedLists"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_structfaiss_1_1InvertedLists')"><img src="closed.png" alt="-"/> Public Attributes inherited from <a class="el" href="structfaiss_1_1InvertedLists.html">faiss::InvertedLists</a></td></tr>
<tr class="memitem:afaf8b7aa3e846aa4553f6aae67827ec8 inherit pub_attribs_structfaiss_1_1InvertedLists"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afaf8b7aa3e846aa4553f6aae67827ec8"></a>
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1InvertedLists.html#afaf8b7aa3e846aa4553f6aae67827ec8">nlist</a></td></tr>
<tr class="memdesc:afaf8b7aa3e846aa4553f6aae67827ec8 inherit pub_attribs_structfaiss_1_1InvertedLists"><td class="mdescLeft"> </td><td class="mdescRight">number of possible key values <br/></td></tr>
<tr class="separator:afaf8b7aa3e846aa4553f6aae67827ec8 inherit pub_attribs_structfaiss_1_1InvertedLists"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae06049e4259edb47d443ef87bdedc744 inherit pub_attribs_structfaiss_1_1InvertedLists"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae06049e4259edb47d443ef87bdedc744"></a>
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1InvertedLists.html#ae06049e4259edb47d443ef87bdedc744">code_size</a></td></tr>
<tr class="memdesc:ae06049e4259edb47d443ef87bdedc744 inherit pub_attribs_structfaiss_1_1InvertedLists"><td class="mdescLeft"> </td><td class="mdescRight">code size per vector in bytes <br/></td></tr>
<tr class="separator:ae06049e4259edb47d443ef87bdedc744 inherit pub_attribs_structfaiss_1_1InvertedLists"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_types_structfaiss_1_1InvertedLists"><td colspan="2" onclick="javascript:toggleInherit('pub_types_structfaiss_1_1InvertedLists')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="structfaiss_1_1InvertedLists.html">faiss::InvertedLists</a></td></tr>
<tr class="memitem:a2bb406f72dcad45cf03974ff14bfa473 inherit pub_types_structfaiss_1_1InvertedLists"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2bb406f72dcad45cf03974ff14bfa473"></a>
typedef <a class="el" href="structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea">Index::idx_t</a> </td><td class="memItemRight" valign="bottom"><b>idx_t</b></td></tr>
<tr class="separator:a2bb406f72dcad45cf03974ff14bfa473 inherit pub_types_structfaiss_1_1InvertedLists"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>use the first inverted lists if they are non-empty otherwise use the second</p>
<p>This is useful if il1 has a few inverted lists that are too long, and that il0 has replacement lists for those, with empty lists for the others. </p>
<p>Definition at line <a class="el" href="InvertedLists_8h_source.html#l00307">307</a> of file <a class="el" href="InvertedLists_8h_source.html">InvertedLists.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a4376b14cd4e349d51848995c102659af"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const uint8_t * faiss::MaskedInvertedLists::get_codes </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>list_no</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>get the codes for an inverted list must be released by release_codes</p>
<dl class="section return"><dt>Returns</dt><dd>codes size list_size * code_size </dd></dl>
<p>Implements <a class="el" href="structfaiss_1_1InvertedLists.html#a60b12f9efe940b617a8380adceef4032">faiss::InvertedLists</a>.</p>
<p>Definition at line <a class="el" href="InvertedLists_8cpp_source.html#l00569">569</a> of file <a class="el" href="InvertedLists_8cpp_source.html">InvertedLists.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a924d45d2ab3809c728e7b02ec569b2ba"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const idx_t * faiss::MaskedInvertedLists::get_ids </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>list_no</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>get the ids for an inverted list must be released by release_ids</p>
<dl class="section return"><dt>Returns</dt><dd>ids size list_size </dd></dl>
<p>Implements <a class="el" href="structfaiss_1_1InvertedLists.html#a3ab6b389d8d85c5fbf23889064df7e95">faiss::InvertedLists</a>.</p>
<p>Definition at line <a class="el" href="InvertedLists_8cpp_source.html#l00575">575</a> of file <a class="el" href="InvertedLists_8cpp_source.html">InvertedLists.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a429657c4c203d472f59147f301de0ede"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const uint8_t * faiss::MaskedInvertedLists::get_single_code </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>list_no</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>offset</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>a single code in an inverted list (should be deallocated with release_codes) </dd></dl>
<p>Reimplemented from <a class="el" href="structfaiss_1_1InvertedLists.html#afc2760bed7c210f2fad9b03109f561ee">faiss::InvertedLists</a>.</p>
<p>Definition at line <a class="el" href="InvertedLists_8cpp_source.html#l00600">600</a> of file <a class="el" href="InvertedLists_8cpp_source.html">InvertedLists.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="af0d9f7b61caef91e30124b0f7a9d44b9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">idx_t faiss::MaskedInvertedLists::get_single_id </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>list_no</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>offset</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>a single id in an inverted list </dd></dl>
<p>Reimplemented from <a class="el" href="structfaiss_1_1InvertedLists.html#a21b52cdb0601cd225bd7924932310876">faiss::InvertedLists</a>.</p>
<p>Definition at line <a class="el" href="InvertedLists_8cpp_source.html#l00594">594</a> of file <a class="el" href="InvertedLists_8cpp_source.html">InvertedLists.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5fbd34b4052c314148c44f14b4d3c2d3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void faiss::MaskedInvertedLists::prefetch_lists </td>
<td>(</td>
<td class="paramtype">const idx_t * </td>
<td class="paramname"><em>list_nos</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>nlist</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>prepare the following lists (default does nothing) a list can be -1 hence the signed long </p>
<p>Reimplemented from <a class="el" href="structfaiss_1_1InvertedLists.html#ac537aa14d2731c0ff907169211389b76">faiss::InvertedLists</a>.</p>
<p>Definition at line <a class="el" href="InvertedLists_8cpp_source.html#l00607">607</a> of file <a class="el" href="InvertedLists_8cpp_source.html">InvertedLists.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li>/data/users/hoss/faiss/<a class="el" href="InvertedLists_8h_source.html">InvertedLists.h</a></li>
<li>/data/users/hoss/faiss/<a class="el" href="InvertedLists_8cpp_source.html">InvertedLists.cpp</a></li>
</ul>
</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>