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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>Faiss: /data/users/matthijs/github_faiss/faiss/gpu/test/TestUtils.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_6b3ae6988449b0834e9596fad5d75199.html">gpu</a></li><li class="navelem"><a class="el" href="dir_43be364029218a94c5bcb5d8c78d7156.html">test</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">TestUtils.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"> * Copyright (c) 2015-present, Facebook, Inc.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * All rights reserved.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * This source code is licensed under the BSD+Patents license found in the</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * LICENSE file in the root directory of this source tree.</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// Copyright 2004-present Facebook. All Rights Reserved.</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include "../test/TestUtils.h"</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include "../../utils.h"</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 <gtest/gtest.h></span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <set></span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <sstream></span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <time.h></span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include <unordered_map></span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">namespace </span>faiss { <span class="keyword">namespace </span>gpu {</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">inline</span> <span class="keywordtype">float</span> relativeError(<span class="keywordtype">float</span> a, <span class="keywordtype">float</span> b) {</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <span class="keywordflow">return</span> std::abs(a - b) / (0.5f * (std::abs(a) + std::abs(b)));</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> </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">// This seed is also used for the faiss float_rand API; in a test it</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">// is all within a single thread, so it is ok</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keywordtype">long</span> s_seed = 1;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keywordtype">void</span> newTestSeed() {</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keyword">struct </span>timespec t;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  clock_gettime(CLOCK_REALTIME, &t);</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  setTestSeed(t.tv_nsec);</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> </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keywordtype">void</span> setTestSeed(<span class="keywordtype">long</span> seed) {</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  printf(<span class="stringliteral">"testing with random seed %ld\n"</span>, seed);</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>  srand48(seed);</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  s_seed = seed;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> }</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> <span class="keywordtype">int</span> randVal(<span class="keywordtype">int</span> a, <span class="keywordtype">int</span> b) {</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  EXPECT_GE(a, 0);</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  EXPECT_LE(a, b);</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordflow">return</span> a + (lrand48() % (b + 1 - a));</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> </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="keywordtype">bool</span> randBool() {</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordflow">return</span> randSelect<bool>({<span class="keyword">true</span>, <span class="keyword">false</span>});</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> }</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> std::vector<float> randVecs(<span class="keywordtype">size_t</span> num, <span class="keywordtype">size_t</span> dim) {</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  std::vector<float> v(num * dim);</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">static</span> <span class="keywordtype">bool</span> first = <span class="keyword">true</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>  faiss::float_rand(v.data(), v.size(), s_seed);</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="comment">// unfortunately we generate separate sets of vectors, and don't</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="comment">// want the same values</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  ++s_seed;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordflow">return</span> v;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> }</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="keywordtype">void</span> compareIndices(<span class="keyword">const</span> std::vector<float>& queryVecs,</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <a class="code" href="structfaiss_1_1Index.html">faiss::Index</a>& refIndex,</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <a class="code" href="structfaiss_1_1Index.html">faiss::Index</a>& testIndex,</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordtype">int</span> numQuery, <span class="keywordtype">int</span> dim, <span class="keywordtype">int</span> k,</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">const</span> std::string& configMsg,</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordtype">float</span> maxRelativeError,</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordtype">float</span> pctMaxDiff1,</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordtype">float</span> pctMaxDiffN) {</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="comment">// Compare</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  std::vector<float> refDistance(numQuery * k, 0);</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  std::vector<faiss::Index::idx_t> refIndices(numQuery * k, -1);</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  refIndex.<a class="code" href="structfaiss_1_1Index.html#aced51b1ebc33c47ab3ae15ea906559a7">search</a>(numQuery, queryVecs.data(),</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  k, refDistance.data(), refIndices.data());</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>  std::vector<float> testDistance(numQuery * k, 0);</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  std::vector<faiss::Index::idx_t> testIndices(numQuery * k, -1);</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  testIndex.<a class="code" href="structfaiss_1_1Index.html#aced51b1ebc33c47ab3ae15ea906559a7">search</a>(numQuery, queryVecs.data(),</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  k, testDistance.data(), testIndices.data());</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>  faiss::gpu::compareLists(refDistance.data(),</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  refIndices.data(),</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  testDistance.data(),</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  testIndices.data(),</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  numQuery, k,</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  configMsg,</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keyword">true</span>, <span class="keyword">false</span>, <span class="keyword">true</span>,</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  maxRelativeError, pctMaxDiff1, pctMaxDiffN);</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> </div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="keywordtype">void</span> compareIndices(<a class="code" href="structfaiss_1_1Index.html">faiss::Index</a>& refIndex,</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <a class="code" href="structfaiss_1_1Index.html">faiss::Index</a>& testIndex,</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keywordtype">int</span> numQuery, <span class="keywordtype">int</span> dim, <span class="keywordtype">int</span> k,</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keyword">const</span> std::string& configMsg,</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keywordtype">float</span> maxRelativeError,</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keywordtype">float</span> pctMaxDiff1,</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keywordtype">float</span> pctMaxDiffN) {</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keyword">auto</span> queryVecs = faiss::gpu::randVecs(numQuery, dim);</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>  compareIndices(queryVecs,</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  refIndex,</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  testIndex,</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  numQuery, dim, k,</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  configMsg,</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  maxRelativeError,</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  pctMaxDiff1,</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  pctMaxDiffN);</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> }</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">template</span> <<span class="keyword">typename</span> T></div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="keyword">inline</span> T lookup(<span class="keyword">const</span> T* p, <span class="keywordtype">int</span> i, <span class="keywordtype">int</span> j, <span class="keywordtype">int</span> <span class="comment">/*dim1*/</span>, <span class="keywordtype">int</span> dim2) {</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keywordflow">return</span> p[i * dim2 + j];</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> </div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="keywordtype">void</span> compareLists(<span class="keyword">const</span> <span class="keywordtype">float</span>* refDist,</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keyword">const</span> <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">faiss::Index::idx_t</a>* refInd,</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keyword">const</span> <span class="keywordtype">float</span>* testDist,</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="keyword">const</span> <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">faiss::Index::idx_t</a>* testInd,</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="keywordtype">int</span> dim1, <span class="keywordtype">int</span> dim2,</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="keyword">const</span> std::string& configMsg,</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keywordtype">bool</span> printBasicStats, <span class="keywordtype">bool</span> printDiffs, <span class="keywordtype">bool</span> assertOnErr,</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="keywordtype">float</span> maxRelativeError,</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="keywordtype">float</span> pctMaxDiff1,</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <span class="keywordtype">float</span> pctMaxDiffN) {</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> </div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <span class="keywordtype">float</span> maxAbsErr = 0.0f;</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i < dim1 * dim2; ++i) {</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  maxAbsErr = std::max(maxAbsErr, std::abs(refDist[i] - testDist[i]));</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  }</div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <span class="keywordtype">int</span> numResults = dim1 * dim2;</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="comment">// query -> {index -> result position}</span></div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  std::vector<std::unordered_map<faiss::Index::idx_t, int>> refIndexMap;</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="keywordflow">for</span> (<span class="keywordtype">int</span> query = 0; query < dim1; ++query) {</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  std::unordered_map<faiss::Index::idx_t, int> indices;</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> </div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="keywordflow">for</span> (<span class="keywordtype">int</span> result = 0; result < dim2; ++result) {</div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  indices[lookup(refInd, query, result, dim1, dim2)] = result;</div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  }</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>  refIndexMap.emplace_back(std::move(indices));</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  }</div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> </div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  <span class="comment">// See how far off the indices are</span></div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  <span class="comment">// Keep track of the difference for each entry</span></div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  std::vector<std::vector<int>> indexDiffs;</div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span> </div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  <span class="keywordtype">int</span> diff1 = 0; <span class="comment">// index differs by 1</span></div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  <span class="keywordtype">int</span> diffN = 0; <span class="comment">// index differs by >1</span></div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <span class="keywordtype">int</span> diffInf = 0; <span class="comment">// index not found in the other</span></div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  <span class="keywordtype">int</span> nonUniqueIndices = 0;</div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span> </div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <span class="keywordtype">double</span> avgDiff = 0.0;</div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  <span class="keywordtype">int</span> maxDiff = 0;</div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  <span class="keywordtype">float</span> maxRelErr = 0.0f;</div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span> </div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  <span class="keywordflow">for</span> (<span class="keywordtype">int</span> query = 0; query < dim1; ++query) {</div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  std::vector<int> diffs;</div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  std::set<faiss::Index::idx_t> uniqueIndices;</div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> </div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  <span class="keyword">auto</span>& indices = refIndexMap[query];</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="keywordflow">for</span> (<span class="keywordtype">int</span> result = 0; result < dim2; ++result) {</div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  <span class="keyword">auto</span> t = lookup(testInd, query, result, dim1, dim2);</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">// All indices reported within a query should be unique; this is</span></div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  <span class="comment">// a serious error if is otherwise the case</span></div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  <span class="keywordtype">bool</span> uniqueIndex = uniqueIndices.count(t) == 0;</div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  <span class="keywordflow">if</span> (assertOnErr) {</div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  EXPECT_TRUE(uniqueIndex) << configMsg</div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>  << <span class="stringliteral">" "</span> << query</div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  << <span class="stringliteral">" "</span> << result</div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  << <span class="stringliteral">" "</span> << t;</div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  }</div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span> </div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  <span class="keywordflow">if</span> (!uniqueIndex) {</div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  ++nonUniqueIndices;</div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  } <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  uniqueIndices.insert(t);</div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  }</div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span> </div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  <span class="keyword">auto</span> it = indices.find(t);</div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  <span class="keywordflow">if</span> (it != indices.end()) {</div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>  <span class="keywordtype">int</span> diff = std::abs(result - it->second);</div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span>  diffs.push_back(diff);</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>  <span class="keywordflow">if</span> (diff == 1) {</div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  ++diff1;</div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  maxDiff = std::max(diff, maxDiff);</div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (diff > 1) {</div>
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  ++diffN;</div>
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  maxDiff = std::max(diff, maxDiff);</div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  }</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>  avgDiff += (double) diff;</div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  } <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span>  ++diffInf;</div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  diffs.push_back(-1);</div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  <span class="comment">// don't count this for maxDiff</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>  <span class="keyword">auto</span> refD = lookup(refDist, query, result, dim1, dim2);</div>
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  <span class="keyword">auto</span> testD = lookup(testDist, query, result, dim1, dim2);</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>  <span class="keywordtype">float</span> relErr = relativeError(refD, testD);</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="keywordflow">if</span> (assertOnErr) {</div>
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span>  EXPECT_LE(relErr, maxRelativeError) << configMsg</div>
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  << <span class="stringliteral">" ("</span> << query << <span class="stringliteral">", "</span> << result</div>
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span>  << <span class="stringliteral">") refD: "</span> << refD</div>
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span>  << <span class="stringliteral">" testD: "</span> << testD;</div>
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span>  }</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>  maxRelErr = std::max(maxRelErr, relErr);</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> </div>
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span>  indexDiffs.emplace_back(std::move(diffs));</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> </div>
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span>  <span class="keywordflow">if</span> (assertOnErr) {</div>
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span>  EXPECT_LE((<span class="keywordtype">float</span>) (diff1 + diffN + diffInf),</div>
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span>  (<span class="keywordtype">float</span>) numResults * pctMaxDiff1) << configMsg;</div>
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span> </div>
<div class="line"><a name="l00230"></a><span class="lineno"> 230</span>  <span class="comment">// Don't count diffInf because that could be diff1 as far as we</span></div>
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span>  <span class="comment">// know</span></div>
<div class="line"><a name="l00232"></a><span class="lineno"> 232</span>  EXPECT_LE((<span class="keywordtype">float</span>) diffN, (<span class="keywordtype">float</span>) numResults * pctMaxDiffN) << configMsg;</div>
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span>  }</div>
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span> </div>
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span>  avgDiff /= (double) numResults;</div>
<div class="line"><a name="l00236"></a><span class="lineno"> 236</span> </div>
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span>  <span class="keywordflow">if</span> (printBasicStats) {</div>
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span>  <span class="keywordflow">if</span> (!configMsg.empty()) {</div>
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span>  printf(<span class="stringliteral">"Config\n"</span></div>
<div class="line"><a name="l00240"></a><span class="lineno"> 240</span>  <span class="stringliteral">"----------------------------\n"</span></div>
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span>  <span class="stringliteral">"%s\n"</span>,</div>
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span>  configMsg.c_str());</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">"Result error and differences\n"</span></div>
<div class="line"><a name="l00246"></a><span class="lineno"> 246</span>  <span class="stringliteral">"----------------------------\n"</span></div>
<div class="line"><a name="l00247"></a><span class="lineno"> 247</span>  <span class="stringliteral">"max abs diff %.7f rel diff %.7f\n"</span></div>
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span>  <span class="stringliteral">"idx diff avg: %.5g max: %d\n"</span></div>
<div class="line"><a name="l00249"></a><span class="lineno"> 249</span>  <span class="stringliteral">"idx diff of 1: %d (%.3f%% of queries)\n"</span></div>
<div class="line"><a name="l00250"></a><span class="lineno"> 250</span>  <span class="stringliteral">"idx diff of >1: %d (%.3f%% of queries)\n"</span></div>
<div class="line"><a name="l00251"></a><span class="lineno"> 251</span>  <span class="stringliteral">"idx diff not found: %d (%.3f%% of queries)"</span></div>
<div class="line"><a name="l00252"></a><span class="lineno"> 252</span>  <span class="stringliteral">" [typically a last element inversion]\n"</span></div>
<div class="line"><a name="l00253"></a><span class="lineno"> 253</span>  <span class="stringliteral">"non-unique indices: %d (a serious error if >0)\n"</span>,</div>
<div class="line"><a name="l00254"></a><span class="lineno"> 254</span>  maxAbsErr, maxRelErr,</div>
<div class="line"><a name="l00255"></a><span class="lineno"> 255</span>  avgDiff, maxDiff,</div>
<div class="line"><a name="l00256"></a><span class="lineno"> 256</span>  diff1, 100.0f * (<span class="keywordtype">float</span>) diff1 / (<span class="keywordtype">float</span>) numResults,</div>
<div class="line"><a name="l00257"></a><span class="lineno"> 257</span>  diffN, 100.0f * (<span class="keywordtype">float</span>) diffN / (<span class="keywordtype">float</span>) numResults,</div>
<div class="line"><a name="l00258"></a><span class="lineno"> 258</span>  diffInf, 100.0f * (<span class="keywordtype">float</span>) diffInf / (<span class="keywordtype">float</span>) numResults,</div>
<div class="line"><a name="l00259"></a><span class="lineno"> 259</span>  nonUniqueIndices);</div>
<div class="line"><a name="l00260"></a><span class="lineno"> 260</span>  }</div>
<div class="line"><a name="l00261"></a><span class="lineno"> 261</span> </div>
<div class="line"><a name="l00262"></a><span class="lineno"> 262</span>  <span class="keywordflow">if</span> (printDiffs) {</div>
<div class="line"><a name="l00263"></a><span class="lineno"> 263</span>  printf(<span class="stringliteral">"differences:\n"</span>);</div>
<div class="line"><a name="l00264"></a><span class="lineno"> 264</span>  printf(<span class="stringliteral">"==================\n"</span>);</div>
<div class="line"><a name="l00265"></a><span class="lineno"> 265</span>  <span class="keywordflow">for</span> (<span class="keywordtype">int</span> query = 0; query < dim1; ++query) {</div>
<div class="line"><a name="l00266"></a><span class="lineno"> 266</span>  <span class="keywordflow">for</span> (<span class="keywordtype">int</span> result = 0; result < dim2; ++result) {</div>
<div class="line"><a name="l00267"></a><span class="lineno"> 267</span>  <span class="keywordtype">long</span> refI = lookup(refInd, query, result, dim1, dim2);</div>
<div class="line"><a name="l00268"></a><span class="lineno"> 268</span>  <span class="keywordtype">long</span> testI = lookup(testInd, query, result, dim1, dim2);</div>
<div class="line"><a name="l00269"></a><span class="lineno"> 269</span> </div>
<div class="line"><a name="l00270"></a><span class="lineno"> 270</span>  <span class="keywordflow">if</span> (refI != testI) {</div>
<div class="line"><a name="l00271"></a><span class="lineno"> 271</span>  <span class="keywordtype">float</span> refD = lookup(refDist, query, result, dim1, dim2);</div>
<div class="line"><a name="l00272"></a><span class="lineno"> 272</span>  <span class="keywordtype">float</span> testD = lookup(testDist, query, result, dim1, dim2);</div>
<div class="line"><a name="l00273"></a><span class="lineno"> 273</span> </div>
<div class="line"><a name="l00274"></a><span class="lineno"> 274</span>  <span class="keywordtype">float</span> maxDist = std::max(refD, testD);</div>
<div class="line"><a name="l00275"></a><span class="lineno"> 275</span>  <span class="keywordtype">float</span> delta = std::abs(refD - testD);</div>
<div class="line"><a name="l00276"></a><span class="lineno"> 276</span> </div>
<div class="line"><a name="l00277"></a><span class="lineno"> 277</span>  <span class="keywordtype">float</span> relErr = delta / maxDist;</div>
<div class="line"><a name="l00278"></a><span class="lineno"> 278</span> </div>
<div class="line"><a name="l00279"></a><span class="lineno"> 279</span>  <span class="keywordflow">if</span> (refD == testD) {</div>
<div class="line"><a name="l00280"></a><span class="lineno"> 280</span>  printf(<span class="stringliteral">"(%d, %d [%d]) (ref %ld tst %ld dist ==)\n"</span>,</div>
<div class="line"><a name="l00281"></a><span class="lineno"> 281</span>  query, result,</div>
<div class="line"><a name="l00282"></a><span class="lineno"> 282</span>  indexDiffs[query][result],</div>
<div class="line"><a name="l00283"></a><span class="lineno"> 283</span>  refI, testI);</div>
<div class="line"><a name="l00284"></a><span class="lineno"> 284</span>  } <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00285"></a><span class="lineno"> 285</span>  printf(<span class="stringliteral">"(%d, %d [%d]) (ref %ld tst %ld abs %.8f "</span></div>
<div class="line"><a name="l00286"></a><span class="lineno"> 286</span>  <span class="stringliteral">"rel %.8f ref %a tst %a)\n"</span>,</div>
<div class="line"><a name="l00287"></a><span class="lineno"> 287</span>  query, result,</div>
<div class="line"><a name="l00288"></a><span class="lineno"> 288</span>  indexDiffs[query][result],</div>
<div class="line"><a name="l00289"></a><span class="lineno"> 289</span>  refI, testI, delta, relErr, refD, testD);</div>
<div class="line"><a name="l00290"></a><span class="lineno"> 290</span>  }</div>
<div class="line"><a name="l00291"></a><span class="lineno"> 291</span>  }</div>
<div class="line"><a name="l00292"></a><span class="lineno"> 292</span>  }</div>
<div class="line"><a name="l00293"></a><span class="lineno"> 293</span>  }</div>
<div class="line"><a name="l00294"></a><span class="lineno"> 294</span>  }</div>
<div class="line"><a name="l00295"></a><span class="lineno"> 295</span> }</div>
<div class="line"><a name="l00296"></a><span class="lineno"> 296</span> </div>
<div class="line"><a name="l00297"></a><span class="lineno"> 297</span> } }</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_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_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><!-- 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>