faiss/docs/html/InvertedLists_8h_source.html

492 lines
93 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/InvertedLists.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/InvertedLists.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="comment">// -*- c++ -*-</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;</div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#ifndef FAISS_INVERTEDLISTS_IVF_H</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define FAISS_INVERTEDLISTS_IVF_H</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor"></span><span class="comment"></span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * Definition of inverted lists + a few common classes that implement</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * the interface.</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;</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#include &quot;Index.h&quot;</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="keyword">namespace </span>faiss {</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="comment">/** Table of inverted lists</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="comment"> * multithreading rules:</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="comment"> * - concurrent read accesses are allowed</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="comment"> * - concurrent update accesses are allowed</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="comment"> * - for resize and add_entries, only concurrent access to different lists</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="comment"> * are allowed</span></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"><a class="line" href="structfaiss_1_1InvertedLists.html"> 31</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> {</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keyword">typedef</span> <a class="code" href="structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea">Index::idx_t</a> idx_t;</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"><a class="line" href="structfaiss_1_1InvertedLists.html#afaf8b7aa3e846aa4553f6aae67827ec8"> 34</a></span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1InvertedLists.html#afaf8b7aa3e846aa4553f6aae67827ec8">nlist</a>; <span class="comment">///&lt; number of possible key values</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="structfaiss_1_1InvertedLists.html#ae06049e4259edb47d443ef87bdedc744"> 35</a></span>&#160;<span class="comment"></span> <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1InvertedLists.html#ae06049e4259edb47d443ef87bdedc744">code_size</a>; <span class="comment">///&lt; code size per vector in bytes</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <a class="code" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> (<span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1InvertedLists.html#afaf8b7aa3e846aa4553f6aae67827ec8">nlist</a>, <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1InvertedLists.html#ae06049e4259edb47d443ef87bdedc744">code_size</a>);</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="comment">/*************************</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="comment"> * Read only functions */</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="comment"> /// get the size of a list</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1InvertedLists.html#a9bd256053ee360473842105460fe285f">list_size</a>(<span class="keywordtype">size_t</span> list_no) <span class="keyword">const</span> = 0;</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="comment"> /** get the codes for an inverted list</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="comment"> * must be released by release_codes</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="comment"> * @return codes size list_size * code_size</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keyword">virtual</span> <span class="keyword">const</span> uint8_t * <a class="code" href="structfaiss_1_1InvertedLists.html#a60b12f9efe940b617a8380adceef4032">get_codes</a> (<span class="keywordtype">size_t</span> list_no) <span class="keyword">const</span> = 0;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="comment"> /** get the ids for an inverted list</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;<span class="comment"> * must be released by release_ids</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"> * @return ids size list_size</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keyword">virtual</span> <span class="keyword">const</span> idx_t * <a class="code" href="structfaiss_1_1InvertedLists.html#a3ab6b389d8d85c5fbf23889064df7e95">get_ids</a> (<span class="keywordtype">size_t</span> list_no) <span class="keyword">const</span> = 0;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;<span class="comment"> /// release codes returned by get_codes (default implementation is nop</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;<span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1InvertedLists.html#ad6a2111630ecd67ee5119d5198abcfb1">release_codes</a> (<span class="keywordtype">size_t</span> list_no, <span class="keyword">const</span> uint8_t *codes) <span class="keyword">const</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"> /// release ids returned by get_ids</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;<span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1InvertedLists.html#ae1618d2b5dca2704d3af8ced58548ac9">release_ids</a> (<span class="keywordtype">size_t</span> list_no, <span class="keyword">const</span> idx_t *ids) <span class="keyword">const</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"> /// @return a single id in an inverted list</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;<span class="comment"></span> <span class="keyword">virtual</span> idx_t <a class="code" href="structfaiss_1_1InvertedLists.html#a21b52cdb0601cd225bd7924932310876">get_single_id</a> (<span class="keywordtype">size_t</span> list_no, <span class="keywordtype">size_t</span> offset) <span class="keyword">const</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="comment"> /// @return a single code in an inverted list</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;<span class="comment"> /// (should be deallocated with release_codes)</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;<span class="comment"></span> <span class="keyword">virtual</span> <span class="keyword">const</span> uint8_t * <a class="code" href="structfaiss_1_1InvertedLists.html#afc2760bed7c210f2fad9b03109f561ee">get_single_code</a> (</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="keywordtype">size_t</span> list_no, <span class="keywordtype">size_t</span> offset) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;<span class="comment"> /// prepare the following lists (default does nothing)</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;<span class="comment"> /// a list can be -1 hence the signed long</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;<span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1InvertedLists.html#ac537aa14d2731c0ff907169211389b76">prefetch_lists</a> (<span class="keyword">const</span> idx_t *list_nos, <span class="keywordtype">int</span> <a class="code" href="structfaiss_1_1InvertedLists.html#afaf8b7aa3e846aa4553f6aae67827ec8">nlist</a>) <span class="keyword">const</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="comment">/*************************</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;<span class="comment"> * writing functions */</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;<span class="comment"> /// add one entry to an inverted list</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;<span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1InvertedLists.html#acd3e36cc06fc49e02773e403a84dba95">add_entry</a> (<span class="keywordtype">size_t</span> list_no, idx_t theid,</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <span class="keyword">const</span> uint8_t *code);</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; <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> add_entries (</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="keywordtype">size_t</span> list_no, <span class="keywordtype">size_t</span> n_entry,</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <span class="keyword">const</span> idx_t* ids, <span class="keyword">const</span> uint8_t *code) = 0;</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">virtual</span> <span class="keywordtype">void</span> update_entry (<span class="keywordtype">size_t</span> list_no, <span class="keywordtype">size_t</span> offset,</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; idx_t <span class="keywordtype">id</span>, <span class="keyword">const</span> uint8_t *code);</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> update_entries (<span class="keywordtype">size_t</span> list_no, <span class="keywordtype">size_t</span> offset, <span class="keywordtype">size_t</span> n_entry,</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <span class="keyword">const</span> idx_t *ids, <span class="keyword">const</span> uint8_t *code) = 0;</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="keyword">virtual</span> <span class="keywordtype">void</span> resize (<span class="keywordtype">size_t</span> list_no, <span class="keywordtype">size_t</span> new_size) = 0;</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">virtual</span> <span class="keywordtype">void</span> reset ();</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;<span class="comment"> /// move all entries from oivf (empty on output)</span></div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160;<span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1InvertedLists.html#ac2a0686121ef5bdd6eb70f7eb3cf9b3a">merge_from</a> (<a class="code" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> *oivf, <span class="keywordtype">size_t</span> add_id);</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; <span class="keyword">virtual</span> ~<a class="code" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> ();</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; <span class="comment">/*************************</span></div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;<span class="comment"> * statistics */</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160;<span class="comment"> /// 1= perfectly balanced, &gt;1: imbalanced</span></div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160;<span class="comment"></span> <span class="keywordtype">double</span> <a class="code" href="structfaiss_1_1InvertedLists.html#aacf34f6cf392771fe2e68210cd4e009b">imbalance_factor</a> () <span class="keyword">const</span>;</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160;<span class="comment"> /// display some stats about the inverted lists</span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;<span class="comment"></span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1InvertedLists.html#a156de8be4b21a0dfa9a48a3918a0b5c3">print_stats</a> () <span class="keyword">const</span>;</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160;<span class="comment"> /// sum up list sizes</span></div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;<span class="comment"></span> <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1InvertedLists.html#a722eef5a0e5bf5dcf78228a903e16af9">compute_ntotal</a> () <span class="keyword">const</span>;</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; <span class="comment">/**************************************</span></div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160;<span class="comment"> * Scoped inverted lists (for automatic deallocation)</span></div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160;<span class="comment"> * instead of writing:</span></div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160;<span class="comment"> * uint8_t * codes = invlists-&gt;get_codes (10);</span></div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160;<span class="comment"> * ... use codes</span></div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160;<span class="comment"> * invlists-&gt;release_codes(10, codes)</span></div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160;<span class="comment"> * write:</span></div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160;<span class="comment"> * ScopedCodes codes (invlists, 10);</span></div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160;<span class="comment"> * ... use codes.get()</span></div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160;<span class="comment"> * // release called automatically when codes goes out of scope</span></div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160;<span class="comment"> * the following function call also works:</span></div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160;<span class="comment"> * foo (123, ScopedCodes (invlists, 10).get(), 456);</span></div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160;</div>
<div class="line"><a name="l00136"></a><span class="lineno"><a class="line" href="structfaiss_1_1InvertedLists_1_1ScopedIds.html"> 136</a></span>&#160; <span class="keyword">struct </span><a class="code" href="structfaiss_1_1InvertedLists_1_1ScopedIds.html">ScopedIds</a> {</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; <span class="keyword">const</span> <a class="code" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> *il;</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; <span class="keyword">const</span> idx_t *ids;</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; <span class="keywordtype">size_t</span> list_no;</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160;</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; <a class="code" href="structfaiss_1_1InvertedLists_1_1ScopedIds.html">ScopedIds</a> (<span class="keyword">const</span> <a class="code" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> *il, <span class="keywordtype">size_t</span> list_no):</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; il (il), ids (il-&gt;<a class="code" href="structfaiss_1_1InvertedLists.html#a3ab6b389d8d85c5fbf23889064df7e95">get_ids</a> (list_no)), list_no (list_no)</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;</div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160; <span class="keyword">const</span> idx_t *<span class="keyword">get</span>() {<span class="keywordflow">return</span> ids; }</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; idx_t operator [] (<span class="keywordtype">size_t</span> i)<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160; <span class="keywordflow">return</span> ids[i];</div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160; }</div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160;</div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160; ~<a class="code" href="structfaiss_1_1InvertedLists_1_1ScopedIds.html">ScopedIds</a> () {</div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160; il-&gt;<a class="code" href="structfaiss_1_1InvertedLists.html#ae1618d2b5dca2704d3af8ced58548ac9">release_ids</a> (list_no, ids);</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;</div>
<div class="line"><a name="l00156"></a><span class="lineno"><a class="line" href="structfaiss_1_1InvertedLists_1_1ScopedCodes.html"> 156</a></span>&#160; <span class="keyword">struct </span><a class="code" href="structfaiss_1_1InvertedLists_1_1ScopedCodes.html">ScopedCodes</a> {</div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160; <span class="keyword">const</span> <a class="code" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> *il;</div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160; <span class="keyword">const</span> uint8_t *codes;</div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160; <span class="keywordtype">size_t</span> list_no;</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; <a class="code" href="structfaiss_1_1InvertedLists_1_1ScopedCodes.html">ScopedCodes</a> (<span class="keyword">const</span> <a class="code" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> *il, <span class="keywordtype">size_t</span> list_no):</div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160; il (il), codes (il-&gt;<a class="code" href="structfaiss_1_1InvertedLists.html#a60b12f9efe940b617a8380adceef4032">get_codes</a> (list_no)), list_no (list_no)</div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160; {}</div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160;</div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160; <a class="code" href="structfaiss_1_1InvertedLists_1_1ScopedCodes.html">ScopedCodes</a> (<span class="keyword">const</span> <a class="code" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> *il, <span class="keywordtype">size_t</span> list_no, <span class="keywordtype">size_t</span> offset):</div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160; il (il), codes (il-&gt;<a class="code" href="structfaiss_1_1InvertedLists.html#afc2760bed7c210f2fad9b03109f561ee">get_single_code</a> (list_no, offset)),</div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160; list_no (list_no)</div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160; {}</div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160;</div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160; <span class="keyword">const</span> uint8_t *<span class="keyword">get</span>() {<span class="keywordflow">return</span> codes; }</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; ~<a class="code" href="structfaiss_1_1InvertedLists_1_1ScopedCodes.html">ScopedCodes</a> () {</div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160; il-&gt;<a class="code" href="structfaiss_1_1InvertedLists.html#ad6a2111630ecd67ee5119d5198abcfb1">release_codes</a> (list_no, codes);</div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160; }</div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160; };</div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160;</div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>&#160;</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;</div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>&#160;<span class="comment">/// simple (default) implementation as an array of inverted lists</span></div>
<div class="line"><a name="l00182"></a><span class="lineno"><a class="line" href="structfaiss_1_1ArrayInvertedLists.html"> 182</a></span>&#160;<span class="comment"></span><span class="keyword">struct </span><a class="code" href="structfaiss_1_1ArrayInvertedLists.html">ArrayInvertedLists</a>: <a class="code" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> {</div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>&#160; std::vector &lt; std::vector&lt;uint8_t&gt; &gt; codes; <span class="comment">// binary codes, size nlist</span></div>
<div class="line"><a name="l00184"></a><span class="lineno"><a class="line" href="structfaiss_1_1ArrayInvertedLists.html#a48563a58d3bbfbb4334f3afdf2c9ba7a"> 184</a></span>&#160; std::vector &lt; std::vector&lt;idx_t&gt; &gt; <a class="code" href="structfaiss_1_1ArrayInvertedLists.html#a48563a58d3bbfbb4334f3afdf2c9ba7a">ids</a>; <span class="comment">///&lt; Inverted lists for indexes</span></div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>&#160; <a class="code" href="structfaiss_1_1ArrayInvertedLists.html">ArrayInvertedLists</a> (<span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1InvertedLists.html#afaf8b7aa3e846aa4553f6aae67827ec8">nlist</a>, <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1InvertedLists.html#ae06049e4259edb47d443ef87bdedc744">code_size</a>);</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; <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1ArrayInvertedLists.html#af43d3f5c5bd897205853b289603fb42b">list_size</a>(<span class="keywordtype">size_t</span> list_no) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>&#160; <span class="keyword">const</span> uint8_t * <a class="code" href="structfaiss_1_1ArrayInvertedLists.html#abf4ab66d09d8a1b707dddc77d0c2e8fc">get_codes</a> (<span class="keywordtype">size_t</span> list_no) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>&#160; <span class="keyword">const</span> idx_t * <a class="code" href="structfaiss_1_1ArrayInvertedLists.html#abd59f7cf340d9c17eb6b402579e4010b">get_ids</a> (<span class="keywordtype">size_t</span> list_no) <span class="keyword">const override</span>;</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="keywordtype">size_t</span> add_entries (</div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span>&#160; <span class="keywordtype">size_t</span> list_no, <span class="keywordtype">size_t</span> n_entry,</div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span>&#160; <span class="keyword">const</span> idx_t* <a class="code" href="structfaiss_1_1ArrayInvertedLists.html#a48563a58d3bbfbb4334f3afdf2c9ba7a">ids</a>, <span class="keyword">const</span> uint8_t *code) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span>&#160;</div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>&#160; <span class="keywordtype">void</span> update_entries (<span class="keywordtype">size_t</span> list_no, <span class="keywordtype">size_t</span> offset, <span class="keywordtype">size_t</span> n_entry,</div>
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span>&#160; <span class="keyword">const</span> idx_t *<a class="code" href="structfaiss_1_1ArrayInvertedLists.html#a48563a58d3bbfbb4334f3afdf2c9ba7a">ids</a>, <span class="keyword">const</span> uint8_t *code) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span>&#160;</div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span>&#160; <span class="keywordtype">void</span> resize (<span class="keywordtype">size_t</span> list_no, <span class="keywordtype">size_t</span> new_size) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span>&#160;</div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span>&#160; <span class="keyword">virtual</span> ~<a class="code" href="structfaiss_1_1ArrayInvertedLists.html">ArrayInvertedLists</a> ();</div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span>&#160;};</div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span>&#160;</div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>&#160;<span class="comment">/*****************************************************************</span></div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>&#160;<span class="comment"> * Meta-inverted lists</span></div>
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span>&#160;<span class="comment"> * About terminology: the inverted lists are seen as a sparse matrix,</span></div>
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span>&#160;<span class="comment"> * that can be stacked horizontally, vertically and sliced.</span></div>
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span>&#160;<span class="comment"> *****************************************************************/</span></div>
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span>&#160;</div>
<div class="line"><a name="l00211"></a><span class="lineno"><a class="line" href="structfaiss_1_1ReadOnlyInvertedLists.html"> 211</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structfaiss_1_1ReadOnlyInvertedLists.html">ReadOnlyInvertedLists</a>: <a class="code" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> {</div>
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span>&#160;</div>
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span>&#160; <a class="code" href="structfaiss_1_1ReadOnlyInvertedLists.html">ReadOnlyInvertedLists</a> (<span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1InvertedLists.html#afaf8b7aa3e846aa4553f6aae67827ec8">nlist</a>, <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1InvertedLists.html#ae06049e4259edb47d443ef87bdedc744">code_size</a>):</div>
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span>&#160; <a class="code" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> (nlist, code_size) {}</div>
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span>&#160;</div>
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span>&#160; <span class="keywordtype">size_t</span> add_entries (</div>
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span>&#160; <span class="keywordtype">size_t</span> list_no, <span class="keywordtype">size_t</span> n_entry,</div>
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span>&#160; <span class="keyword">const</span> idx_t* ids, <span class="keyword">const</span> uint8_t *code) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span>&#160;</div>
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span>&#160; <span class="keywordtype">void</span> update_entries (<span class="keywordtype">size_t</span> list_no, <span class="keywordtype">size_t</span> offset, <span class="keywordtype">size_t</span> n_entry,</div>
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span>&#160; <span class="keyword">const</span> idx_t *ids, <span class="keyword">const</span> uint8_t *code) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span>&#160;</div>
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span>&#160; <span class="keywordtype">void</span> resize (<span class="keywordtype">size_t</span> list_no, <span class="keywordtype">size_t</span> new_size) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span>&#160;</div>
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span>&#160;};</div>
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span>&#160;</div>
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span>&#160;<span class="comment">/// Horizontal stack of inverted lists</span></div>
<div class="line"><a name="l00229"></a><span class="lineno"><a class="line" href="structfaiss_1_1HStackInvertedLists.html"> 229</a></span>&#160;<span class="comment"></span><span class="keyword">struct </span><a class="code" href="structfaiss_1_1HStackInvertedLists.html">HStackInvertedLists</a>: <a class="code" href="structfaiss_1_1ReadOnlyInvertedLists.html">ReadOnlyInvertedLists</a> {</div>
<div class="line"><a name="l00230"></a><span class="lineno"> 230</span>&#160;</div>
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span>&#160; std::vector&lt;const InvertedLists *&gt;ils;</div>
<div class="line"><a name="l00232"></a><span class="lineno"> 232</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span>&#160;<span class="comment"> /// build InvertedLists by concatenating nil of them</span></div>
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span>&#160;<span class="comment"></span> <a class="code" href="structfaiss_1_1HStackInvertedLists.html#a882d2fde7902129f3ee2473efc4442da">HStackInvertedLists</a> (<span class="keywordtype">int</span> nil, <span class="keyword">const</span> <a class="code" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> **ils);</div>
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span>&#160;</div>
<div class="line"><a name="l00236"></a><span class="lineno"> 236</span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1HStackInvertedLists.html#af8330d7cdc185533a1286e3413810c5e">list_size</a>(<span class="keywordtype">size_t</span> list_no) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span>&#160; <span class="keyword">const</span> uint8_t * <a class="code" href="structfaiss_1_1HStackInvertedLists.html#a3a69cb5d1c05fa6b583672c459ecc4a6">get_codes</a> (<span class="keywordtype">size_t</span> list_no) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span>&#160; <span class="keyword">const</span> idx_t * <a class="code" href="structfaiss_1_1HStackInvertedLists.html#af812098083c022166d29a20846de173e">get_ids</a> (<span class="keywordtype">size_t</span> list_no) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span>&#160;</div>
<div class="line"><a name="l00240"></a><span class="lineno"> 240</span>&#160; <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1HStackInvertedLists.html#a249f680477fac00cdfcf319c3bbe8c05">prefetch_lists</a> (<span class="keyword">const</span> idx_t *list_nos, <span class="keywordtype">int</span> <a class="code" href="structfaiss_1_1InvertedLists.html#afaf8b7aa3e846aa4553f6aae67827ec8">nlist</a>) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span>&#160;</div>
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span>&#160; <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1HStackInvertedLists.html#ad431aa76dc678d71747dcbc9379d123a">release_codes</a> (<span class="keywordtype">size_t</span> list_no, <span class="keyword">const</span> uint8_t *codes) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span>&#160; <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1HStackInvertedLists.html#aa987a3ecea9f4df3340fd8c21f5d7000">release_ids</a> (<span class="keywordtype">size_t</span> list_no, <span class="keyword">const</span> idx_t *ids) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span>&#160;</div>
<div class="line"><a name="l00245"></a><span class="lineno"> 245</span>&#160; idx_t <a class="code" href="structfaiss_1_1HStackInvertedLists.html#aff00b896467e63cf821d35668804b039">get_single_id</a> (<span class="keywordtype">size_t</span> list_no, <span class="keywordtype">size_t</span> offset) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00246"></a><span class="lineno"> 246</span>&#160;</div>
<div class="line"><a name="l00247"></a><span class="lineno"> 247</span>&#160; <span class="keyword">const</span> uint8_t * <a class="code" href="structfaiss_1_1HStackInvertedLists.html#aeef6bd41622796f5d142e60fe78a5da8">get_single_code</a> (</div>
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span>&#160; <span class="keywordtype">size_t</span> list_no, <span class="keywordtype">size_t</span> offset) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00249"></a><span class="lineno"> 249</span>&#160;</div>
<div class="line"><a name="l00250"></a><span class="lineno"> 250</span>&#160;};</div>
<div class="line"><a name="l00251"></a><span class="lineno"> 251</span>&#160;</div>
<div class="line"><a name="l00252"></a><span class="lineno"> 252</span>&#160;<span class="keyword">using</span> <a class="code" href="structfaiss_1_1HStackInvertedLists.html">ConcatenatedInvertedLists</a> = <a class="code" href="structfaiss_1_1HStackInvertedLists.html">HStackInvertedLists</a>;</div>
<div class="line"><a name="l00253"></a><span class="lineno"> 253</span>&#160;</div>
<div class="line"><a name="l00254"></a><span class="lineno"> 254</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00255"></a><span class="lineno"> 255</span>&#160;<span class="comment">/// vertical slice of indexes in another InvertedLists</span></div>
<div class="line"><a name="l00256"></a><span class="lineno"><a class="line" href="structfaiss_1_1SliceInvertedLists.html"> 256</a></span>&#160;<span class="comment"></span><span class="keyword">struct </span><a class="code" href="structfaiss_1_1SliceInvertedLists.html">SliceInvertedLists</a>: <a class="code" href="structfaiss_1_1ReadOnlyInvertedLists.html">ReadOnlyInvertedLists</a> {</div>
<div class="line"><a name="l00257"></a><span class="lineno"> 257</span>&#160; <span class="keyword">const</span> <a class="code" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> *il;</div>
<div class="line"><a name="l00258"></a><span class="lineno"> 258</span>&#160; idx_t i0, i1;</div>
<div class="line"><a name="l00259"></a><span class="lineno"> 259</span>&#160;</div>
<div class="line"><a name="l00260"></a><span class="lineno"> 260</span>&#160; <a class="code" href="structfaiss_1_1SliceInvertedLists.html">SliceInvertedLists</a>(<span class="keyword">const</span> <a class="code" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> *il, idx_t i0, idx_t i1);</div>
<div class="line"><a name="l00261"></a><span class="lineno"> 261</span>&#160;</div>
<div class="line"><a name="l00262"></a><span class="lineno"> 262</span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1SliceInvertedLists.html#ab58bf7449476fc4638bc0a004f7ecb07">list_size</a>(<span class="keywordtype">size_t</span> list_no) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00263"></a><span class="lineno"> 263</span>&#160; <span class="keyword">const</span> uint8_t * <a class="code" href="structfaiss_1_1SliceInvertedLists.html#a95e1c091bea8695c6df29ed87b3cf0d9">get_codes</a> (<span class="keywordtype">size_t</span> list_no) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00264"></a><span class="lineno"> 264</span>&#160; <span class="keyword">const</span> idx_t * <a class="code" href="structfaiss_1_1SliceInvertedLists.html#ac5eb6df92e3bc9d49d7e88f0ff8d3a88">get_ids</a> (<span class="keywordtype">size_t</span> list_no) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00265"></a><span class="lineno"> 265</span>&#160;</div>
<div class="line"><a name="l00266"></a><span class="lineno"> 266</span>&#160; <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1SliceInvertedLists.html#a362456fac3002d1a5625a13dbfc0752b">release_codes</a> (<span class="keywordtype">size_t</span> list_no, <span class="keyword">const</span> uint8_t *codes) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00267"></a><span class="lineno"> 267</span>&#160; <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1SliceInvertedLists.html#ad3001048c22bcff5a1a8fb3c13d6a9ca">release_ids</a> (<span class="keywordtype">size_t</span> list_no, <span class="keyword">const</span> idx_t *ids) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00268"></a><span class="lineno"> 268</span>&#160;</div>
<div class="line"><a name="l00269"></a><span class="lineno"> 269</span>&#160; idx_t <a class="code" href="structfaiss_1_1SliceInvertedLists.html#a714d282706a7301772fcd145854a976e">get_single_id</a> (<span class="keywordtype">size_t</span> list_no, <span class="keywordtype">size_t</span> offset) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00270"></a><span class="lineno"> 270</span>&#160;</div>
<div class="line"><a name="l00271"></a><span class="lineno"> 271</span>&#160; <span class="keyword">const</span> uint8_t * <a class="code" href="structfaiss_1_1SliceInvertedLists.html#abc95a98970bb7b4b044c5a61520c20d3">get_single_code</a> (</div>
<div class="line"><a name="l00272"></a><span class="lineno"> 272</span>&#160; <span class="keywordtype">size_t</span> list_no, <span class="keywordtype">size_t</span> offset) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00273"></a><span class="lineno"> 273</span>&#160;</div>
<div class="line"><a name="l00274"></a><span class="lineno"> 274</span>&#160; <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1SliceInvertedLists.html#a40f74e21271fa5492fb9b78bb04a514f">prefetch_lists</a> (<span class="keyword">const</span> idx_t *list_nos, <span class="keywordtype">int</span> <a class="code" href="structfaiss_1_1InvertedLists.html#afaf8b7aa3e846aa4553f6aae67827ec8">nlist</a>) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00275"></a><span class="lineno"> 275</span>&#160;};</div>
<div class="line"><a name="l00276"></a><span class="lineno"> 276</span>&#160;</div>
<div class="line"><a name="l00277"></a><span class="lineno"> 277</span>&#160;</div>
<div class="line"><a name="l00278"></a><span class="lineno"><a class="line" href="structfaiss_1_1VStackInvertedLists.html"> 278</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structfaiss_1_1VStackInvertedLists.html">VStackInvertedLists</a>: <a class="code" href="structfaiss_1_1ReadOnlyInvertedLists.html">ReadOnlyInvertedLists</a> {</div>
<div class="line"><a name="l00279"></a><span class="lineno"> 279</span>&#160; std::vector&lt;const InvertedLists *&gt;ils;</div>
<div class="line"><a name="l00280"></a><span class="lineno"> 280</span>&#160; std::vector&lt;idx_t&gt; cumsz;</div>
<div class="line"><a name="l00281"></a><span class="lineno"> 281</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00282"></a><span class="lineno"> 282</span>&#160;<span class="comment"> /// build InvertedLists by concatenating nil of them</span></div>
<div class="line"><a name="l00283"></a><span class="lineno"> 283</span>&#160;<span class="comment"></span> <a class="code" href="structfaiss_1_1VStackInvertedLists.html#a8f6ba4b3d64b74409742edad6c6c0f37">VStackInvertedLists</a> (<span class="keywordtype">int</span> nil, <span class="keyword">const</span> <a class="code" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> **ils);</div>
<div class="line"><a name="l00284"></a><span class="lineno"> 284</span>&#160;</div>
<div class="line"><a name="l00285"></a><span class="lineno"> 285</span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1VStackInvertedLists.html#a6398b7faee56b47f1f9817f3763fef01">list_size</a>(<span class="keywordtype">size_t</span> list_no) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00286"></a><span class="lineno"> 286</span>&#160; <span class="keyword">const</span> uint8_t * <a class="code" href="structfaiss_1_1VStackInvertedLists.html#a112f9458bd91ca5dbed2cb6d090a0034">get_codes</a> (<span class="keywordtype">size_t</span> list_no) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00287"></a><span class="lineno"> 287</span>&#160; <span class="keyword">const</span> idx_t * <a class="code" href="structfaiss_1_1VStackInvertedLists.html#a912c3f0417c833a81da5957f4d77452a">get_ids</a> (<span class="keywordtype">size_t</span> list_no) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00288"></a><span class="lineno"> 288</span>&#160;</div>
<div class="line"><a name="l00289"></a><span class="lineno"> 289</span>&#160; <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1VStackInvertedLists.html#a331222282fb32dc55d6f5847bbd1c848">release_codes</a> (<span class="keywordtype">size_t</span> list_no, <span class="keyword">const</span> uint8_t *codes) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00290"></a><span class="lineno"> 290</span>&#160; <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1VStackInvertedLists.html#a3048d4656332d160502cd95b22b53be5">release_ids</a> (<span class="keywordtype">size_t</span> list_no, <span class="keyword">const</span> idx_t *ids) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00291"></a><span class="lineno"> 291</span>&#160;</div>
<div class="line"><a name="l00292"></a><span class="lineno"> 292</span>&#160; idx_t <a class="code" href="structfaiss_1_1VStackInvertedLists.html#ab2d660680d9b4a2667c321515b5baa77">get_single_id</a> (<span class="keywordtype">size_t</span> list_no, <span class="keywordtype">size_t</span> offset) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00293"></a><span class="lineno"> 293</span>&#160;</div>
<div class="line"><a name="l00294"></a><span class="lineno"> 294</span>&#160; <span class="keyword">const</span> uint8_t * <a class="code" href="structfaiss_1_1VStackInvertedLists.html#a3c229e59737b533464f5403c5cf5fca4">get_single_code</a> (</div>
<div class="line"><a name="l00295"></a><span class="lineno"> 295</span>&#160; <span class="keywordtype">size_t</span> list_no, <span class="keywordtype">size_t</span> offset) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00296"></a><span class="lineno"> 296</span>&#160;</div>
<div class="line"><a name="l00297"></a><span class="lineno"> 297</span>&#160; <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1VStackInvertedLists.html#af37c2171d22f7f9200fa5cdedb363471">prefetch_lists</a> (<span class="keyword">const</span> idx_t *list_nos, <span class="keywordtype">int</span> <a class="code" href="structfaiss_1_1InvertedLists.html#afaf8b7aa3e846aa4553f6aae67827ec8">nlist</a>) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00298"></a><span class="lineno"> 298</span>&#160;</div>
<div class="line"><a name="l00299"></a><span class="lineno"> 299</span>&#160;};</div>
<div class="line"><a name="l00300"></a><span class="lineno"> 300</span>&#160;</div>
<div class="line"><a name="l00301"></a><span class="lineno"> 301</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00302"></a><span class="lineno"> 302</span>&#160;<span class="comment">/** use the first inverted lists if they are non-empty otherwise use the second</span></div>
<div class="line"><a name="l00303"></a><span class="lineno"> 303</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00304"></a><span class="lineno"> 304</span>&#160;<span class="comment"> * This is useful if il1 has a few inverted lists that are too long,</span></div>
<div class="line"><a name="l00305"></a><span class="lineno"> 305</span>&#160;<span class="comment"> * and that il0 has replacement lists for those, with empty lists for</span></div>
<div class="line"><a name="l00306"></a><span class="lineno"> 306</span>&#160;<span class="comment"> * the others. */</span></div>
<div class="line"><a name="l00307"></a><span class="lineno"><a class="line" href="structfaiss_1_1MaskedInvertedLists.html"> 307</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structfaiss_1_1MaskedInvertedLists.html">MaskedInvertedLists</a>: <a class="code" href="structfaiss_1_1ReadOnlyInvertedLists.html">ReadOnlyInvertedLists</a> {</div>
<div class="line"><a name="l00308"></a><span class="lineno"> 308</span>&#160;</div>
<div class="line"><a name="l00309"></a><span class="lineno"> 309</span>&#160; <span class="keyword">const</span> <a class="code" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> *il0;</div>
<div class="line"><a name="l00310"></a><span class="lineno"> 310</span>&#160; <span class="keyword">const</span> <a class="code" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> *il1;</div>
<div class="line"><a name="l00311"></a><span class="lineno"> 311</span>&#160;</div>
<div class="line"><a name="l00312"></a><span class="lineno"> 312</span>&#160; <a class="code" href="structfaiss_1_1MaskedInvertedLists.html">MaskedInvertedLists</a> (<span class="keyword">const</span> <a class="code" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> *il0,</div>
<div class="line"><a name="l00313"></a><span class="lineno"> 313</span>&#160; <span class="keyword">const</span> <a class="code" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> *il1);</div>
<div class="line"><a name="l00314"></a><span class="lineno"> 314</span>&#160;</div>
<div class="line"><a name="l00315"></a><span class="lineno"> 315</span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1MaskedInvertedLists.html#a5c400887da892a68ce47eff56e30dffc">list_size</a>(<span class="keywordtype">size_t</span> list_no) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00316"></a><span class="lineno"> 316</span>&#160; <span class="keyword">const</span> uint8_t * <a class="code" href="structfaiss_1_1MaskedInvertedLists.html#a4376b14cd4e349d51848995c102659af">get_codes</a> (<span class="keywordtype">size_t</span> list_no) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00317"></a><span class="lineno"> 317</span>&#160; <span class="keyword">const</span> idx_t * <a class="code" href="structfaiss_1_1MaskedInvertedLists.html#a924d45d2ab3809c728e7b02ec569b2ba">get_ids</a> (<span class="keywordtype">size_t</span> list_no) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00318"></a><span class="lineno"> 318</span>&#160;</div>
<div class="line"><a name="l00319"></a><span class="lineno"> 319</span>&#160; <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1MaskedInvertedLists.html#a64e66ef4c7dc387091f533cc61d88273">release_codes</a> (<span class="keywordtype">size_t</span> list_no, <span class="keyword">const</span> uint8_t *codes) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00320"></a><span class="lineno"> 320</span>&#160; <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1MaskedInvertedLists.html#a86c8d8c022c79c32b3f776f2ad4f3b1e">release_ids</a> (<span class="keywordtype">size_t</span> list_no, <span class="keyword">const</span> idx_t *ids) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00321"></a><span class="lineno"> 321</span>&#160;</div>
<div class="line"><a name="l00322"></a><span class="lineno"> 322</span>&#160; idx_t <a class="code" href="structfaiss_1_1MaskedInvertedLists.html#af0d9f7b61caef91e30124b0f7a9d44b9">get_single_id</a> (<span class="keywordtype">size_t</span> list_no, <span class="keywordtype">size_t</span> offset) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00323"></a><span class="lineno"> 323</span>&#160;</div>
<div class="line"><a name="l00324"></a><span class="lineno"> 324</span>&#160; <span class="keyword">const</span> uint8_t * <a class="code" href="structfaiss_1_1MaskedInvertedLists.html#a429657c4c203d472f59147f301de0ede">get_single_code</a> (</div>
<div class="line"><a name="l00325"></a><span class="lineno"> 325</span>&#160; <span class="keywordtype">size_t</span> list_no, <span class="keywordtype">size_t</span> offset) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00326"></a><span class="lineno"> 326</span>&#160;</div>
<div class="line"><a name="l00327"></a><span class="lineno"> 327</span>&#160; <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1MaskedInvertedLists.html#a5fbd34b4052c314148c44f14b4d3c2d3">prefetch_lists</a> (<span class="keyword">const</span> idx_t *list_nos, <span class="keywordtype">int</span> <a class="code" href="structfaiss_1_1InvertedLists.html#afaf8b7aa3e846aa4553f6aae67827ec8">nlist</a>) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00328"></a><span class="lineno"> 328</span>&#160;</div>
<div class="line"><a name="l00329"></a><span class="lineno"> 329</span>&#160;};</div>
<div class="line"><a name="l00330"></a><span class="lineno"> 330</span>&#160;</div>
<div class="line"><a name="l00331"></a><span class="lineno"> 331</span>&#160;} <span class="comment">// namespace faiss</span></div>
<div class="line"><a name="l00332"></a><span class="lineno"> 332</span>&#160;</div>
<div class="line"><a name="l00333"></a><span class="lineno"> 333</span>&#160;</div>
<div class="line"><a name="l00334"></a><span class="lineno"> 334</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="structfaiss_1_1ArrayInvertedLists_html_abf4ab66d09d8a1b707dddc77d0c2e8fc"><div class="ttname"><a href="structfaiss_1_1ArrayInvertedLists.html#abf4ab66d09d8a1b707dddc77d0c2e8fc">faiss::ArrayInvertedLists::get_codes</a></div><div class="ttdeci">const uint8_t * get_codes(size_t list_no) const override</div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00165">InvertedLists.cpp:165</a></div></div>
<div class="ttc" id="structfaiss_1_1VStackInvertedLists_html_af37c2171d22f7f9200fa5cdedb363471"><div class="ttname"><a href="structfaiss_1_1VStackInvertedLists.html#af37c2171d22f7f9200fa5cdedb363471">faiss::VStackInvertedLists::prefetch_lists</a></div><div class="ttdeci">void prefetch_lists(const idx_t *list_nos, int nlist) const override</div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00512">InvertedLists.cpp:512</a></div></div>
<div class="ttc" id="structfaiss_1_1HStackInvertedLists_html_aff00b896467e63cf821d35668804b039"><div class="ttname"><a href="structfaiss_1_1HStackInvertedLists.html#aff00b896467e63cf821d35668804b039">faiss::HStackInvertedLists::get_single_id</a></div><div class="ttdeci">idx_t get_single_id(size_t list_no, size_t offset) const override</div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00302">InvertedLists.cpp:302</a></div></div>
<div class="ttc" id="structfaiss_1_1ArrayInvertedLists_html"><div class="ttname"><a href="structfaiss_1_1ArrayInvertedLists.html">faiss::ArrayInvertedLists</a></div><div class="ttdoc">simple (default) implementation as an array of inverted lists </div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8h_source.html#l00182">InvertedLists.h:182</a></div></div>
<div class="ttc" id="structfaiss_1_1SliceInvertedLists_html_ad3001048c22bcff5a1a8fb3c13d6a9ca"><div class="ttname"><a href="structfaiss_1_1SliceInvertedLists.html#ad3001048c22bcff5a1a8fb3c13d6a9ca">faiss::SliceInvertedLists::release_ids</a></div><div class="ttdeci">void release_ids(size_t list_no, const idx_t *ids) const override</div><div class="ttdoc">release ids returned by get_ids </div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00391">InvertedLists.cpp:391</a></div></div>
<div class="ttc" id="structfaiss_1_1MaskedInvertedLists_html_a86c8d8c022c79c32b3f776f2ad4f3b1e"><div class="ttname"><a href="structfaiss_1_1MaskedInvertedLists.html#a86c8d8c022c79c32b3f776f2ad4f3b1e">faiss::MaskedInvertedLists::release_ids</a></div><div class="ttdeci">void release_ids(size_t list_no, const idx_t *ids) const override</div><div class="ttdoc">release ids returned by get_ids </div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00588">InvertedLists.cpp:588</a></div></div>
<div class="ttc" id="structfaiss_1_1ArrayInvertedLists_html_abd59f7cf340d9c17eb6b402579e4010b"><div class="ttname"><a href="structfaiss_1_1ArrayInvertedLists.html#abd59f7cf340d9c17eb6b402579e4010b">faiss::ArrayInvertedLists::get_ids</a></div><div class="ttdeci">const idx_t * get_ids(size_t list_no) const override</div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00172">InvertedLists.cpp:172</a></div></div>
<div class="ttc" id="structfaiss_1_1InvertedLists_html_a3ab6b389d8d85c5fbf23889064df7e95"><div class="ttname"><a href="structfaiss_1_1InvertedLists.html#a3ab6b389d8d85c5fbf23889064df7e95">faiss::InvertedLists::get_ids</a></div><div class="ttdeci">virtual const idx_t * get_ids(size_t list_no) const =0</div></div>
<div class="ttc" id="structfaiss_1_1InvertedLists_html_aacf34f6cf392771fe2e68210cd4e009b"><div class="ttname"><a href="structfaiss_1_1InvertedLists.html#aacf34f6cf392771fe2e68210cd4e009b">faiss::InvertedLists::imbalance_factor</a></div><div class="ttdeci">double imbalance_factor() const </div><div class="ttdoc">1= perfectly balanced, &amp;gt;1: imbalanced </div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00099">InvertedLists.cpp:99</a></div></div>
<div class="ttc" id="structfaiss_1_1SliceInvertedLists_html_ac5eb6df92e3bc9d49d7e88f0ff8d3a88"><div class="ttname"><a href="structfaiss_1_1SliceInvertedLists.html#ac5eb6df92e3bc9d49d7e88f0ff8d3a88">faiss::SliceInvertedLists::get_ids</a></div><div class="ttdeci">const idx_t * get_ids(size_t list_no) const override</div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00379">InvertedLists.cpp:379</a></div></div>
<div class="ttc" id="structfaiss_1_1SliceInvertedLists_html_a714d282706a7301772fcd145854a976e"><div class="ttname"><a href="structfaiss_1_1SliceInvertedLists.html#a714d282706a7301772fcd145854a976e">faiss::SliceInvertedLists::get_single_id</a></div><div class="ttdeci">idx_t get_single_id(size_t list_no, size_t offset) const override</div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00384">InvertedLists.cpp:384</a></div></div>
<div class="ttc" id="structfaiss_1_1SliceInvertedLists_html"><div class="ttname"><a href="structfaiss_1_1SliceInvertedLists.html">faiss::SliceInvertedLists</a></div><div class="ttdoc">vertical slice of indexes in another InvertedLists </div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8h_source.html#l00256">InvertedLists.h:256</a></div></div>
<div class="ttc" id="structfaiss_1_1MaskedInvertedLists_html_a5fbd34b4052c314148c44f14b4d3c2d3"><div class="ttname"><a href="structfaiss_1_1MaskedInvertedLists.html#a5fbd34b4052c314148c44f14b4d3c2d3">faiss::MaskedInvertedLists::prefetch_lists</a></div><div class="ttdeci">void prefetch_lists(const idx_t *list_nos, int nlist) const override</div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00607">InvertedLists.cpp:607</a></div></div>
<div class="ttc" id="structfaiss_1_1InvertedLists_html_a9bd256053ee360473842105460fe285f"><div class="ttname"><a href="structfaiss_1_1InvertedLists.html#a9bd256053ee360473842105460fe285f">faiss::InvertedLists::list_size</a></div><div class="ttdeci">virtual size_t list_size(size_t list_no) const =0</div><div class="ttdoc">get the size of a list </div></div>
<div class="ttc" id="structfaiss_1_1MaskedInvertedLists_html_a5c400887da892a68ce47eff56e30dffc"><div class="ttname"><a href="structfaiss_1_1MaskedInvertedLists.html#a5c400887da892a68ce47eff56e30dffc">faiss::MaskedInvertedLists::list_size</a></div><div class="ttdeci">size_t list_size(size_t list_no) const override</div><div class="ttdoc">get the size of a list </div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00563">InvertedLists.cpp:563</a></div></div>
<div class="ttc" id="structfaiss_1_1MaskedInvertedLists_html_a429657c4c203d472f59147f301de0ede"><div class="ttname"><a href="structfaiss_1_1MaskedInvertedLists.html#a429657c4c203d472f59147f301de0ede">faiss::MaskedInvertedLists::get_single_code</a></div><div class="ttdeci">const uint8_t * get_single_code(size_t list_no, size_t offset) const override</div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00600">InvertedLists.cpp:600</a></div></div>
<div class="ttc" id="structfaiss_1_1InvertedLists_html"><div class="ttname"><a href="structfaiss_1_1InvertedLists.html">faiss::InvertedLists</a></div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8h_source.html#l00031">InvertedLists.h:31</a></div></div>
<div class="ttc" id="structfaiss_1_1VStackInvertedLists_html_a3c229e59737b533464f5403c5cf5fca4"><div class="ttname"><a href="structfaiss_1_1VStackInvertedLists.html#a3c229e59737b533464f5403c5cf5fca4">faiss::VStackInvertedLists::get_single_code</a></div><div class="ttdeci">const uint8_t * get_single_code(size_t list_no, size_t offset) const override</div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00474">InvertedLists.cpp:474</a></div></div>
<div class="ttc" id="structfaiss_1_1InvertedLists_html_ac2a0686121ef5bdd6eb70f7eb3cf9b3a"><div class="ttname"><a href="structfaiss_1_1InvertedLists.html#ac2a0686121ef5bdd6eb70f7eb3cf9b3a">faiss::InvertedLists::merge_from</a></div><div class="ttdeci">void merge_from(InvertedLists *oivf, size_t add_id)</div><div class="ttdoc">move all entries from oivf (empty on output) </div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00077">InvertedLists.cpp:77</a></div></div>
<div class="ttc" id="structfaiss_1_1InvertedLists_html_a21b52cdb0601cd225bd7924932310876"><div class="ttname"><a href="structfaiss_1_1InvertedLists.html#a21b52cdb0601cd225bd7924932310876">faiss::InvertedLists::get_single_id</a></div><div class="ttdeci">virtual idx_t get_single_id(size_t list_no, size_t offset) const </div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00035">InvertedLists.cpp:35</a></div></div>
<div class="ttc" id="structfaiss_1_1Index_html_ad3f0d3071f987baabbdd3da4500c87ea"><div class="ttname"><a href="structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea">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#l00062">Index.h:62</a></div></div>
<div class="ttc" id="structfaiss_1_1InvertedLists_html_ae06049e4259edb47d443ef87bdedc744"><div class="ttname"><a href="structfaiss_1_1InvertedLists.html#ae06049e4259edb47d443ef87bdedc744">faiss::InvertedLists::code_size</a></div><div class="ttdeci">size_t code_size</div><div class="ttdoc">code size per vector in bytes </div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8h_source.html#l00035">InvertedLists.h:35</a></div></div>
<div class="ttc" id="structfaiss_1_1InvertedLists_html_afc2760bed7c210f2fad9b03109f561ee"><div class="ttname"><a href="structfaiss_1_1InvertedLists.html#afc2760bed7c210f2fad9b03109f561ee">faiss::InvertedLists::get_single_code</a></div><div class="ttdeci">virtual const uint8_t * get_single_code(size_t list_no, size_t offset) const </div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00052">InvertedLists.cpp:52</a></div></div>
<div class="ttc" id="structfaiss_1_1VStackInvertedLists_html_a8f6ba4b3d64b74409742edad6c6c0f37"><div class="ttname"><a href="structfaiss_1_1VStackInvertedLists.html#a8f6ba4b3d64b74409742edad6c6c0f37">faiss::VStackInvertedLists::VStackInvertedLists</a></div><div class="ttdeci">VStackInvertedLists(int nil, const InvertedLists **ils)</div><div class="ttdoc">build InvertedLists by concatenating nil of them </div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00446">InvertedLists.cpp:446</a></div></div>
<div class="ttc" id="structfaiss_1_1InvertedLists_html_a722eef5a0e5bf5dcf78228a903e16af9"><div class="ttname"><a href="structfaiss_1_1InvertedLists.html#a722eef5a0e5bf5dcf78228a903e16af9">faiss::InvertedLists::compute_ntotal</a></div><div class="ttdeci">size_t compute_ntotal() const </div><div class="ttdoc">sum up list sizes </div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00126">InvertedLists.cpp:126</a></div></div>
<div class="ttc" id="structfaiss_1_1VStackInvertedLists_html_a112f9458bd91ca5dbed2cb6d090a0034"><div class="ttname"><a href="structfaiss_1_1VStackInvertedLists.html#a112f9458bd91ca5dbed2cb6d090a0034">faiss::VStackInvertedLists::get_codes</a></div><div class="ttdeci">const uint8_t * get_codes(size_t list_no) const override</div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00467">InvertedLists.cpp:467</a></div></div>
<div class="ttc" id="structfaiss_1_1MaskedInvertedLists_html"><div class="ttname"><a href="structfaiss_1_1MaskedInvertedLists.html">faiss::MaskedInvertedLists</a></div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8h_source.html#l00307">InvertedLists.h:307</a></div></div>
<div class="ttc" id="structfaiss_1_1InvertedLists_html_acd3e36cc06fc49e02773e403a84dba95"><div class="ttname"><a href="structfaiss_1_1InvertedLists.html#acd3e36cc06fc49e02773e403a84dba95">faiss::InvertedLists::add_entry</a></div><div class="ttdeci">virtual size_t add_entry(size_t list_no, idx_t theid, const uint8_t *code)</div><div class="ttdoc">add one entry to an inverted list </div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00059">InvertedLists.cpp:59</a></div></div>
<div class="ttc" id="structfaiss_1_1VStackInvertedLists_html"><div class="ttname"><a href="structfaiss_1_1VStackInvertedLists.html">faiss::VStackInvertedLists</a></div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8h_source.html#l00278">InvertedLists.h:278</a></div></div>
<div class="ttc" id="structfaiss_1_1HStackInvertedLists_html_a3a69cb5d1c05fa6b583672c459ecc4a6"><div class="ttname"><a href="structfaiss_1_1HStackInvertedLists.html#a3a69cb5d1c05fa6b583672c459ecc4a6">faiss::HStackInvertedLists::get_codes</a></div><div class="ttdeci">const uint8_t * get_codes(size_t list_no) const override</div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00250">InvertedLists.cpp:250</a></div></div>
<div class="ttc" id="structfaiss_1_1HStackInvertedLists_html_af8330d7cdc185533a1286e3413810c5e"><div class="ttname"><a href="structfaiss_1_1HStackInvertedLists.html#af8330d7cdc185533a1286e3413810c5e">faiss::HStackInvertedLists::list_size</a></div><div class="ttdeci">size_t list_size(size_t list_no) const override</div><div class="ttdoc">get the size of a list </div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00240">InvertedLists.cpp:240</a></div></div>
<div class="ttc" id="structfaiss_1_1HStackInvertedLists_html_a249f680477fac00cdfcf319c3bbe8c05"><div class="ttname"><a href="structfaiss_1_1HStackInvertedLists.html#a249f680477fac00cdfcf319c3bbe8c05">faiss::HStackInvertedLists::prefetch_lists</a></div><div class="ttdeci">void prefetch_lists(const idx_t *list_nos, int nlist) const override</div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00322">InvertedLists.cpp:322</a></div></div>
<div class="ttc" id="structfaiss_1_1VStackInvertedLists_html_a6398b7faee56b47f1f9817f3763fef01"><div class="ttname"><a href="structfaiss_1_1VStackInvertedLists.html#a6398b7faee56b47f1f9817f3763fef01">faiss::VStackInvertedLists::list_size</a></div><div class="ttdeci">size_t list_size(size_t list_no) const override</div><div class="ttdoc">get the size of a list </div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00460">InvertedLists.cpp:460</a></div></div>
<div class="ttc" id="structfaiss_1_1SliceInvertedLists_html_a40f74e21271fa5492fb9b78bb04a514f"><div class="ttname"><a href="structfaiss_1_1SliceInvertedLists.html#a40f74e21271fa5492fb9b78bb04a514f">faiss::SliceInvertedLists::prefetch_lists</a></div><div class="ttdeci">void prefetch_lists(const idx_t *list_nos, int nlist) const override</div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00395">InvertedLists.cpp:395</a></div></div>
<div class="ttc" id="structfaiss_1_1HStackInvertedLists_html_a882d2fde7902129f3ee2473efc4442da"><div class="ttname"><a href="structfaiss_1_1HStackInvertedLists.html#a882d2fde7902129f3ee2473efc4442da">faiss::HStackInvertedLists::HStackInvertedLists</a></div><div class="ttdeci">HStackInvertedLists(int nil, const InvertedLists **ils)</div><div class="ttdoc">build InvertedLists by concatenating nil of them </div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00227">InvertedLists.cpp:227</a></div></div>
<div class="ttc" id="structfaiss_1_1HStackInvertedLists_html_aeef6bd41622796f5d142e60fe78a5da8"><div class="ttname"><a href="structfaiss_1_1HStackInvertedLists.html#aeef6bd41622796f5d142e60fe78a5da8">faiss::HStackInvertedLists::get_single_code</a></div><div class="ttdeci">const uint8_t * get_single_code(size_t list_no, size_t offset) const override</div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00265">InvertedLists.cpp:265</a></div></div>
<div class="ttc" id="structfaiss_1_1HStackInvertedLists_html"><div class="ttname"><a href="structfaiss_1_1HStackInvertedLists.html">faiss::HStackInvertedLists</a></div><div class="ttdoc">Horizontal stack of inverted lists. </div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8h_source.html#l00229">InvertedLists.h:229</a></div></div>
<div class="ttc" id="structfaiss_1_1MaskedInvertedLists_html_af0d9f7b61caef91e30124b0f7a9d44b9"><div class="ttname"><a href="structfaiss_1_1MaskedInvertedLists.html#af0d9f7b61caef91e30124b0f7a9d44b9">faiss::MaskedInvertedLists::get_single_id</a></div><div class="ttdeci">idx_t get_single_id(size_t list_no, size_t offset) const override</div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00594">InvertedLists.cpp:594</a></div></div>
<div class="ttc" id="structfaiss_1_1MaskedInvertedLists_html_a4376b14cd4e349d51848995c102659af"><div class="ttname"><a href="structfaiss_1_1MaskedInvertedLists.html#a4376b14cd4e349d51848995c102659af">faiss::MaskedInvertedLists::get_codes</a></div><div class="ttdeci">const uint8_t * get_codes(size_t list_no) const override</div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00569">InvertedLists.cpp:569</a></div></div>
<div class="ttc" id="structfaiss_1_1VStackInvertedLists_html_a912c3f0417c833a81da5957f4d77452a"><div class="ttname"><a href="structfaiss_1_1VStackInvertedLists.html#a912c3f0417c833a81da5957f4d77452a">faiss::VStackInvertedLists::get_ids</a></div><div class="ttdeci">const idx_t * get_ids(size_t list_no) const override</div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00490">InvertedLists.cpp:490</a></div></div>
<div class="ttc" id="structfaiss_1_1SliceInvertedLists_html_ab58bf7449476fc4638bc0a004f7ecb07"><div class="ttname"><a href="structfaiss_1_1SliceInvertedLists.html#ab58bf7449476fc4638bc0a004f7ecb07">faiss::SliceInvertedLists::list_size</a></div><div class="ttdeci">size_t list_size(size_t list_no) const override</div><div class="ttdoc">get the size of a list </div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00357">InvertedLists.cpp:357</a></div></div>
<div class="ttc" id="structfaiss_1_1InvertedLists_html_afaf8b7aa3e846aa4553f6aae67827ec8"><div class="ttname"><a href="structfaiss_1_1InvertedLists.html#afaf8b7aa3e846aa4553f6aae67827ec8">faiss::InvertedLists::nlist</a></div><div class="ttdeci">size_t nlist</div><div class="ttdoc">number of possible key values </div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8h_source.html#l00034">InvertedLists.h:34</a></div></div>
<div class="ttc" id="structfaiss_1_1SliceInvertedLists_html_abc95a98970bb7b4b044c5a61520c20d3"><div class="ttname"><a href="structfaiss_1_1SliceInvertedLists.html#abc95a98970bb7b4b044c5a61520c20d3">faiss::SliceInvertedLists::get_single_code</a></div><div class="ttdeci">const uint8_t * get_single_code(size_t list_no, size_t offset) const override</div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00367">InvertedLists.cpp:367</a></div></div>
<div class="ttc" id="structfaiss_1_1ReadOnlyInvertedLists_html"><div class="ttname"><a href="structfaiss_1_1ReadOnlyInvertedLists.html">faiss::ReadOnlyInvertedLists</a></div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8h_source.html#l00211">InvertedLists.h:211</a></div></div>
<div class="ttc" id="structfaiss_1_1ArrayInvertedLists_html_a48563a58d3bbfbb4334f3afdf2c9ba7a"><div class="ttname"><a href="structfaiss_1_1ArrayInvertedLists.html#a48563a58d3bbfbb4334f3afdf2c9ba7a">faiss::ArrayInvertedLists::ids</a></div><div class="ttdeci">std::vector&lt; std::vector&lt; idx_t &gt; &gt; ids</div><div class="ttdoc">Inverted lists for indexes. </div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8h_source.html#l00184">InvertedLists.h:184</a></div></div>
<div class="ttc" id="structfaiss_1_1HStackInvertedLists_html_aa987a3ecea9f4df3340fd8c21f5d7000"><div class="ttname"><a href="structfaiss_1_1HStackInvertedLists.html#aa987a3ecea9f4df3340fd8c21f5d7000">faiss::HStackInvertedLists::release_ids</a></div><div class="ttdeci">void release_ids(size_t list_no, const idx_t *ids) const override</div><div class="ttdoc">release ids returned by get_ids </div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00318">InvertedLists.cpp:318</a></div></div>
<div class="ttc" id="structfaiss_1_1MaskedInvertedLists_html_a924d45d2ab3809c728e7b02ec569b2ba"><div class="ttname"><a href="structfaiss_1_1MaskedInvertedLists.html#a924d45d2ab3809c728e7b02ec569b2ba">faiss::MaskedInvertedLists::get_ids</a></div><div class="ttdeci">const idx_t * get_ids(size_t list_no) const override</div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00575">InvertedLists.cpp:575</a></div></div>
<div class="ttc" id="structfaiss_1_1InvertedLists_html_a156de8be4b21a0dfa9a48a3918a0b5c3"><div class="ttname"><a href="structfaiss_1_1InvertedLists.html#a156de8be4b21a0dfa9a48a3918a0b5c3">faiss::InvertedLists::print_stats</a></div><div class="ttdeci">void print_stats() const </div><div class="ttdoc">display some stats about the inverted lists </div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00109">InvertedLists.cpp:109</a></div></div>
<div class="ttc" id="structfaiss_1_1InvertedLists_html_a60b12f9efe940b617a8380adceef4032"><div class="ttname"><a href="structfaiss_1_1InvertedLists.html#a60b12f9efe940b617a8380adceef4032">faiss::InvertedLists::get_codes</a></div><div class="ttdeci">virtual const uint8_t * get_codes(size_t list_no) const =0</div></div>
<div class="ttc" id="structfaiss_1_1InvertedLists_html_ac537aa14d2731c0ff907169211389b76"><div class="ttname"><a href="structfaiss_1_1InvertedLists.html#ac537aa14d2731c0ff907169211389b76">faiss::InvertedLists::prefetch_lists</a></div><div class="ttdeci">virtual void prefetch_lists(const idx_t *list_nos, int nlist) const </div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00049">InvertedLists.cpp:49</a></div></div>
<div class="ttc" id="structfaiss_1_1InvertedLists_html_ae1618d2b5dca2704d3af8ced58548ac9"><div class="ttname"><a href="structfaiss_1_1InvertedLists.html#ae1618d2b5dca2704d3af8ced58548ac9">faiss::InvertedLists::release_ids</a></div><div class="ttdeci">virtual void release_ids(size_t list_no, const idx_t *ids) const </div><div class="ttdoc">release ids returned by get_ids </div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00046">InvertedLists.cpp:46</a></div></div>
<div class="ttc" id="structfaiss_1_1VStackInvertedLists_html_a331222282fb32dc55d6f5847bbd1c848"><div class="ttname"><a href="structfaiss_1_1VStackInvertedLists.html#a331222282fb32dc55d6f5847bbd1c848">faiss::VStackInvertedLists::release_codes</a></div><div class="ttdeci">void release_codes(size_t list_no, const uint8_t *codes) const override</div><div class="ttdoc">release codes returned by get_codes (default implementation is nop </div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00483">InvertedLists.cpp:483</a></div></div>
<div class="ttc" id="structfaiss_1_1InvertedLists_1_1ScopedIds_html"><div class="ttname"><a href="structfaiss_1_1InvertedLists_1_1ScopedIds.html">faiss::InvertedLists::ScopedIds</a></div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8h_source.html#l00136">InvertedLists.h:136</a></div></div>
<div class="ttc" id="structfaiss_1_1SliceInvertedLists_html_a95e1c091bea8695c6df29ed87b3cf0d9"><div class="ttname"><a href="structfaiss_1_1SliceInvertedLists.html#a95e1c091bea8695c6df29ed87b3cf0d9">faiss::SliceInvertedLists::get_codes</a></div><div class="ttdeci">const uint8_t * get_codes(size_t list_no) const override</div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00362">InvertedLists.cpp:362</a></div></div>
<div class="ttc" id="structfaiss_1_1VStackInvertedLists_html_a3048d4656332d160502cd95b22b53be5"><div class="ttname"><a href="structfaiss_1_1VStackInvertedLists.html#a3048d4656332d160502cd95b22b53be5">faiss::VStackInvertedLists::release_ids</a></div><div class="ttdeci">void release_ids(size_t list_no, const idx_t *ids) const override</div><div class="ttdoc">release ids returned by get_ids </div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00506">InvertedLists.cpp:506</a></div></div>
<div class="ttc" id="structfaiss_1_1MaskedInvertedLists_html_a64e66ef4c7dc387091f533cc61d88273"><div class="ttname"><a href="structfaiss_1_1MaskedInvertedLists.html#a64e66ef4c7dc387091f533cc61d88273">faiss::MaskedInvertedLists::release_codes</a></div><div class="ttdeci">void release_codes(size_t list_no, const uint8_t *codes) const override</div><div class="ttdoc">release codes returned by get_codes (default implementation is nop </div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00581">InvertedLists.cpp:581</a></div></div>
<div class="ttc" id="structfaiss_1_1ArrayInvertedLists_html_af43d3f5c5bd897205853b289603fb42b"><div class="ttname"><a href="structfaiss_1_1ArrayInvertedLists.html#af43d3f5c5bd897205853b289603fb42b">faiss::ArrayInvertedLists::list_size</a></div><div class="ttdeci">size_t list_size(size_t list_no) const override</div><div class="ttdoc">get the size of a list </div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00159">InvertedLists.cpp:159</a></div></div>
<div class="ttc" id="structfaiss_1_1InvertedLists_html_ad6a2111630ecd67ee5119d5198abcfb1"><div class="ttname"><a href="structfaiss_1_1InvertedLists.html#ad6a2111630ecd67ee5119d5198abcfb1">faiss::InvertedLists::release_codes</a></div><div class="ttdeci">virtual void release_codes(size_t list_no, const uint8_t *codes) const </div><div class="ttdoc">release codes returned by get_codes (default implementation is nop </div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00043">InvertedLists.cpp:43</a></div></div>
<div class="ttc" id="structfaiss_1_1InvertedLists_1_1ScopedCodes_html"><div class="ttname"><a href="structfaiss_1_1InvertedLists_1_1ScopedCodes.html">faiss::InvertedLists::ScopedCodes</a></div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8h_source.html#l00156">InvertedLists.h:156</a></div></div>
<div class="ttc" id="structfaiss_1_1VStackInvertedLists_html_ab2d660680d9b4a2667c321515b5baa77"><div class="ttname"><a href="structfaiss_1_1VStackInvertedLists.html#ab2d660680d9b4a2667c321515b5baa77">faiss::VStackInvertedLists::get_single_id</a></div><div class="ttdeci">idx_t get_single_id(size_t list_no, size_t offset) const override</div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00497">InvertedLists.cpp:497</a></div></div>
<div class="ttc" id="structfaiss_1_1HStackInvertedLists_html_ad431aa76dc678d71747dcbc9379d123a"><div class="ttname"><a href="structfaiss_1_1HStackInvertedLists.html#ad431aa76dc678d71747dcbc9379d123a">faiss::HStackInvertedLists::release_codes</a></div><div class="ttdeci">void release_codes(size_t list_no, const uint8_t *codes) const override</div><div class="ttdoc">release codes returned by get_codes (default implementation is nop </div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00283">InvertedLists.cpp:283</a></div></div>
<div class="ttc" id="structfaiss_1_1SliceInvertedLists_html_a362456fac3002d1a5625a13dbfc0752b"><div class="ttname"><a href="structfaiss_1_1SliceInvertedLists.html#a362456fac3002d1a5625a13dbfc0752b">faiss::SliceInvertedLists::release_codes</a></div><div class="ttdeci">void release_codes(size_t list_no, const uint8_t *codes) const override</div><div class="ttdoc">release codes returned by get_codes (default implementation is nop </div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00374">InvertedLists.cpp:374</a></div></div>
<div class="ttc" id="structfaiss_1_1HStackInvertedLists_html_af812098083c022166d29a20846de173e"><div class="ttname"><a href="structfaiss_1_1HStackInvertedLists.html#af812098083c022166d29a20846de173e">faiss::HStackInvertedLists::get_ids</a></div><div class="ttdeci">const idx_t * get_ids(size_t list_no) const override</div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00287">InvertedLists.cpp:287</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>