mirrors
/
faiss
mirror of https://github.com/facebookresearch/faiss.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
faiss/docs/html/IndexShards_8h_source.html

206 lines
26 KiB
HTML
Raw Normal View History

Facebook sync (May 2019) + relicense (#838) 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
2019-05-28 22:17:22 +08:00
<!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/IndexShards.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/IndexShards.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">#pragma once</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#include &quot;Index.h&quot;</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &quot;IndexBinary.h&quot;</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#include &quot;ThreadedIndex.h&quot;</span></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">namespace </span>faiss {</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> * Index that concatenates the results from several sub-indexes</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> IndexT&gt;</div>
<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexShardsTemplate.html"> 20</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structfaiss_1_1IndexShardsTemplate.html">IndexShardsTemplate</a> : <span class="keyword">public</span> <a class="code" href="classfaiss_1_1ThreadedIndex.html">ThreadedIndex</a>&lt;IndexT&gt; {</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; <span class="keyword">using</span> idx_t = <span class="keyword">typename</span> IndexT::idx_t;</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <span class="keyword">using</span> component_t = <span class="keyword">typename</span> IndexT::component_t;</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="keyword">using</span> distance_t = <span class="keyword">typename</span> IndexT::distance_t;</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"> 25</span>&#160;<span class="comment"> /**</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="comment"> * The dimension that all sub-indices must share will be the dimension of the</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="comment"> * first sub-index added</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="comment"> * @param threaded do we use one thread per sub_index or do</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="comment"> * queries sequentially?</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="comment"> * @param successive_ids should we shift the returned ids by</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="comment"> * the size of each sub-index or return them</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="comment"> * as they are?</span></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="keyword">explicit</span> <a class="code" href="structfaiss_1_1IndexShardsTemplate.html#a2ffc0edbce1815fae55cae188b83a5cf">IndexShardsTemplate</a>(<span class="keywordtype">bool</span> threaded = <span class="keyword">false</span>,</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keywordtype">bool</span> successive_ids = <span class="keyword">true</span>);</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="comment"> /**</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="comment"> * @param threaded do we use one thread per sub_index or do</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="comment"> * queries sequentially?</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="comment"> * @param successive_ids should we shift the returned ids by</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="comment"> * the size of each sub-index or return them</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="comment"> * as they are?</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keyword">explicit</span> <a class="code" href="structfaiss_1_1IndexShardsTemplate.html#a2ffc0edbce1815fae55cae188b83a5cf">IndexShardsTemplate</a>(idx_t d,</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keywordtype">bool</span> threaded = <span class="keyword">false</span>,</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keywordtype">bool</span> successive_ids = <span class="keyword">true</span>);</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="comment"> /// int version due to the implicit bool conversion ambiguity of int as</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="comment"> /// dimension</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="comment"></span> <span class="keyword">explicit</span> <a class="code" href="structfaiss_1_1IndexShardsTemplate.html#a2ffc0edbce1815fae55cae188b83a5cf">IndexShardsTemplate</a>(<span class="keywordtype">int</span> d,</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keywordtype">bool</span> threaded = <span class="keyword">false</span>,</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="keywordtype">bool</span> successive_ids = <span class="keyword">true</span>);</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="comment"> /// Alias for addIndex()</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexShardsTemplate.html#a47a2e1f78d91025857f483be3eb6828a"> 56</a></span>&#160;<span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexShardsTemplate.html#a47a2e1f78d91025857f483be3eb6828a">add_shard</a>(IndexT* index) { this-&gt;<a class="code" href="classfaiss_1_1ThreadedIndex.html#a9a11a672369d48f45cf1dd1bfe0dad87">addIndex</a>(index); }</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;<span class="comment"> /// Alias for removeIndex()</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexShardsTemplate.html#ae0bff98885fecae6c42a474d05563ecd"> 59</a></span>&#160;<span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexShardsTemplate.html#ae0bff98885fecae6c42a474d05563ecd">remove_shard</a>(IndexT* index) { this-&gt;<a class="code" href="classfaiss_1_1ThreadedIndex.html#a21604d6b8b8d42e6cc78c26e85564027">removeIndex</a>(index); }</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;<span class="comment"> /// supported only for sub-indices that implement add_with_ids</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;<span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexShardsTemplate.html#a45647579ff21e0945d8a87a97ec705fe">add</a>(idx_t n, <span class="keyword">const</span> component_t* x) <span class="keyword">override</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"> /**</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;<span class="comment"> * Cases (successive_ids, xids):</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;<span class="comment"> * - true, non-NULL ERROR: it makes no sense to pass in ids and</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;<span class="comment"> * request them to be shifted</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;<span class="comment"> * - true, NULL OK, but should be called only once (calls add()</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;<span class="comment"> * on sub-indexes).</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;<span class="comment"> * - false, non-NULL OK: will call add_with_ids with passed in xids</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;<span class="comment"> * distributed evenly over shards</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;<span class="comment"> * - false, NULL OK: will call add_with_ids on each sub-index,</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;<span class="comment"> * starting at ntotal</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexShardsTemplate.html#a15e0b4a2fd85f9345537d215a331ed91">add_with_ids</a>(idx_t n, <span class="keyword">const</span> component_t* x, <span class="keyword">const</span> idx_t* xids) <span class="keyword">override</span>;</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; <span class="keywordtype">void</span> search(idx_t n, <span class="keyword">const</span> component_t* x, idx_t k,</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; distance_t* distances, idx_t* labels) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="keywordtype">void</span> train(idx_t n, <span class="keyword">const</span> component_t* x) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <span class="comment">// update metric_type and ntotal. Call if you changes something in</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="comment">// the shard indexes.</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; <span class="keywordtype">void</span> sync_with_shard_indexes();</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; <span class="keywordtype">bool</span> successive_ids;</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="keyword">protected</span>:<span class="comment"></span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;<span class="comment"> /// Called just after an index is added</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;<span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexShardsTemplate.html#a1d78dd47e9dc49488947e90dbc85e1ac">onAfterAddIndex</a>(IndexT* index) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;<span class="comment"> /// Called just after an index is removed</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;<span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexShardsTemplate.html#a0488d95e9d45e0cfab203c83e3a8e3c1">onAfterRemoveIndex</a>(IndexT* index) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;};</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;<span class="keyword">using</span> IndexShards = IndexShardsTemplate&lt;Index&gt;;</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;<span class="keyword">using</span> IndexBinaryShards = IndexShardsTemplate&lt;IndexBinary&gt;;</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160;</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;} <span class="comment">// namespace faiss</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"><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="structfaiss_1_1IndexShardsTemplate_html_a15e0b4a2fd85f9345537d215a331ed91"><div class="ttname"><a href="structfaiss_1_1IndexShardsTemplate.html#a15e0b4a2fd85f9345537d215a331ed91">faiss::IndexShardsTemplate::add_with_ids</a></div><div class="ttdeci">void add_with_ids(idx_t n, const component_t *x, const idx_t *xids) override</div><div class="ttdef"><b>Definition:</b> <a href="IndexShards_8cpp_source.html#l00198">IndexShards.cpp:198</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="structfaiss_1_1IndexShardsTemplate_html_a47a2e1f78d91025857f483be3eb6828a"><div class="ttname"><a href="structfaiss_1_1IndexShardsTemplate.html#a47a2e1f78d91025857f483be3eb6828a">faiss::IndexShardsTemplate::add_shard</a></div><div class="ttdeci">void add_shard(IndexT *index)</div><div class="ttdoc">Alias for addIndex() </div><div class="ttdef"><b>Definition:</b> <a href="IndexShards_8h_source.html#l00056">IndexShards.h:56</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexShardsTemplate_html_a2ffc0edbce1815fae55cae188b83a5cf"><div class="ttname"><a href="structfaiss_1_1IndexShardsTemplate.html#a2ffc0edbce1815fae55cae188b83a5cf">faiss::IndexShardsTemplate::IndexShardsTemplate</a></div><div class="ttdeci">IndexShardsTemplate(bool threaded=false, bool successive_ids=true)</div><div class="ttdef"><b>Definition:</b> <a href="IndexShards_8cpp_source.html#l00126">IndexShards.cpp:126</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexShardsTemplate_html"><div class="ttname"><a href="structfaiss_1_1IndexShardsTemplate.html">faiss::IndexShardsTemplate</a></div><div class="ttdef"><b>Definition:</b> <a href="IndexShards_8h_source.html#l00020">IndexShards.h:20</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexShardsTemplate_html_a45647579ff21e0945d8a87a97ec705fe"><div class="ttname"><a href="structfaiss_1_1IndexShardsTemplate.html#a45647579ff21e0945d8a87a97ec705fe">faiss::IndexShardsTemplate::add</a></div><div class="ttdeci">void add(idx_t n, const component_t *x) override</div><div class="ttdoc">supported only for sub-indices that implement add_with_ids </div><div class="ttdef"><b>Definition:</b> <a href="IndexShards_8cpp_source.html#l00191">IndexShards.cpp:191</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexShardsTemplate_html_a1d78dd47e9dc49488947e90dbc85e1ac"><div class="ttname"><a href="structfaiss_1_1IndexShardsTemplate.html#a1d78dd47e9dc49488947e90dbc85e1ac">faiss::IndexShardsTemplate::onAfterAddIndex</a></div><div class="ttdeci">void onAfterAddIndex(IndexT *index) override</div><div class="ttdoc">Called just after an index is added. </div><div class="ttdef"><b>Definition:</b> <a href="IndexShards_8cpp_source.html#l00134">IndexShards.cpp:134</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexShardsTemplate_html_ae0bff98885fecae6c42a474d05563ecd"><div class="ttname"><a href="structfaiss_1_1IndexShardsTemplate.html#ae0bff98885fecae6c42a474d05563ecd">faiss::IndexShardsTemplate::remove_shard</a></div><div class="ttdeci">void remove_shard(IndexT *index)</div><div class="ttdoc">Alias for removeIndex() </div><div class="ttdef"><b>Definition:</b> <a href="IndexShards_8h_source.html#l00059">IndexShards.h:59</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexShardsTemplate_html_a0488d95e9d45e0cfab203c83e3a8e3c1"><div class="ttname"><a href="structfaiss_1_1IndexShardsTemplate.html#a0488d95e9d45e0cfab203c83e3a8e3c1">faiss::IndexShardsTemplate::onAfterRemoveIndex</a></div><div class="ttdeci">void onAfterRemoveIndex(IndexT *index) override</div><div class="ttdoc">Called just after an index is removed. </div><div class="ttdef"><b>Definition:</b> <a href="IndexShards_8cpp_source.html#l00140">IndexShards.cpp:140</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>