Skip to content

F
faiss
Switch branch/tag
Find file
BlameHistoryPermalink
IndexIVFFlat_8h_source.html 38.5 KB
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 
<!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/IndexIVFFlat.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&#160;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&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<!-- 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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</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 class="header">
  <div class="headertitle">
<div class="title">/tmp/faiss/IndexIVFFlat.h</div>  </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * Copyright (c) 2015-present, Facebook, Inc.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> * All rights reserved.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<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>&#160;<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>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;</div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment">// -*- c++ -*-</span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;</div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="preprocessor">#ifndef FAISS_INDEX_IVF_FLAT_H</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define FAISS_INDEX_IVF_FLAT_H</span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="preprocessor">#include &lt;unordered_map&gt;</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;</div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="preprocessor">#include &quot;IndexIVF.h&quot;</span></div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;</div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;</div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="keyword">namespace </span>faiss {</div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment">/** Inverted file with stored vectors. Here the inverted file</span></div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment"> * pre-selects the vectors to be searched, but they are not otherwise</span></div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment"> * encoded, the code array just contains the raw float entries.</span></div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexIVFFlat.html">   25</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structfaiss_1_1IndexIVFFlat.html">IndexIVFFlat</a>: <a class="code" href="structfaiss_1_1IndexIVF.html">IndexIVF</a> {</div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;</div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;    <a class="code" href="structfaiss_1_1IndexIVFFlat.html">IndexIVFFlat</a> (</div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;            <a class="code" href="structfaiss_1_1Index.html">Index</a> * <a class="code" href="structfaiss_1_1Level1Quantizer.html#a3cf99e2ee92b8558a066f821efab95d5">quantizer</a>, <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1Index.html#a2a002388d2c081c2dbab8508dcefe73d">d</a>, <span class="keywordtype">size_t</span> nlist_,</div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;            <a class="code" href="namespacefaiss.html#afd12191c638da74760ff397cf319752c">MetricType</a> = METRIC_L2);</div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="comment">    /// same as add_with_ids, with precomputed coarse quantizer</span></div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="comment"></span>    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVFFlat.html#aea729c3d8c70bdd93f8e413e834851a4">add_core</a> (<a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> n, <span class="keyword">const</span> <span class="keywordtype">float</span> * x, <span class="keyword">const</span> <span class="keywordtype">long</span> *xids,</div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;                   <span class="keyword">const</span> <span class="keywordtype">long</span> *precomputed_idx);</div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="comment">    /// implemented for all IndexIVF* classes</span></div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="comment"></span>    <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVFFlat.html#a5f7356766632d3ce2838f285aa6b8e76">add_with_ids</a>(<a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> n, <span class="keyword">const</span> <span class="keywordtype">float</span>* x, <span class="keyword">const</span> <span class="keywordtype">long</span>* xids) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;</div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVFFlat.html#a2c445db1ccbad852dad17e60e0fac950">encode_vectors</a>(<a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> n, <span class="keyword">const</span> <span class="keywordtype">float</span>* x,</div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;                        <span class="keyword">const</span> <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> *list_nos,</div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;                        uint8_t * codes) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;</div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;    <span class="comment">/*</span></div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="comment">    void search_preassigned (idx_t n, const float *x, idx_t k,</span></div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;<span class="comment">                             const idx_t *assign,</span></div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="comment">                             const float *centroid_dis,</span></div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;<span class="comment">                             float *distances, idx_t *labels,</span></div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="comment">                             bool store_pairs,</span></div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="comment">                             const IVFSearchParameters *params=nullptr</span></div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;<span class="comment">                             ) const override;</span></div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;<span class="comment">    */</span></div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;    <a class="code" href="structfaiss_1_1InvertedListScanner.html">InvertedListScanner</a> *<a class="code" href="structfaiss_1_1IndexIVFFlat.html#a05cbcc239916559b29b1eb1943b00440">get_InvertedListScanner</a> (<span class="keywordtype">bool</span> store_pairs)</div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;        <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;</div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVFFlat.html#ad2b306f160e153b5cfb572cf1d8ece24">range_search</a>(</div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;        <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> n,</div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;        <span class="keyword">const</span> <span class="keywordtype">float</span>* x,</div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;        <span class="keywordtype">float</span> radius,</div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;        <a class="code" href="structfaiss_1_1RangeSearchResult.html">RangeSearchResult</a>* result) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;<span class="comment">    /** Update a subset of vectors.</span></div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="comment">     *</span></div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;<span class="comment">     * The index must have a direct_map</span></div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<span class="comment">     *</span></div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;<span class="comment">     * @param nv     nb of vectors to update</span></div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;<span class="comment">     * @param idx    vector indices to update, size nv</span></div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;<span class="comment">     * @param v      vectors of new values, size nv*d</span></div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;<span class="comment">     */</span></div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVFFlat.html#a2adc0b0002c32ddc01aec4ab96dd659f">update_vectors</a> (<span class="keywordtype">int</span> nv, <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> *idx, <span class="keyword">const</span> <span class="keywordtype">float</span> *v);</div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;</div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVFFlat.html#a1267faf361fc3831ddafe7abc51f0ba2">reconstruct_from_offset</a> (<span class="keywordtype">long</span> list_no, <span class="keywordtype">long</span> offset,</div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;                                  <span class="keywordtype">float</span>* recons) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;</div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;    <a class="code" href="structfaiss_1_1IndexIVFFlat.html">IndexIVFFlat</a> () {}</div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;};</div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;</div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;</div>
<div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexIVFFlatDedup.html">   77</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structfaiss_1_1IndexIVFFlatDedup.html">IndexIVFFlatDedup</a>: <a class="code" href="structfaiss_1_1IndexIVFFlat.html">IndexIVFFlat</a> {</div>
<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;<span class="comment">    /** Maps ids stored in the index to the ids of vectors that are</span></div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;<span class="comment">     *  the same. When a vector is unique, it does not appear in the</span></div>
<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;<span class="comment">     *  instances map */</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexIVFFlatDedup.html#a1ff220494d504dd806e5daf290ec0e7a">   82</a></span>&#160;    std::unordered_multimap &lt;idx_t, idx_t&gt; <a class="code" href="structfaiss_1_1IndexIVFFlatDedup.html#a1ff220494d504dd806e5daf290ec0e7a">instances</a>;</div>
<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;</div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;    <a class="code" href="structfaiss_1_1IndexIVFFlatDedup.html">IndexIVFFlatDedup</a> (</div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;            <a class="code" href="structfaiss_1_1Index.html">Index</a> * <a class="code" href="structfaiss_1_1Level1Quantizer.html#a3cf99e2ee92b8558a066f821efab95d5">quantizer</a>, <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1Index.html#a2a002388d2c081c2dbab8508dcefe73d">d</a>, <span class="keywordtype">size_t</span> nlist_,</div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;            <a class="code" href="namespacefaiss.html#afd12191c638da74760ff397cf319752c">MetricType</a> = METRIC_L2);</div>
<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;<span class="comment">    /// also dedups the training set</span></div>
<div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;<span class="comment"></span>    <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVFFlatDedup.html#a24002a8c3f12aa2784833c14b13b427e">train</a>(idx_t n, <span class="keyword">const</span> <span class="keywordtype">float</span>* x) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;<span class="comment">    /// implemented for all IndexIVF* classes</span></div>
<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;<span class="comment"></span>    <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVFFlatDedup.html#ae1d5f41f4987f4e02938738436f082bf">add_with_ids</a>(idx_t n, <span class="keyword">const</span> <span class="keywordtype">float</span>* x, <span class="keyword">const</span> <span class="keywordtype">long</span>* xids) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;</div>
<div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVFFlatDedup.html#a88f84494a02e8ceab79982bcbcab4fa5">search_preassigned</a> (idx_t n, <span class="keyword">const</span> <span class="keywordtype">float</span> *x, idx_t k,</div>
<div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;                             <span class="keyword">const</span> idx_t *<a class="code" href="structfaiss_1_1Index.html#a8bc5d8d1cd0dd7b34b3c98a9f76b4a9c">assign</a>,</div>
<div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;                             <span class="keyword">const</span> <span class="keywordtype">float</span> *centroid_dis,</div>
<div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;                             <span class="keywordtype">float</span> *distances, idx_t *labels,</div>
<div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;                             <span class="keywordtype">bool</span> store_pairs,</div>
<div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;                             <span class="keyword">const</span> <a class="code" href="structfaiss_1_1IVFSearchParameters.html">IVFSearchParameters</a> *params=<span class="keyword">nullptr</span></div>
<div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;                             ) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;</div>
<div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;    <span class="keywordtype">long</span> <a class="code" href="structfaiss_1_1IndexIVFFlatDedup.html#aae53833bb1e4041358cd4e5407d6a296">remove_ids</a>(<span class="keyword">const</span> <a class="code" href="structfaiss_1_1IDSelector.html">IDSelector</a>&amp; sel) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;<span class="comment">    /// not implemented</span></div>
<div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;<span class="comment"></span>    <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVFFlatDedup.html#acb4f1350039546f5001c5fc36ac0fb2d">range_search</a>(</div>
<div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;        idx_t n,</div>
<div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;        <span class="keyword">const</span> <span class="keywordtype">float</span>* x,</div>
<div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;        <span class="keywordtype">float</span> radius,</div>
<div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;        <a class="code" href="structfaiss_1_1RangeSearchResult.html">RangeSearchResult</a>* result) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;<span class="comment">    /// not implemented</span></div>
<div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;<span class="comment"></span>    <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVFFlatDedup.html#a0782b04472858d993ad4c0ffc81b1844">update_vectors</a> (<span class="keywordtype">int</span> nv, idx_t *idx, <span class="keyword">const</span> <span class="keywordtype">float</span> *v) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;</div>
<div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;<span class="comment">    /// not implemented</span></div>
<div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;<span class="comment"></span>    <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVFFlatDedup.html#adedda3a8e10704acc5639b7f6aa065f7">reconstruct_from_offset</a> (<span class="keywordtype">long</span> list_no, <span class="keywordtype">long</span> offset,</div>
<div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;                                  <span class="keywordtype">float</span>* recons) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;</div>
<div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;    <a class="code" href="structfaiss_1_1IndexIVFFlatDedup.html">IndexIVFFlatDedup</a> () {}</div>
<div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;</div>
<div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;</div>
<div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;};</div>
<div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;</div>
<div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;</div>
<div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;</div>
<div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;} <span class="comment">// namespace faiss</span></div>
<div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;</div>
<div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;<span class="preprocessor">#endif</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#l00091">IndexIVF.h:91</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVFFlatDedup_html_a24002a8c3f12aa2784833c14b13b427e"><div class="ttname"><a href="structfaiss_1_1IndexIVFFlatDedup.html#a24002a8c3f12aa2784833c14b13b427e">faiss::IndexIVFFlatDedup::train</a></div><div class="ttdeci">void train(idx_t n, const float *x) override</div><div class="ttdoc">also dedups the training set </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVFFlat_8cpp_source.html#l00288">IndexIVFFlat.cpp:288</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVFFlatDedup_html_adedda3a8e10704acc5639b7f6aa065f7"><div class="ttname"><a href="structfaiss_1_1IndexIVFFlatDedup.html#adedda3a8e10704acc5639b7f6aa065f7">faiss::IndexIVFFlatDedup::reconstruct_from_offset</a></div><div class="ttdeci">void reconstruct_from_offset(long list_no, long offset, float *recons) const override</div><div class="ttdoc">not implemented </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVFFlat_8cpp_source.html#l00516">IndexIVFFlat.cpp:516</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVFFlat_html_a2c445db1ccbad852dad17e60e0fac950"><div class="ttname"><a href="structfaiss_1_1IndexIVFFlat.html#a2c445db1ccbad852dad17e60e0fac950">faiss::IndexIVFFlat::encode_vectors</a></div><div class="ttdeci">void encode_vectors(idx_t n, const float *x, const idx_t *list_nos, uint8_t *codes) const override</div><div class="ttdef"><b>Definition:</b> <a href="IndexIVFFlat_8cpp_source.html#l00083">IndexIVFFlat.cpp:83</a></div></div>
<div class="ttc" id="structfaiss_1_1Index_html_a8bc5d8d1cd0dd7b34b3c98a9f76b4a9c"><div class="ttname"><a href="structfaiss_1_1Index.html#a8bc5d8d1cd0dd7b34b3c98a9f76b4a9c">faiss::Index::assign</a></div><div class="ttdeci">void assign(idx_t n, const float *x, idx_t *labels, idx_t k=1)</div><div class="ttdef"><b>Definition:</b> <a href="Index_8cpp_source.html#l00035">Index.cpp:35</a></div></div>
<div class="ttc" id="structfaiss_1_1IDSelector_html"><div class="ttname"><a href="structfaiss_1_1IDSelector.html">faiss::IDSelector</a></div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8h_source.html#l00054">AuxIndexStructures.h:54</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVFFlat_html_ad2b306f160e153b5cfb572cf1d8ece24"><div class="ttname"><a href="structfaiss_1_1IndexIVFFlat.html#ad2b306f160e153b5cfb572cf1d8ece24">faiss::IndexIVFFlat::range_search</a></div><div class="ttdeci">void range_search(idx_t n, const float *x, float radius, RangeSearchResult *result) const override</div><div class="ttdef"><b>Definition:</b> <a href="IndexIVFFlat_8cpp_source.html#l00171">IndexIVFFlat.cpp:171</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVFFlat_html"><div class="ttname"><a href="structfaiss_1_1IndexIVFFlat.html">faiss::IndexIVFFlat</a></div><div class="ttdef"><b>Definition:</b> <a href="IndexIVFFlat_8h_source.html#l00025">IndexIVFFlat.h:25</a></div></div>
<div class="ttc" id="structfaiss_1_1IVFSearchParameters_html"><div class="ttname"><a href="structfaiss_1_1IVFSearchParameters.html">faiss::IVFSearchParameters</a></div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00061">IndexIVF.h:61</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#l00066">Index.h:66</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVFFlatDedup_html_ae1d5f41f4987f4e02938738436f082bf"><div class="ttname"><a href="structfaiss_1_1IndexIVFFlatDedup.html#ae1d5f41f4987f4e02938738436f082bf">faiss::IndexIVFFlatDedup::add_with_ids</a></div><div class="ttdeci">void add_with_ids(idx_t n, const float *x, const long *xids) override</div><div class="ttdoc">implemented for all IndexIVF* classes </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVFFlat_8cpp_source.html#l00315">IndexIVFFlat.cpp:315</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVFFlatDedup_html_a88f84494a02e8ceab79982bcbcab4fa5"><div class="ttname"><a href="structfaiss_1_1IndexIVFFlatDedup.html#a88f84494a02e8ceab79982bcbcab4fa5">faiss::IndexIVFFlatDedup::search_preassigned</a></div><div class="ttdeci">void search_preassigned(idx_t n, const float *x, idx_t k, const idx_t *assign, const float *centroid_dis, float *distances, idx_t *labels, bool store_pairs, const IVFSearchParameters *params=nullptr) const override</div><div class="ttdef"><b>Definition:</b> <a href="IndexIVFFlat_8cpp_source.html#l00371">IndexIVFFlat.cpp:371</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVFFlat_html_a5f7356766632d3ce2838f285aa6b8e76"><div class="ttname"><a href="structfaiss_1_1IndexIVFFlat.html#a5f7356766632d3ce2838f285aa6b8e76">faiss::IndexIVFFlat::add_with_ids</a></div><div class="ttdeci">void add_with_ids(idx_t n, const float *x, const long *xids) override</div><div class="ttdoc">implemented for all IndexIVF* classes </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVFFlat_8cpp_source.html#l00037">IndexIVFFlat.cpp:37</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#l00064">Index.h:64</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVFFlat_html_a1267faf361fc3831ddafe7abc51f0ba2"><div class="ttname"><a href="structfaiss_1_1IndexIVFFlat.html#a1267faf361fc3831ddafe7abc51f0ba2">faiss::IndexIVFFlat::reconstruct_from_offset</a></div><div class="ttdeci">void reconstruct_from_offset(long list_no, long offset, float *recons) const override</div><div class="ttdef"><b>Definition:</b> <a href="IndexIVFFlat_8cpp_source.html#l00259">IndexIVFFlat.cpp:259</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVFFlat_html_a2adc0b0002c32ddc01aec4ab96dd659f"><div class="ttname"><a href="structfaiss_1_1IndexIVFFlat.html#a2adc0b0002c32ddc01aec4ab96dd659f">faiss::IndexIVFFlat::update_vectors</a></div><div class="ttdeci">virtual void update_vectors(int nv, idx_t *idx, const float *v)</div><div class="ttdef"><b>Definition:</b> <a href="IndexIVFFlat_8cpp_source.html#l00223">IndexIVFFlat.cpp:223</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVFFlatDedup_html_acb4f1350039546f5001c5fc36ac0fb2d"><div class="ttname"><a href="structfaiss_1_1IndexIVFFlatDedup.html#acb4f1350039546f5001c5fc36ac0fb2d">faiss::IndexIVFFlatDedup::range_search</a></div><div class="ttdeci">void range_search(idx_t n, const float *x, float radius, RangeSearchResult *result) const override</div><div class="ttdoc">not implemented </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVFFlat_8cpp_source.html#l00501">IndexIVFFlat.cpp:501</a></div></div>
<div class="ttc" id="structfaiss_1_1InvertedListScanner_html"><div class="ttname"><a href="structfaiss_1_1InvertedListScanner.html">faiss::InvertedListScanner</a></div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00261">IndexIVF.h:261</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVFFlatDedup_html_a0782b04472858d993ad4c0ffc81b1844"><div class="ttname"><a href="structfaiss_1_1IndexIVFFlatDedup.html#a0782b04472858d993ad4c0ffc81b1844">faiss::IndexIVFFlatDedup::update_vectors</a></div><div class="ttdeci">void update_vectors(int nv, idx_t *idx, const float *v) override</div><div class="ttdoc">not implemented </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVFFlat_8cpp_source.html#l00510">IndexIVFFlat.cpp:510</a></div></div>
<div class="ttc" id="structfaiss_1_1RangeSearchResult_html"><div class="ttname"><a href="structfaiss_1_1RangeSearchResult.html">faiss::RangeSearchResult</a></div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8h_source.html#l00031">AuxIndexStructures.h:31</a></div></div>
<div class="ttc" id="structfaiss_1_1Index_html"><div class="ttname"><a href="structfaiss_1_1Index.html">faiss::Index</a></div><div class="ttdef"><b>Definition:</b> <a href="Index_8h_source.html#l00062">Index.h:62</a></div></div>
<div class="ttc" id="structfaiss_1_1Level1Quantizer_html_a3cf99e2ee92b8558a066f821efab95d5"><div class="ttname"><a href="structfaiss_1_1Level1Quantizer.html#a3cf99e2ee92b8558a066f821efab95d5">faiss::Level1Quantizer::quantizer</a></div><div class="ttdeci">Index * quantizer</div><div class="ttdoc">quantizer that maps vectors to inverted lists </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00033">IndexIVF.h:33</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVFFlatDedup_html_aae53833bb1e4041358cd4e5407d6a296"><div class="ttname"><a href="structfaiss_1_1IndexIVFFlatDedup.html#aae53833bb1e4041358cd4e5407d6a296">faiss::IndexIVFFlatDedup::remove_ids</a></div><div class="ttdeci">long remove_ids(const IDSelector &amp;sel) override</div><div class="ttdoc">Dataset manipulation functions. </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVFFlat_8cpp_source.html#l00426">IndexIVFFlat.cpp:426</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#l00045">Index.h:45</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVFFlatDedup_html"><div class="ttname"><a href="structfaiss_1_1IndexIVFFlatDedup.html">faiss::IndexIVFFlatDedup</a></div><div class="ttdef"><b>Definition:</b> <a href="IndexIVFFlat_8h_source.html#l00077">IndexIVFFlat.h:77</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVFFlat_html_a05cbcc239916559b29b1eb1943b00440"><div class="ttname"><a href="structfaiss_1_1IndexIVFFlat.html#a05cbcc239916559b29b1eb1943b00440">faiss::IndexIVFFlat::get_InvertedListScanner</a></div><div class="ttdeci">InvertedListScanner * get_InvertedListScanner(bool store_pairs) const override</div><div class="ttdoc">get a scanner for this index (store_pairs means ignore labels) </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVFFlat_8cpp_source.html#l00148">IndexIVFFlat.cpp:148</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVFFlat_html_aea729c3d8c70bdd93f8e413e834851a4"><div class="ttname"><a href="structfaiss_1_1IndexIVFFlat.html#aea729c3d8c70bdd93f8e413e834851a4">faiss::IndexIVFFlat::add_core</a></div><div class="ttdeci">virtual void add_core(idx_t n, const float *x, const long *xids, const long *precomputed_idx)</div><div class="ttdoc">same as add_with_ids, with precomputed coarse quantizer </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVFFlat_8cpp_source.html#l00042">IndexIVFFlat.cpp:42</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVFFlatDedup_html_a1ff220494d504dd806e5daf290ec0e7a"><div class="ttname"><a href="structfaiss_1_1IndexIVFFlatDedup.html#a1ff220494d504dd806e5daf290ec0e7a">faiss::IndexIVFFlatDedup::instances</a></div><div class="ttdeci">std::unordered_multimap&lt; idx_t, idx_t &gt; instances</div><div class="ttdef"><b>Definition:</b> <a href="IndexIVFFlat_8h_source.html#l00082">IndexIVFFlat.h:82</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>