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
<!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/GpuIndexIVF.h 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">GpuIndexIVF.h</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">#pragma once</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include "GpuIndex.h"</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include "GpuIndexFlat.h"</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include "GpuIndicesOptions.h"</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include "../Clustering.h"</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">namespace </span>faiss { <span class="keyword">struct </span>IndexIVF; }</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">class </span>GpuIndexFlat;</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">class </span>GpuResources;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="structfaiss_1_1gpu_1_1GpuIndexIVFConfig.html"> 25</a></span> <span class="keyword">struct </span><a class="code" href="structfaiss_1_1gpu_1_1GpuIndexIVFConfig.html">GpuIndexIVFConfig</a> : <span class="keyword">public</span> <a class="code" href="structfaiss_1_1gpu_1_1GpuIndexConfig.html">GpuIndexConfig</a> {</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="keyword">inline</span> <a class="code" href="structfaiss_1_1gpu_1_1GpuIndexIVFConfig.html">GpuIndexIVFConfig</a>()</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  : <a class="code" href="structfaiss_1_1gpu_1_1GpuIndexIVFConfig.html#af432221761d48e4753f501208a60264d">indicesOptions</a>(INDICES_64_BIT) {</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  }</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"></span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> /// Index storage options for the GPU</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="structfaiss_1_1gpu_1_1GpuIndexIVFConfig.html#af432221761d48e4753f501208a60264d"> 31</a></span> <span class="comment"></span> IndicesOptions <a class="code" href="structfaiss_1_1gpu_1_1GpuIndexIVFConfig.html#af432221761d48e4753f501208a60264d">indicesOptions</a>;</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"> /// Configuration for the coarse quantizer object</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="structfaiss_1_1gpu_1_1GpuIndexIVFConfig.html#a6d357a9a67a2fed9c8e7b139712d30f6"> 34</a></span> <span class="comment"></span> <a class="code" href="structfaiss_1_1gpu_1_1GpuIndexFlatConfig.html">GpuIndexFlatConfig</a> <a class="code" href="structfaiss_1_1gpu_1_1GpuIndexIVFConfig.html#a6d357a9a67a2fed9c8e7b139712d30f6">flatConfig</a>;</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"><a class="line" href="classfaiss_1_1gpu_1_1GpuIndexIVF.html"> 37</a></span> <span class="keyword">class </span><a class="code" href="classfaiss_1_1gpu_1_1GpuIndexIVF.html">GpuIndexIVF</a> : <span class="keyword">public</span> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndex.html">GpuIndex</a> {</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexIVF.html">GpuIndexIVF</a>(<a class="code" href="classfaiss_1_1gpu_1_1GpuResources.html">GpuResources</a>* resources,</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordtype">int</span> dims,</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <a class="code" href="namespacefaiss.html#afd12191c638da74760ff397cf319752c">faiss::MetricType</a> metric,</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordtype">int</span> nlist,</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <a class="code" href="structfaiss_1_1gpu_1_1GpuIndexIVFConfig.html">GpuIndexIVFConfig</a> config = <a class="code" href="structfaiss_1_1gpu_1_1GpuIndexIVFConfig.html">GpuIndexIVFConfig</a>());</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  ~<a class="code" href="classfaiss_1_1gpu_1_1GpuIndexIVF.html">GpuIndexIVF</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">private</span>:<span class="comment"></span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> /// Shared initialization functions</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"></span> <span class="keywordtype">void</span> init_();</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="keyword">public</span>:<span class="comment"></span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> /// Copy what we need from the CPU equivalent</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexIVF.html#a94c2c171f9a2d27085dea9101067bdf2">copyFrom</a>(<span class="keyword">const</span> <a class="code" href="structfaiss_1_1IndexIVF.html">faiss::IndexIVF</a>* index);</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"></span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> /// Copy what we have to the CPU equivalent</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexIVF.html#a1db0a796b8b2917d989952c5f07fbe55">copyTo</a>(<a class="code" href="structfaiss_1_1IndexIVF.html">faiss::IndexIVF</a>* index) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"></span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> /// Returns the number of inverted lists we're managing</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexIVF.html#a43a63e93d55b79eac38173f219743ddf">getNumLists</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"></span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> /// Return the quantizer we're using</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"></span> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexFlat.html">GpuIndexFlat</a>* <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexIVF.html#afe6eb789377072b309d7a385aa0d1c5e">getQuantizer</a>();</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"></span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> /// Sets the number of list probes per query</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexIVF.html#a1efac4b9801d57fa6d0085d6aed9c1f2">setNumProbes</a>(<span class="keywordtype">int</span> nprobe);</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"></span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> /// Returns our current number of list probes per query</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexIVF.html#a13bce124f8acada641daf60d6edddb33">getNumProbes</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"></span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> /// `x` can be resident on the CPU or any GPU; the proper copies are</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> /// performed</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> /// Forwards to add_with_ids; assigns IDs as needed</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> /// FIXME: remove override for C++03 compatibility</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexIVF.html#ace41857c97a357284acbe4556c9da3da">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) <span class="keyword">override</span>;</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="keyword">protected</span>:</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordtype">void</span> trainQuantizer_(<a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">faiss::Index::idx_t</a> n, <span class="keyword">const</span> <span class="keywordtype">float</span>* x);</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="keyword">public</span>:<span class="comment"></span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> /// Exposed as IndexIVF does to allow overriding clustering</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> /// parameters</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1GpuIndexIVF.html#a520803e209b44c904b876d6b8dad23c9"> 82</a></span> <span class="comment"></span> <a class="code" href="structfaiss_1_1ClusteringParameters.html">ClusteringParameters</a> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexIVF.html#a520803e209b44c904b876d6b8dad23c9">cp</a>;</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <a class="code" href="structfaiss_1_1gpu_1_1GpuIndexIVFConfig.html">GpuIndexIVFConfig</a> ivfConfig_;</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"></span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> /// Number of inverted lists that we manage</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1GpuIndexIVF.html#aba606c141e714fab843493cc58167494"> 88</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexIVF.html#aba606c141e714fab843493cc58167494">nlist_</a>;</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"></span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> /// Number of inverted list probes per query</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1GpuIndexIVF.html#a187bdcbbac02bf8fd0e6bb40a1c0426b"> 91</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexIVF.html#a187bdcbbac02bf8fd0e6bb40a1c0426b">nprobe_</a>;</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"></span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> /// Quantizer for inverted lists</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="classfaiss_1_1gpu_1_1GpuIndexIVF.html#aaa7dd748e3cbd7ef68f2e384ac503eab"> 94</a></span> <span class="comment"></span> <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexFlat.html">GpuIndexFlat</a>* <a class="code" href="classfaiss_1_1gpu_1_1GpuIndexIVF.html#aaa7dd748e3cbd7ef68f2e384ac503eab">quantizer_</a>;</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> </div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> } } <span class="comment">// namespace</span></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html">faiss::IndexIVF</a></div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00045">IndexIVF.h:45</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndexIVF_html_a13bce124f8acada641daf60d6edddb33"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndexIVF.html#a13bce124f8acada641daf60d6edddb33">faiss::gpu::GpuIndexIVF::getNumProbes</a></div><div class="ttdeci">int getNumProbes() const </div><div class="ttdoc">Returns our current number of list probes per query. </div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexIVF_8cu_source.html#l00210">GpuIndexIVF.cu:210</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndexIVF_html_a1efac4b9801d57fa6d0085d6aed9c1f2"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndexIVF.html#a1efac4b9801d57fa6d0085d6aed9c1f2">faiss::gpu::GpuIndexIVF::setNumProbes</a></div><div class="ttdeci">void setNumProbes(int nprobe)</div><div class="ttdoc">Sets the number of list probes per query. </div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexIVF_8cu_source.html#l00202">GpuIndexIVF.cu:202</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndexIVF_html_a43a63e93d55b79eac38173f219743ddf"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndexIVF.html#a43a63e93d55b79eac38173f219743ddf">faiss::gpu::GpuIndexIVF::getNumLists</a></div><div class="ttdeci">int getNumLists() const </div><div class="ttdoc">Returns the number of inverted lists we&#39;re managing. </div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexIVF_8cu_source.html#l00197">GpuIndexIVF.cu:197</a></div></div>
<div class="ttc" id="structfaiss_1_1gpu_1_1GpuIndexIVFConfig_html"><div class="ttname"><a href="structfaiss_1_1gpu_1_1GpuIndexIVFConfig.html">faiss::gpu::GpuIndexIVFConfig</a></div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexIVF_8h_source.html#l00025">GpuIndexIVF.h:25</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuResources_html"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuResources.html">faiss::gpu::GpuResources</a></div><div class="ttdef"><b>Definition:</b> <a href="GpuResources_8h_source.html#l00023">GpuResources.h:23</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndex_html"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndex.html">faiss::gpu::GpuIndex</a></div><div class="ttdef"><b>Definition:</b> <a href="GpuIndex_8h_source.html#l00035">GpuIndex.h:35</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndexIVF_html"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndexIVF.html">faiss::gpu::GpuIndexIVF</a></div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexIVF_8h_source.html#l00037">GpuIndexIVF.h:37</a></div></div>
<div class="ttc" id="structfaiss_1_1gpu_1_1GpuIndexFlatConfig_html"><div class="ttname"><a href="structfaiss_1_1gpu_1_1GpuIndexFlatConfig.html">faiss::gpu::GpuIndexFlatConfig</a></div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexFlat_8h_source.html#l00027">GpuIndexFlat.h:27</a></div></div>
<div class="ttc" id="structfaiss_1_1gpu_1_1GpuIndexIVFConfig_html_a6d357a9a67a2fed9c8e7b139712d30f6"><div class="ttname"><a href="structfaiss_1_1gpu_1_1GpuIndexIVFConfig.html#a6d357a9a67a2fed9c8e7b139712d30f6">faiss::gpu::GpuIndexIVFConfig::flatConfig</a></div><div class="ttdeci">GpuIndexFlatConfig flatConfig</div><div class="ttdoc">Configuration for the coarse quantizer object. </div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexIVF_8h_source.html#l00034">GpuIndexIVF.h:34</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndexIVF_html_afe6eb789377072b309d7a385aa0d1c5e"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndexIVF.html#afe6eb789377072b309d7a385aa0d1c5e">faiss::gpu::GpuIndexIVF::getQuantizer</a></div><div class="ttdeci">GpuIndexFlat * getQuantizer()</div><div class="ttdoc">Return the quantizer we&#39;re using. </div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexIVF_8cu_source.html#l00075">GpuIndexIVF.cu:75</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndexIVF_html_a187bdcbbac02bf8fd0e6bb40a1c0426b"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndexIVF.html#a187bdcbbac02bf8fd0e6bb40a1c0426b">faiss::gpu::GpuIndexIVF::nprobe_</a></div><div class="ttdeci">int nprobe_</div><div class="ttdoc">Number of inverted list probes per query. </div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexIVF_8h_source.html#l00091">GpuIndexIVF.h:91</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndexIVF_html_a1db0a796b8b2917d989952c5f07fbe55"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndexIVF.html#a1db0a796b8b2917d989952c5f07fbe55">faiss::gpu::GpuIndexIVF::copyTo</a></div><div class="ttdeci">void copyTo(faiss::IndexIVF *index) const </div><div class="ttdoc">Copy what we have to the CPU equivalent. </div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexIVF_8cu_source.html#l00148">GpuIndexIVF.cu:148</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_1GpuIndexIVF_html_aba606c141e714fab843493cc58167494"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndexIVF.html#aba606c141e714fab843493cc58167494">faiss::gpu::GpuIndexIVF::nlist_</a></div><div class="ttdeci">int nlist_</div><div class="ttdoc">Number of inverted lists that we manage. </div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexIVF_8h_source.html#l00088">GpuIndexIVF.h:88</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndexIVF_html_aaa7dd748e3cbd7ef68f2e384ac503eab"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndexIVF.html#aaa7dd748e3cbd7ef68f2e384ac503eab">faiss::gpu::GpuIndexIVF::quantizer_</a></div><div class="ttdeci">GpuIndexFlat * quantizer_</div><div class="ttdoc">Quantizer for inverted lists. </div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexIVF_8h_source.html#l00094">GpuIndexIVF.h:94</a></div></div>
<div class="ttc" id="structfaiss_1_1ClusteringParameters_html"><div class="ttname"><a href="structfaiss_1_1ClusteringParameters.html">faiss::ClusteringParameters</a></div><div class="ttdef"><b>Definition:</b> <a href="Clustering_8h_source.html#l00024">Clustering.h:24</a></div></div>
<div class="ttc" id="structfaiss_1_1gpu_1_1GpuIndexConfig_html"><div class="ttname"><a href="structfaiss_1_1gpu_1_1GpuIndexConfig.html">faiss::gpu::GpuIndexConfig</a></div><div class="ttdef"><b>Definition:</b> <a href="GpuIndex_8h_source.html#l00020">GpuIndex.h:20</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndexFlat_html"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndexFlat.html">faiss::gpu::GpuIndexFlat</a></div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexFlat_8h_source.html#l00054">GpuIndexFlat.h:54</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndexIVF_html_a94c2c171f9a2d27085dea9101067bdf2"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndexIVF.html#a94c2c171f9a2d27085dea9101067bdf2">faiss::gpu::GpuIndexIVF::copyFrom</a></div><div class="ttdeci">void copyFrom(const faiss::IndexIVF *index)</div><div class="ttdoc">Copy what we need from the CPU equivalent. </div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexIVF_8cu_source.html#l00080">GpuIndexIVF.cu:80</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndexIVF_html_ace41857c97a357284acbe4556c9da3da"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndexIVF.html#ace41857c97a357284acbe4556c9da3da">faiss::gpu::GpuIndexIVF::add</a></div><div class="ttdeci">void add(Index::idx_t n, const float *x) override</div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexIVF_8cu_source.html#l00215">GpuIndexIVF.cu:215</a></div></div>
<div class="ttc" id="classfaiss_1_1gpu_1_1GpuIndexIVF_html_a520803e209b44c904b876d6b8dad23c9"><div class="ttname"><a href="classfaiss_1_1gpu_1_1GpuIndexIVF.html#a520803e209b44c904b876d6b8dad23c9">faiss::gpu::GpuIndexIVF::cp</a></div><div class="ttdeci">ClusteringParameters cp</div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexIVF_8h_source.html#l00082">GpuIndexIVF.h:82</a></div></div>
<div class="ttc" id="structfaiss_1_1gpu_1_1GpuIndexIVFConfig_html_af432221761d48e4753f501208a60264d"><div class="ttname"><a href="structfaiss_1_1gpu_1_1GpuIndexIVFConfig.html#af432221761d48e4753f501208a60264d">faiss::gpu::GpuIndexIVFConfig::indicesOptions</a></div><div class="ttdeci">IndicesOptions indicesOptions</div><div class="ttdoc">Index storage options for the GPU. </div><div class="ttdef"><b>Definition:</b> <a href="GpuIndexIVF_8h_source.html#l00031">GpuIndexIVF.h:31</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>