mirror of
https://github.com/facebookresearch/faiss.git
synced 2025-06-03 21:54:02 +08:00
0df3f646fc
various bugfixes from github issues kmean with some frozen centroids GPU better tiling for large flat datasets default AVX for vector ops
553 lines
60 KiB
HTML
553 lines
60 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.5"/>
|
|
<title>Faiss: faiss::IndexIVFPQR 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_1IndexIVFPQR.html">IndexIVFPQR</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_1IndexIVFPQR-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">faiss::IndexIVFPQR Struct Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code>#include <<a class="el" href="IndexIVFPQ_8h_source.html">IndexIVFPQ.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for faiss::IndexIVFPQR:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="structfaiss_1_1IndexIVFPQR.png" usemap="#faiss::IndexIVFPQR_map" alt=""/>
|
|
<map id="faiss::IndexIVFPQR_map" name="faiss::IndexIVFPQR_map">
|
|
<area href="structfaiss_1_1IndexIVFPQ.html" alt="faiss::IndexIVFPQ" shape="rect" coords="0,112,120,136"/>
|
|
<area href="structfaiss_1_1IndexIVF.html" alt="faiss::IndexIVF" shape="rect" coords="0,56,120,80"/>
|
|
<area href="structfaiss_1_1Index.html" alt="faiss::Index" shape="rect" coords="0,0,120,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:aa465b697b8ca9aa5970ad92ac246580a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa465b697b8ca9aa5970ad92ac246580a"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>IndexIVFPQR</b> (<a class="el" href="structfaiss_1_1Index.html">Index</a> *<a class="el" href="structfaiss_1_1IndexIVF.html#a4b40cc7a70dff41196a3b8769586667a">quantizer</a>, size_t <a class="el" href="structfaiss_1_1Index.html#a2a002388d2c081c2dbab8508dcefe73d">d</a>, size_t <a class="el" href="structfaiss_1_1IndexIVF.html#ab38fde4c923abefc4185eb7450b5b95b">nlist</a>, size_t M, size_t nbits_per_idx, size_t M_refine, size_t nbits_per_idx_refine)</td></tr>
|
|
<tr class="separator:aa465b697b8ca9aa5970ad92ac246580a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae0e979a014a9defe2254e9543657b075"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae0e979a014a9defe2254e9543657b075"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFPQR.html#ae0e979a014a9defe2254e9543657b075">reset</a> () override</td></tr>
|
|
<tr class="memdesc:ae0e979a014a9defe2254e9543657b075"><td class="mdescLeft"> </td><td class="mdescRight">removes all elements from the database. <br/></td></tr>
|
|
<tr class="separator:ae0e979a014a9defe2254e9543657b075"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acc5eeeeb8ac8d2581ef07947932d9f6c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acc5eeeeb8ac8d2581ef07947932d9f6c"></a>
|
|
long </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFPQR.html#acc5eeeeb8ac8d2581ef07947932d9f6c">remove_ids</a> (const <a class="el" href="structfaiss_1_1IDSelector.html">IDSelector</a> &sel) override</td></tr>
|
|
<tr class="memdesc:acc5eeeeb8ac8d2581ef07947932d9f6c"><td class="mdescLeft"> </td><td class="mdescRight">Dataset manipulation functions. <br/></td></tr>
|
|
<tr class="separator:acc5eeeeb8ac8d2581ef07947932d9f6c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a68ed7cae5bec89fcdcb6a1d2addbd5a8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a68ed7cae5bec89fcdcb6a1d2addbd5a8"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFPQR.html#a68ed7cae5bec89fcdcb6a1d2addbd5a8">train_residual</a> (<a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> n, const float *x) override</td></tr>
|
|
<tr class="memdesc:a68ed7cae5bec89fcdcb6a1d2addbd5a8"><td class="mdescLeft"> </td><td class="mdescRight">trains the two product quantizers <br/></td></tr>
|
|
<tr class="separator:a68ed7cae5bec89fcdcb6a1d2addbd5a8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4b6154a5194d574d037ba78c137a2fa5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFPQR.html#a4b6154a5194d574d037ba78c137a2fa5">add_with_ids</a> (<a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> n, const float *x, const long *xids) override</td></tr>
|
|
<tr class="separator:a4b6154a5194d574d037ba78c137a2fa5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a186b746f22b65ddf416b1e821b0866ec"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a186b746f22b65ddf416b1e821b0866ec"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFPQR.html#a186b746f22b65ddf416b1e821b0866ec">add_core</a> (<a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> n, const float *x, const long *xids, const long *precomputed_idx=nullptr)</td></tr>
|
|
<tr class="memdesc:a186b746f22b65ddf416b1e821b0866ec"><td class="mdescLeft"> </td><td class="mdescRight">same as add_with_ids, but optionally use the precomputed list ids <br/></td></tr>
|
|
<tr class="separator:a186b746f22b65ddf416b1e821b0866ec"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0f0d8fc6b2c6aa2431c1730111a3b22a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFPQR.html#a0f0d8fc6b2c6aa2431c1730111a3b22a">reconstruct_n</a> (<a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> i0, <a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> ni, float *recons) const override</td></tr>
|
|
<tr class="separator:a0f0d8fc6b2c6aa2431c1730111a3b22a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a31a1fec2a88b410ea96ce5be7d527be9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFPQR.html#a31a1fec2a88b410ea96ce5be7d527be9">merge_from</a> (<a class="el" href="structfaiss_1_1IndexIVF.html">IndexIVF</a> &other, <a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> add_id) override</td></tr>
|
|
<tr class="separator:a31a1fec2a88b410ea96ce5be7d527be9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3e982ee6f1a3a025148270701867d04f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFPQR.html#a3e982ee6f1a3a025148270701867d04f">search</a> (<a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> n, const float *x, <a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> k, float *distances, <a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> *labels) const override</td></tr>
|
|
<tr class="separator:a3e982ee6f1a3a025148270701867d04f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_structfaiss_1_1IndexIVFPQ"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structfaiss_1_1IndexIVFPQ')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="structfaiss_1_1IndexIVFPQ.html">faiss::IndexIVFPQ</a></td></tr>
|
|
<tr class="memitem:a38e177f44798228fe81a0c35b86080fc inherit pub_methods_structfaiss_1_1IndexIVFPQ"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a38e177f44798228fe81a0c35b86080fc"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>IndexIVFPQ</b> (<a class="el" href="structfaiss_1_1Index.html">Index</a> *<a class="el" href="structfaiss_1_1IndexIVF.html#a4b40cc7a70dff41196a3b8769586667a">quantizer</a>, size_t <a class="el" href="structfaiss_1_1Index.html#a2a002388d2c081c2dbab8508dcefe73d">d</a>, size_t <a class="el" href="structfaiss_1_1IndexIVF.html#ab38fde4c923abefc4185eb7450b5b95b">nlist</a>, size_t M, size_t nbits_per_idx)</td></tr>
|
|
<tr class="separator:a38e177f44798228fe81a0c35b86080fc inherit pub_methods_structfaiss_1_1IndexIVFPQ"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac0cb8421b9885d691696d2ff4f76894b inherit pub_methods_structfaiss_1_1IndexIVFPQ"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFPQ.html#ac0cb8421b9885d691696d2ff4f76894b">add_core_o</a> (<a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> n, const float *x, const long *xids, float *residuals_2, const long *precomputed_idx=nullptr)</td></tr>
|
|
<tr class="separator:ac0cb8421b9885d691696d2ff4f76894b inherit pub_methods_structfaiss_1_1IndexIVFPQ"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4e06f04853dcb424dc393de5f641e917 inherit pub_methods_structfaiss_1_1IndexIVFPQ"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4e06f04853dcb424dc393de5f641e917"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFPQ.html#a4e06f04853dcb424dc393de5f641e917">train_residual_o</a> (<a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> n, const float *x, float *residuals_2)</td></tr>
|
|
<tr class="memdesc:a4e06f04853dcb424dc393de5f641e917 inherit pub_methods_structfaiss_1_1IndexIVFPQ"><td class="mdescLeft"> </td><td class="mdescRight">same as train_residual, also output 2nd level residuals <br/></td></tr>
|
|
<tr class="separator:a4e06f04853dcb424dc393de5f641e917 inherit pub_methods_structfaiss_1_1IndexIVFPQ"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a28ce697b1381eb7e7d7d25774a25e175 inherit pub_methods_structfaiss_1_1IndexIVFPQ"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFPQ.html#a28ce697b1381eb7e7d7d25774a25e175">reconstruct</a> (<a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> key, float *recons) const override</td></tr>
|
|
<tr class="separator:a28ce697b1381eb7e7d7d25774a25e175 inherit pub_methods_structfaiss_1_1IndexIVFPQ"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aee355b57acde203a3caed46a93e16a3c inherit pub_methods_structfaiss_1_1IndexIVFPQ"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFPQ.html#aee355b57acde203a3caed46a93e16a3c">find_duplicates</a> (<a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> *<a class="el" href="structfaiss_1_1IndexIVF.html#af16d325f5bef22b2e5f90ceea796e80d">ids</a>, size_t *lims) const </td></tr>
|
|
<tr class="separator:aee355b57acde203a3caed46a93e16a3c inherit pub_methods_structfaiss_1_1IndexIVFPQ"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa26497bd5b44c5dbbebfe6bfe453119e inherit pub_methods_structfaiss_1_1IndexIVFPQ"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa26497bd5b44c5dbbebfe6bfe453119e"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>encode</b> (long key, const float *x, uint8_t *code) const </td></tr>
|
|
<tr class="separator:aa26497bd5b44c5dbbebfe6bfe453119e inherit pub_methods_structfaiss_1_1IndexIVFPQ"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1ae6cdd996bbd398fa4e87646c8f3ba6 inherit pub_methods_structfaiss_1_1IndexIVFPQ"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFPQ.html#a1ae6cdd996bbd398fa4e87646c8f3ba6">encode_multiple</a> (size_t n, long *keys, const float *x, uint8_t *codes, bool compute_keys=false) const </td></tr>
|
|
<tr class="separator:a1ae6cdd996bbd398fa4e87646c8f3ba6 inherit pub_methods_structfaiss_1_1IndexIVFPQ"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae1fb0cc3051dec8e322a78c443f8fc9a inherit pub_methods_structfaiss_1_1IndexIVFPQ"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae1fb0cc3051dec8e322a78c443f8fc9a"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFPQ.html#ae1fb0cc3051dec8e322a78c443f8fc9a">decode_multiple</a> (size_t n, const long *keys, const uint8_t *xcodes, float *x) const </td></tr>
|
|
<tr class="memdesc:ae1fb0cc3051dec8e322a78c443f8fc9a inherit pub_methods_structfaiss_1_1IndexIVFPQ"><td class="mdescLeft"> </td><td class="mdescRight">inverse of encode_multiple <br/></td></tr>
|
|
<tr class="separator:ae1fb0cc3051dec8e322a78c443f8fc9a inherit pub_methods_structfaiss_1_1IndexIVFPQ"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a150a37cf3e8a7e37cb8dab1d5678bc02 inherit pub_methods_structfaiss_1_1IndexIVFPQ"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFPQ.html#a150a37cf3e8a7e37cb8dab1d5678bc02">search_preassigned</a> (<a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> n, const float *x, <a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> k, const <a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> *<a class="el" href="structfaiss_1_1Index.html#a8bc5d8d1cd0dd7b34b3c98a9f76b4a9c">assign</a>, const float *centroid_dis, float *distances, <a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> *labels, bool store_pairs) const override</td></tr>
|
|
<tr class="separator:a150a37cf3e8a7e37cb8dab1d5678bc02 inherit pub_methods_structfaiss_1_1IndexIVFPQ"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6310771a6e161e0bb4c46719550895f8 inherit pub_methods_structfaiss_1_1IndexIVFPQ"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFPQ.html#a6310771a6e161e0bb4c46719550895f8">search_and_reconstruct</a> (<a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> n, const float *x, <a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> k, float *distances, <a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> *labels, float *reconstructed)</td></tr>
|
|
<tr class="separator:a6310771a6e161e0bb4c46719550895f8 inherit pub_methods_structfaiss_1_1IndexIVFPQ"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad99c215aeaf92e995cb97f4044c4d267 inherit pub_methods_structfaiss_1_1IndexIVFPQ"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFPQ.html#ad99c215aeaf92e995cb97f4044c4d267">precompute_table</a> ()</td></tr>
|
|
<tr class="memdesc:ad99c215aeaf92e995cb97f4044c4d267 inherit pub_methods_structfaiss_1_1IndexIVFPQ"><td class="mdescLeft"> </td><td class="mdescRight">build precomputed table <a href="#ad99c215aeaf92e995cb97f4044c4d267">More...</a><br/></td></tr>
|
|
<tr class="separator:ad99c215aeaf92e995cb97f4044c4d267 inherit pub_methods_structfaiss_1_1IndexIVFPQ"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_structfaiss_1_1IndexIVF"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structfaiss_1_1IndexIVF')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="structfaiss_1_1IndexIVF.html">faiss::IndexIVF</a></td></tr>
|
|
<tr class="memitem:a617f8c4ff40619d141c5c21dbf758ddf inherit pub_methods_structfaiss_1_1IndexIVF"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVF.html#a617f8c4ff40619d141c5c21dbf758ddf">IndexIVF</a> (<a class="el" href="structfaiss_1_1Index.html">Index</a> *<a class="el" href="structfaiss_1_1IndexIVF.html#a4b40cc7a70dff41196a3b8769586667a">quantizer</a>, size_t <a class="el" href="structfaiss_1_1Index.html#a2a002388d2c081c2dbab8508dcefe73d">d</a>, size_t <a class="el" href="structfaiss_1_1IndexIVF.html#ab38fde4c923abefc4185eb7450b5b95b">nlist</a>, <a class="el" href="namespacefaiss.html#afd12191c638da74760ff397cf319752c">MetricType</a> metric=METRIC_INNER_PRODUCT)</td></tr>
|
|
<tr class="separator:a617f8c4ff40619d141c5c21dbf758ddf inherit pub_methods_structfaiss_1_1IndexIVF"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7a1d5eec194db0977b2318c6ed6a2b86 inherit pub_methods_structfaiss_1_1IndexIVF"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7a1d5eec194db0977b2318c6ed6a2b86"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVF.html#a7a1d5eec194db0977b2318c6ed6a2b86">train</a> (<a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> n, const float *x) override</td></tr>
|
|
<tr class="memdesc:a7a1d5eec194db0977b2318c6ed6a2b86 inherit pub_methods_structfaiss_1_1IndexIVF"><td class="mdescLeft"> </td><td class="mdescRight">Trains the quantizer and calls train_residual to train sub-quantizers. <br/></td></tr>
|
|
<tr class="separator:a7a1d5eec194db0977b2318c6ed6a2b86 inherit pub_methods_structfaiss_1_1IndexIVF"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a821002a9d3a1a74dc8d6f6072eca4075 inherit pub_methods_structfaiss_1_1IndexIVF"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a821002a9d3a1a74dc8d6f6072eca4075"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVF.html#a821002a9d3a1a74dc8d6f6072eca4075">add</a> (<a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> n, const float *x) override</td></tr>
|
|
<tr class="memdesc:a821002a9d3a1a74dc8d6f6072eca4075 inherit pub_methods_structfaiss_1_1IndexIVF"><td class="mdescLeft"> </td><td class="mdescRight">Quantizes x and calls add_with_key. <br/></td></tr>
|
|
<tr class="separator:a821002a9d3a1a74dc8d6f6072eca4075 inherit pub_methods_structfaiss_1_1IndexIVF"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2fc63f9bbfe64e05106366465ece2187 inherit pub_methods_structfaiss_1_1IndexIVF"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVF.html#a2fc63f9bbfe64e05106366465ece2187">copy_subset_to</a> (<a class="el" href="structfaiss_1_1IndexIVF.html">IndexIVF</a> &other, int subset_type, long a1, long a2) const </td></tr>
|
|
<tr class="separator:a2fc63f9bbfe64e05106366465ece2187 inherit pub_methods_structfaiss_1_1IndexIVF"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0475311f5faee84d024066906bae0bbd inherit pub_methods_structfaiss_1_1IndexIVF"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0475311f5faee84d024066906bae0bbd"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><b>get_list_size</b> (size_t list_no) const </td></tr>
|
|
<tr class="separator:a0475311f5faee84d024066906bae0bbd inherit pub_methods_structfaiss_1_1IndexIVF"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1c11ce77f459e2ab3e5d9a4c2263ad89 inherit pub_methods_structfaiss_1_1IndexIVF"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVF.html#a1c11ce77f459e2ab3e5d9a4c2263ad89">make_direct_map</a> (bool new_maintain_direct_map=true)</td></tr>
|
|
<tr class="separator:a1c11ce77f459e2ab3e5d9a4c2263ad89 inherit pub_methods_structfaiss_1_1IndexIVF"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeab84d4edf2cf9747c923e1a8395d9f3 inherit pub_methods_structfaiss_1_1IndexIVF"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeab84d4edf2cf9747c923e1a8395d9f3"></a>
|
|
double </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVF.html#aeab84d4edf2cf9747c923e1a8395d9f3">imbalance_factor</a> () const </td></tr>
|
|
<tr class="memdesc:aeab84d4edf2cf9747c923e1a8395d9f3 inherit pub_methods_structfaiss_1_1IndexIVF"><td class="mdescLeft"> </td><td class="mdescRight">1= perfectly balanced, >1: imbalanced <br/></td></tr>
|
|
<tr class="separator:aeab84d4edf2cf9747c923e1a8395d9f3 inherit pub_methods_structfaiss_1_1IndexIVF"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a513dfec3a250f08a9fdd18a24178e6bb inherit pub_methods_structfaiss_1_1IndexIVF"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a513dfec3a250f08a9fdd18a24178e6bb"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVF.html#a513dfec3a250f08a9fdd18a24178e6bb">print_stats</a> () const </td></tr>
|
|
<tr class="memdesc:a513dfec3a250f08a9fdd18a24178e6bb inherit pub_methods_structfaiss_1_1IndexIVF"><td class="mdescLeft"> </td><td class="mdescRight">display some stats about the inverted lists <br/></td></tr>
|
|
<tr class="separator:a513dfec3a250f08a9fdd18a24178e6bb inherit pub_methods_structfaiss_1_1IndexIVF"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_structfaiss_1_1Index"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structfaiss_1_1Index')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="structfaiss_1_1Index.html">faiss::Index</a></td></tr>
|
|
<tr class="memitem:a18475cb29370bd6ac3c9f41d39f2e8ec inherit pub_methods_structfaiss_1_1Index"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a18475cb29370bd6ac3c9f41d39f2e8ec"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>Index</b> (<a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> <a class="el" href="structfaiss_1_1Index.html#a2a002388d2c081c2dbab8508dcefe73d">d</a>=0, <a class="el" href="namespacefaiss.html#afd12191c638da74760ff397cf319752c">MetricType</a> metric=METRIC_INNER_PRODUCT)</td></tr>
|
|
<tr class="separator:a18475cb29370bd6ac3c9f41d39f2e8ec inherit pub_methods_structfaiss_1_1Index"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a236897832a58dbb205e2d662c1929fb1 inherit pub_methods_structfaiss_1_1Index"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1Index.html#a236897832a58dbb205e2d662c1929fb1">range_search</a> (<a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> n, const float *x, float radius, <a class="el" href="structfaiss_1_1RangeSearchResult.html">RangeSearchResult</a> *result) const </td></tr>
|
|
<tr class="separator:a236897832a58dbb205e2d662c1929fb1 inherit pub_methods_structfaiss_1_1Index"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8bc5d8d1cd0dd7b34b3c98a9f76b4a9c inherit pub_methods_structfaiss_1_1Index"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1Index.html#a8bc5d8d1cd0dd7b34b3c98a9f76b4a9c">assign</a> (<a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> n, const float *x, <a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> *labels, <a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> k=1)</td></tr>
|
|
<tr class="separator:a8bc5d8d1cd0dd7b34b3c98a9f76b4a9c inherit pub_methods_structfaiss_1_1Index"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaae77608bbda70b1098897e9167a82f9 inherit pub_methods_structfaiss_1_1Index"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1Index.html#aaae77608bbda70b1098897e9167a82f9">compute_residual</a> (const float *x, float *residual, <a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> key) const </td></tr>
|
|
<tr class="separator:aaae77608bbda70b1098897e9167a82f9 inherit pub_methods_structfaiss_1_1Index"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a373c30e3d87d1d4e616f450d87152b1a inherit pub_methods_structfaiss_1_1Index"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1Index.html#a373c30e3d87d1d4e616f450d87152b1a">display</a> () const </td></tr>
|
|
<tr class="separator:a373c30e3d87d1d4e616f450d87152b1a inherit pub_methods_structfaiss_1_1Index"><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:a4a80540e7cdfb3e43712ffb93e083a7c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4a80540e7cdfb3e43712ffb93e083a7c"></a>
|
|
<a class="el" href="structfaiss_1_1ProductQuantizer.html">ProductQuantizer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFPQR.html#a4a80540e7cdfb3e43712ffb93e083a7c">refine_pq</a></td></tr>
|
|
<tr class="memdesc:a4a80540e7cdfb3e43712ffb93e083a7c"><td class="mdescLeft"> </td><td class="mdescRight">3rd level quantizer <br/></td></tr>
|
|
<tr class="separator:a4a80540e7cdfb3e43712ffb93e083a7c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a588bd0b733c8db18eaeb7bc287afd16e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a588bd0b733c8db18eaeb7bc287afd16e"></a>
|
|
std::vector< uint8_t > </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFPQR.html#a588bd0b733c8db18eaeb7bc287afd16e">refine_codes</a></td></tr>
|
|
<tr class="memdesc:a588bd0b733c8db18eaeb7bc287afd16e"><td class="mdescLeft"> </td><td class="mdescRight">corresponding codes <br/></td></tr>
|
|
<tr class="separator:a588bd0b733c8db18eaeb7bc287afd16e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0b02a4151ceacc070352f8b15cc0ee0b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0b02a4151ceacc070352f8b15cc0ee0b"></a>
|
|
float </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFPQR.html#a0b02a4151ceacc070352f8b15cc0ee0b">k_factor</a></td></tr>
|
|
<tr class="memdesc:a0b02a4151ceacc070352f8b15cc0ee0b"><td class="mdescLeft"> </td><td class="mdescRight">factor between k requested in search and the k requested from the IVFPQ <br/></td></tr>
|
|
<tr class="separator:a0b02a4151ceacc070352f8b15cc0ee0b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_attribs_structfaiss_1_1IndexIVFPQ"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_structfaiss_1_1IndexIVFPQ')"><img src="closed.png" alt="-"/> Public Attributes inherited from <a class="el" href="structfaiss_1_1IndexIVFPQ.html">faiss::IndexIVFPQ</a></td></tr>
|
|
<tr class="memitem:afd13b471df293ae5a6e895704c69a4c3 inherit pub_attribs_structfaiss_1_1IndexIVFPQ"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afd13b471df293ae5a6e895704c69a4c3"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFPQ.html#afd13b471df293ae5a6e895704c69a4c3">by_residual</a></td></tr>
|
|
<tr class="memdesc:afd13b471df293ae5a6e895704c69a4c3 inherit pub_attribs_structfaiss_1_1IndexIVFPQ"><td class="mdescLeft"> </td><td class="mdescRight">Encode residual or plain vector? <br/></td></tr>
|
|
<tr class="separator:afd13b471df293ae5a6e895704c69a4c3 inherit pub_attribs_structfaiss_1_1IndexIVFPQ"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1c66ff073c18a1edbe8444c24d870583 inherit pub_attribs_structfaiss_1_1IndexIVFPQ"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1c66ff073c18a1edbe8444c24d870583"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFPQ.html#a1c66ff073c18a1edbe8444c24d870583">use_precomputed_table</a></td></tr>
|
|
<tr class="memdesc:a1c66ff073c18a1edbe8444c24d870583 inherit pub_attribs_structfaiss_1_1IndexIVFPQ"><td class="mdescLeft"> </td><td class="mdescRight">if by_residual, build precompute tables <br/></td></tr>
|
|
<tr class="separator:a1c66ff073c18a1edbe8444c24d870583 inherit pub_attribs_structfaiss_1_1IndexIVFPQ"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a007303be116c8da65b6d058e3fc77d16 inherit pub_attribs_structfaiss_1_1IndexIVFPQ"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a007303be116c8da65b6d058e3fc77d16"></a>
|
|
<a class="el" href="structfaiss_1_1ProductQuantizer.html">ProductQuantizer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFPQ.html#a007303be116c8da65b6d058e3fc77d16">pq</a></td></tr>
|
|
<tr class="memdesc:a007303be116c8da65b6d058e3fc77d16 inherit pub_attribs_structfaiss_1_1IndexIVFPQ"><td class="mdescLeft"> </td><td class="mdescRight">produces the codes <br/></td></tr>
|
|
<tr class="separator:a007303be116c8da65b6d058e3fc77d16 inherit pub_attribs_structfaiss_1_1IndexIVFPQ"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9d5373633df7a9bec4de69400b9adeed inherit pub_attribs_structfaiss_1_1IndexIVFPQ"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9d5373633df7a9bec4de69400b9adeed"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFPQ.html#a9d5373633df7a9bec4de69400b9adeed">do_polysemous_training</a></td></tr>
|
|
<tr class="memdesc:a9d5373633df7a9bec4de69400b9adeed inherit pub_attribs_structfaiss_1_1IndexIVFPQ"><td class="mdescLeft"> </td><td class="mdescRight">reorder PQ centroids after training? <br/></td></tr>
|
|
<tr class="separator:a9d5373633df7a9bec4de69400b9adeed inherit pub_attribs_structfaiss_1_1IndexIVFPQ"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2b14cbb5acb3fc28a4df8fde3f5567cd inherit pub_attribs_structfaiss_1_1IndexIVFPQ"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2b14cbb5acb3fc28a4df8fde3f5567cd"></a>
|
|
<a class="el" href="structfaiss_1_1PolysemousTraining.html">PolysemousTraining</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFPQ.html#a2b14cbb5acb3fc28a4df8fde3f5567cd">polysemous_training</a></td></tr>
|
|
<tr class="memdesc:a2b14cbb5acb3fc28a4df8fde3f5567cd inherit pub_attribs_structfaiss_1_1IndexIVFPQ"><td class="mdescLeft"> </td><td class="mdescRight">if NULL, use default <br/></td></tr>
|
|
<tr class="separator:a2b14cbb5acb3fc28a4df8fde3f5567cd inherit pub_attribs_structfaiss_1_1IndexIVFPQ"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7430fc4fa030c96497abced3b68358d4 inherit pub_attribs_structfaiss_1_1IndexIVFPQ"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7430fc4fa030c96497abced3b68358d4"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFPQ.html#a7430fc4fa030c96497abced3b68358d4">scan_table_threshold</a></td></tr>
|
|
<tr class="memdesc:a7430fc4fa030c96497abced3b68358d4 inherit pub_attribs_structfaiss_1_1IndexIVFPQ"><td class="mdescLeft"> </td><td class="mdescRight">use table computation or on-the-fly? <br/></td></tr>
|
|
<tr class="separator:a7430fc4fa030c96497abced3b68358d4 inherit pub_attribs_structfaiss_1_1IndexIVFPQ"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a77501995b3671e377102d2db1a93ade4 inherit pub_attribs_structfaiss_1_1IndexIVFPQ"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a77501995b3671e377102d2db1a93ade4"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFPQ.html#a77501995b3671e377102d2db1a93ade4">max_codes</a></td></tr>
|
|
<tr class="memdesc:a77501995b3671e377102d2db1a93ade4 inherit pub_attribs_structfaiss_1_1IndexIVFPQ"><td class="mdescLeft"> </td><td class="mdescRight">max nb of codes to visit to do a query <br/></td></tr>
|
|
<tr class="separator:a77501995b3671e377102d2db1a93ade4 inherit pub_attribs_structfaiss_1_1IndexIVFPQ"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3093a0a3e128eafce6e0583b75e9662e inherit pub_attribs_structfaiss_1_1IndexIVFPQ"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3093a0a3e128eafce6e0583b75e9662e"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFPQ.html#a3093a0a3e128eafce6e0583b75e9662e">polysemous_ht</a></td></tr>
|
|
<tr class="memdesc:a3093a0a3e128eafce6e0583b75e9662e inherit pub_attribs_structfaiss_1_1IndexIVFPQ"><td class="mdescLeft"> </td><td class="mdescRight">Hamming thresh for polysemous filtering. <br/></td></tr>
|
|
<tr class="separator:a3093a0a3e128eafce6e0583b75e9662e inherit pub_attribs_structfaiss_1_1IndexIVFPQ"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9b310195d610c3e326471b3758206b59 inherit pub_attribs_structfaiss_1_1IndexIVFPQ"><td class="memItemLeft" align="right" valign="top">std::vector< float > </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFPQ.html#a9b310195d610c3e326471b3758206b59">precomputed_table</a></td></tr>
|
|
<tr class="separator:a9b310195d610c3e326471b3758206b59 inherit pub_attribs_structfaiss_1_1IndexIVFPQ"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_attribs_structfaiss_1_1IndexIVF"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_structfaiss_1_1IndexIVF')"><img src="closed.png" alt="-"/> Public Attributes inherited from <a class="el" href="structfaiss_1_1IndexIVF.html">faiss::IndexIVF</a></td></tr>
|
|
<tr class="memitem:ab38fde4c923abefc4185eb7450b5b95b inherit pub_attribs_structfaiss_1_1IndexIVF"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab38fde4c923abefc4185eb7450b5b95b"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVF.html#ab38fde4c923abefc4185eb7450b5b95b">nlist</a></td></tr>
|
|
<tr class="memdesc:ab38fde4c923abefc4185eb7450b5b95b inherit pub_attribs_structfaiss_1_1IndexIVF"><td class="mdescLeft"> </td><td class="mdescRight">number of possible key values <br/></td></tr>
|
|
<tr class="separator:ab38fde4c923abefc4185eb7450b5b95b inherit pub_attribs_structfaiss_1_1IndexIVF"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:affed235eadf27a13d753ee4d33a1dc58 inherit pub_attribs_structfaiss_1_1IndexIVF"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="affed235eadf27a13d753ee4d33a1dc58"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVF.html#affed235eadf27a13d753ee4d33a1dc58">nprobe</a></td></tr>
|
|
<tr class="memdesc:affed235eadf27a13d753ee4d33a1dc58 inherit pub_attribs_structfaiss_1_1IndexIVF"><td class="mdescLeft"> </td><td class="mdescRight">number of probes at query time <br/></td></tr>
|
|
<tr class="separator:affed235eadf27a13d753ee4d33a1dc58 inherit pub_attribs_structfaiss_1_1IndexIVF"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4b40cc7a70dff41196a3b8769586667a inherit pub_attribs_structfaiss_1_1IndexIVF"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4b40cc7a70dff41196a3b8769586667a"></a>
|
|
<a class="el" href="structfaiss_1_1Index.html">Index</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVF.html#a4b40cc7a70dff41196a3b8769586667a">quantizer</a></td></tr>
|
|
<tr class="memdesc:a4b40cc7a70dff41196a3b8769586667a inherit pub_attribs_structfaiss_1_1IndexIVF"><td class="mdescLeft"> </td><td class="mdescRight">quantizer that maps vectors to inverted lists <br/></td></tr>
|
|
<tr class="separator:a4b40cc7a70dff41196a3b8769586667a inherit pub_attribs_structfaiss_1_1IndexIVF"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a28c248ae6a2b0991c012ab7abe13574a inherit pub_attribs_structfaiss_1_1IndexIVF"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVF.html#a28c248ae6a2b0991c012ab7abe13574a">quantizer_trains_alone</a></td></tr>
|
|
<tr class="separator:a28c248ae6a2b0991c012ab7abe13574a inherit pub_attribs_structfaiss_1_1IndexIVF"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aed2e9757ad5f3c234fd8ad60175a2a73 inherit pub_attribs_structfaiss_1_1IndexIVF"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aed2e9757ad5f3c234fd8ad60175a2a73"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVF.html#aed2e9757ad5f3c234fd8ad60175a2a73">own_fields</a></td></tr>
|
|
<tr class="memdesc:aed2e9757ad5f3c234fd8ad60175a2a73 inherit pub_attribs_structfaiss_1_1IndexIVF"><td class="mdescLeft"> </td><td class="mdescRight">whether object owns the quantizer <br/></td></tr>
|
|
<tr class="separator:aed2e9757ad5f3c234fd8ad60175a2a73 inherit pub_attribs_structfaiss_1_1IndexIVF"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9746bcd42ecec1501f221e918b25e8e7 inherit pub_attribs_structfaiss_1_1IndexIVF"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9746bcd42ecec1501f221e918b25e8e7"></a>
|
|
<a class="el" href="structfaiss_1_1ClusteringParameters.html">ClusteringParameters</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVF.html#a9746bcd42ecec1501f221e918b25e8e7">cp</a></td></tr>
|
|
<tr class="memdesc:a9746bcd42ecec1501f221e918b25e8e7 inherit pub_attribs_structfaiss_1_1IndexIVF"><td class="mdescLeft"> </td><td class="mdescRight">to override default clustering params <br/></td></tr>
|
|
<tr class="separator:a9746bcd42ecec1501f221e918b25e8e7 inherit pub_attribs_structfaiss_1_1IndexIVF"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9795f618f962afbb79681b4af36d1d86 inherit pub_attribs_structfaiss_1_1IndexIVF"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9795f618f962afbb79681b4af36d1d86"></a>
|
|
<a class="el" href="structfaiss_1_1Index.html">Index</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVF.html#a9795f618f962afbb79681b4af36d1d86">clustering_index</a></td></tr>
|
|
<tr class="memdesc:a9795f618f962afbb79681b4af36d1d86 inherit pub_attribs_structfaiss_1_1IndexIVF"><td class="mdescLeft"> </td><td class="mdescRight">to override index used during clustering <br/></td></tr>
|
|
<tr class="separator:a9795f618f962afbb79681b4af36d1d86 inherit pub_attribs_structfaiss_1_1IndexIVF"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af16d325f5bef22b2e5f90ceea796e80d inherit pub_attribs_structfaiss_1_1IndexIVF"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af16d325f5bef22b2e5f90ceea796e80d"></a>
|
|
std::vector< std::vector< long > > </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVF.html#af16d325f5bef22b2e5f90ceea796e80d">ids</a></td></tr>
|
|
<tr class="memdesc:af16d325f5bef22b2e5f90ceea796e80d inherit pub_attribs_structfaiss_1_1IndexIVF"><td class="mdescLeft"> </td><td class="mdescRight">Inverted lists for indexes. <br/></td></tr>
|
|
<tr class="separator:af16d325f5bef22b2e5f90ceea796e80d inherit pub_attribs_structfaiss_1_1IndexIVF"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a46d1aeddb60643c5b3f096147c3e028f inherit pub_attribs_structfaiss_1_1IndexIVF"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a46d1aeddb60643c5b3f096147c3e028f"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVF.html#a46d1aeddb60643c5b3f096147c3e028f">code_size</a></td></tr>
|
|
<tr class="memdesc:a46d1aeddb60643c5b3f096147c3e028f inherit pub_attribs_structfaiss_1_1IndexIVF"><td class="mdescLeft"> </td><td class="mdescRight">code size per vector in bytes <br/></td></tr>
|
|
<tr class="separator:a46d1aeddb60643c5b3f096147c3e028f inherit pub_attribs_structfaiss_1_1IndexIVF"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3ab3b0d0c941980ec554fc239e4cbfdd inherit pub_attribs_structfaiss_1_1IndexIVF"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3ab3b0d0c941980ec554fc239e4cbfdd"></a>
|
|
std::vector< std::vector<br class="typebreak"/>
|
|
< uint8_t > > </td><td class="memItemRight" valign="bottom"><b>codes</b></td></tr>
|
|
<tr class="separator:a3ab3b0d0c941980ec554fc239e4cbfdd inherit pub_attribs_structfaiss_1_1IndexIVF"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aedd0c14b5654295b291638ec7f9f9517 inherit pub_attribs_structfaiss_1_1IndexIVF"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aedd0c14b5654295b291638ec7f9f9517"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVF.html#aedd0c14b5654295b291638ec7f9f9517">maintain_direct_map</a></td></tr>
|
|
<tr class="memdesc:aedd0c14b5654295b291638ec7f9f9517 inherit pub_attribs_structfaiss_1_1IndexIVF"><td class="mdescLeft"> </td><td class="mdescRight">map for direct access to the elements. Enables <a class="el" href="structfaiss_1_1Index.html#aaef6f4132b1f390121ebb11058baf190">reconstruct()</a>. <br/></td></tr>
|
|
<tr class="separator:aedd0c14b5654295b291638ec7f9f9517 inherit pub_attribs_structfaiss_1_1IndexIVF"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a59fcfc4625260315c6423adc21d31ce9 inherit pub_attribs_structfaiss_1_1IndexIVF"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a59fcfc4625260315c6423adc21d31ce9"></a>
|
|
std::vector< long > </td><td class="memItemRight" valign="bottom"><b>direct_map</b></td></tr>
|
|
<tr class="separator:a59fcfc4625260315c6423adc21d31ce9 inherit pub_attribs_structfaiss_1_1IndexIVF"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_attribs_structfaiss_1_1Index"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_structfaiss_1_1Index')"><img src="closed.png" alt="-"/> Public Attributes inherited from <a class="el" href="structfaiss_1_1Index.html">faiss::Index</a></td></tr>
|
|
<tr class="memitem:a2a002388d2c081c2dbab8508dcefe73d inherit pub_attribs_structfaiss_1_1Index"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2a002388d2c081c2dbab8508dcefe73d"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1Index.html#a2a002388d2c081c2dbab8508dcefe73d">d</a></td></tr>
|
|
<tr class="memdesc:a2a002388d2c081c2dbab8508dcefe73d inherit pub_attribs_structfaiss_1_1Index"><td class="mdescLeft"> </td><td class="mdescRight">vector dimension <br/></td></tr>
|
|
<tr class="separator:a2a002388d2c081c2dbab8508dcefe73d inherit pub_attribs_structfaiss_1_1Index"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6970683faa021b7a6f1a0865c0d4eccd inherit pub_attribs_structfaiss_1_1Index"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6970683faa021b7a6f1a0865c0d4eccd"></a>
|
|
<a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1Index.html#a6970683faa021b7a6f1a0865c0d4eccd">ntotal</a></td></tr>
|
|
<tr class="memdesc:a6970683faa021b7a6f1a0865c0d4eccd inherit pub_attribs_structfaiss_1_1Index"><td class="mdescLeft"> </td><td class="mdescRight">total nb of indexed vectors <br/></td></tr>
|
|
<tr class="separator:a6970683faa021b7a6f1a0865c0d4eccd inherit pub_attribs_structfaiss_1_1Index"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5590d847c5c2b958affd2a05e58a6f23 inherit pub_attribs_structfaiss_1_1Index"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5590d847c5c2b958affd2a05e58a6f23"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1Index.html#a5590d847c5c2b958affd2a05e58a6f23">verbose</a></td></tr>
|
|
<tr class="memdesc:a5590d847c5c2b958affd2a05e58a6f23 inherit pub_attribs_structfaiss_1_1Index"><td class="mdescLeft"> </td><td class="mdescRight">verbosity level <br/></td></tr>
|
|
<tr class="separator:a5590d847c5c2b958affd2a05e58a6f23 inherit pub_attribs_structfaiss_1_1Index"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6e92732617c4dbe364e7678dd8773a7f inherit pub_attribs_structfaiss_1_1Index"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6e92732617c4dbe364e7678dd8773a7f"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1Index.html#a6e92732617c4dbe364e7678dd8773a7f">is_trained</a></td></tr>
|
|
<tr class="memdesc:a6e92732617c4dbe364e7678dd8773a7f inherit pub_attribs_structfaiss_1_1Index"><td class="mdescLeft"> </td><td class="mdescRight">set if the <a class="el" href="structfaiss_1_1Index.html">Index</a> does not require training, or if training is done already <br/></td></tr>
|
|
<tr class="separator:a6e92732617c4dbe364e7678dd8773a7f inherit pub_attribs_structfaiss_1_1Index"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8e18f641854b2bde83ecff0a2f9a6f4e inherit pub_attribs_structfaiss_1_1Index"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8e18f641854b2bde83ecff0a2f9a6f4e"></a>
|
|
<a class="el" href="namespacefaiss.html#afd12191c638da74760ff397cf319752c">MetricType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1Index.html#a8e18f641854b2bde83ecff0a2f9a6f4e">metric_type</a></td></tr>
|
|
<tr class="memdesc:a8e18f641854b2bde83ecff0a2f9a6f4e inherit pub_attribs_structfaiss_1_1Index"><td class="mdescLeft"> </td><td class="mdescRight">type of metric this index uses for search <br/></td></tr>
|
|
<tr class="separator:a8e18f641854b2bde83ecff0a2f9a6f4e inherit pub_attribs_structfaiss_1_1Index"><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_1Index"><td colspan="2" onclick="javascript:toggleInherit('pub_types_structfaiss_1_1Index')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="structfaiss_1_1Index.html">faiss::Index</a></td></tr>
|
|
<tr class="memitem:a040c6aed1f224f3ea7bf58eebc0c31a4 inherit pub_types_structfaiss_1_1Index"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a040c6aed1f224f3ea7bf58eebc0c31a4"></a>
|
|
typedef long </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a></td></tr>
|
|
<tr class="memdesc:a040c6aed1f224f3ea7bf58eebc0c31a4 inherit pub_types_structfaiss_1_1Index"><td class="mdescLeft"> </td><td class="mdescRight">all indices are this type <br/></td></tr>
|
|
<tr class="separator:a040c6aed1f224f3ea7bf58eebc0c31a4 inherit pub_types_structfaiss_1_1Index"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p><a class="el" href="structfaiss_1_1Index.html">Index</a> with an additional level of PQ refinement </p>
|
|
|
|
<p>Definition at line <a class="el" href="IndexIVFPQ_8h_source.html#l00168">168</a> of file <a class="el" href="IndexIVFPQ_8h_source.html">IndexIVFPQ.h</a>.</p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a4b6154a5194d574d037ba78c137a2fa5"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void faiss::IndexIVFPQR::add_with_ids </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> </td>
|
|
<td class="paramname"><em>n</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const float * </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const long * </td>
|
|
<td class="paramname"><em>xids</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></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>Same as add, but stores xids instead of sequential ids.</p>
|
|
<p>The default implementation fails with an assertion, as it is not supported by all indexes.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">xids</td><td>if non-null, ids to store for the vectors (size n) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="structfaiss_1_1IndexIVFPQ.html#a981c2748bfbd9b018494f119279a0342">faiss::IndexIVFPQ</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="IndexIVFPQ_8cpp_source.html#l01189">1189</a> of file <a class="el" href="IndexIVFPQ_8cpp_source.html">IndexIVFPQ.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a31a1fec2a88b410ea96ce5be7d527be9"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void faiss::IndexIVFPQR::merge_from </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structfaiss_1_1IndexIVF.html">IndexIVF</a> & </td>
|
|
<td class="paramname"><em>other</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> </td>
|
|
<td class="paramname"><em>add_id</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></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>moves the entries from another dataset to self. On output, other is empty. add_id is added to all moved ids (for sequential ids, this would be this->ntotal </p>
|
|
|
|
<p>Reimplemented from <a class="el" href="structfaiss_1_1IndexIVF.html#a0f22cc237c30c935df5b6560aecf8f01">faiss::IndexIVF</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="IndexIVFPQ_8cpp_source.html#l01320">1320</a> of file <a class="el" href="IndexIVFPQ_8cpp_source.html">IndexIVFPQ.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0f0d8fc6b2c6aa2431c1730111a3b22a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void faiss::IndexIVFPQR::reconstruct_n </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> </td>
|
|
<td class="paramname"><em>i0</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> </td>
|
|
<td class="paramname"><em>ni</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float * </td>
|
|
<td class="paramname"><em>recons</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>Reconstruct a subset of the indexed vectors</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">i0</td><td>first vector to reconstruct </td></tr>
|
|
<tr><td class="paramname">ni</td><td>nb of vectors to reconstruct </td></tr>
|
|
<tr><td class="paramname">recons</td><td>output array of reconstructed vectors, size ni * d </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="structfaiss_1_1IndexIVFPQ.html#a1df10e9e5f4ff0dabf283f19ad94bbd4">faiss::IndexIVFPQ</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="IndexIVFPQ_8cpp_source.html#l01301">1301</a> of file <a class="el" href="IndexIVFPQ_8cpp_source.html">IndexIVFPQ.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a3e982ee6f1a3a025148270701867d04f"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void faiss::IndexIVFPQR::search </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> </td>
|
|
<td class="paramname"><em>n</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const float * </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> </td>
|
|
<td class="paramname"><em>k</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float * </td>
|
|
<td class="paramname"><em>distances</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> * </td>
|
|
<td class="paramname"><em>labels</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>assign the vectors, then call search_preassign </p>
|
|
|
|
<p>Reimplemented from <a class="el" href="structfaiss_1_1IndexIVF.html#ae2fd47b7d52603659e269aa8f6abb613">faiss::IndexIVF</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="IndexIVFPQ_8cpp_source.html#l01212">1212</a> of file <a class="el" href="IndexIVFPQ_8cpp_source.html">IndexIVFPQ.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="IndexIVFPQ_8h_source.html">IndexIVFPQ.h</a></li>
|
|
<li>/data/users/matthijs/github_faiss/faiss/<a class="el" href="IndexIVFPQ_8cpp_source.html">IndexIVFPQ.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>
|