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
<!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/hoss/faiss/gpu/GpuDistance.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_5956a3e80a20e8e03eb577bedb92689f.html">gpu</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">GpuDistance.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) Facebook, Inc. and its affiliates.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * This source code is licensed under the MIT license found in the</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * LICENSE file in the root directory of this source tree.</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</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="preprocessor">#include "GpuDistance.h"</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include "../FaissAssert.h"</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include "GpuResources.h"</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include "impl/Distance.cuh"</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include "utils/ConversionOperators.cuh"</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include "utils/CopyUtils.cuh"</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include "utils/DeviceUtils.h"</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include "utils/DeviceTensor.cuh"</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="preprocessor">#include <thrust/execution_policy.h></span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include <thrust/transform.h></span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">namespace </span>faiss { <span class="keyword">namespace </span>gpu {</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="keywordtype">void</span> bruteForceKnn(GpuResources* resources,</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <a class="code" href="namespacefaiss.html#afd12191c638da74760ff397cf319752c">faiss::MetricType</a> metric,</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <span class="comment">// A region of memory size numVectors x dims, with dims</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="comment">// innermost</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="keyword">const</span> <span class="keywordtype">float</span>* vectors,</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="keywordtype">bool</span> vectorsRowMajor,</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keywordtype">int</span> numVectors,</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="comment">// A region of memory size numQueries x dims, with dims</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="comment">// innermost</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keyword">const</span> <span class="keywordtype">float</span>* queries,</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keywordtype">bool</span> queriesRowMajor,</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keywordtype">int</span> numQueries,</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keywordtype">int</span> dims,</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keywordtype">int</span> k,</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="comment">// A region of memory size numQueries x k, with k</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="comment">// innermost</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordtype">float</span>* outDistances,</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="comment">// A region of memory size numQueries x k, with k</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="comment">// innermost</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <a class="code" href="structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea">faiss::Index::idx_t</a>* outIndices) {</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keyword">auto</span> device = getCurrentDevice();</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keyword">auto</span> stream = resources->getDefaultStreamCurrentDevice();</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">auto</span>& mem = resources->getMemoryManagerCurrentDevice();</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">auto</span> tVectors = toDevice<float, 2>(resources,</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  device,</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keyword">const_cast<</span><span class="keywordtype">float</span>*<span class="keyword">></span>(vectors),</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  stream,</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  {vectorsRowMajor ? numVectors : dims,</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  vectorsRowMajor ? dims : numVectors});</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">auto</span> tQueries = toDevice<float, 2>(resources,</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  device,</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">const_cast<</span><span class="keywordtype">float</span>*<span class="keyword">></span>(queries),</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  stream,</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  {queriesRowMajor ? numQueries : dims,</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  queriesRowMajor ? dims : numQueries});</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="keyword">auto</span> tOutDistances = toDevice<float, 2>(resources,</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  device,</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  outDistances,</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  stream,</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  {numQueries, k});</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>  <span class="comment">// FlatIndex only supports an interface returning int indices, allocate</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="comment">// temporary memory for it</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  DeviceTensor<int, 2, true> tOutIntIndices(mem, {numQueries, k}, stream);</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="comment">// Do the work</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordflow">if</span> (metric == faiss::MetricType::METRIC_L2) {</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  runL2Distance(resources,</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  tVectors,</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  vectorsRowMajor,</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keyword">nullptr</span>, <span class="comment">// compute norms in temp memory</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  tQueries,</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  queriesRowMajor,</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  k,</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  tOutDistances,</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  tOutIntIndices);</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (metric == faiss::MetricType::METRIC_INNER_PRODUCT) {</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  runIPDistance(resources,</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  tVectors,</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  vectorsRowMajor,</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  tQueries,</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  queriesRowMajor,</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  k,</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  tOutDistances,</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  tOutIntIndices);</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  } <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  FAISS_THROW_MSG(<span class="stringliteral">"metric should be METRIC_L2 or METRIC_INNER_PRODUCT"</span>);</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  }</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="comment">// Convert and copy int indices out</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keyword">auto</span> tOutIndices = toDevice<faiss::Index::idx_t, 2>(resources,</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  device,</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  outIndices,</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  stream,</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  {numQueries, k});</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="comment">// Convert int to idx_t</span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  thrust::transform(thrust::cuda::par.on(stream),</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  tOutIntIndices.data(),</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  tOutIntIndices.end(),</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  tOutIndices.data(),</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  IntToIdxType());</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="comment">// Copy back if necessary</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  fromDevice<float, 2>(tOutDistances, outDistances, stream);</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  fromDevice<faiss::Index::idx_t, 2>(tOutIndices, outIndices, stream);</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> }</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> } } <span class="comment">// namespace</span></div>
<div class="ttc" id="structfaiss_1_1Index_html_ad3f0d3071f987baabbdd3da4500c87ea"><div class="ttname"><a href="structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea">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="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#l00044">Index.h:44</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>