188 lines
25 KiB
HTML
188 lines
25 KiB
HTML
<!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.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>
|
|
</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"> </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 class="header">
|
|
<div class="headertitle">
|
|
<div class="title">/data/users/hoss/faiss/ThreadedIndex.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) Facebook, Inc. and its affiliates.</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * This source code is licensed under the MIT license found in the</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * LICENSE file in the root directory of this source tree.</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> </div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include "Index.h"</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include "IndexBinary.h"</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include "WorkerThread.h"</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <memory></span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <vector></span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="keyword">namespace </span>faiss {</div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">/// A holder of indices in a collection of threads</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">/// The interface to this class itself is not thread safe</span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"></span><span class="keyword">template</span> <<span class="keyword">typename</span> IndexT></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="classfaiss_1_1ThreadedIndex.html"> 21</a></span> <span class="keyword">class </span><a class="code" href="classfaiss_1_1ThreadedIndex.html">ThreadedIndex</a> : <span class="keyword">public</span> IndexT {</div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <span class="keyword">explicit</span> <a class="code" href="classfaiss_1_1ThreadedIndex.html">ThreadedIndex</a>(<span class="keywordtype">bool</span> threaded);</div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <span class="keyword">explicit</span> <a class="code" href="classfaiss_1_1ThreadedIndex.html">ThreadedIndex</a>(<span class="keywordtype">int</span> d, <span class="keywordtype">bool</span> threaded);</div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  ~<a class="code" href="classfaiss_1_1ThreadedIndex.html">ThreadedIndex</a>() <span class="keyword">override</span>;</div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> /// override an index that is managed by ourselves.</span></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> /// WARNING: once an index is added, it becomes unsafe to touch it from any</span></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> /// other thread than that on which is managing it, until we are shut</span></div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> /// down. Use runOnIndex to perform work on it instead.</span></div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classfaiss_1_1ThreadedIndex.html#a9a11a672369d48f45cf1dd1bfe0dad87">addIndex</a>(IndexT* index);</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> /// Remove an index that is managed by ourselves.</span></div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> /// This will flush all pending work on that index, and then shut</span></div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> /// down its managing thread, and will remove the index.</span></div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classfaiss_1_1ThreadedIndex.html#a21604d6b8b8d42e6cc78c26e85564027">removeIndex</a>(IndexT* index);</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> /// Run a function on all indices, in the thread that the index is</span></div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> /// managed in.</span></div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> /// Function arguments are (index in collection, index pointer)</span></div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classfaiss_1_1ThreadedIndex.html#a30ade89dc4e571868cf121e5592d6687">runOnIndex</a>(std::function<<span class="keywordtype">void</span>(<span class="keywordtype">int</span>, IndexT*)> f);</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordtype">void</span> <a class="code" href="classfaiss_1_1ThreadedIndex.html#a30ade89dc4e571868cf121e5592d6687">runOnIndex</a>(std::function<<span class="keywordtype">void</span>(<span class="keywordtype">int</span>, <span class="keyword">const</span> IndexT*)> f) <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> /// faiss::Index API</span></div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> /// All indices receive the same call</span></div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="classfaiss_1_1ThreadedIndex.html#a4536f6e7a8cce1f79bebc420ae1e909b">reset</a>() <span class="keyword">override</span>;</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> /// Returns the number of sub-indices</span></div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classfaiss_1_1ThreadedIndex.html#a25aac2b3024e7f900687f85f625afaba"> 50</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="classfaiss_1_1ThreadedIndex.html#a25aac2b3024e7f900687f85f625afaba">count</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classfaiss_1_1ThreadedIndex.html#acb0dc6a321ad80636d5fef5cc7edd05b">indices_</a>.size(); }</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> /// Returns the i-th sub-index</span></div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="classfaiss_1_1ThreadedIndex.html#a9d150a2d26d97b703af2a78e0c564c0e"> 53</a></span> <span class="comment"></span> IndexT* <a class="code" href="classfaiss_1_1ThreadedIndex.html#a9d150a2d26d97b703af2a78e0c564c0e">at</a>(<span class="keywordtype">int</span> i) { <span class="keywordflow">return</span> <a class="code" href="classfaiss_1_1ThreadedIndex.html#acb0dc6a321ad80636d5fef5cc7edd05b">indices_</a>[i].first; }</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> /// Returns the i-th sub-index (const version)</span></div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="classfaiss_1_1ThreadedIndex.html#ae84b4b14209700f372b9a82b78123f1a"> 56</a></span> <span class="comment"></span> <span class="keyword">const</span> IndexT* <a class="code" href="classfaiss_1_1ThreadedIndex.html#ae84b4b14209700f372b9a82b78123f1a">at</a>(<span class="keywordtype">int</span> i)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classfaiss_1_1ThreadedIndex.html#acb0dc6a321ad80636d5fef5cc7edd05b">indices_</a>[i].first; }</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> /// Whether or not we are responsible for deleting our contained indices</span></div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="classfaiss_1_1ThreadedIndex.html#a33201cb008802a729f61c76d519cb58a"> 59</a></span> <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="classfaiss_1_1ThreadedIndex.html#a33201cb008802a729f61c76d519cb58a">own_fields</a>;</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">protected</span>:<span class="comment"></span></div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> /// Called just after an index is added</span></div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classfaiss_1_1ThreadedIndex.html#abdcae15f8589c53d4fa648fb2d5ab625">onAfterAddIndex</a>(IndexT* index);</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> /// Called just after an index is removed</span></div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classfaiss_1_1ThreadedIndex.html#a3bfc1a3002a150d850b20dc40c5d31fe">onAfterRemoveIndex</a>(IndexT* index);</div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="keyword">protected</span>:</div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> waitAndHandleFutures(std::vector<std::future<bool>>& v);</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> /// Collection of Index instances, with their managing worker thread if any</span></div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="classfaiss_1_1ThreadedIndex.html#acb0dc6a321ad80636d5fef5cc7edd05b"> 72</a></span> <span class="comment"></span> std::vector<std::pair<IndexT*, std::unique_ptr<WorkerThread>>> <a class="code" href="classfaiss_1_1ThreadedIndex.html#acb0dc6a321ad80636d5fef5cc7edd05b">indices_</a>;</div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> /// Is this index multi-threaded?</span></div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"><a class="line" href="classfaiss_1_1ThreadedIndex.html#a1031b2c900e9ba53573e617539b3c488"> 75</a></span> <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="classfaiss_1_1ThreadedIndex.html#a1031b2c900e9ba53573e617539b3c488">isThreaded_</a>;</div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> };</div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> } <span class="comment">// namespace</span></div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="preprocessor">#include "ThreadedIndex-inl.h"</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="classfaiss_1_1ThreadedIndex_html_a1031b2c900e9ba53573e617539b3c488"><div class="ttname"><a href="classfaiss_1_1ThreadedIndex.html#a1031b2c900e9ba53573e617539b3c488">faiss::ThreadedIndex::isThreaded_</a></div><div class="ttdeci">bool isThreaded_</div><div class="ttdoc">Is this index multi-threaded? </div><div class="ttdef"><b>Definition:</b> <a href="ThreadedIndex_8h_source.html#l00075">ThreadedIndex.h:75</a></div></div>
|
|
<div class="ttc" id="classfaiss_1_1ThreadedIndex_html_ae84b4b14209700f372b9a82b78123f1a"><div class="ttname"><a href="classfaiss_1_1ThreadedIndex.html#ae84b4b14209700f372b9a82b78123f1a">faiss::ThreadedIndex::at</a></div><div class="ttdeci">const IndexT * at(int i) const </div><div class="ttdoc">Returns the i-th sub-index (const version) </div><div class="ttdef"><b>Definition:</b> <a href="ThreadedIndex_8h_source.html#l00056">ThreadedIndex.h:56</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_a33201cb008802a729f61c76d519cb58a"><div class="ttname"><a href="classfaiss_1_1ThreadedIndex.html#a33201cb008802a729f61c76d519cb58a">faiss::ThreadedIndex::own_fields</a></div><div class="ttdeci">bool own_fields</div><div class="ttdoc">Whether or not we are responsible for deleting our contained indices. </div><div class="ttdef"><b>Definition:</b> <a href="ThreadedIndex_8h_source.html#l00059">ThreadedIndex.h:59</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_acb0dc6a321ad80636d5fef5cc7edd05b"><div class="ttname"><a href="classfaiss_1_1ThreadedIndex.html#acb0dc6a321ad80636d5fef5cc7edd05b">faiss::ThreadedIndex::indices_</a></div><div class="ttdeci">std::vector< std::pair< IndexT *, std::unique_ptr< WorkerThread > > > indices_</div><div class="ttdoc">Collection of Index instances, with their managing worker thread if any. </div><div class="ttdef"><b>Definition:</b> <a href="ThreadedIndex_8h_source.html#l00072">ThreadedIndex.h:72</a></div></div>
|
|
<div class="ttc" id="classfaiss_1_1ThreadedIndex_html_a25aac2b3024e7f900687f85f625afaba"><div class="ttname"><a href="classfaiss_1_1ThreadedIndex.html#a25aac2b3024e7f900687f85f625afaba">faiss::ThreadedIndex::count</a></div><div class="ttdeci">int count() const </div><div class="ttdoc">Returns the number of sub-indices. </div><div class="ttdef"><b>Definition:</b> <a href="ThreadedIndex_8h_source.html#l00050">ThreadedIndex.h:50</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< void(int, IndexT *)> 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_1ThreadedIndex_html_a9d150a2d26d97b703af2a78e0c564c0e"><div class="ttname"><a href="classfaiss_1_1ThreadedIndex.html#a9d150a2d26d97b703af2a78e0c564c0e">faiss::ThreadedIndex::at</a></div><div class="ttdeci">IndexT * at(int i)</div><div class="ttdoc">Returns the i-th sub-index. </div><div class="ttdef"><b>Definition:</b> <a href="ThreadedIndex_8h_source.html#l00053">ThreadedIndex.h:53</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="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  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.5
|
|
</small></address>
|
|
</body>
|
|
</html>
|