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
<!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/GpuIndex.cu 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> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">GpuIndex.cu</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 "GpuIndex.h"</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include "../FaissAssert.h"</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include "GpuResources.h"</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include "utils/DeviceUtils.h"</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <stdio.h></span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">namespace </span>faiss { <span class="keyword">namespace </span>gpu {</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="comment">// Default size for which we page add or search</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> constexpr <span class="keywordtype">size_t</span> kAddPageSize = (size_t) 256 * 1024 * 1024;</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> constexpr <span class="keywordtype">size_t</span> kSearchPageSize = (size_t) 256 * 1024 * 1024;</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="comment">// Or, maximum number of vectors to consider per page of add or search</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> constexpr <span class="keywordtype">size_t</span> kAddVecSize = (size_t) 512 * 1024;</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">// Use a smaller search size, as precomputed code usage on IVFPQ</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">// requires substantial amounts of memory</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">// FIXME: parameterize based on algorithm need</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> constexpr <span class="keywordtype">size_t</span> kSearchVecSize = (size_t) 32 * 1024;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> GpuIndex::GpuIndex(GpuResources* resources,</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keywordtype">int</span> dims,</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <a class="code" href="namespacefaiss.html#afd12191c638da74760ff397cf319752c">faiss::MetricType</a> metric,</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  GpuIndexConfig config) :</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  Index(dims, metric),</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  resources_(resources),</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  device_(config.device),</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  memorySpace_(config.memorySpace) {</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  FAISS_THROW_IF_NOT_FMT(device_ < getNumDevices(),</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="stringliteral">"Invalid GPU device %d"</span>, device_);</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  FAISS_THROW_IF_NOT_MSG(dims > 0, <span class="stringliteral">"Invalid number of dimensions"</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="preprocessor">#ifdef FAISS_UNIFIED_MEM</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor"></span> FAISS_THROW_IF_NOT_FMT(</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  memorySpace_ == MemorySpace::Device ||</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  (memorySpace_ == MemorySpace::Unified &&</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  getFullUnifiedMemSupport(device_)),</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="stringliteral">"Device %d does not support full CUDA 8 Unified Memory (CC 6.0+)"</span>,</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  config.device);</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor">#else</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="preprocessor"></span> FAISS_THROW_IF_NOT_MSG(memorySpace_ == MemorySpace::Device,</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="stringliteral">"Must compile with CUDA 8+ for Unified Memory support"</span>);</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  FAISS_ASSERT(resources_);</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  resources_->initializeForDevice(device_);</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> </div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="keywordtype">void</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1GpuIndex.html#af576341f6996b0e80e26b9748db51eb7"> 61</a></span> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndex.html#af576341f6996b0e80e26b9748db51eb7">GpuIndex::add</a>(<a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">Index::idx_t</a> n, <span class="keyword">const</span> <span class="keywordtype">float</span>* x) {</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <a class="code" href="classfaiss_1_1gpu_1_1GpuIndex.html#a90a4b0c76c15512d1d231383c404d8d2">addInternal_</a>(n, x, <span class="keyword">nullptr</span>);</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> </div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="keywordtype">void</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1GpuIndex.html#a47f6969fe60d82b8e3407557ba9eec88"> 66</a></span> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndex.html#a47f6969fe60d82b8e3407557ba9eec88">GpuIndex::add_with_ids</a>(<a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">Index::idx_t</a> n,</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keyword">const</span> <span class="keywordtype">float</span>* x,</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keyword">const</span> <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">Index::idx_t</a>* ids) {</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <a class="code" href="classfaiss_1_1gpu_1_1GpuIndex.html#a90a4b0c76c15512d1d231383c404d8d2">addInternal_</a>(n, x, ids);</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> }</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> <span class="keywordtype">void</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1GpuIndex.html#a90a4b0c76c15512d1d231383c404d8d2"> 73</a></span> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndex.html#a90a4b0c76c15512d1d231383c404d8d2">GpuIndex::addInternal_</a>(<a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">Index::idx_t</a> n,</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">const</span> <span class="keywordtype">float</span>* x,</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keyword">const</span> <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">Index::idx_t</a>* ids) {</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <a class="code" href="classfaiss_1_1gpu_1_1DeviceScope.html">DeviceScope</a> scope(<a class="code" href="classfaiss_1_1gpu_1_1GpuIndex.html#a67750633faa35677ee505a1e61cfe142">device_</a>);</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>  FAISS_THROW_IF_NOT_MSG(this-><a class="code" href="structfaiss_1_1Index.html#a6e92732617c4dbe364e7678dd8773a7f">is_trained</a>, <span class="stringliteral">"Index not trained"</span>);</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordflow">if</span> (n > 0) {</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordtype">size_t</span> totalSize = n * (size_t) this-><a class="code" href="structfaiss_1_1Index.html#a2a002388d2c081c2dbab8508dcefe73d">d</a> * <span class="keyword">sizeof</span>(<span class="keywordtype">float</span>);</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordflow">if</span> (totalSize > kAddPageSize || n > kAddVecSize) {</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="comment">// How many vectors fit into kAddPageSize?</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordtype">size_t</span> maxNumVecsForPageSize =</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  kAddPageSize / ((size_t) this-><a class="code" href="structfaiss_1_1Index.html#a2a002388d2c081c2dbab8508dcefe73d">d</a> * <span class="keyword">sizeof</span>(<span class="keywordtype">float</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="comment">// Always add at least 1 vector, if we have huge vectors</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  maxNumVecsForPageSize = std::max(maxNumVecsForPageSize, (<span class="keywordtype">size_t</span>) 1);</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keywordtype">size_t</span> tileSize = std::min((<span class="keywordtype">size_t</span>) n, maxNumVecsForPageSize);</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  tileSize = std::min(tileSize, kSearchVecSize);</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> i = 0; i < n; i += tileSize) {</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordtype">size_t</span> curNum = std::min(tileSize, n - i);</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <a class="code" href="classfaiss_1_1gpu_1_1GpuIndex.html#a345819c6214c2a6eb7874dde1145036f">addImpl_</a>(curNum,</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  x + i * (<span class="keywordtype">size_t</span>) this-><a class="code" href="structfaiss_1_1Index.html#a2a002388d2c081c2dbab8508dcefe73d">d</a>,</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  ids ? ids + i : <span class="keyword">nullptr</span>);</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  }</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  } <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <a class="code" href="classfaiss_1_1gpu_1_1GpuIndex.html#a345819c6214c2a6eb7874dde1145036f">addImpl_</a>(n, x, ids);</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</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> }</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">void</span></div>
<div class="line"><a name="l00108"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1GpuIndex.html#a6f1cadb5e8970c9c1fdf15eddb9d874f"> 108</a></span> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndex.html#a6f1cadb5e8970c9c1fdf15eddb9d874f">GpuIndex::search</a>(<a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">Index::idx_t</a> n,</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keyword">const</span> <span class="keywordtype">float</span>* x,</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">Index::idx_t</a> k,</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keywordtype">float</span>* distances,</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">Index::idx_t</a>* labels)<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <a class="code" href="classfaiss_1_1gpu_1_1DeviceScope.html">DeviceScope</a> scope(<a class="code" href="classfaiss_1_1gpu_1_1GpuIndex.html#a67750633faa35677ee505a1e61cfe142">device_</a>);</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>  FAISS_THROW_IF_NOT_MSG(this-><a class="code" href="structfaiss_1_1Index.html#a6e92732617c4dbe364e7678dd8773a7f">is_trained</a>, <span class="stringliteral">"Index not trained"</span>);</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keywordflow">if</span> (n > 0) {</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keywordtype">size_t</span> totalSize = n * (size_t) this-><a class="code" href="structfaiss_1_1Index.html#a2a002388d2c081c2dbab8508dcefe73d">d</a> * <span class="keyword">sizeof</span>(<span class="keywordtype">float</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="keywordflow">if</span> ((totalSize > kSearchPageSize) || (n > kSearchVecSize)) {</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="comment">// How many vectors fit into kSearchPageSize?</span></div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="comment">// Just consider `x`, not the size of `distances` or `labels`</span></div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="comment">// since they should be small, relatively speaking</span></div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="keywordtype">size_t</span> maxNumVecsForPageSize =</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  kSearchPageSize / ((size_t) this-><a class="code" href="structfaiss_1_1Index.html#a2a002388d2c081c2dbab8508dcefe73d">d</a> * <span class="keyword">sizeof</span>(<span class="keywordtype">float</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>  <span class="comment">// Always search at least 1 vector, if we have huge vectors</span></div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  maxNumVecsForPageSize = std::max(maxNumVecsForPageSize, (<span class="keywordtype">size_t</span>) 1);</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  <span class="keywordtype">size_t</span> tileSize = std::min((<span class="keywordtype">size_t</span>) n, maxNumVecsForPageSize);</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  tileSize = std::min(tileSize, kSearchVecSize);</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <span class="keywordflow">for</span> (<span class="keywordtype">size_t</span> i = 0; i < n; i += tileSize) {</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <span class="keywordtype">size_t</span> curNum = std::min(tileSize, n - i);</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>  <a class="code" href="classfaiss_1_1gpu_1_1GpuIndex.html#a482408e73bfa420d46eed690f2936e04">searchImpl_</a>(curNum,</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  x + i * (<span class="keywordtype">size_t</span>) this-><a class="code" href="structfaiss_1_1Index.html#a2a002388d2c081c2dbab8508dcefe73d">d</a>,</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  k,</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  distances + i * k,</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  labels + i * k);</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  }</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  } <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <a class="code" href="classfaiss_1_1gpu_1_1GpuIndex.html#a482408e73bfa420d46eed690f2936e04">searchImpl_</a>(n, x, k, distances, labels);</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>  }</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> </div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> } } <span class="comment">// namespace</span></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndex_html_a6f1cadb5e8970c9c1fdf15eddb9d874f"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndex.html#a6f1cadb5e8970c9c1fdf15eddb9d874f">faiss::gpu::GpuIndex::search</a></div><div class="ttdeci">void search(faiss::Index::idx_t n, const float *x, faiss::Index::idx_t k, float *distances, faiss::Index::idx_t *labels) const override</div><div class="ttdef"><b>Definition:</b> <a href="GpuIndex_8cu_source.html#l00108">GpuIndex.cu:108</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndex_html_a482408e73bfa420d46eed690f2936e04"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndex.html#a482408e73bfa420d46eed690f2936e04">faiss::gpu::GpuIndex::searchImpl_</a></div><div class="ttdeci">virtual void searchImpl_(faiss::Index::idx_t n, const float *x, faiss::Index::idx_t k, float *distances, faiss::Index::idx_t *labels) const =0</div><div class="ttdoc">Overridden to actually perform the search. </div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndex_html_a90a4b0c76c15512d1d231383c404d8d2"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndex.html#a90a4b0c76c15512d1d231383c404d8d2">faiss::gpu::GpuIndex::addInternal_</a></div><div class="ttdeci">void addInternal_(Index::idx_t n, const float *x, const Index::idx_t *ids)</div><div class="ttdef"><b>Definition:</b> <a href="GpuIndex_8cu_source.html#l00073">GpuIndex.cu:73</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndex_html_a47f6969fe60d82b8e3407557ba9eec88"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndex.html#a47f6969fe60d82b8e3407557ba9eec88">faiss::gpu::GpuIndex::add_with_ids</a></div><div class="ttdeci">void add_with_ids(Index::idx_t n, const float *x, const Index::idx_t *ids) override</div><div class="ttdef"><b>Definition:</b> <a href="GpuIndex_8cu_source.html#l00066">GpuIndex.cu:66</a></div></div>
<div class="ttc" id="structfaiss_1_1Index_html_a2a002388d2c081c2dbab8508dcefe73d"><div class="ttname"><a href="structfaiss_1_1Index.html#a2a002388d2c081c2dbab8508dcefe73d">faiss::Index::d</a></div><div class="ttdeci">int d</div><div class="ttdoc">vector dimension </div><div class="ttdef"><b>Definition:</b> <a href="Index_8h_source.html#l00064">Index.h:64</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndex_html_a67750633faa35677ee505a1e61cfe142"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndex.html#a67750633faa35677ee505a1e61cfe142">faiss::gpu::GpuIndex::device_</a></div><div class="ttdeci">const int device_</div><div class="ttdoc">The GPU device we are resident on. </div><div class="ttdef"><b>Definition:</b> <a href="GpuIndex_8h_source.html#l00094">GpuIndex.h:94</a></div></div>
<div class="ttc" id="structfaiss_1_1Index_html_a040c6aed1f224f3ea7bf58eebc0c31a4"><div class="ttname"><a href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">faiss::Index::idx_t</a></div><div class="ttdeci">long idx_t</div><div class="ttdoc">all indices are this type </div><div class="ttdef"><b>Definition:</b> <a href="Index_8h_source.html#l00062">Index.h:62</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndex_html_a345819c6214c2a6eb7874dde1145036f"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndex.html#a345819c6214c2a6eb7874dde1145036f">faiss::gpu::GpuIndex::addImpl_</a></div><div class="ttdeci">virtual void addImpl_(Index::idx_t n, const float *x, const Index::idx_t *ids)=0</div><div class="ttdoc">Overridden to actually perform the add. </div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndex_html_af576341f6996b0e80e26b9748db51eb7"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndex.html#af576341f6996b0e80e26b9748db51eb7">faiss::gpu::GpuIndex::add</a></div><div class="ttdeci">void add(faiss::Index::idx_t, const float *x) override</div><div class="ttdef"><b>Definition:</b> <a href="GpuIndex_8cu_source.html#l00061">GpuIndex.cu:61</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1DeviceScope_html"><div class="ttname"><a href="classfaiss_1_1gpu_1_1DeviceScope.html">faiss::gpu::DeviceScope</a></div><div class="ttdef"><b>Definition:</b> <a href="DeviceUtils_8h_source.html#l00065">DeviceUtils.h:65</a></div></div>
<div class="ttc" id="structfaiss_1_1Index_html_a6e92732617c4dbe364e7678dd8773a7f"><div class="ttname"><a href="structfaiss_1_1Index.html#a6e92732617c4dbe364e7678dd8773a7f">faiss::Index::is_trained</a></div><div class="ttdeci">bool is_trained</div><div class="ttdoc">set if the Index does not require training, or if training is done already </div><div class="ttdef"><b>Definition:</b> <a href="Index_8h_source.html#l00069">Index.h:69</a></div></div>
<div class="ttc" id="namespacefaiss_html_afd12191c638da74760ff397cf319752c"><div class="ttname"><a href="namespacefaiss.html#afd12191c638da74760ff397cf319752c">faiss::MetricType</a></div><div class="ttdeci">MetricType</div><div class="ttdoc">Some algorithms support both an inner product version and a L2 search version. </div><div class="ttdef"><b>Definition:</b> <a href="Index_8h_source.html#l00043">Index.h:43</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>