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
<!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: demo_sift1M.cpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Faiss
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Friends</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_59425e443f801f1f2fd8bbe4959a3ccf.html">tests</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">demo_sift1M.cpp</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">/**</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright (c) 2015-present, Facebook, Inc.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * All rights reserved.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * This source code is licensed under the CC-by-NC license found in the</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * LICENSE file in the root directory of this source tree.</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>  <span class="comment">// Copyright 2004-present Facebook. All Rights Reserved</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> </div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <cmath></span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <cstdio></span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <cstdlib></span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <cassert></span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <cstring></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 <sys/types.h></span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <sys/stat.h></span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <unistd.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> <span class="preprocessor">#include <sys/time.h></span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "../AutoTune.h"</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"></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"> * To run this demo, please download the ANN_SIFT1M dataset from</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> * http://corpus-texmex.irisa.fr/</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> * and unzip it to the sudirectory sift1M.</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> **/</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">/*****************************************************</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> * I/O functions for fvecs and ivecs</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> *****************************************************/</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keywordtype">float</span> * fvecs_read (<span class="keyword">const</span> <span class="keywordtype">char</span> *fname,</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordtype">size_t</span> *d_out, <span class="keywordtype">size_t</span> *n_out)</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> {</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  FILE *f = fopen(fname, <span class="stringliteral">"r"</span>);</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keywordflow">if</span>(!f) {</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  fprintf(stderr, <span class="stringliteral">"could not open %s\n"</span>, fname);</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  perror(<span class="stringliteral">""</span>);</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  abort();</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  }</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordtype">int</span> d;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  fread(&d, 1, <span class="keyword">sizeof</span>(<span class="keywordtype">int</span>), f);</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  assert((d > 0 && d < 1000000) || !<span class="stringliteral">"unreasonable dimension"</span>);</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  fseek(f, 0, SEEK_SET);</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">struct </span>stat st;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  fstat(fileno(f), &st);</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordtype">size_t</span> sz = st.st_size;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  assert(sz % ((d + 1) * 4) == 0 || !<span class="stringliteral">"weird file size"</span>);</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordtype">size_t</span> n = sz / ((d + 1) * 4);</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  *d_out = d; *n_out = n;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordtype">float</span> *x = <span class="keyword">new</span> <span class="keywordtype">float</span>[n * (d + 1)];</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordtype">size_t</span> nr = fread(x, <span class="keyword">sizeof</span>(<span class="keywordtype">float</span>), n * (d + 1), f);</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  assert(nr == n * (d + 1) || !<span class="stringliteral">"could not read whole file"</span>);</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="comment">// shift array to remove row headers</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordflow">for</span>(<span class="keywordtype">size_t</span> i = 0; i < n; i++)</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  memmove(x + i * d, x + 1 + i * (d + 1), d * <span class="keyword">sizeof</span>(*x));</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  fclose(f);</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordflow">return</span> x;</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> }</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment">// not very clean, but works as long as sizeof(int) == sizeof(float)</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="keywordtype">int</span> *ivecs_read(<span class="keyword">const</span> <span class="keywordtype">char</span> *fname, <span class="keywordtype">size_t</span> *d_out, <span class="keywordtype">size_t</span> *n_out)</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> {</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordflow">return</span> (<span class="keywordtype">int</span>*)fvecs_read(fname, d_out, n_out);</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> }</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="keywordtype">double</span> elapsed ()</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> {</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keyword">struct </span>timeval tv;</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  gettimeofday (&tv, <span class="keyword">nullptr</span>);</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordflow">return</span> tv.tv_sec + tv.tv_usec * 1e-6;</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> }</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="keywordtype">int</span> main()</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> {</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keywordtype">double</span> t0 = elapsed();</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="comment">// this is typically the fastest one.</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *index_key = <span class="stringliteral">"IVF4096,Flat"</span>;</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="comment">// these ones have better memory usage</span></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="comment">// const char *index_key = "Flat";</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="comment">// const char *index_key = "PQ32";</span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="comment">// const char *index_key = "PCA80,Flat";</span></div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="comment">// const char *index_key = "IVF4096,PQ8+16";</span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="comment">// const char *index_key = "IVF4096,PQ32";</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="comment">// const char *index_key = "IMI2x8,PQ32";</span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="comment">// const char *index_key = "IMI2x8,PQ8+16";</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="comment">// const char *index_key = "OPQ16_64,IMI2x8,PQ8+16";</span></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>  <a class="code" href="structfaiss_1_1Index.html">faiss::Index</a> * index;</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="keywordtype">size_t</span> d;</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>  {</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  printf (<span class="stringliteral">"[%.3f s] Loading train set\n"</span>, elapsed() - t0);</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="keywordtype">size_t</span> nt;</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keywordtype">float</span> *xt = fvecs_read(<span class="stringliteral">"sift1M/sift_learn.fvecs"</span>, &d, &nt);</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>  printf (<span class="stringliteral">"[%.3f s] Preparing index \"%s\" d=%ld\n"</span>,</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  elapsed() - t0, index_key, d);</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  index = <a class="code" href="namespacefaiss.html#a0c95ec47726f2ce3fb668dcb1f9a3317">faiss::index_factory</a>(d, index_key);</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>  printf (<span class="stringliteral">"[%.3f s] Training on %ld vectors\n"</span>, elapsed() - t0, nt);</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>  index-><a class="code" href="structfaiss_1_1Index.html#a8f67dfd73993e192dc78f2c93d9d9532">train</a>(nt, xt);</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keyword">delete</span> [] xt;</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  }</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> </div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  {</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  printf (<span class="stringliteral">"[%.3f s] Loading database\n"</span>, elapsed() - t0);</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> nb, d2;</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  <span class="keywordtype">float</span> *xb = fvecs_read(<span class="stringliteral">"sift1M/sift_base.fvecs"</span>, &d2, &nb);</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  assert(d == d2 || !<span class="stringliteral">"dataset does not have same dimension as train set"</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>  printf (<span class="stringliteral">"[%.3f s] Indexing database, size %ld*%ld\n"</span>,</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  elapsed() - t0, nb, d);</div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> </div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  index-><a class="code" href="structfaiss_1_1Index.html#a1b5e9ac70adbce0897dd6c8276ad96f2">add</a>(nb, xb);</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span> </div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  <span class="keyword">delete</span> [] xb;</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> </div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <span class="keywordtype">size_t</span> nq;</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <span class="keywordtype">float</span> *xq;</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>  printf (<span class="stringliteral">"[%.3f s] Loading queries\n"</span>, elapsed() - t0);</div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> </div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  <span class="keywordtype">size_t</span> d2;</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  xq = fvecs_read(<span class="stringliteral">"sift1M/sift_query.fvecs"</span>, &d2, &nq);</div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  assert(d == d2 || !<span class="stringliteral">"query does not have same dimension as train set"</span>);</div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> </div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  }</div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span> </div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <span class="keywordtype">size_t</span> k; <span class="comment">// nb of results per query in the GT</span></div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">faiss::Index::idx_t</a> *gt; <span class="comment">// nq * k matrix of ground-truth nearest-neighbors</span></div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span> </div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  {</div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  printf (<span class="stringliteral">"[%.3f s] Loading ground truth for %ld queries\n"</span>,</div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  elapsed() - t0, nq);</div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span> </div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  <span class="comment">// load ground-truth and convert int to long</span></div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  <span class="keywordtype">size_t</span> nq2;</div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  <span class="keywordtype">int</span> *gt_int = ivecs_read(<span class="stringliteral">"sift1M/sift_groundtruth.ivecs"</span>, &k, &nq2);</div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  assert(nq2 == nq || !<span class="stringliteral">"incorrect nb of ground truth entries"</span>);</div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span> </div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  gt = <span class="keyword">new</span> <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">faiss::Index::idx_t</a>[k * nq];</div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  <span class="keywordflow">for</span>(<span class="keywordtype">int</span> i = 0; i < k * nq; i++) {</div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  gt[i] = gt_int[i];</div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  }</div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  <span class="keyword">delete</span> [] gt_int;</div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  }</div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span> </div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  <span class="comment">// Result of the auto-tuning</span></div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  std::string selected_params;</div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span> </div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  { <span class="comment">// run auto-tuning</span></div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span> </div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>  printf (<span class="stringliteral">"[%.3f s] Preparing auto-tune criterion 1-recall at 1 "</span></div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  <span class="stringliteral">"criterion, with k=%ld nq=%ld\n"</span>, elapsed() - t0, k, nq);</div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span> </div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  <a class="code" href="structfaiss_1_1OneRecallAtRCriterion.html">faiss::OneRecallAtRCriterion</a> crit(nq, 1);</div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  crit.set_groundtruth (k, <span class="keyword">nullptr</span>, gt);</div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  crit.nnn = k; <span class="comment">// by default, the criterion will request only 1 NN</span></div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span> </div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  printf (<span class="stringliteral">"[%.3f s] Preparing auto-tune parameters\n"</span>, elapsed() - t0);</div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span> </div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  <a class="code" href="structfaiss_1_1ParameterSpace.html">faiss::ParameterSpace</a> params;</div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  params.<a class="code" href="structfaiss_1_1ParameterSpace.html#a9304975f379738eda384385eace8ad76">initialize</a>(index);</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>  printf (<span class="stringliteral">"[%.3f s] Auto-tuning over %ld parameters (%ld combinations)\n"</span>,</div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>  elapsed() - t0, params.<a class="code" href="structfaiss_1_1ParameterSpace.html#a334c1bb54bc2b70950a4a63950728cbb">parameter_ranges</a>.size(),</div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span>  params.<a class="code" href="structfaiss_1_1ParameterSpace.html#a488329e3c1f08b9980d8e0f9c1491c75">n_combinations</a>());</div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span> </div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span>  <a class="code" href="structfaiss_1_1OperatingPoints.html">faiss::OperatingPoints</a> ops;</div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  params.<a class="code" href="structfaiss_1_1ParameterSpace.html#a57728d29c4785d9003b9cd564d0c51b2">explore</a> (index, nq, xq, crit, &ops);</div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span> </div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  printf (<span class="stringliteral">"[%.3f s] Found the following operating points: \n"</span>,</div>
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  elapsed() - t0);</div>
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span> </div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  ops.display ();</div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span> </div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span>  <span class="comment">// keep the first parameter that obtains > 0.5 1-recall@1</span></div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i < ops.optimal_pts.size(); i++) {</div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span>  <span class="keywordflow">if</span> (ops.optimal_pts[i].perf > 0.5) {</div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  selected_params = ops.optimal_pts[i].key;</div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  <span class="keywordflow">break</span>;</div>
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span>  }</div>
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  }</div>
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span>  assert (selected_params.size() >= 0 ||</div>
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  !<span class="stringliteral">"could not find good enough op point"</span>);</div>
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span>  }</div>
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span> </div>
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span> </div>
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span>  { <span class="comment">// Use the found configuration to perform a search</span></div>
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span> </div>
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  <a class="code" href="structfaiss_1_1ParameterSpace.html">faiss::ParameterSpace</a> params;</div>
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span> </div>
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span>  printf (<span class="stringliteral">"[%.3f s] Setting parameter configuration \"%s\" on index\n"</span>,</div>
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span>  elapsed() - t0, selected_params.c_str());</div>
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span> </div>
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span>  params.<a class="code" href="structfaiss_1_1ParameterSpace.html#a55783994cee46e9181bad2b3a7a973f4">set_index_parameters</a> (index, selected_params.c_str());</div>
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span> </div>
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span>  printf (<span class="stringliteral">"[%.3f s] Perform a search on %ld queries\n"</span>,</div>
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span>  elapsed() - t0, nq);</div>
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span> </div>
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span>  <span class="comment">// output buffers</span></div>
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span>  <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">faiss::Index::idx_t</a> *I = <span class="keyword">new</span> <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">faiss::Index::idx_t</a>[nq * k];</div>
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span>  <span class="keywordtype">float</span> *D = <span class="keyword">new</span> <span class="keywordtype">float</span>[nq * k];</div>
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span> </div>
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span>  index-><a class="code" href="structfaiss_1_1Index.html#aced51b1ebc33c47ab3ae15ea906559a7">search</a>(nq, xq, k, D, I);</div>
<div class="line"><a name="l00230"></a><span class="lineno"> 230</span> </div>
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span>  printf (<span class="stringliteral">"[%.3f s] Compute recalls\n"</span>, elapsed() - t0);</div>
<div class="line"><a name="l00232"></a><span class="lineno"> 232</span> </div>
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span>  <span class="comment">// evaluate result by hand.</span></div>
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span>  <span class="keywordtype">int</span> n_1 = 0, n_10 = 0, n_100 = 0;</div>
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span>  <span class="keywordflow">for</span>(<span class="keywordtype">int</span> i = 0; i < nq; i++) {</div>
<div class="line"><a name="l00236"></a><span class="lineno"> 236</span>  <span class="keywordtype">int</span> gt_nn = gt[i * k];</div>
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span>  <span class="keywordflow">for</span>(<span class="keywordtype">int</span> j = 0; j < k; j++) {</div>
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span>  <span class="keywordflow">if</span> (I[i * k + j] == gt_nn) {</div>
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span>  <span class="keywordflow">if</span>(j < 1) n_1++;</div>
<div class="line"><a name="l00240"></a><span class="lineno"> 240</span>  <span class="keywordflow">if</span>(j < 10) n_10++;</div>
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span>  <span class="keywordflow">if</span>(j < 100) n_100++;</div>
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span>  }</div>
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span>  }</div>
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span>  }</div>
<div class="line"><a name="l00245"></a><span class="lineno"> 245</span>  printf(<span class="stringliteral">"R@1 = %.4f\n"</span>, n_1 / <span class="keywordtype">float</span>(nq));</div>
<div class="line"><a name="l00246"></a><span class="lineno"> 246</span>  printf(<span class="stringliteral">"R@10 = %.4f\n"</span>, n_10 / <span class="keywordtype">float</span>(nq));</div>
<div class="line"><a name="l00247"></a><span class="lineno"> 247</span>  printf(<span class="stringliteral">"R@100 = %.4f\n"</span>, n_100 / <span class="keywordtype">float</span>(nq));</div>
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span> </div>
<div class="line"><a name="l00249"></a><span class="lineno"> 249</span>  }</div>
<div class="line"><a name="l00250"></a><span class="lineno"> 250</span> </div>
<div class="line"><a name="l00251"></a><span class="lineno"> 251</span>  <span class="keyword">delete</span> [] xq;</div>
<div class="line"><a name="l00252"></a><span class="lineno"> 252</span>  <span class="keyword">delete</span> [] gt;</div>
<div class="line"><a name="l00253"></a><span class="lineno"> 253</span>  <span class="keyword">delete</span> index;</div>
<div class="line"><a name="l00254"></a><span class="lineno"> 254</span>  <span class="keywordflow">return</span> 0;</div>
<div class="line"><a name="l00255"></a><span class="lineno"> 255</span> }</div>
<div class="ttc" id="structfaiss_1_1ParameterSpace_html_a57728d29c4785d9003b9cd564d0c51b2"><div class="ttname"><a href="structfaiss_1_1ParameterSpace.html#a57728d29c4785d9003b9cd564d0c51b2">faiss::ParameterSpace::explore</a></div><div class="ttdeci">void explore(Index *index, size_t nq, const float *xq, const AutoTuneCriterion &crit, OperatingPoints *ops) const </div><div class="ttdef"><b>Definition:</b> <a href="AutoTune_8cpp_source.html#l00512">AutoTune.cpp:512</a></div></div>
<div class="ttc" id="structfaiss_1_1ParameterSpace_html_a334c1bb54bc2b70950a4a63950728cbb"><div class="ttname"><a href="structfaiss_1_1ParameterSpace.html#a334c1bb54bc2b70950a4a63950728cbb">faiss::ParameterSpace::parameter_ranges</a></div><div class="ttdeci">std::vector< ParameterRange > parameter_ranges</div><div class="ttdoc">all tunable parameters </div><div class="ttdef"><b>Definition:</b> <a href="AutoTune_8h_source.html#l00135">AutoTune.h:135</a></div></div>
<div class="ttc" id="structfaiss_1_1OperatingPoints_html"><div class="ttname"><a href="structfaiss_1_1OperatingPoints.html">faiss::OperatingPoints</a></div><div class="ttdef"><b>Definition:</b> <a href="AutoTune_8h_source.html#l00094">AutoTune.h:94</a></div></div>
<div class="ttc" id="structfaiss_1_1Index_html_a1b5e9ac70adbce0897dd6c8276ad96f2"><div class="ttname"><a href="structfaiss_1_1Index.html#a1b5e9ac70adbce0897dd6c8276ad96f2">faiss::Index::add</a></div><div class="ttdeci">virtual void add(idx_t n, const float *x)=0</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#l00064">Index.h:64</a></div></div>
<div class="ttc" id="structfaiss_1_1Index_html_aced51b1ebc33c47ab3ae15ea906559a7"><div class="ttname"><a href="structfaiss_1_1Index.html#aced51b1ebc33c47ab3ae15ea906559a7">faiss::Index::search</a></div><div class="ttdeci">virtual void search(idx_t n, const float *x, idx_t k, float *distances, idx_t *labels) const =0</div></div>
<div class="ttc" id="structfaiss_1_1ParameterSpace_html_a9304975f379738eda384385eace8ad76"><div class="ttname"><a href="structfaiss_1_1ParameterSpace.html#a9304975f379738eda384385eace8ad76">faiss::ParameterSpace::initialize</a></div><div class="ttdeci">virtual void initialize(const Index *index)</div><div class="ttdoc">initialize with reasonable parameters for the index </div><div class="ttdef"><b>Definition:</b> <a href="AutoTune_8cpp_source.html#l00330">AutoTune.cpp:330</a></div></div>
<div class="ttc" id="structfaiss_1_1ParameterSpace_html_a488329e3c1f08b9980d8e0f9c1491c75"><div class="ttname"><a href="structfaiss_1_1ParameterSpace.html#a488329e3c1f08b9980d8e0f9c1491c75">faiss::ParameterSpace::n_combinations</a></div><div class="ttdeci">size_t n_combinations() const </div><div class="ttdoc">nb of combinations, = product of values sizes </div><div class="ttdef"><b>Definition:</b> <a href="AutoTune_8cpp_source.html#l00267">AutoTune.cpp:267</a></div></div>
<div class="ttc" id="structfaiss_1_1ParameterSpace_html_a55783994cee46e9181bad2b3a7a973f4"><div class="ttname"><a href="structfaiss_1_1ParameterSpace.html#a55783994cee46e9181bad2b3a7a973f4">faiss::ParameterSpace::set_index_parameters</a></div><div class="ttdeci">void set_index_parameters(Index *index, size_t cno) const </div><div class="ttdoc">set a combination of parameters on an index </div><div class="ttdef"><b>Definition:</b> <a href="AutoTune_8cpp_source.html#l00388">AutoTune.cpp:388</a></div></div>
<div class="ttc" id="structfaiss_1_1ParameterSpace_html"><div class="ttname"><a href="structfaiss_1_1ParameterSpace.html">faiss::ParameterSpace</a></div><div class="ttdef"><b>Definition:</b> <a href="AutoTune_8h_source.html#l00133">AutoTune.h:133</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#l00061">Index.h:61</a></div></div>
<div class="ttc" id="structfaiss_1_1Index_html_a8f67dfd73993e192dc78f2c93d9d9532"><div class="ttname"><a href="structfaiss_1_1Index.html#a8f67dfd73993e192dc78f2c93d9d9532">faiss::Index::train</a></div><div class="ttdeci">virtual void train(idx_t n, const float *x)</div><div class="ttdef"><b>Definition:</b> <a href="Index_8h_source.html#l00092">Index.h:92</a></div></div>
<div class="ttc" id="namespacefaiss_html_a0c95ec47726f2ce3fb668dcb1f9a3317"><div class="ttname"><a href="namespacefaiss.html#a0c95ec47726f2ce3fb668dcb1f9a3317">faiss::index_factory</a></div><div class="ttdeci">Index * index_factory(int d, const char *description_in, MetricType metric)</div><div class="ttdef"><b>Definition:</b> <a href="AutoTune_8cpp_source.html#l00623">AutoTune.cpp:623</a></div></div>
<div class="ttc" id="structfaiss_1_1OneRecallAtRCriterion_html"><div class="ttname"><a href="structfaiss_1_1OneRecallAtRCriterion.html">faiss::OneRecallAtRCriterion</a></div><div class="ttdef"><b>Definition:</b> <a href="AutoTune_8h_source.html#l00058">AutoTune.h:58</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>