Skip to content

F
faiss
Switch branch/tag
Find file
BlameHistoryPermalink
  • Lucas Hosseini's avatar
    Facebook sync (May 2019) + relicense (#838) · a8118acb
    Lucas Hosseini authored 
    Changelog:

- changed license: BSD+Patents -> MIT
- propagates exceptions raised in sub-indexes of IndexShards and IndexReplicas
- support for searching several inverted lists in parallel (parallel_mode != 0)
- better support for PQ codes where nbit != 8 or 16
- IVFSpectralHash implementation: spectral hash codes inside an IVF
- 6-bit per component scalar quantizer (4 and 8 bit were already supported)
- combinations of inverted lists: HStackInvertedLists and VStackInvertedLists
- configurable number of threads for OnDiskInvertedLists prefetching (including 0=no prefetch)
- more test and demo code compatible with Python 3 (print with parentheses)
- refactored benchmark code: data loading is now in a single file
    Unverified
    a8118acb
ThreadedIndex-inl_8h_source.html 35.5 KB
EditWeb IDE
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 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 
<!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/ThreadedIndex-inl.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">/data/users/hoss/faiss/ThreadedIndex-inl.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) Facebook, Inc. and its affiliates.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<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>&#160;<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>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;</div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="preprocessor">#include &quot;FaissAssert.h&quot;</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="preprocessor">#include &lt;exception&gt;</span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="preprocessor">#include &lt;iostream&gt;</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;</div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="keyword">namespace </span>faiss {</div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;</div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> IndexT&gt;</div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;ThreadedIndex&lt;IndexT&gt;::ThreadedIndex(<span class="keywordtype">bool</span> threaded)</div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;    <span class="comment">// 0 is default dimension</span></div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;    : ThreadedIndex(0, threaded) {</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;</div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> IndexT&gt;</div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;ThreadedIndex&lt;IndexT&gt;::ThreadedIndex(<span class="keywordtype">int</span> <a class="code" href="structfaiss_1_1ProductQuantizer.html#a567cd512438f9e3404d9339a232d7695">d</a>, <span class="keywordtype">bool</span> threaded)</div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;    : IndexT(d),</div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;      own_fields(false),</div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;      isThreaded_(threaded) {</div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;  }</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;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> IndexT&gt;</div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;ThreadedIndex&lt;IndexT&gt;::~ThreadedIndex() {</div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;  <span class="keywordflow">for</span> (<span class="keyword">auto</span>&amp; p : indices_) {</div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;    <span class="keywordflow">if</span> (isThreaded_) {</div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;      <span class="comment">// should have worker thread</span></div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;      FAISS_ASSERT((<span class="keywordtype">bool</span>) p.second);</div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;</div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;      <span class="comment">// This will also flush all pending work</span></div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;      p.second-&gt;stop();</div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;      p.second-&gt;waitForThreadExit();</div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;    } <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;      <span class="comment">// should not have worker thread</span></div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;      FAISS_ASSERT(!(<span class="keywordtype">bool</span>) p.second);</div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;    }</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="keywordflow">if</span> (own_fields) {</div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;      <span class="keyword">delete</span> p.first;</div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;    }</div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;  }</div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;}</div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;</div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> IndexT&gt;</div>
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="classfaiss_1_1ThreadedIndex.html#a9a11a672369d48f45cf1dd1bfe0dad87">   49</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classfaiss_1_1ThreadedIndex.html#a9a11a672369d48f45cf1dd1bfe0dad87">ThreadedIndex&lt;IndexT&gt;::addIndex</a>(IndexT* index) {</div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;  <span class="comment">// We inherit the dimension from the first index added to us if we don&#39;t have</span></div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;  <span class="comment">// a set dimension</span></div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;  <span class="keywordflow">if</span> (indices_.empty() &amp;&amp; this-&gt;<a class="code" href="structfaiss_1_1ProductQuantizer.html#a567cd512438f9e3404d9339a232d7695">d</a> == 0) {</div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;    this-&gt;<a class="code" href="structfaiss_1_1ProductQuantizer.html#a567cd512438f9e3404d9339a232d7695">d</a> = index-&gt;d;</div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;  }</div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;</div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;  <span class="comment">// The new index must match our set dimension</span></div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;  FAISS_THROW_IF_NOT_FMT(this-&gt;<a class="code" href="structfaiss_1_1ProductQuantizer.html#a567cd512438f9e3404d9339a232d7695">d</a> == index-&gt;d,</div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;                         <span class="stringliteral">&quot;addIndex: dimension mismatch for &quot;</span></div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;                         <span class="stringliteral">&quot;newly added index; expecting dim %d, &quot;</span></div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;                         <span class="stringliteral">&quot;new index has dim %d&quot;</span>,</div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;                         this-&gt;d, index-&gt;d);</div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;</div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;  <span class="keywordflow">if</span> (!indices_.empty()) {</div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;    <span class="keyword">auto</span>&amp; existing = indices_.front().first;</div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;</div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;    FAISS_THROW_IF_NOT_MSG(index-&gt;metric_type == existing-&gt;metric_type,</div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;                           <span class="stringliteral">&quot;addIndex: newly added index is &quot;</span></div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;                           <span class="stringliteral">&quot;of different metric type than old index&quot;</span>);</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="comment">// Make sure this index is not duplicated</span></div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;    <span class="keywordflow">for</span> (<span class="keyword">auto</span>&amp; p : indices_) {</div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;      FAISS_THROW_IF_NOT_MSG(p.first != index,</div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;                             <span class="stringliteral">&quot;addIndex: attempting to add index &quot;</span></div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;                             <span class="stringliteral">&quot;that is already in the collection&quot;</span>);</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">   77</span>&#160;</div>
<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;  indices_.emplace_back(</div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;    std::make_pair(</div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;      index,</div>
<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;      std::unique_ptr&lt;WorkerThread&gt;(isThreaded_ ?</div>
<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;                                    <span class="keyword">new</span> <a class="code" href="classfaiss_1_1WorkerThread.html">WorkerThread</a> : <span class="keyword">nullptr</span>)));</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;  onAfterAddIndex(index);</div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;}</div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;</div>
<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> IndexT&gt;</div>
<div class="line"><a name="l00088"></a><span class="lineno"><a class="line" href="classfaiss_1_1ThreadedIndex.html#a21604d6b8b8d42e6cc78c26e85564027">   88</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classfaiss_1_1ThreadedIndex.html#a21604d6b8b8d42e6cc78c26e85564027">ThreadedIndex&lt;IndexT&gt;::removeIndex</a>(IndexT* index) {</div>
<div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;  <span class="keywordflow">for</span> (<span class="keyword">auto</span> it = indices_.begin(); it != indices_.end(); ++it) {</div>
<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;    <span class="keywordflow">if</span> (it-&gt;first == index) {</div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;      <span class="comment">// This is our index; stop the worker thread before removing it,</span></div>
<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;      <span class="comment">// to ensure that it has finished before function exit</span></div>
<div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;      <span class="keywordflow">if</span> (isThreaded_) {</div>
<div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;        <span class="comment">// should have worker thread</span></div>
<div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;        FAISS_ASSERT((<span class="keywordtype">bool</span>) it-&gt;second);</div>
<div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;        it-&gt;second-&gt;stop();</div>
<div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;        it-&gt;second-&gt;waitForThreadExit();</div>
<div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;      } <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;        <span class="comment">// should not have worker thread</span></div>
<div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;        FAISS_ASSERT(!(<span class="keywordtype">bool</span>) it-&gt;second);</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;</div>
<div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;      indices_.erase(it);</div>
<div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;      onAfterRemoveIndex(index);</div>
<div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;</div>
<div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;      <span class="keywordflow">if</span> (own_fields) {</div>
<div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;        <span class="keyword">delete</span> index;</div>
<div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;      }</div>
<div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;</div>
<div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;      <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;    }</div>
<div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;  }</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">// could not find our index</span></div>
<div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;  FAISS_THROW_MSG(<span class="stringliteral">&quot;IndexReplicas::removeIndex: index not found&quot;</span>);</div>
<div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;}</div>
<div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;</div>
<div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> IndexT&gt;</div>
<div class="line"><a name="l00119"></a><span class="lineno"><a class="line" href="classfaiss_1_1ThreadedIndex.html#a30ade89dc4e571868cf121e5592d6687">  119</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classfaiss_1_1ThreadedIndex.html#a30ade89dc4e571868cf121e5592d6687">ThreadedIndex&lt;IndexT&gt;::runOnIndex</a>(std::function&lt;<span class="keywordtype">void</span>(<span class="keywordtype">int</span>, IndexT*)&gt; f) {</div>
<div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;  <span class="keywordflow">if</span> (isThreaded_) {</div>
<div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;    std::vector&lt;std::future&lt;bool&gt;&gt; v;</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;    <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i &lt; this-&gt;indices_.size(); ++i) {</div>
<div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;      <span class="keyword">auto</span>&amp; p = this-&gt;indices_[i];</div>
<div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;      <span class="keyword">auto</span> indexPtr = p.first;</div>
<div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;      v.emplace_back(p.second-&gt;add([f, i, indexPtr](){ f(i, indexPtr); }));</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;</div>
<div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;    waitAndHandleFutures(v);</div>
<div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;  } <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;    <span class="comment">// Multiple exceptions may be thrown; gather them as we encounter them,</span></div>
<div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;    <span class="comment">// while letting everything else run to completion</span></div>
<div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;    std::vector&lt;std::pair&lt;int, std::exception_ptr&gt;&gt; exceptions;</div>
<div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;</div>
<div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;    <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i &lt; this-&gt;indices_.size(); ++i) {</div>
<div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;      <span class="keyword">auto</span>&amp; p = this-&gt;indices_[i];</div>
<div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;      <span class="keywordflow">try</span> {</div>
<div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;        f(i, p.first);</div>
<div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;      } <span class="keywordflow">catch</span> (...) {</div>
<div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;        exceptions.emplace_back(std::make_pair(i, std::current_exception()));</div>
<div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;      }</div>
<div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;    }</div>
<div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;</div>
<div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;    <a class="code" href="namespacefaiss.html#a542cf4d499962a3d7a0db924424d8870">handleExceptions</a>(exceptions);</div>
<div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;  }</div>
<div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;}</div>
<div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;</div>
<div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> IndexT&gt;</div>
<div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;<span class="keywordtype">void</span> <a class="code" href="classfaiss_1_1ThreadedIndex.html#a30ade89dc4e571868cf121e5592d6687">ThreadedIndex&lt;IndexT&gt;::runOnIndex</a>(</div>
<div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;  std::function&lt;<span class="keywordtype">void</span>(<span class="keywordtype">int</span>, <span class="keyword">const</span> IndexT*)&gt; f)<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;  <span class="keyword">const_cast&lt;</span>ThreadedIndex&lt;IndexT&gt;*<span class="keyword">&gt;</span>(<span class="keyword">this</span>)-&gt;runOnIndex(</div>
<div class="line"><a name="l00152"></a><span class="lineno">  152</span>&#160;    [f](<span class="keywordtype">int</span> i, IndexT* idx){ f(i, idx); });</div>
<div class="line"><a name="l00153"></a><span class="lineno">  153</span>&#160;}</div>
<div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;</div>
<div class="line"><a name="l00155"></a><span class="lineno">  155</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> IndexT&gt;</div>
<div class="line"><a name="l00156"></a><span class="lineno"><a class="line" href="classfaiss_1_1ThreadedIndex.html#a4536f6e7a8cce1f79bebc420ae1e909b">  156</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classfaiss_1_1ThreadedIndex.html#a4536f6e7a8cce1f79bebc420ae1e909b">ThreadedIndex&lt;IndexT&gt;::reset</a>() {</div>
<div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;  runOnIndex([](<span class="keywordtype">int</span>, IndexT* index){ index-&gt;reset(); });</div>
<div class="line"><a name="l00158"></a><span class="lineno">  158</span>&#160;  this-&gt;ntotal = 0;</div>
<div class="line"><a name="l00159"></a><span class="lineno">  159</span>&#160;  this-&gt;is_trained = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00160"></a><span class="lineno">  160</span>&#160;}</div>
<div class="line"><a name="l00161"></a><span class="lineno">  161</span>&#160;</div>
<div class="line"><a name="l00162"></a><span class="lineno">  162</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> IndexT&gt;</div>
<div class="line"><a name="l00163"></a><span class="lineno">  163</span>&#160;<span class="keywordtype">void</span></div>
<div class="line"><a name="l00164"></a><span class="lineno"><a class="line" href="classfaiss_1_1ThreadedIndex.html#abdcae15f8589c53d4fa648fb2d5ab625">  164</a></span>&#160;<a class="code" href="classfaiss_1_1ThreadedIndex.html#abdcae15f8589c53d4fa648fb2d5ab625">ThreadedIndex&lt;IndexT&gt;::onAfterAddIndex</a>(IndexT* index) {</div>
<div class="line"><a name="l00165"></a><span class="lineno">  165</span>&#160;}</div>
<div class="line"><a name="l00166"></a><span class="lineno">  166</span>&#160;</div>
<div class="line"><a name="l00167"></a><span class="lineno">  167</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> IndexT&gt;</div>
<div class="line"><a name="l00168"></a><span class="lineno">  168</span>&#160;<span class="keywordtype">void</span></div>
<div class="line"><a name="l00169"></a><span class="lineno"><a class="line" href="classfaiss_1_1ThreadedIndex.html#a3bfc1a3002a150d850b20dc40c5d31fe">  169</a></span>&#160;<a class="code" href="classfaiss_1_1ThreadedIndex.html#a3bfc1a3002a150d850b20dc40c5d31fe">ThreadedIndex&lt;IndexT&gt;::onAfterRemoveIndex</a>(IndexT* index) {</div>
<div class="line"><a name="l00170"></a><span class="lineno">  170</span>&#160;}</div>
<div class="line"><a name="l00171"></a><span class="lineno">  171</span>&#160;</div>
<div class="line"><a name="l00172"></a><span class="lineno">  172</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> IndexT&gt;</div>
<div class="line"><a name="l00173"></a><span class="lineno">  173</span>&#160;<span class="keywordtype">void</span></div>
<div class="line"><a name="l00174"></a><span class="lineno">  174</span>&#160;<a class="code" href="classfaiss_1_1ThreadedIndex.html">ThreadedIndex&lt;IndexT&gt;::waitAndHandleFutures</a>(std::vector&lt;std::future&lt;bool&gt;&gt;&amp; v) {</div>
<div class="line"><a name="l00175"></a><span class="lineno">  175</span>&#160;  <span class="comment">// Blocking wait for completion for all of the indices, capturing any</span></div>
<div class="line"><a name="l00176"></a><span class="lineno">  176</span>&#160;  <span class="comment">// exceptions that are generated</span></div>
<div class="line"><a name="l00177"></a><span class="lineno">  177</span>&#160;  std::vector&lt;std::pair&lt;int, std::exception_ptr&gt;&gt; exceptions;</div>
<div class="line"><a name="l00178"></a><span class="lineno">  178</span>&#160;</div>
<div class="line"><a name="l00179"></a><span class="lineno">  179</span>&#160;  <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i &lt; v.size(); ++i) {</div>
<div class="line"><a name="l00180"></a><span class="lineno">  180</span>&#160;    <span class="keyword">auto</span>&amp; fut = v[i];</div>
<div class="line"><a name="l00181"></a><span class="lineno">  181</span>&#160;</div>
<div class="line"><a name="l00182"></a><span class="lineno">  182</span>&#160;    <span class="keywordflow">try</span> {</div>
<div class="line"><a name="l00183"></a><span class="lineno">  183</span>&#160;      fut.get();</div>
<div class="line"><a name="l00184"></a><span class="lineno">  184</span>&#160;    } <span class="keywordflow">catch</span> (...) {</div>
<div class="line"><a name="l00185"></a><span class="lineno">  185</span>&#160;      exceptions.emplace_back(std::make_pair(i, std::current_exception()));</div>
<div class="line"><a name="l00186"></a><span class="lineno">  186</span>&#160;    }</div>
<div class="line"><a name="l00187"></a><span class="lineno">  187</span>&#160;  }</div>
<div class="line"><a name="l00188"></a><span class="lineno">  188</span>&#160;</div>
<div class="line"><a name="l00189"></a><span class="lineno">  189</span>&#160;  <a class="code" href="namespacefaiss.html#a542cf4d499962a3d7a0db924424d8870">handleExceptions</a>(exceptions);</div>
<div class="line"><a name="l00190"></a><span class="lineno">  190</span>&#160;}</div>
<div class="line"><a name="l00191"></a><span class="lineno">  191</span>&#160;</div>
<div class="line"><a name="l00192"></a><span class="lineno">  192</span>&#160;} <span class="comment">// namespace</span></div>
<div class="ttc" id="classfaiss_1_1ThreadedIndex_html_a21604d6b8b8d42e6cc78c26e85564027"><div class="ttname"><a href="classfaiss_1_1ThreadedIndex.html#a21604d6b8b8d42e6cc78c26e85564027">faiss::ThreadedIndex::removeIndex</a></div><div class="ttdeci">void removeIndex(IndexT *index)</div><div class="ttdef"><b>Definition:</b> <a href="ThreadedIndex-inl_8h_source.html#l00088">ThreadedIndex-inl.h:88</a></div></div>
<div class="ttc" id="namespacefaiss_html_a542cf4d499962a3d7a0db924424d8870"><div class="ttname"><a href="namespacefaiss.html#a542cf4d499962a3d7a0db924424d8870">faiss::handleExceptions</a></div><div class="ttdeci">void handleExceptions(std::vector&lt; std::pair&lt; int, std::exception_ptr &gt;&gt; &amp;exceptions)</div><div class="ttdef"><b>Definition:</b> <a href="FaissException_8cpp_source.html#l00035">FaissException.cpp:35</a></div></div>
<div class="ttc" id="classfaiss_1_1ThreadedIndex_html"><div class="ttname"><a href="classfaiss_1_1ThreadedIndex.html">faiss::ThreadedIndex</a></div><div class="ttdef"><b>Definition:</b> <a href="ThreadedIndex_8h_source.html#l00021">ThreadedIndex.h:21</a></div></div>
<div class="ttc" id="classfaiss_1_1ThreadedIndex_html_a9a11a672369d48f45cf1dd1bfe0dad87"><div class="ttname"><a href="classfaiss_1_1ThreadedIndex.html#a9a11a672369d48f45cf1dd1bfe0dad87">faiss::ThreadedIndex::addIndex</a></div><div class="ttdeci">void addIndex(IndexT *index)</div><div class="ttdef"><b>Definition:</b> <a href="ThreadedIndex-inl_8h_source.html#l00049">ThreadedIndex-inl.h:49</a></div></div>
<div class="ttc" id="classfaiss_1_1ThreadedIndex_html_a30ade89dc4e571868cf121e5592d6687"><div class="ttname"><a href="classfaiss_1_1ThreadedIndex.html#a30ade89dc4e571868cf121e5592d6687">faiss::ThreadedIndex::runOnIndex</a></div><div class="ttdeci">void runOnIndex(std::function&lt; void(int, IndexT *)&gt; f)</div><div class="ttdef"><b>Definition:</b> <a href="ThreadedIndex-inl_8h_source.html#l00119">ThreadedIndex-inl.h:119</a></div></div>
<div class="ttc" id="classfaiss_1_1ThreadedIndex_html_a3bfc1a3002a150d850b20dc40c5d31fe"><div class="ttname"><a href="classfaiss_1_1ThreadedIndex.html#a3bfc1a3002a150d850b20dc40c5d31fe">faiss::ThreadedIndex::onAfterRemoveIndex</a></div><div class="ttdeci">virtual void onAfterRemoveIndex(IndexT *index)</div><div class="ttdoc">Called just after an index is removed. </div><div class="ttdef"><b>Definition:</b> <a href="ThreadedIndex-inl_8h_source.html#l00169">ThreadedIndex-inl.h:169</a></div></div>
<div class="ttc" id="classfaiss_1_1WorkerThread_html"><div class="ttname"><a href="classfaiss_1_1WorkerThread.html">faiss::WorkerThread</a></div><div class="ttdef"><b>Definition:</b> <a href="WorkerThread_8h_source.html#l00018">WorkerThread.h:18</a></div></div>
<div class="ttc" id="classfaiss_1_1ThreadedIndex_html_abdcae15f8589c53d4fa648fb2d5ab625"><div class="ttname"><a href="classfaiss_1_1ThreadedIndex.html#abdcae15f8589c53d4fa648fb2d5ab625">faiss::ThreadedIndex::onAfterAddIndex</a></div><div class="ttdeci">virtual void onAfterAddIndex(IndexT *index)</div><div class="ttdoc">Called just after an index is added. </div><div class="ttdef"><b>Definition:</b> <a href="ThreadedIndex-inl_8h_source.html#l00164">ThreadedIndex-inl.h:164</a></div></div>
<div class="ttc" id="structfaiss_1_1ProductQuantizer_html_a567cd512438f9e3404d9339a232d7695"><div class="ttname"><a href="structfaiss_1_1ProductQuantizer.html#a567cd512438f9e3404d9339a232d7695">faiss::ProductQuantizer::d</a></div><div class="ttdeci">size_t d</div><div class="ttdoc">size of the input vectors </div><div class="ttdef"><b>Definition:</b> <a href="ProductQuantizer_8h_source.html#l00027">ProductQuantizer.h:27</a></div></div>
<div class="ttc" id="classfaiss_1_1ThreadedIndex_html_a4536f6e7a8cce1f79bebc420ae1e909b"><div class="ttname"><a href="classfaiss_1_1ThreadedIndex.html#a4536f6e7a8cce1f79bebc420ae1e909b">faiss::ThreadedIndex::reset</a></div><div class="ttdeci">void reset() override</div><div class="ttdef"><b>Definition:</b> <a href="ThreadedIndex-inl_8h_source.html#l00156">ThreadedIndex-inl.h:156</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>