faiss/docs/html/structfaiss_1_1IndexBinaryI...

151 lines
20 KiB
HTML
Raw Normal View History

<!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: Member List</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&#160;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&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</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_1IndexBinaryIVF.html">IndexBinaryIVF</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">faiss::IndexBinaryIVF Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="structfaiss_1_1IndexBinaryIVF.html">faiss::IndexBinaryIVF</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#aaa0eb1eca49892304ceaa11bd3a5ffa1">add</a>(idx_t n, const uint8_t *x) override</td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html">faiss::IndexBinaryIVF</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#a6f74afc490b61ba896ecfad037c9a429">add_core</a>(idx_t n, const uint8_t *x, const long *xids, const long *precomputed_idx)</td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html">faiss::IndexBinaryIVF</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#a8f5fc7b1cc59623154f7922459d8c7bb">add_with_ids</a>(idx_t n, const uint8_t *x, const long *xids) override</td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html">faiss::IndexBinaryIVF</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr><td class="entry"><a class="el" href="structfaiss_1_1IndexBinary.html#a27c32414471c57138b248583fc0c5f8c">assign</a>(idx_t n, const uint8_t *x, idx_t *labels, idx_t k=1)</td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinary.html">faiss::IndexBinary</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#ae4b4048070a6fc5aa3226a2edf42db5e">clustering_index</a></td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html">faiss::IndexBinaryIVF</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structfaiss_1_1IndexBinary.html#a277c2645b8def11c5d982384098c5380">code_size</a></td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinary.html">faiss::IndexBinary</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>component_t</b> typedef (defined in <a class="el" href="structfaiss_1_1IndexBinary.html">faiss::IndexBinary</a>)</td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinary.html">faiss::IndexBinary</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#a0c3d371cf3985da70b6dacac74f03491">cp</a></td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html">faiss::IndexBinaryIVF</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structfaiss_1_1IndexBinary.html#a0e485a7189eec2675032486d3b12cf88">d</a></td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinary.html">faiss::IndexBinary</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>direct_map</b> (defined in <a class="el" href="structfaiss_1_1IndexBinaryIVF.html">faiss::IndexBinaryIVF</a>)</td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html">faiss::IndexBinaryIVF</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structfaiss_1_1IndexBinary.html#a63d722545b95badd251f3e8770b9bb9b">display</a>() const </td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinary.html">faiss::IndexBinary</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>distance_t</b> typedef (defined in <a class="el" href="structfaiss_1_1IndexBinary.html">faiss::IndexBinary</a>)</td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinary.html">faiss::IndexBinary</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>get_InvertedListScanner</b>(bool store_pairs=false) const (defined in <a class="el" href="structfaiss_1_1IndexBinaryIVF.html">faiss::IndexBinaryIVF</a>)</td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html">faiss::IndexBinaryIVF</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>get_list_size</b>(size_t list_no) const (defined in <a class="el" href="structfaiss_1_1IndexBinaryIVF.html">faiss::IndexBinaryIVF</a>)</td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html">faiss::IndexBinaryIVF</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structfaiss_1_1IndexBinary.html#a01749bbdbd3b7ec6bb9390257ab16c5c">idx_t</a> typedef</td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinary.html">faiss::IndexBinary</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>IndexBinary</b>(idx_t d=0, MetricType metric=METRIC_L2) (defined in <a class="el" href="structfaiss_1_1IndexBinary.html">faiss::IndexBinary</a>)</td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinary.html">faiss::IndexBinary</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">explicit</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#a569058430e4b1b81204df1c2cbd3084a">IndexBinaryIVF</a>(IndexBinary *quantizer, size_t d, size_t nlist)</td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html">faiss::IndexBinaryIVF</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>IndexBinaryIVF</b>() (defined in <a class="el" href="structfaiss_1_1IndexBinaryIVF.html">faiss::IndexBinaryIVF</a>)</td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html">faiss::IndexBinaryIVF</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#a094ef9572645ff86a76ff4df967bf65a">invlists</a></td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html">faiss::IndexBinaryIVF</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structfaiss_1_1IndexBinary.html#a132119ae93e240b54621c5c669853c7f">is_trained</a></td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinary.html">faiss::IndexBinary</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#a1ae109b12efeb9b3349c1de2c6d480e5">maintain_direct_map</a></td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html">faiss::IndexBinaryIVF</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#a280d0a3958664c3eb4164fcb62496b00">make_direct_map</a>(bool new_maintain_direct_map=true)</td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html">faiss::IndexBinaryIVF</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#a18ffc5dbf15b4a86a8c868ca845ea4c9">max_codes</a></td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html">faiss::IndexBinaryIVF</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#a5296e62b0524f13ff66c61fb7db499a2">merge_from</a>(IndexBinaryIVF &amp;other, idx_t add_id)</td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html">faiss::IndexBinaryIVF</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structfaiss_1_1IndexBinary.html#a344529c829717012b530ef9c13b145b7">metric_type</a></td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinary.html">faiss::IndexBinary</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#a9eb4370bcc95994822c3a81c290fa919">nlist</a></td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html">faiss::IndexBinaryIVF</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#ae9890e0946f3aba99ccad6b637df0c8b">nprobe</a></td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html">faiss::IndexBinaryIVF</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structfaiss_1_1IndexBinary.html#a41b6759d127475d5fcd2b3982a8f355e">ntotal</a></td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinary.html">faiss::IndexBinary</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#a2c7bc3be67d829d49ac1ab2afc4f6b0c">own_fields</a></td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html">faiss::IndexBinaryIVF</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>own_invlists</b> (defined in <a class="el" href="structfaiss_1_1IndexBinaryIVF.html">faiss::IndexBinaryIVF</a>)</td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html">faiss::IndexBinaryIVF</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#a5c08ac8e6c1444e61b9f357cfba34e2e">quantizer</a></td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html">faiss::IndexBinaryIVF</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structfaiss_1_1IndexBinary.html#adec414108d34c63e4a06b6d3f9a3fa35">range_search</a>(idx_t n, const uint8_t *x, int radius, RangeSearchResult *result) const </td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinary.html">faiss::IndexBinary</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#ad233d3fcf4e001849301c0fbeb675f81">reconstruct</a>(idx_t key, uint8_t *recons) const override</td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html">faiss::IndexBinaryIVF</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#a9e0d01c30760152fbac8f08bb5825de4">reconstruct_from_offset</a>(long list_no, long offset, uint8_t *recons) const </td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html">faiss::IndexBinaryIVF</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#a4a8cd9437b9adc21696aefe1fa440a22">reconstruct_n</a>(idx_t i0, idx_t ni, uint8_t *recons) const override</td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html">faiss::IndexBinaryIVF</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#a06d0e73e7ece9689000f936e7f1e2960">remove_ids</a>(const IDSelector &amp;sel) override</td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html">faiss::IndexBinaryIVF</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>replace_invlists</b>(InvertedLists *il, bool own=false) (defined in <a class="el" href="structfaiss_1_1IndexBinaryIVF.html">faiss::IndexBinaryIVF</a>)</td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html">faiss::IndexBinaryIVF</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#a9dfe26312102f0010940fd2fbdf87d85">reset</a>() override</td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html">faiss::IndexBinaryIVF</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#aeaf24ee802fe8f43879c735c363b6fd5">search</a>(idx_t n, const uint8_t *x, idx_t k, int32_t *distances, idx_t *labels) const override</td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html">faiss::IndexBinaryIVF</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#a75260a5d45fb24a9a3c3462786f1de4d">search_and_reconstruct</a>(idx_t n, const uint8_t *x, idx_t k, int32_t *distances, idx_t *labels, uint8_t *recons) const override</td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html">faiss::IndexBinaryIVF</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#a4f33ec7083279f26c0966c5445ec702d">search_preassigned</a>(idx_t n, const uint8_t *x, idx_t k, const idx_t *assign, const int32_t *centroid_dis, int32_t *distances, idx_t *labels, bool store_pairs, const IVFSearchParameters *params=nullptr) const </td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html">faiss::IndexBinaryIVF</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#a4b4b1ba42e6af7c30ccbaf0fc0f38034">train</a>(idx_t n, const uint8_t *x) override</td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html">faiss::IndexBinaryIVF</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html#abcab702ebe1814ff432401bfd39df492">use_heap</a></td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html">faiss::IndexBinaryIVF</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="structfaiss_1_1IndexBinary.html#a1656c00d77d55999becd71e3d8ea6dd7">verbose</a></td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinary.html">faiss::IndexBinary</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>~IndexBinary</b>() (defined in <a class="el" href="structfaiss_1_1IndexBinary.html">faiss::IndexBinary</a>)</td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinary.html">faiss::IndexBinary</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>~IndexBinaryIVF</b>() override (defined in <a class="el" href="structfaiss_1_1IndexBinaryIVF.html">faiss::IndexBinaryIVF</a>)</td><td class="entry"><a class="el" href="structfaiss_1_1IndexBinaryIVF.html">faiss::IndexBinaryIVF</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>