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
<!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::BinaryInvertedListScanner 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_1BinaryInvertedListScanner.html">BinaryInvertedListScanner</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="structfaiss_1_1BinaryInvertedListScanner-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">faiss::BinaryInvertedListScanner Struct Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a79acbd6558c3a0e6b3261e5cc53292af"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a79acbd6558c3a0e6b3261e5cc53292af"></a>
using </td><td class="memItemRight" valign="bottom"><b>idx_t</b> = <a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">Index::idx_t</a></td></tr>
<tr class="separator:a79acbd6558c3a0e6b3261e5cc53292af"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:a22bf6ac0128e4e45768f91b4de58fdb6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a22bf6ac0128e4e45768f91b4de58fdb6"></a>
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1BinaryInvertedListScanner.html#a22bf6ac0128e4e45768f91b4de58fdb6">set_query</a> (const uint8_t *query_vector)=0</td></tr>
<tr class="memdesc:a22bf6ac0128e4e45768f91b4de58fdb6"><td class="mdescLeft"> </td><td class="mdescRight">from now on we handle this query. <br/></td></tr>
<tr class="separator:a22bf6ac0128e4e45768f91b4de58fdb6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae28e1381cb4c16ff9941c909fe9c4122"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae28e1381cb4c16ff9941c909fe9c4122"></a>
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1BinaryInvertedListScanner.html#ae28e1381cb4c16ff9941c909fe9c4122">set_list</a> (idx_t list_no, uint8_t coarse_dis)=0</td></tr>
<tr class="memdesc:ae28e1381cb4c16ff9941c909fe9c4122"><td class="mdescLeft"> </td><td class="mdescRight">following codes come from this inverted list <br/></td></tr>
<tr class="separator:ae28e1381cb4c16ff9941c909fe9c4122"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac33be0f074b682e9afc44bd7cf0741b2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac33be0f074b682e9afc44bd7cf0741b2"></a>
virtual uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1BinaryInvertedListScanner.html#ac33be0f074b682e9afc44bd7cf0741b2">distance_to_code</a> (const uint8_t *code) const =0</td></tr>
<tr class="memdesc:ac33be0f074b682e9afc44bd7cf0741b2"><td class="mdescLeft"> </td><td class="mdescRight">compute a single query-to-code distance <br/></td></tr>
<tr class="separator:ac33be0f074b682e9afc44bd7cf0741b2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9ddb2bb0b513829b39528463c46f90f5"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1BinaryInvertedListScanner.html#a9ddb2bb0b513829b39528463c46f90f5">scan_codes</a> (size_t n, const uint8_t *codes, const idx_t *ids, int32_t *distances, idx_t *labels, size_t k) const =0</td></tr>
<tr class="separator:a9ddb2bb0b513829b39528463c46f90f5"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p>Definition at line <a class="el" href="IndexBinaryIVF_8h_source.html#l00187">187</a> of file <a class="el" href="IndexBinaryIVF_8h_source.html">IndexBinaryIVF.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a9ddb2bb0b513829b39528463c46f90f5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual size_t faiss::BinaryInvertedListScanner::scan_codes </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>n</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint8_t * </td>
<td class="paramname"><em>codes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const idx_t * </td>
<td class="paramname"><em>ids</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"><em>distances</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">idx_t * </td>
<td class="paramname"><em>labels</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>k</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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>compute the distances to codes. (distances, labels) should be organized as a min- or max-heap</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">n</td><td>number of codes to scan </td></tr>
<tr><td class="paramname">codes</td><td>codes to scan (n * code_size) </td></tr>
<tr><td class="paramname">ids</td><td>corresponding ids (ignored if store_pairs) </td></tr>
<tr><td class="paramname">distances</td><td>heap distances (size k) </td></tr>
<tr><td class="paramname">labels</td><td>heap labels (size k) </td></tr>
<tr><td class="paramname">k</td><td>heap size </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>/tmp/faiss/<a class="el" href="IndexBinaryIVF_8h_source.html">IndexBinaryIVF.h</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>