<!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::InvertedLists 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_1InvertedLists.html">InvertedLists</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="structfaiss_1_1InvertedLists-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">faiss::InvertedLists Struct Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="InvertedLists_8h_source.html">InvertedLists.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for faiss::InvertedLists:</div>
<div class="dyncontent">
<div class="center">
<img src="structfaiss_1_1InvertedLists.png" usemap="#faiss::InvertedLists_map" alt=""/>
<map id="faiss::InvertedLists_map" name="faiss::InvertedLists_map">
<area href="structfaiss_1_1ArrayInvertedLists.html" title="simple (default) implementation as an array of inverted lists " alt="faiss::ArrayInvertedLists" shape="rect" coords="0,56,171,80"/>
<area href="structfaiss_1_1OnDiskInvertedLists.html" alt="faiss::OnDiskInvertedLists" shape="rect" coords="181,56,352,80"/>
<area href="structfaiss_1_1ReadOnlyInvertedLists.html" alt="faiss::ReadOnlyInvertedLists" shape="rect" coords="362,56,533,80"/>
<area href="structfaiss_1_1HStackInvertedLists.html" title="Horizontal stack of inverted lists. " alt="faiss::HStackInvertedLists" shape="rect" coords="90,112,261,136"/>
<area href="structfaiss_1_1MaskedInvertedLists.html" alt="faiss::MaskedInvertedLists" shape="rect" coords="271,112,442,136"/>
<area href="structfaiss_1_1SliceInvertedLists.html" title="vertical slice of indexes in another InvertedLists " alt="faiss::SliceInvertedLists" shape="rect" coords="452,112,623,136"/>
<area href="structfaiss_1_1VStackInvertedLists.html" alt="faiss::VStackInvertedLists" shape="rect" coords="633,112,804,136"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1InvertedLists_1_1ScopedCodes.html">ScopedCodes</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1InvertedLists_1_1ScopedIds.html">ScopedIds</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a2bb406f72dcad45cf03974ff14bfa473"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2bb406f72dcad45cf03974ff14bfa473"></a>
typedef <a class="el" href="structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea">Index::idx_t</a> </td><td class="memItemRight" valign="bottom"><b>idx_t</b></td></tr>
<tr class="separator:a2bb406f72dcad45cf03974ff14bfa473"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:a83d053d03720d938dc4fc4e2f674619c"><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"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9bd256053ee360473842105460fe285f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9bd256053ee360473842105460fe285f"></a>
virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1InvertedLists.html#a9bd256053ee360473842105460fe285f">list_size</a> (size_t list_no) const =0</td></tr>
<tr class="memdesc:a9bd256053ee360473842105460fe285f"><td class="mdescLeft"> </td><td class="mdescRight">get the size of a list <br/></td></tr>
<tr class="separator:a9bd256053ee360473842105460fe285f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a60b12f9efe940b617a8380adceef4032"><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#a60b12f9efe940b617a8380adceef4032">get_codes</a> (size_t list_no) const =0</td></tr>
<tr class="separator:a60b12f9efe940b617a8380adceef4032"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3ab6b389d8d85c5fbf23889064df7e95"><td class="memItemLeft" align="right" valign="top">virtual const idx_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1InvertedLists.html#a3ab6b389d8d85c5fbf23889064df7e95">get_ids</a> (size_t list_no) const =0</td></tr>
<tr class="separator:a3ab6b389d8d85c5fbf23889064df7e95"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad6a2111630ecd67ee5119d5198abcfb1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad6a2111630ecd67ee5119d5198abcfb1"></a>
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1InvertedLists.html#ad6a2111630ecd67ee5119d5198abcfb1">release_codes</a> (size_t list_no, const uint8_t *codes) const </td></tr>
<tr class="memdesc:ad6a2111630ecd67ee5119d5198abcfb1"><td class="mdescLeft"> </td><td class="mdescRight">release codes returned by get_codes (default implementation is nop <br/></td></tr>
<tr class="separator:ad6a2111630ecd67ee5119d5198abcfb1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae1618d2b5dca2704d3af8ced58548ac9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae1618d2b5dca2704d3af8ced58548ac9"></a>
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1InvertedLists.html#ae1618d2b5dca2704d3af8ced58548ac9">release_ids</a> (size_t list_no, const idx_t *ids) const </td></tr>
<tr class="memdesc:ae1618d2b5dca2704d3af8ced58548ac9"><td class="mdescLeft"> </td><td class="mdescRight">release ids returned by get_ids <br/></td></tr>
<tr class="separator:ae1618d2b5dca2704d3af8ced58548ac9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a21b52cdb0601cd225bd7924932310876"><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"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afc2760bed7c210f2fad9b03109f561ee"><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"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac537aa14d2731c0ff907169211389b76"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1InvertedLists.html#ac537aa14d2731c0ff907169211389b76">prefetch_lists</a> (const idx_t *list_nos, int <a class="el" href="structfaiss_1_1InvertedLists.html#afaf8b7aa3e846aa4553f6aae67827ec8">nlist</a>) const </td></tr>
<tr class="separator:ac537aa14d2731c0ff907169211389b76"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acd3e36cc06fc49e02773e403a84dba95"><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"><td class="mdescLeft"> </td><td class="mdescRight">add one entry to an inverted list <br/></td></tr>
<tr class="separator:acd3e36cc06fc49e02773e403a84dba95"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0a2adbbd1d6b4f8ed1cbfa9bb93f4401"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0a2adbbd1d6b4f8ed1cbfa9bb93f4401"></a>
virtual size_t </td><td class="memItemRight" valign="bottom"><b>add_entries</b> (size_t list_no, size_t n_entry, const idx_t *ids, const uint8_t *code)=0</td></tr>
<tr class="separator:a0a2adbbd1d6b4f8ed1cbfa9bb93f4401"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a57e1382949b91f77acc46790b6431056"><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"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afb45f0f325bf82f73737d804f8dbf49e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afb45f0f325bf82f73737d804f8dbf49e"></a>
virtual 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 *ids, const uint8_t *code)=0</td></tr>
<tr class="separator:afb45f0f325bf82f73737d804f8dbf49e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aae502a3372d94450e0b8ff4350b43610"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aae502a3372d94450e0b8ff4350b43610"></a>
virtual void </td><td class="memItemRight" valign="bottom"><b>resize</b> (size_t list_no, size_t new_size)=0</td></tr>
<tr class="separator:aae502a3372d94450e0b8ff4350b43610"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a72e736253a669dad5f6e5188168e5c60"><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"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac2a0686121ef5bdd6eb70f7eb3cf9b3a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac2a0686121ef5bdd6eb70f7eb3cf9b3a"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1InvertedLists.html#ac2a0686121ef5bdd6eb70f7eb3cf9b3a">merge_from</a> (<a class="el" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> *oivf, size_t add_id)</td></tr>
<tr class="memdesc:ac2a0686121ef5bdd6eb70f7eb3cf9b3a"><td class="mdescLeft"> </td><td class="mdescRight">move all entries from oivf (empty on output) <br/></td></tr>
<tr class="separator:ac2a0686121ef5bdd6eb70f7eb3cf9b3a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aacf34f6cf392771fe2e68210cd4e009b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aacf34f6cf392771fe2e68210cd4e009b"></a>
double </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1InvertedLists.html#aacf34f6cf392771fe2e68210cd4e009b">imbalance_factor</a> () const </td></tr>
<tr class="memdesc:aacf34f6cf392771fe2e68210cd4e009b"><td class="mdescLeft"> </td><td class="mdescRight">1= perfectly balanced, >1: imbalanced <br/></td></tr>
<tr class="separator:aacf34f6cf392771fe2e68210cd4e009b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a156de8be4b21a0dfa9a48a3918a0b5c3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a156de8be4b21a0dfa9a48a3918a0b5c3"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1InvertedLists.html#a156de8be4b21a0dfa9a48a3918a0b5c3">print_stats</a> () const </td></tr>
<tr class="memdesc:a156de8be4b21a0dfa9a48a3918a0b5c3"><td class="mdescLeft"> </td><td class="mdescRight">display some stats about the inverted lists <br/></td></tr>
<tr class="separator:a156de8be4b21a0dfa9a48a3918a0b5c3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a722eef5a0e5bf5dcf78228a903e16af9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a722eef5a0e5bf5dcf78228a903e16af9"></a>
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1InvertedLists.html#a722eef5a0e5bf5dcf78228a903e16af9">compute_ntotal</a> () const </td></tr>
<tr class="memdesc:a722eef5a0e5bf5dcf78228a903e16af9"><td class="mdescLeft"> </td><td class="mdescRight">sum up list sizes <br/></td></tr>
<tr class="separator:a722eef5a0e5bf5dcf78228a903e16af9"><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:afaf8b7aa3e846aa4553f6aae67827ec8"><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"><td class="mdescLeft"> </td><td class="mdescRight">number of possible key values <br/></td></tr>
<tr class="separator:afaf8b7aa3e846aa4553f6aae67827ec8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae06049e4259edb47d443ef87bdedc744"><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"><td class="mdescLeft"> </td><td class="mdescRight">code size per vector in bytes <br/></td></tr>
<tr class="separator:ae06049e4259edb47d443ef87bdedc744"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Table of inverted lists multithreading rules:</p>
<ul>
<li>concurrent read accesses are allowed</li>
<li>concurrent update accesses are allowed</li>
<li>for resize and add_entries, only concurrent access to different lists are allowed </li>
</ul>
<p>Definition at line <a class="el" href="InvertedLists_8h_source.html#l00031">31</a> of file <a class="el" href="InvertedLists_8h_source.html">InvertedLists.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a60b12f9efe940b617a8380adceef4032"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const uint8_t* faiss::InvertedLists::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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>get the codes for an inverted list must be released by release_codes</p>
<dl class="section return"><dt>Returns</dt><dd>codes size list_size * code_size </dd></dl>
<p>Implemented in <a class="el" href="structfaiss_1_1MaskedInvertedLists.html#a4376b14cd4e349d51848995c102659af">faiss::MaskedInvertedLists</a>, <a class="el" href="structfaiss_1_1VStackInvertedLists.html#a112f9458bd91ca5dbed2cb6d090a0034">faiss::VStackInvertedLists</a>, <a class="el" href="structfaiss_1_1SliceInvertedLists.html#a95e1c091bea8695c6df29ed87b3cf0d9">faiss::SliceInvertedLists</a>, <a class="el" href="structfaiss_1_1HStackInvertedLists.html#a3a69cb5d1c05fa6b583672c459ecc4a6">faiss::HStackInvertedLists</a>, <a class="el" href="structfaiss_1_1ArrayInvertedLists.html#abf4ab66d09d8a1b707dddc77d0c2e8fc">faiss::ArrayInvertedLists</a>, and <a class="el" href="structfaiss_1_1OnDiskInvertedLists.html#a1695e1d8d64a00e8e5f57ebf2210cb87">faiss::OnDiskInvertedLists</a>.</p>
</div>
</div>
<a class="anchor" id="a3ab6b389d8d85c5fbf23889064df7e95"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const idx_t* faiss::InvertedLists::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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>get the ids for an inverted list must be released by release_ids</p>
<dl class="section return"><dt>Returns</dt><dd>ids size list_size </dd></dl>
<p>Implemented in <a class="el" href="structfaiss_1_1MaskedInvertedLists.html#a924d45d2ab3809c728e7b02ec569b2ba">faiss::MaskedInvertedLists</a>, <a class="el" href="structfaiss_1_1VStackInvertedLists.html#a912c3f0417c833a81da5957f4d77452a">faiss::VStackInvertedLists</a>, <a class="el" href="structfaiss_1_1SliceInvertedLists.html#ac5eb6df92e3bc9d49d7e88f0ff8d3a88">faiss::SliceInvertedLists</a>, <a class="el" href="structfaiss_1_1HStackInvertedLists.html#af812098083c022166d29a20846de173e">faiss::HStackInvertedLists</a>, <a class="el" href="structfaiss_1_1ArrayInvertedLists.html#abd59f7cf340d9c17eb6b402579e4010b">faiss::ArrayInvertedLists</a>, and <a class="el" href="structfaiss_1_1OnDiskInvertedLists.html#ae54e7c6abc10c3d59ea3cd1113466957">faiss::OnDiskInvertedLists</a>.</p>
</div>
</div>
<a class="anchor" id="afc2760bed7c210f2fad9b03109f561ee"></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::InvertedLists::get_single_code </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>list_no</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>offset</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>a single code in an inverted list (should be deallocated with release_codes) </dd></dl>
<p>Reimplemented in <a class="el" href="structfaiss_1_1MaskedInvertedLists.html#a429657c4c203d472f59147f301de0ede">faiss::MaskedInvertedLists</a>, <a class="el" href="structfaiss_1_1VStackInvertedLists.html#a3c229e59737b533464f5403c5cf5fca4">faiss::VStackInvertedLists</a>, <a class="el" href="structfaiss_1_1SliceInvertedLists.html#abc95a98970bb7b4b044c5a61520c20d3">faiss::SliceInvertedLists</a>, and <a class="el" href="structfaiss_1_1HStackInvertedLists.html#aeef6bd41622796f5d142e60fe78a5da8">faiss::HStackInvertedLists</a>.</p>
<p>Definition at line <a class="el" href="InvertedLists_8cpp_source.html#l00052">52</a> of file <a class="el" href="InvertedLists_8cpp_source.html">InvertedLists.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a21b52cdb0601cd225bd7924932310876"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">InvertedLists::idx_t faiss::InvertedLists::get_single_id </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>list_no</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>offset</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>a single id in an inverted list </dd></dl>
<p>Reimplemented in <a class="el" href="structfaiss_1_1MaskedInvertedLists.html#af0d9f7b61caef91e30124b0f7a9d44b9">faiss::MaskedInvertedLists</a>, <a class="el" href="structfaiss_1_1VStackInvertedLists.html#ab2d660680d9b4a2667c321515b5baa77">faiss::VStackInvertedLists</a>, <a class="el" href="structfaiss_1_1SliceInvertedLists.html#a714d282706a7301772fcd145854a976e">faiss::SliceInvertedLists</a>, and <a class="el" href="structfaiss_1_1HStackInvertedLists.html#aff00b896467e63cf821d35668804b039">faiss::HStackInvertedLists</a>.</p>
<p>Definition at line <a class="el" href="InvertedLists_8cpp_source.html#l00035">35</a> of file <a class="el" href="InvertedLists_8cpp_source.html">InvertedLists.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ac537aa14d2731c0ff907169211389b76"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void faiss::InvertedLists::prefetch_lists </td>
<td>(</td>
<td class="paramtype">const idx_t * </td>
<td class="paramname"><em>list_nos</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>nlist</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>prepare the following lists (default does nothing) a list can be -1 hence the signed long </p>
<p>Reimplemented in <a class="el" href="structfaiss_1_1MaskedInvertedLists.html#a5fbd34b4052c314148c44f14b4d3c2d3">faiss::MaskedInvertedLists</a>, <a class="el" href="structfaiss_1_1VStackInvertedLists.html#af37c2171d22f7f9200fa5cdedb363471">faiss::VStackInvertedLists</a>, <a class="el" href="structfaiss_1_1SliceInvertedLists.html#a40f74e21271fa5492fb9b78bb04a514f">faiss::SliceInvertedLists</a>, <a class="el" href="structfaiss_1_1HStackInvertedLists.html#a249f680477fac00cdfcf319c3bbe8c05">faiss::HStackInvertedLists</a>, and <a class="el" href="structfaiss_1_1OnDiskInvertedLists.html#a04ad61e3a23ced0aea032bf1e699436d">faiss::OnDiskInvertedLists</a>.</p>
<p>Definition at line <a class="el" href="InvertedLists_8cpp_source.html#l00049">49</a> of file <a class="el" href="InvertedLists_8cpp_source.html">InvertedLists.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li>/data/users/hoss/faiss/<a class="el" href="InvertedLists_8h_source.html">InvertedLists.h</a></li>
<li>/data/users/hoss/faiss/<a class="el" href="InvertedLists_8cpp_source.html">InvertedLists.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>