<!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/matthijs/github_faiss/faiss/OnDiskInvertedLists.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Faiss
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Friends</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">/data/users/matthijs/github_faiss/faiss/OnDiskInvertedLists.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (c) 2015-present, Facebook, Inc.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * All rights reserved.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * This source code is licensed under the BSD+Patents license found in the</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * LICENSE file in the root directory of this source tree.</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#ifndef FAISS_ON_DISK_INVERTED_LISTS_H</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor"></span><span class="preprocessor">#define FAISS_ON_DISK_INVERTED_LISTS_H</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <vector></span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <list></span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include "IndexIVF.h"</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">namespace </span>faiss {</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">struct </span>LockLevels;</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"></span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">/** On-disk storage of inverted lists.</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * The data is stored in a mmapped chunk of memory (base ptointer ptr,</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * size totsize). Each list is a range of memory that contains (object</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * List) that contains:</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> * - uint8_t codes[capacity * code_size]</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> * - followed by idx_t ids[capacity]</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> * in each of the arrays, the size <= capacity first elements are</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> * used, the rest is not initialized.</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> * Addition and resize are supported by:</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> * - roundind up the capacity of the lists to a power of two</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> * - maintaining a list of empty slots, sorted by size.</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> * - resizing the mmapped block is adjusted as needed.</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> * An OnDiskInvertedLists is compact if the size == capacity for all</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> * lists and there are no available slots.</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> * Addition to the invlists is slow. For incremental add it is better</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> * to use a default ArrayInvertedLists object and convert it to an</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> * OnDisk with merge_from.</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * When it is known that a set of lists will be accessed, it is useful</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> * to call prefetch_lists, that launches a set of threads to read the</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> * lists in parallel.</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="structfaiss_1_1OnDiskInvertedLists.html"> 52</a></span> <span class="keyword">struct </span><a class="code" href="structfaiss_1_1OnDiskInvertedLists.html">OnDiskInvertedLists</a>: <a class="code" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> {</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div>
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="structfaiss_1_1OnDiskInvertedLists_1_1List.html"> 54</a></span>  <span class="keyword">struct </span><a class="code" href="structfaiss_1_1OnDiskInvertedLists_1_1List.html">List</a> {</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordtype">size_t</span> size; <span class="comment">// size of inverted list (entries)</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordtype">size_t</span> capacity; <span class="comment">// allocated size (entries)</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordtype">size_t</span> offset; <span class="comment">// offset in buffer (bytes)</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <a class="code" href="structfaiss_1_1OnDiskInvertedLists_1_1List.html">List</a> ();</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  };</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  std::vector<List> lists;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div>
<div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="structfaiss_1_1OnDiskInvertedLists_1_1Slot.html"> 63</a></span>  <span class="keyword">struct </span><a class="code" href="structfaiss_1_1OnDiskInvertedLists_1_1Slot.html">Slot</a> {</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordtype">size_t</span> offset; <span class="comment">// bytes</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordtype">size_t</span> capacity; <span class="comment">// bytes</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <a class="code" href="structfaiss_1_1OnDiskInvertedLists_1_1Slot.html">Slot</a> (<span class="keywordtype">size_t</span> offset, <span class="keywordtype">size_t</span> capacity);</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <a class="code" href="structfaiss_1_1OnDiskInvertedLists_1_1Slot.html">Slot</a> ();</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  };</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  std::list<Slot> slots;</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  std::string filename;</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordtype">size_t</span> totsize;</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  uint8_t *ptr; <span class="comment">// mmap base pointer</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordtype">bool</span> read_only; <span class="comment">/// are inverted lists mapped read-only</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"></span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <a class="code" href="structfaiss_1_1OnDiskInvertedLists.html">OnDiskInvertedLists</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="l00078"></a><span class="lineno"> 78</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *filename);</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1OnDiskInvertedLists.html#a19b264dfe5a541c1427d3b635ad887f5">list_size</a>(<span class="keywordtype">size_t</span> list_no) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keyword">const</span> uint8_t * <a class="code" href="structfaiss_1_1OnDiskInvertedLists.html#a1695e1d8d64a00e8e5f57ebf2210cb87">get_codes</a> (<span class="keywordtype">size_t</span> list_no) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keyword">const</span> idx_t * <a class="code" href="structfaiss_1_1OnDiskInvertedLists.html#ae54e7c6abc10c3d59ea3cd1113466957">get_ids</a> (<span class="keywordtype">size_t</span> list_no) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordtype">size_t</span> add_entries (</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <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>  <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="l00087"></a><span class="lineno"> 87</span> </div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</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="l00089"></a><span class="lineno"> 89</span>  <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="l00090"></a><span class="lineno"> 90</span> </div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <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="l00092"></a><span class="lineno"> 92</span> </div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="comment">// copy all inverted lists into *this, in compact form (without</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="comment">// allocating slots)</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordtype">size_t</span> merge_from (<span class="keyword">const</span> <a class="code" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> **ils, <span class="keywordtype">int</span> n_il);</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1OnDiskInvertedLists.html#aed1cdb979275ec1e6ab8f0c7fead60c7">prefetch_lists</a> (<span class="keyword">const</span> <span class="keywordtype">long</span> *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="l00098"></a><span class="lineno"> 98</span> </div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keyword">virtual</span> ~<a class="code" href="structfaiss_1_1OnDiskInvertedLists.html">OnDiskInvertedLists</a> ();</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="comment">// private</span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <a class="code" href="structfaiss_1_1LockLevels.html">LockLevels</a> * locks;</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="comment">// encapsulates the threads that are busy prefeteching</span></div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keyword">struct </span><a class="code" href="structfaiss_1_1OnDiskInvertedLists_1_1OngoingPrefetch.html">OngoingPrefetch</a>;</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <a class="code" href="structfaiss_1_1OnDiskInvertedLists_1_1OngoingPrefetch.html">OngoingPrefetch</a> *pf;</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> </div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keywordtype">void</span> do_mmap ();</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keywordtype">void</span> update_totsize (<span class="keywordtype">size_t</span> new_totsize);</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keywordtype">void</span> resize_locked (<span class="keywordtype">size_t</span> list_no, <span class="keywordtype">size_t</span> new_size);</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="keywordtype">size_t</span> allocate_slot (<span class="keywordtype">size_t</span> capacity);</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keywordtype">void</span> free_slot (<span class="keywordtype">size_t</span> offset, <span class="keywordtype">size_t</span> capacity);</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="comment">// empty constructor for the I/O functions</span></div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <a class="code" href="structfaiss_1_1OnDiskInvertedLists.html">OnDiskInvertedLists</a> ();</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> };</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> </div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> </div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> </div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> } <span class="comment">// namespace faiss</span></div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> </div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="preprocessor">#endif</span></div>
<div class="ttc" id="structfaiss_1_1OnDiskInvertedLists_html_ae54e7c6abc10c3d59ea3cd1113466957"><div class="ttname"><a href="structfaiss_1_1OnDiskInvertedLists.html#ae54e7c6abc10c3d59ea3cd1113466957">faiss::OnDiskInvertedLists::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="OnDiskInvertedLists_8cpp_source.html#l00371">OnDiskInvertedLists.cpp:371</a></div></div>
<div class="ttc" id="structfaiss_1_1LockLevels_html"><div class="ttname"><a href="structfaiss_1_1LockLevels.html">faiss::LockLevels</a></div><div class="ttdef"><b>Definition:</b> <a href="OnDiskInvertedLists_8cpp_source.html#l00031">OnDiskInvertedLists.cpp:31</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="IndexIVF_8h_source.html#l00067">IndexIVF.h:67</a></div></div>
<div class="ttc" id="structfaiss_1_1OnDiskInvertedLists_1_1OngoingPrefetch_html"><div class="ttname"><a href="structfaiss_1_1OnDiskInvertedLists_1_1OngoingPrefetch.html">faiss::OnDiskInvertedLists::OngoingPrefetch</a></div><div class="ttdef"><b>Definition:</b> <a href="OnDiskInvertedLists_8cpp_source.html#l00142">OnDiskInvertedLists.cpp:142</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="IndexIVF_8h_source.html#l00071">IndexIVF.h:71</a></div></div>
<div class="ttc" id="structfaiss_1_1OnDiskInvertedLists_html_a1695e1d8d64a00e8e5f57ebf2210cb87"><div class="ttname"><a href="structfaiss_1_1OnDiskInvertedLists.html#a1695e1d8d64a00e8e5f57ebf2210cb87">faiss::OnDiskInvertedLists::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="OnDiskInvertedLists_8cpp_source.html#l00366">OnDiskInvertedLists.cpp:366</a></div></div>
<div class="ttc" id="structfaiss_1_1OnDiskInvertedLists_1_1Slot_html"><div class="ttname"><a href="structfaiss_1_1OnDiskInvertedLists_1_1Slot.html">faiss::OnDiskInvertedLists::Slot</a></div><div class="ttdef"><b>Definition:</b> <a href="OnDiskInvertedLists_8h_source.html#l00063">OnDiskInvertedLists.h:63</a></div></div>
<div class="ttc" id="structfaiss_1_1OnDiskInvertedLists_html_a19b264dfe5a541c1427d3b635ad887f5"><div class="ttname"><a href="structfaiss_1_1OnDiskInvertedLists.html#a19b264dfe5a541c1427d3b635ad887f5">faiss::OnDiskInvertedLists::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="OnDiskInvertedLists_8cpp_source.html#l00360">OnDiskInvertedLists.cpp:360</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="IndexIVF_8h_source.html#l00070">IndexIVF.h:70</a></div></div>
<div class="ttc" id="structfaiss_1_1OnDiskInvertedLists_html"><div class="ttname"><a href="structfaiss_1_1OnDiskInvertedLists.html">faiss::OnDiskInvertedLists</a></div><div class="ttdef"><b>Definition:</b> <a href="OnDiskInvertedLists_8h_source.html#l00052">OnDiskInvertedLists.h:52</a></div></div>
<div class="ttc" id="structfaiss_1_1OnDiskInvertedLists_1_1List_html"><div class="ttname"><a href="structfaiss_1_1OnDiskInvertedLists_1_1List.html">faiss::OnDiskInvertedLists::List</a></div><div class="ttdef"><b>Definition:</b> <a href="OnDiskInvertedLists_8h_source.html#l00054">OnDiskInvertedLists.h:54</a></div></div>
<div class="ttc" id="structfaiss_1_1OnDiskInvertedLists_html_aed1cdb979275ec1e6ab8f0c7fead60c7"><div class="ttname"><a href="structfaiss_1_1OnDiskInvertedLists.html#aed1cdb979275ec1e6ab8f0c7fead60c7">faiss::OnDiskInvertedLists::prefetch_lists</a></div><div class="ttdeci">void prefetch_lists(const long *list_nos, int nlist) const override</div><div class="ttdef"><b>Definition:</b> <a href="OnDiskInvertedLists_8cpp_source.html#l00222">OnDiskInvertedLists.cpp:222</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>