351 lines
56 KiB
HTML
351 lines
56 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: /tmp/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 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">/tmp/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> <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> <span class="comment">// -*- c++ -*-</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_INVERTEDLISTS_IVF_H</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor"></span><span class="preprocessor">#define FAISS_INVERTEDLISTS_IVF_H</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor"></span><span class="comment"></span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * Definition of inverted lists + a few common classes that implement</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * the interface.</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include <vector></span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include "Index.h"</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> </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">namespace </span>faiss {</div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">/** Table of inverted lists</span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * multithreading rules:</span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * - concurrent read accesses are allowed</span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * - concurrent update accesses are allowed</span></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * - for resize and add_entries, only concurrent access to different lists</span></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> * are allowed</span></div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="structfaiss_1_1InvertedLists.html"> 32</a></span> <span class="keyword">struct </span><a class="code" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> {</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keyword">typedef</span> <a class="code" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">Index::idx_t</a> idx_t;</div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="structfaiss_1_1InvertedLists.html#afaf8b7aa3e846aa4553f6aae67827ec8"> 35</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1InvertedLists.html#afaf8b7aa3e846aa4553f6aae67827ec8">nlist</a>; <span class="comment">///< number of possible key values</span></div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="structfaiss_1_1InvertedLists.html#ae06049e4259edb47d443ef87bdedc744"> 36</a></span> <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">///< code size per vector in bytes</span></div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <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="l00039"></a><span class="lineno"> 39</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"> * Read only functions */</span></div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> /// get the size of a list</span></div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <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="l00045"></a><span class="lineno"> 45</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> /** get the codes for an inverted list</span></div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> * must be released by release_codes</span></div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> * @return codes size list_size * code_size</span></div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <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="l00052"></a><span class="lineno"> 52</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> /** get the ids for an inverted list</span></div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> * must be released by release_ids</span></div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> * @return ids size list_size</span></div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="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="l00059"></a><span class="lineno"> 59</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> /// release codes returned by get_codes (default implementation is nop</span></div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1InvertedLists.html#a3f88cb5bb3073eb7d9777e838208190f">release_codes</a> (<span class="keyword">const</span> uint8_t *codes) <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> /// release ids returned by get_ids</span></div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1InvertedLists.html#a6930df334c12b6a20e2c82e165462028">release_ids</a> (<span class="keyword">const</span> idx_t *ids) <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> /// @return a single id in an inverted list</span></div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <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="l00068"></a><span class="lineno"> 68</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> /// @return a single code in an inverted list</span></div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> /// (should be deallocated with release_codes)</span></div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <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="l00072"></a><span class="lineno"> 72</span>  <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="l00073"></a><span class="lineno"> 73</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> /// prepare the following lists (default does nothing)</span></div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> /// a list can be -1 hence the signed long</span></div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1InvertedLists.html#a4e62994e54a0834f130bb4ba09c16a9c">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</span>;</div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="comment">/*************************</span></div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> * writing functions */</span></div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> /// add one entry to an inverted list</span></div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <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="l00083"></a><span class="lineno"> 83</span>  <span class="keyword">const</span> uint8_t *code);</div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> add_entries (</div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordtype">size_t</span> list_no, <span class="keywordtype">size_t</span> n_entry,</div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keyword">const</span> idx_t* ids, <span class="keyword">const</span> uint8_t *code) = 0;</div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <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="l00090"></a><span class="lineno"> 90</span>  idx_t <span class="keywordtype">id</span>, <span class="keyword">const</span> uint8_t *code);</div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <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="l00093"></a><span class="lineno"> 93</span>  <span class="keyword">const</span> idx_t *ids, <span class="keyword">const</span> uint8_t *code) = 0;</div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <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="l00096"></a><span class="lineno"> 96</span> </div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> reset ();</div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> /// move all entries from oivf (empty on output)</span></div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <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="l00101"></a><span class="lineno"> 101</span> </div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keyword">virtual</span> ~<a class="code" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> ();</div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> </div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="comment">/**************************************</span></div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> * Scoped inverted lists (for automatic deallocation)</span></div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> * instead of writing:</span></div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> * uint8_t * codes = invlists->get_codes (10);</span></div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> * ... use codes</span></div>
|
|
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> * invlists->release_codes(codes)</span></div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> * write:</span></div>
|
|
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"> * ScopedCodes codes (invlists, 10);</span></div>
|
|
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"> * ... use codes.get()</span></div>
|
|
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> * // release called automatically when codes goes out of scope</span></div>
|
|
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> * the following function call also works:</span></div>
|
|
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> * foo (123, ScopedCodes (invlists, 10).get(), 456);</span></div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"> *</span></div>
|
|
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div>
|
|
<div class="line"><a name="l00125"></a><span class="lineno"><a class="line" href="structfaiss_1_1InvertedLists_1_1ScopedIds.html"> 125</a></span>  <span class="keyword">struct </span><a class="code" href="structfaiss_1_1InvertedLists_1_1ScopedIds.html">ScopedIds</a> {</div>
|
|
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keyword">const</span> <a class="code" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> *il;</div>
|
|
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="keyword">const</span> idx_t *ids;</div>
|
|
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> </div>
|
|
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <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="l00130"></a><span class="lineno"> 130</span>  il (il), ids (il-><a class="code" href="structfaiss_1_1InvertedLists.html#a3ab6b389d8d85c5fbf23889064df7e95">get_ids</a> (list_no))</div>
|
|
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  {}</div>
|
|
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div>
|
|
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <span class="keyword">const</span> idx_t *<span class="keyword">get</span>() {<span class="keywordflow">return</span> ids; }</div>
|
|
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> </div>
|
|
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  idx_t operator [] (<span class="keywordtype">size_t</span> i)<span class="keyword"> const </span>{</div>
|
|
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <span class="keywordflow">return</span> ids[i];</div>
|
|
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  }</div>
|
|
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> </div>
|
|
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  ~<a class="code" href="structfaiss_1_1InvertedLists_1_1ScopedIds.html">ScopedIds</a> () {</div>
|
|
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  il-><a class="code" href="structfaiss_1_1InvertedLists.html#a6930df334c12b6a20e2c82e165462028">release_ids</a> (ids);</div>
|
|
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  }</div>
|
|
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  };</div>
|
|
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> </div>
|
|
<div class="line"><a name="l00144"></a><span class="lineno"><a class="line" href="structfaiss_1_1InvertedLists_1_1ScopedCodes.html"> 144</a></span>  <span class="keyword">struct </span><a class="code" href="structfaiss_1_1InvertedLists_1_1ScopedCodes.html">ScopedCodes</a> {</div>
|
|
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <span class="keyword">const</span> <a class="code" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> *il;</div>
|
|
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  <span class="keyword">const</span> uint8_t *codes;</div>
|
|
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> </div>
|
|
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <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="l00149"></a><span class="lineno"> 149</span>  il (il), codes (il-><a class="code" href="structfaiss_1_1InvertedLists.html#a60b12f9efe940b617a8380adceef4032">get_codes</a> (list_no))</div>
|
|
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  {}</div>
|
|
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span> </div>
|
|
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  <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="l00153"></a><span class="lineno"> 153</span>  il (il), codes (il-><a class="code" href="structfaiss_1_1InvertedLists.html#afc2760bed7c210f2fad9b03109f561ee">get_single_code</a> (list_no, offset))</div>
|
|
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  {}</div>
|
|
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span> </div>
|
|
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <span class="keyword">const</span> uint8_t *<span class="keyword">get</span>() {<span class="keywordflow">return</span> codes; }</div>
|
|
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> </div>
|
|
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  ~<a class="code" href="structfaiss_1_1InvertedLists_1_1ScopedCodes.html">ScopedCodes</a> () {</div>
|
|
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  il-><a class="code" href="structfaiss_1_1InvertedLists.html#a3f88cb5bb3073eb7d9777e838208190f">release_codes</a> (codes);</div>
|
|
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  }</div>
|
|
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  };</div>
|
|
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span> </div>
|
|
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span> </div>
|
|
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span> };</div>
|
|
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span> </div>
|
|
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment">/// simple (default) implementation as an array of inverted lists</span></div>
|
|
<div class="line"><a name="l00168"></a><span class="lineno"><a class="line" href="structfaiss_1_1ArrayInvertedLists.html"> 168</a></span> <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="l00169"></a><span class="lineno"> 169</span>  std::vector < std::vector<uint8_t> > codes; <span class="comment">// binary codes, size nlist</span></div>
|
|
<div class="line"><a name="l00170"></a><span class="lineno"><a class="line" href="structfaiss_1_1ArrayInvertedLists.html#a48563a58d3bbfbb4334f3afdf2c9ba7a"> 170</a></span>  std::vector < std::vector<idx_t> > <a class="code" href="structfaiss_1_1ArrayInvertedLists.html#a48563a58d3bbfbb4334f3afdf2c9ba7a">ids</a>; <span class="comment">///< Inverted lists for indexes</span></div>
|
|
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  <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="l00173"></a><span class="lineno"> 173</span> </div>
|
|
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  <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="l00175"></a><span class="lineno"> 175</span>  <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="l00176"></a><span class="lineno"> 176</span>  <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="l00177"></a><span class="lineno"> 177</span> </div>
|
|
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  <span class="keywordtype">size_t</span> add_entries (</div>
|
|
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  <span class="keywordtype">size_t</span> list_no, <span class="keywordtype">size_t</span> n_entry,</div>
|
|
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  <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="l00181"></a><span class="lineno"> 181</span> </div>
|
|
<div class="line"><a name="l00182"></a><span class="lineno"> 182</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="l00183"></a><span class="lineno"> 183</span>  <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="l00184"></a><span class="lineno"> 184</span> </div>
|
|
<div class="line"><a name="l00185"></a><span class="lineno"> 185</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="l00186"></a><span class="lineno"> 186</span> </div>
|
|
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  <span class="keyword">virtual</span> ~<a class="code" href="structfaiss_1_1ArrayInvertedLists.html">ArrayInvertedLists</a> ();</div>
|
|
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span> };</div>
|
|
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span> </div>
|
|
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="comment">/// inverted lists built as the concatenation of a set of invlists</span></div>
|
|
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="comment">/// (read-only)</span></div>
|
|
<div class="line"><a name="l00193"></a><span class="lineno"><a class="line" href="structfaiss_1_1ConcatenatedInvertedLists.html"> 193</a></span> <span class="comment"></span><span class="keyword">struct </span><a class="code" href="structfaiss_1_1ConcatenatedInvertedLists.html">ConcatenatedInvertedLists</a>: <a class="code" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> {</div>
|
|
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span> </div>
|
|
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  std::vector<const InvertedLists *>ils;</div>
|
|
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment"> /// build InvertedLists by concatenating nil of them</span></div>
|
|
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="comment"></span> <a class="code" href="structfaiss_1_1ConcatenatedInvertedLists.html#a55e8e8fcd065c34f0fb0bc51ced7b864">ConcatenatedInvertedLists</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="l00199"></a><span class="lineno"> 199</span> </div>
|
|
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1ConcatenatedInvertedLists.html#ae0a5c0e8d256302da0a569ad055c00e5">list_size</a>(<span class="keywordtype">size_t</span> list_no) <span class="keyword">const override</span>;</div>
|
|
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span>  <span class="keyword">const</span> uint8_t * <a class="code" href="structfaiss_1_1ConcatenatedInvertedLists.html#a58b6ba927b61665915b4b9a35c5277ae">get_codes</a> (<span class="keywordtype">size_t</span> list_no) <span class="keyword">const override</span>;</div>
|
|
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  <span class="keyword">const</span> idx_t * <a class="code" href="structfaiss_1_1ConcatenatedInvertedLists.html#a886e88bc6bf2ebd996b3f62adb9d0cc6">get_ids</a> (<span class="keywordtype">size_t</span> list_no) <span class="keyword">const override</span>;</div>
|
|
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span> </div>
|
|
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1ConcatenatedInvertedLists.html#accfbd4f63cbd78c9db162c60afe31848">release_codes</a> (<span class="keyword">const</span> uint8_t *codes) <span class="keyword">const override</span>;</div>
|
|
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1ConcatenatedInvertedLists.html#ae9670e5e9afce0ebc1f43317d25b45e2">release_ids</a> (<span class="keyword">const</span> idx_t *ids) <span class="keyword">const override</span>;</div>
|
|
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span> </div>
|
|
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  idx_t <a class="code" href="structfaiss_1_1ConcatenatedInvertedLists.html#a60bcb32205363041a75bc509ce36d933">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="l00208"></a><span class="lineno"> 208</span> </div>
|
|
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  <span class="keyword">const</span> uint8_t * <a class="code" href="structfaiss_1_1ConcatenatedInvertedLists.html#a159368893fd1c80999600214af416719">get_single_code</a> (</div>
|
|
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span>  <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="l00211"></a><span class="lineno"> 211</span> </div>
|
|
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span>  <span class="keywordtype">size_t</span> add_entries (</div>
|
|
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span>  <span class="keywordtype">size_t</span> list_no, <span class="keywordtype">size_t</span> n_entry,</div>
|
|
<div class="line"><a name="l00214"></a><span class="lineno"> 214</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="l00215"></a><span class="lineno"> 215</span> </div>
|
|
<div class="line"><a name="l00216"></a><span class="lineno"> 216</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="l00217"></a><span class="lineno"> 217</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="l00218"></a><span class="lineno"> 218</span> </div>
|
|
<div class="line"><a name="l00219"></a><span class="lineno"> 219</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="l00220"></a><span class="lineno"> 220</span> </div>
|
|
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span> };</div>
|
|
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span> </div>
|
|
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span> } <span class="comment">// namespace faiss</span></div>
|
|
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span> </div>
|
|
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span> </div>
|
|
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <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#l00131">InvertedLists.cpp:131</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1ConcatenatedInvertedLists_html"><div class="ttname"><a href="structfaiss_1_1ConcatenatedInvertedLists.html">faiss::ConcatenatedInvertedLists</a></div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8h_source.html#l00193">InvertedLists.h:193</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#l00168">InvertedLists.h:168</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#l00138">InvertedLists.cpp:138</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_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_1ConcatenatedInvertedLists_html_accfbd4f63cbd78c9db162c60afe31848"><div class="ttname"><a href="structfaiss_1_1ConcatenatedInvertedLists.html#accfbd4f63cbd78c9db162c60afe31848">faiss::ConcatenatedInvertedLists::release_codes</a></div><div class="ttdeci">void release_codes(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#l00225">InvertedLists.cpp:225</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1ConcatenatedInvertedLists_html_ae9670e5e9afce0ebc1f43317d25b45e2"><div class="ttname"><a href="structfaiss_1_1ConcatenatedInvertedLists.html#ae9670e5e9afce0ebc1f43317d25b45e2">faiss::ConcatenatedInvertedLists::release_ids</a></div><div class="ttdeci">void release_ids(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#l00260">InvertedLists.cpp:260</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1ConcatenatedInvertedLists_html_a55e8e8fcd065c34f0fb0bc51ced7b864"><div class="ttname"><a href="structfaiss_1_1ConcatenatedInvertedLists.html#a55e8e8fcd065c34f0fb0bc51ced7b864">faiss::ConcatenatedInvertedLists::ConcatenatedInvertedLists</a></div><div class="ttdeci">ConcatenatedInvertedLists(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#l00169">InvertedLists.cpp:169</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#l00032">InvertedLists.h:32</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#l00078">InvertedLists.cpp:78</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#l00036">InvertedLists.cpp:36</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#l00036">InvertedLists.h:36</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#l00053">InvertedLists.cpp:53</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1ConcatenatedInvertedLists_html_a886e88bc6bf2ebd996b3f62adb9d0cc6"><div class="ttname"><a href="structfaiss_1_1ConcatenatedInvertedLists.html#a886e88bc6bf2ebd996b3f62adb9d0cc6">faiss::ConcatenatedInvertedLists::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#l00229">InvertedLists.cpp:229</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#l00060">InvertedLists.cpp:60</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1Index_html_a040c6aed1f224f3ea7bf58eebc0c31a4"><div class="ttname"><a href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">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#l00064">Index.h:64</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1ConcatenatedInvertedLists_html_a159368893fd1c80999600214af416719"><div class="ttname"><a href="structfaiss_1_1ConcatenatedInvertedLists.html#a159368893fd1c80999600214af416719">faiss::ConcatenatedInvertedLists::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#l00207">InvertedLists.cpp:207</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1ConcatenatedInvertedLists_html_a60bcb32205363041a75bc509ce36d933"><div class="ttname"><a href="structfaiss_1_1ConcatenatedInvertedLists.html#a60bcb32205363041a75bc509ce36d933">faiss::ConcatenatedInvertedLists::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#l00244">InvertedLists.cpp:244</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1InvertedLists_html_a4e62994e54a0834f130bb4ba09c16a9c"><div class="ttname"><a href="structfaiss_1_1InvertedLists.html#a4e62994e54a0834f130bb4ba09c16a9c">faiss::InvertedLists::prefetch_lists</a></div><div class="ttdeci">virtual void prefetch_lists(const long *list_nos, int nlist) const </div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8cpp_source.html#l00050">InvertedLists.cpp:50</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#l00035">InvertedLists.h:35</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1ConcatenatedInvertedLists_html_ae0a5c0e8d256302da0a569ad055c00e5"><div class="ttname"><a href="structfaiss_1_1ConcatenatedInvertedLists.html#ae0a5c0e8d256302da0a569ad055c00e5">faiss::ConcatenatedInvertedLists::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#l00182">InvertedLists.cpp:182</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< std::vector< idx_t > > ids</div><div class="ttdoc">Inverted lists for indexes. </div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8h_source.html#l00170">InvertedLists.h:170</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1ConcatenatedInvertedLists_html_a58b6ba927b61665915b4b9a35c5277ae"><div class="ttname"><a href="structfaiss_1_1ConcatenatedInvertedLists.html#a58b6ba927b61665915b4b9a35c5277ae">faiss::ConcatenatedInvertedLists::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#l00192">InvertedLists.cpp:192</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1InvertedLists_html_a3f88cb5bb3073eb7d9777e838208190f"><div class="ttname"><a href="structfaiss_1_1InvertedLists.html#a3f88cb5bb3073eb7d9777e838208190f">faiss::InvertedLists::release_codes</a></div><div class="ttdeci">virtual void release_codes(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#l00044">InvertedLists.cpp:44</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_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#l00125">InvertedLists.h:125</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#l00125">InvertedLists.cpp:125</a></div></div>
|
|
<div class="ttc" id="structfaiss_1_1InvertedLists_html_a6930df334c12b6a20e2c82e165462028"><div class="ttname"><a href="structfaiss_1_1InvertedLists.html#a6930df334c12b6a20e2c82e165462028">faiss::InvertedLists::release_ids</a></div><div class="ttdeci">virtual void release_ids(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#l00047">InvertedLists.cpp:47</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#l00144">InvertedLists.h:144</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>
|