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
<!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: /tmp/faiss/c_api/IndexIVF_c.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_5fcc7c5aeda0d349161ae950b251beed.html">c_api</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">IndexIVF_c.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> <span class="comment">// -*- c -*-</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> </div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#ifndef FAISS_INDEX_IVF_C_H</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor"></span><span class="preprocessor">#define FAISS_INDEX_IVF_C_H</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include "faiss_c.h"</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include "Index_c.h"</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include "Clustering_c.h"</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor"></span><span class="comment"></span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">/** Index based on a inverted file (IVF)</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * In the inverted file, the quantizer (an Index instance) provides a</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * quantization index for each vector to be added. The quantization</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * index maps to a list (aka inverted list or posting list), where the</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * id of the vector is then stored.</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"> * At search time, the vector to be searched is also quantized, and</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> * only the list corresponding to the quantization index is</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> * searched. This speeds up the search by making it</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> * non-exhaustive. This can be relaxed using multi-probe search: a few</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> * (nprobe) quantization indices are selected and several inverted</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> * lists are visited.</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> * Sub-classes implement a post-filtering of the index that refines</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> * the distance estimation from the query to databse vectors.</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> FAISS_DECLARE_CLASS_INHERITED(IndexIVF, Index)</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> FAISS_DECLARE_DESTRUCTOR(IndexIVF)</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> FAISS_DECLARE_INDEX_DOWNCAST(IndexIVF)</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"></span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment">/// number of possible key values</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"></span>FAISS_DECLARE_GETTER(IndexIVF, <span class="keywordtype">size_t</span>, nlist)<span class="comment"></span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment">/// number of probes at query time</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"></span>FAISS_DECLARE_GETTER(IndexIVF, <span class="keywordtype">size_t</span>, nprobe)<span class="comment"></span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment">/// quantizer that maps vectors to inverted lists</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"></span>FAISS_DECLARE_GETTER(IndexIVF, FaissIndex*, quantizer)<span class="comment"></span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> * = 0: use the quantizer as index in a kmeans training</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> * = 1: just pass on the training set to the train() of the quantizer</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> * = 2: kmeans training on a flat index + add the centroids to the quantizer</span></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> FAISS_DECLARE_GETTER(IndexIVF, <span class="keywordtype">char</span>, quantizer_trains_alone)</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"></span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment">/// whether object owns the quantizer</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"></span>FAISS_DECLARE_GETTER(IndexIVF, <span class="keywordtype">int</span>, own_fields)</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"></span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment">/** moves the entries from another dataset to self. On output,</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> * other is empty. add_id is added to all moved ids (for</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> * sequential ids, this would be this->ntotal */</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="keywordtype">int</span> faiss_IndexIVF_merge_from(</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  FaissIndexIVF* index, FaissIndexIVF* other, idx_t add_id);</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"></span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment">/** copy a subset of the entries index to the other index</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> * if subset_type == 0: copies ids in [a1, a2)</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> * if subset_type == 1: copies ids if id % a1 == a2</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> * if subset_type == 2: copies inverted lists such that a1</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> * elements are left before and a2 elements are after</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="keywordtype">int</span> faiss_IndexIVF_copy_subset_to(</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  const FaissIndexIVF* index, FaissIndexIVF* other, <span class="keywordtype">int</span> subset_type, <span class="keywordtype">long</span> a1,</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordtype">long</span> a2);</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"></span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment">/** search a set of vectors, that are pre-quantized by the IVF</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> * quantizer. Fill in the corresponding heaps with the query</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> * results. search() calls this.</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> * @param n nb of vectors to query</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> * @param x query vectors, size nx * d</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> * @param assign coarse quantization indices, size nx * nprobe</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"> * @param centroid_dis</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"> * distances to coarse centroids, size nx * nprobe</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> * @param distance</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> * output distances, size n * k</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> * @param labels output labels, size n * k</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> * @param store_pairs store inv list index + inv list offset</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> * instead in upper/lower 32 bit of result,</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> * instead of ids (used for reranking).</span></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="keywordtype">int</span> faiss_IndexIVF_search_preassigned (const FaissIndexIVF* index,</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  idx_t n, const <span class="keywordtype">float</span> *x, idx_t k, const idx_t *assign,</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  const <span class="keywordtype">float</span> *centroid_dis, <span class="keywordtype">float</span> *distances, idx_t *labels,</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordtype">int</span> store_pairs);</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="keywordtype">size_t</span> faiss_IndexIVF_get_list_size(const FaissIndexIVF* index,</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keywordtype">size_t</span> list_no);</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"></span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment">/** intialize a direct map</span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> * @param new_maintain_direct_map if true, create a direct map,</span></div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> * else clear it</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="keywordtype">int</span> faiss_IndexIVF_make_direct_map(FaissIndexIVF* index,</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="keywordtype">int</span> new_maintain_direct_map);</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"></span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment">/// 1= perfectly balanced, >1: imbalanced</span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"></span><span class="keywordtype">double</span> faiss_IndexIVF_imbalance_factor (const FaissIndexIVF* index);</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"></span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment">/// display some stats about the inverted lists</span></div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"></span><span class="keywordtype">void</span> faiss_IndexIVF_print_stats (const FaissIndexIVF* index);</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> </div>
<div class="line"><a name="l00116"></a><span class="lineno"><a class="line" href="structFaissIndexIVFStats.html"> 116</a></span> typedef struct <a class="code" href="structFaissIndexIVFStats.html">FaissIndexIVFStats</a> {</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keywordtype">size_t</span> nq; <span class="comment">// nb of queries run</span></div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keywordtype">size_t</span> nlist; <span class="comment">// nb of inverted lists scanned</span></div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keywordtype">size_t</span> ndis; <span class="comment">// nb of distancs computed</span></div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> } <a class="code" href="structFaissIndexIVFStats.html">FaissIndexIVFStats</a>;</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> </div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="keywordtype">void</span> faiss_IndexIVFStats_reset(<a class="code" href="structFaissIndexIVFStats.html">FaissIndexIVFStats</a>* stats);</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> </div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> faiss_IndexIVFStats_init(<a class="code" href="structFaissIndexIVFStats.html">FaissIndexIVFStats</a>* stats) {</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  faiss_IndexIVFStats_reset(stats);</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"></span></div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment">/** Inverted file with stored vectors. Here the inverted file</span></div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"> * pre-selects the vectors to be searched, but they are not otherwise</span></div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"> * encoded, the code array just contains the raw float entries.</span></div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> FAISS_DECLARE_CLASS(IndexIVFFlat)</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> FAISS_DECLARE_DESTRUCTOR(IndexIVFFlat)</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> faiss_IndexIVFFlat_new(FaissIndexIVFFlat** p_index);</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="keywordtype">int</span> faiss_IndexIVFFlat_new_with(FaissIndexIVFFlat** p_index,</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  FaissIndex* quantizer, <span class="keywordtype">size_t</span> d, <span class="keywordtype">size_t</span> nlist);</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="keywordtype">int</span> faiss_IndexIVFFlat_new_with_metric(</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  FaissIndexIVFFlat** p_index, FaissIndex* quantizer, <span class="keywordtype">size_t</span> d, <span class="keywordtype">size_t</span> nlist,</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  FaissMetricType metric);</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> </div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="keywordtype">int</span> faiss_IndexIVFFlat_add_core(FaissIndexIVFFlat* index, idx_t n, </div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  const <span class="keywordtype">float</span> * x, const <span class="keywordtype">long</span> *xids, const <span class="keywordtype">long</span> *precomputed_idx);</div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"></span></div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment">/** Update a subset of vectors.</span></div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"> * The index must have a direct_map</span></div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"> * @param nv nb of vectors to update</span></div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment"> * @param idx vector indices to update, size nv</span></div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"> * @param v vectors of new values, size nv*d</span></div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="keywordtype">int</span> faiss_IndexIVFFlat_update_vectors(FaissIndexIVFFlat* index, <span class="keywordtype">int</span> nv,</div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  idx_t *idx, const <span class="keywordtype">float</span> *v);</div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> </div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="preprocessor"></span>}</div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="preprocessor"></span></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="preprocessor">#endif</span></div>
<div class="ttc" id="structFaissIndexIVFStats_html"><div class="ttname"><a href="structFaissIndexIVFStats.html">FaissIndexIVFStats</a></div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF__c_8h_source.html#l00116">IndexIVF_c.h:116</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>