<!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::VStackInvertedLists 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_1VStackInvertedLists.html">VStackInvertedLists</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_1VStackInvertedLists-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">faiss::VStackInvertedLists Struct Reference</div> </div> </div><!--header--> <div class="contents"> <div class="dynheader"> Inheritance diagram for faiss::VStackInvertedLists:</div> <div class="dyncontent"> <div class="center"> <img src="structfaiss_1_1VStackInvertedLists.png" usemap="#faiss::VStackInvertedLists_map" alt=""/> <map id="faiss::VStackInvertedLists_map" name="faiss::VStackInvertedLists_map"> <area href="structfaiss_1_1ReadOnlyInvertedLists.html" alt="faiss::ReadOnlyInvertedLists" shape="rect" coords="0,56,171,80"/> <area href="structfaiss_1_1InvertedLists.html" alt="faiss::InvertedLists" shape="rect" coords="0,0,171,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:a8f6ba4b3d64b74409742edad6c6c0f37"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8f6ba4b3d64b74409742edad6c6c0f37"></a>  </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1VStackInvertedLists.html#a8f6ba4b3d64b74409742edad6c6c0f37">VStackInvertedLists</a> (int nil, const <a class="el" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> **ils)</td></tr> <tr class="memdesc:a8f6ba4b3d64b74409742edad6c6c0f37"><td class="mdescLeft"> </td><td class="mdescRight">build <a class="el" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> by concatenating nil of them <br/></td></tr> <tr class="separator:a8f6ba4b3d64b74409742edad6c6c0f37"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a6398b7faee56b47f1f9817f3763fef01"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6398b7faee56b47f1f9817f3763fef01"></a> size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1VStackInvertedLists.html#a6398b7faee56b47f1f9817f3763fef01">list_size</a> (size_t list_no) const override</td></tr> <tr class="memdesc:a6398b7faee56b47f1f9817f3763fef01"><td class="mdescLeft"> </td><td class="mdescRight">get the size of a list <br/></td></tr> <tr class="separator:a6398b7faee56b47f1f9817f3763fef01"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a112f9458bd91ca5dbed2cb6d090a0034"><td class="memItemLeft" align="right" valign="top">const uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1VStackInvertedLists.html#a112f9458bd91ca5dbed2cb6d090a0034">get_codes</a> (size_t list_no) const override</td></tr> <tr class="separator:a112f9458bd91ca5dbed2cb6d090a0034"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a912c3f0417c833a81da5957f4d77452a"><td class="memItemLeft" align="right" valign="top">const idx_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1VStackInvertedLists.html#a912c3f0417c833a81da5957f4d77452a">get_ids</a> (size_t list_no) const override</td></tr> <tr class="separator:a912c3f0417c833a81da5957f4d77452a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a331222282fb32dc55d6f5847bbd1c848"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a331222282fb32dc55d6f5847bbd1c848"></a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1VStackInvertedLists.html#a331222282fb32dc55d6f5847bbd1c848">release_codes</a> (size_t list_no, const uint8_t *codes) const override</td></tr> <tr class="memdesc:a331222282fb32dc55d6f5847bbd1c848"><td class="mdescLeft"> </td><td class="mdescRight">release codes returned by get_codes (default implementation is nop <br/></td></tr> <tr class="separator:a331222282fb32dc55d6f5847bbd1c848"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a3048d4656332d160502cd95b22b53be5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3048d4656332d160502cd95b22b53be5"></a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1VStackInvertedLists.html#a3048d4656332d160502cd95b22b53be5">release_ids</a> (size_t list_no, const idx_t *ids) const override</td></tr> <tr class="memdesc:a3048d4656332d160502cd95b22b53be5"><td class="mdescLeft"> </td><td class="mdescRight">release ids returned by get_ids <br/></td></tr> <tr class="separator:a3048d4656332d160502cd95b22b53be5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab2d660680d9b4a2667c321515b5baa77"><td class="memItemLeft" align="right" valign="top">idx_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1VStackInvertedLists.html#ab2d660680d9b4a2667c321515b5baa77">get_single_id</a> (size_t list_no, size_t offset) const override</td></tr> <tr class="separator:ab2d660680d9b4a2667c321515b5baa77"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a3c229e59737b533464f5403c5cf5fca4"><td class="memItemLeft" align="right" valign="top">const uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1VStackInvertedLists.html#a3c229e59737b533464f5403c5cf5fca4">get_single_code</a> (size_t list_no, size_t offset) const override</td></tr> <tr class="separator:a3c229e59737b533464f5403c5cf5fca4"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af37c2171d22f7f9200fa5cdedb363471"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1VStackInvertedLists.html#af37c2171d22f7f9200fa5cdedb363471">prefetch_lists</a> (const idx_t *list_nos, int <a class="el" href="structfaiss_1_1InvertedLists.html#afaf8b7aa3e846aa4553f6aae67827ec8">nlist</a>) const override</td></tr> <tr class="separator:af37c2171d22f7f9200fa5cdedb363471"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pub_methods_structfaiss_1_1ReadOnlyInvertedLists"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structfaiss_1_1ReadOnlyInvertedLists')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="structfaiss_1_1ReadOnlyInvertedLists.html">faiss::ReadOnlyInvertedLists</a></td></tr> <tr class="memitem:a38b8814659bc9dd48a96191aa3f1b01c inherit pub_methods_structfaiss_1_1ReadOnlyInvertedLists"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a38b8814659bc9dd48a96191aa3f1b01c"></a>  </td><td class="memItemRight" valign="bottom"><b>ReadOnlyInvertedLists</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:a38b8814659bc9dd48a96191aa3f1b01c inherit pub_methods_structfaiss_1_1ReadOnlyInvertedLists"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0734538244d8c5969e3e23e38faf1c0c inherit pub_methods_structfaiss_1_1ReadOnlyInvertedLists"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0734538244d8c5969e3e23e38faf1c0c"></a> 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) override</td></tr> <tr class="separator:a0734538244d8c5969e3e23e38faf1c0c inherit pub_methods_structfaiss_1_1ReadOnlyInvertedLists"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a33c3a5174bcf6709dcefec8bdc4b9a52 inherit pub_methods_structfaiss_1_1ReadOnlyInvertedLists"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a33c3a5174bcf6709dcefec8bdc4b9a52"></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 *ids, const uint8_t *code) override</td></tr> <tr class="separator:a33c3a5174bcf6709dcefec8bdc4b9a52 inherit pub_methods_structfaiss_1_1ReadOnlyInvertedLists"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7b65c76388ba2fbc17a7060f6cf87039 inherit pub_methods_structfaiss_1_1ReadOnlyInvertedLists"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7b65c76388ba2fbc17a7060f6cf87039"></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:a7b65c76388ba2fbc17a7060f6cf87039 inherit pub_methods_structfaiss_1_1ReadOnlyInvertedLists"><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: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> <tr class="memitem:ac2a0686121ef5bdd6eb70f7eb3cf9b3a inherit pub_methods_structfaiss_1_1InvertedLists"><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 inherit pub_methods_structfaiss_1_1InvertedLists"><td class="mdescLeft"> </td><td class="mdescRight">move all entries from oivf (empty on output) <br/></td></tr> <tr class="separator:ac2a0686121ef5bdd6eb70f7eb3cf9b3a inherit pub_methods_structfaiss_1_1InvertedLists"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aacf34f6cf392771fe2e68210cd4e009b inherit pub_methods_structfaiss_1_1InvertedLists"><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 inherit pub_methods_structfaiss_1_1InvertedLists"><td class="mdescLeft"> </td><td class="mdescRight">1= perfectly balanced, >1: imbalanced <br/></td></tr> <tr class="separator:aacf34f6cf392771fe2e68210cd4e009b inherit pub_methods_structfaiss_1_1InvertedLists"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a156de8be4b21a0dfa9a48a3918a0b5c3 inherit pub_methods_structfaiss_1_1InvertedLists"><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 inherit pub_methods_structfaiss_1_1InvertedLists"><td class="mdescLeft"> </td><td class="mdescRight">display some stats about the inverted lists <br/></td></tr> <tr class="separator:a156de8be4b21a0dfa9a48a3918a0b5c3 inherit pub_methods_structfaiss_1_1InvertedLists"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a722eef5a0e5bf5dcf78228a903e16af9 inherit pub_methods_structfaiss_1_1InvertedLists"><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 inherit pub_methods_structfaiss_1_1InvertedLists"><td class="mdescLeft"> </td><td class="mdescRight">sum up list sizes <br/></td></tr> <tr class="separator:a722eef5a0e5bf5dcf78228a903e16af9 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:a7ed923c2a52b86ae6012ac058d2d2388"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7ed923c2a52b86ae6012ac058d2d2388"></a> std::vector< const <br class="typebreak"/> <a class="el" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> * > </td><td class="memItemRight" valign="bottom"><b>ils</b></td></tr> <tr class="separator:a7ed923c2a52b86ae6012ac058d2d2388"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad9c47fdc34b29918bfc07ea2a16d50e6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad9c47fdc34b29918bfc07ea2a16d50e6"></a> std::vector< idx_t > </td><td class="memItemRight" valign="bottom"><b>cumsz</b></td></tr> <tr class="separator:ad9c47fdc34b29918bfc07ea2a16d50e6"><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#ad3f0d3071f987baabbdd3da4500c87ea">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="InvertedLists_8h_source.html#l00278">278</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="a112f9458bd91ca5dbed2cb6d090a0034"></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::VStackInvertedLists::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"> <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>Implements <a class="el" href="structfaiss_1_1InvertedLists.html#a60b12f9efe940b617a8380adceef4032">faiss::InvertedLists</a>.</p> <p>Definition at line <a class="el" href="InvertedLists_8cpp_source.html#l00467">467</a> of file <a class="el" href="InvertedLists_8cpp_source.html">InvertedLists.cpp</a>.</p> </div> </div> <a class="anchor" id="a912c3f0417c833a81da5957f4d77452a"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">const <a class="el" href="structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea">Index::idx_t</a> * faiss::VStackInvertedLists::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"> <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>Implements <a class="el" href="structfaiss_1_1InvertedLists.html#a3ab6b389d8d85c5fbf23889064df7e95">faiss::InvertedLists</a>.</p> <p>Definition at line <a class="el" href="InvertedLists_8cpp_source.html#l00490">490</a> of file <a class="el" href="InvertedLists_8cpp_source.html">InvertedLists.cpp</a>.</p> </div> </div> <a class="anchor" id="a3c229e59737b533464f5403c5cf5fca4"></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::VStackInvertedLists::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">override</span><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 from <a class="el" href="structfaiss_1_1InvertedLists.html#afc2760bed7c210f2fad9b03109f561ee">faiss::InvertedLists</a>.</p> <p>Definition at line <a class="el" href="InvertedLists_8cpp_source.html#l00474">474</a> of file <a class="el" href="InvertedLists_8cpp_source.html">InvertedLists.cpp</a>.</p> </div> </div> <a class="anchor" id="ab2d660680d9b4a2667c321515b5baa77"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea">Index::idx_t</a> faiss::VStackInvertedLists::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">override</span><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 from <a class="el" href="structfaiss_1_1InvertedLists.html#a21b52cdb0601cd225bd7924932310876">faiss::InvertedLists</a>.</p> <p>Definition at line <a class="el" href="InvertedLists_8cpp_source.html#l00497">497</a> of file <a class="el" href="InvertedLists_8cpp_source.html">InvertedLists.cpp</a>.</p> </div> </div> <a class="anchor" id="af37c2171d22f7f9200fa5cdedb363471"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void faiss::VStackInvertedLists::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">override</span><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 from <a class="el" href="structfaiss_1_1InvertedLists.html#ac537aa14d2731c0ff907169211389b76">faiss::InvertedLists</a>.</p> <p>Definition at line <a class="el" href="InvertedLists_8cpp_source.html#l00512">512</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>