<!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: faiss::ArrayInvertedLists Struct Reference</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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><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="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacefaiss.html">faiss</a></li><li class="navelem"><a class="el" href="structfaiss_1_1ArrayInvertedLists.html">ArrayInvertedLists</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="structfaiss_1_1ArrayInvertedLists-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">faiss::ArrayInvertedLists Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for faiss::ArrayInvertedLists:</div>
<div class="dyncontent">
<div class="center">
<img src="structfaiss_1_1ArrayInvertedLists.png" usemap="#faiss::ArrayInvertedLists_map" alt=""/>
<map id="faiss::ArrayInvertedLists_map" name="faiss::ArrayInvertedLists_map">
<area href="structfaiss_1_1InvertedLists.html" alt="faiss::InvertedLists" shape="rect" coords="0,0,148,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:afae7ba66af56f43cabf089674ebc965d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afae7ba66af56f43cabf089674ebc965d"></a>
 </td><td class="memItemRight" valign="bottom"><b>ArrayInvertedLists</b> (size_t <a class="el" href="structfaiss_1_1InvertedLists.html#afaf8b7aa3e846aa4553f6aae67827ec8">nlist</a>, size_t <a class="el" href="structfaiss_1_1InvertedLists.html#ae06049e4259edb47d443ef87bdedc744">code_size</a>)</td></tr>
<tr class="separator:afae7ba66af56f43cabf089674ebc965d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af43d3f5c5bd897205853b289603fb42b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af43d3f5c5bd897205853b289603fb42b"></a>
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1ArrayInvertedLists.html#af43d3f5c5bd897205853b289603fb42b">list_size</a> (size_t list_no) const override</td></tr>
<tr class="memdesc:af43d3f5c5bd897205853b289603fb42b"><td class="mdescLeft"> </td><td class="mdescRight">get the size of a list <br/></td></tr>
<tr class="separator:af43d3f5c5bd897205853b289603fb42b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abf4ab66d09d8a1b707dddc77d0c2e8fc"><td class="memItemLeft" align="right" valign="top">const uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1ArrayInvertedLists.html#abf4ab66d09d8a1b707dddc77d0c2e8fc">get_codes</a> (size_t list_no) const override</td></tr>
<tr class="separator:abf4ab66d09d8a1b707dddc77d0c2e8fc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abd59f7cf340d9c17eb6b402579e4010b"><td class="memItemLeft" align="right" valign="top">const idx_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1ArrayInvertedLists.html#abd59f7cf340d9c17eb6b402579e4010b">get_ids</a> (size_t list_no) const override</td></tr>
<tr class="separator:abd59f7cf340d9c17eb6b402579e4010b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6b1f8d4cfe8413065c416d442bd4636b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6b1f8d4cfe8413065c416d442bd4636b"></a>
size_t </td><td class="memItemRight" valign="bottom"><b>add_entries</b> (size_t list_no, size_t n_entry, const idx_t *<a class="el" href="structfaiss_1_1ArrayInvertedLists.html#a48563a58d3bbfbb4334f3afdf2c9ba7a">ids</a>, const uint8_t *code) override</td></tr>
<tr class="separator:a6b1f8d4cfe8413065c416d442bd4636b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af4aa699d0fba82f2d6f755e0b33b49af"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af4aa699d0fba82f2d6f755e0b33b49af"></a>
void </td><td class="memItemRight" valign="bottom"><b>update_entries</b> (size_t list_no, size_t offset, size_t n_entry, const idx_t *<a class="el" href="structfaiss_1_1ArrayInvertedLists.html#a48563a58d3bbfbb4334f3afdf2c9ba7a">ids</a>, const uint8_t *code) override</td></tr>
<tr class="separator:af4aa699d0fba82f2d6f755e0b33b49af"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2077262cafd78d12534a6bf780bae148"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2077262cafd78d12534a6bf780bae148"></a>
void </td><td class="memItemRight" valign="bottom"><b>resize</b> (size_t list_no, size_t new_size) override</td></tr>
<tr class="separator:a2077262cafd78d12534a6bf780bae148"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_structfaiss_1_1InvertedLists"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structfaiss_1_1InvertedLists')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="structfaiss_1_1InvertedLists.html">faiss::InvertedLists</a></td></tr>
<tr class="memitem:a83d053d03720d938dc4fc4e2f674619c inherit pub_methods_structfaiss_1_1InvertedLists"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a83d053d03720d938dc4fc4e2f674619c"></a>
 </td><td class="memItemRight" valign="bottom"><b>InvertedLists</b> (size_t <a class="el" href="structfaiss_1_1InvertedLists.html#afaf8b7aa3e846aa4553f6aae67827ec8">nlist</a>, size_t <a class="el" href="structfaiss_1_1InvertedLists.html#ae06049e4259edb47d443ef87bdedc744">code_size</a>)</td></tr>
<tr class="separator:a83d053d03720d938dc4fc4e2f674619c inherit pub_methods_structfaiss_1_1InvertedLists"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a21b52cdb0601cd225bd7924932310876 inherit pub_methods_structfaiss_1_1InvertedLists"><td class="memItemLeft" align="right" valign="top">virtual idx_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1InvertedLists.html#a21b52cdb0601cd225bd7924932310876">get_single_id</a> (size_t list_no, size_t offset) const </td></tr>
<tr class="separator:a21b52cdb0601cd225bd7924932310876 inherit pub_methods_structfaiss_1_1InvertedLists"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afc2760bed7c210f2fad9b03109f561ee inherit pub_methods_structfaiss_1_1InvertedLists"><td class="memItemLeft" align="right" valign="top">virtual const uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1InvertedLists.html#afc2760bed7c210f2fad9b03109f561ee">get_single_code</a> (size_t list_no, size_t offset) const </td></tr>
<tr class="separator:afc2760bed7c210f2fad9b03109f561ee inherit pub_methods_structfaiss_1_1InvertedLists"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4e62994e54a0834f130bb4ba09c16a9c inherit pub_methods_structfaiss_1_1InvertedLists"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1InvertedLists.html#a4e62994e54a0834f130bb4ba09c16a9c">prefetch_lists</a> (const long *list_nos, int <a class="el" href="structfaiss_1_1InvertedLists.html#afaf8b7aa3e846aa4553f6aae67827ec8">nlist</a>) const </td></tr>
<tr class="separator:a4e62994e54a0834f130bb4ba09c16a9c inherit pub_methods_structfaiss_1_1InvertedLists"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acd3e36cc06fc49e02773e403a84dba95 inherit pub_methods_structfaiss_1_1InvertedLists"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acd3e36cc06fc49e02773e403a84dba95"></a>
virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1InvertedLists.html#acd3e36cc06fc49e02773e403a84dba95">add_entry</a> (size_t list_no, idx_t theid, const uint8_t *code)</td></tr>
<tr class="memdesc:acd3e36cc06fc49e02773e403a84dba95 inherit pub_methods_structfaiss_1_1InvertedLists"><td class="mdescLeft"> </td><td class="mdescRight">add one entry to an inverted list <br/></td></tr>
<tr class="separator:acd3e36cc06fc49e02773e403a84dba95 inherit pub_methods_structfaiss_1_1InvertedLists"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a57e1382949b91f77acc46790b6431056 inherit pub_methods_structfaiss_1_1InvertedLists"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a57e1382949b91f77acc46790b6431056"></a>
virtual void </td><td class="memItemRight" valign="bottom"><b>update_entry</b> (size_t list_no, size_t offset, idx_t id, const uint8_t *code)</td></tr>
<tr class="separator:a57e1382949b91f77acc46790b6431056 inherit pub_methods_structfaiss_1_1InvertedLists"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a72e736253a669dad5f6e5188168e5c60 inherit pub_methods_structfaiss_1_1InvertedLists"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a72e736253a669dad5f6e5188168e5c60"></a>
virtual void </td><td class="memItemRight" valign="bottom"><b>reset</b> ()</td></tr>
<tr class="separator:a72e736253a669dad5f6e5188168e5c60 inherit pub_methods_structfaiss_1_1InvertedLists"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:acdab4726f7509cb1653beef13f3f4da1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acdab4726f7509cb1653beef13f3f4da1"></a>
std::vector< std::vector<br class="typebreak"/>
< uint8_t > > </td><td class="memItemRight" valign="bottom"><b>codes</b></td></tr>
<tr class="separator:acdab4726f7509cb1653beef13f3f4da1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a48563a58d3bbfbb4334f3afdf2c9ba7a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a48563a58d3bbfbb4334f3afdf2c9ba7a"></a>
std::vector< std::vector< idx_t > > </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1ArrayInvertedLists.html#a48563a58d3bbfbb4334f3afdf2c9ba7a">ids</a></td></tr>
<tr class="memdesc:a48563a58d3bbfbb4334f3afdf2c9ba7a"><td class="mdescLeft"> </td><td class="mdescRight">Inverted lists for indexes. <br/></td></tr>
<tr class="separator:a48563a58d3bbfbb4334f3afdf2c9ba7a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_attribs_structfaiss_1_1InvertedLists"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_structfaiss_1_1InvertedLists')"><img src="closed.png" alt="-"/> Public Attributes inherited from <a class="el" href="structfaiss_1_1InvertedLists.html">faiss::InvertedLists</a></td></tr>
<tr class="memitem:afaf8b7aa3e846aa4553f6aae67827ec8 inherit pub_attribs_structfaiss_1_1InvertedLists"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afaf8b7aa3e846aa4553f6aae67827ec8"></a>
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1InvertedLists.html#afaf8b7aa3e846aa4553f6aae67827ec8">nlist</a></td></tr>
<tr class="memdesc:afaf8b7aa3e846aa4553f6aae67827ec8 inherit pub_attribs_structfaiss_1_1InvertedLists"><td class="mdescLeft"> </td><td class="mdescRight">number of possible key values <br/></td></tr>
<tr class="separator:afaf8b7aa3e846aa4553f6aae67827ec8 inherit pub_attribs_structfaiss_1_1InvertedLists"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae06049e4259edb47d443ef87bdedc744 inherit pub_attribs_structfaiss_1_1InvertedLists"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae06049e4259edb47d443ef87bdedc744"></a>
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1InvertedLists.html#ae06049e4259edb47d443ef87bdedc744">code_size</a></td></tr>
<tr class="memdesc:ae06049e4259edb47d443ef87bdedc744 inherit pub_attribs_structfaiss_1_1InvertedLists"><td class="mdescLeft"> </td><td class="mdescRight">code size per vector in bytes <br/></td></tr>
<tr class="separator:ae06049e4259edb47d443ef87bdedc744 inherit pub_attribs_structfaiss_1_1InvertedLists"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_types_structfaiss_1_1InvertedLists"><td colspan="2" onclick="javascript:toggleInherit('pub_types_structfaiss_1_1InvertedLists')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="structfaiss_1_1InvertedLists.html">faiss::InvertedLists</a></td></tr>
<tr class="memitem:a2bb406f72dcad45cf03974ff14bfa473 inherit pub_types_structfaiss_1_1InvertedLists"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2bb406f72dcad45cf03974ff14bfa473"></a>
typedef <a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">Index::idx_t</a> </td><td class="memItemRight" valign="bottom"><b>idx_t</b></td></tr>
<tr class="separator:a2bb406f72dcad45cf03974ff14bfa473 inherit pub_types_structfaiss_1_1InvertedLists"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p>Definition at line <a class="el" href="IndexIVF_8h_source.html#l00123">123</a> of file <a class="el" href="IndexIVF_8h_source.html">IndexIVF.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="abf4ab66d09d8a1b707dddc77d0c2e8fc"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const uint8_t * faiss::ArrayInvertedLists::get_codes </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>list_no</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>codes size list_size * code_size </dd></dl>
<p>Implements <a class="el" href="structfaiss_1_1InvertedLists.html#a60b12f9efe940b617a8380adceef4032">faiss::InvertedLists</a>.</p>
<p>Definition at line <a class="el" href="IndexIVF_8cpp_source.html#l00185">185</a> of file <a class="el" href="IndexIVF_8cpp_source.html">IndexIVF.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="abd59f7cf340d9c17eb6b402579e4010b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const InvertedLists::idx_t * faiss::ArrayInvertedLists::get_ids </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>list_no</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>ids size list_size </dd></dl>
<p>Implements <a class="el" href="structfaiss_1_1InvertedLists.html#a3ab6b389d8d85c5fbf23889064df7e95">faiss::InvertedLists</a>.</p>
<p>Definition at line <a class="el" href="IndexIVF_8cpp_source.html#l00191">191</a> of file <a class="el" href="IndexIVF_8cpp_source.html">IndexIVF.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li>/data/users/matthijs/github_faiss/faiss/<a class="el" href="IndexIVF_8h_source.html">IndexIVF.h</a></li>
<li>/data/users/matthijs/github_faiss/faiss/<a class="el" href="IndexIVF_8cpp_source.html">IndexIVF.cpp</a></li>
</ul>
</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>