359 lines
45 KiB
HTML
359 lines
45 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::IndexIVFFlatIPBounds 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_1IndexIVFFlatIPBounds.html">IndexIVFFlatIPBounds</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_1IndexIVFFlatIPBounds-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">faiss::IndexIVFFlatIPBounds Struct Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="dynheader">
|
|
Inheritance diagram for faiss::IndexIVFFlatIPBounds:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="structfaiss_1_1IndexIVFFlatIPBounds.png" usemap="#faiss::IndexIVFFlatIPBounds_map" alt=""/>
|
|
<map id="faiss::IndexIVFFlatIPBounds_map" name="faiss::IndexIVFFlatIPBounds_map">
|
|
<area href="structfaiss_1_1IndexIVFFlat.html" alt="faiss::IndexIVFFlat" shape="rect" coords="0,112,168,136"/>
|
|
<area href="structfaiss_1_1IndexIVF.html" alt="faiss::IndexIVF" shape="rect" coords="0,56,168,80"/>
|
|
<area href="structfaiss_1_1Index.html" alt="faiss::Index" shape="rect" coords="0,0,168,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:ad0036dc8f970f28bb539ee6a3056383f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad0036dc8f970f28bb539ee6a3056383f"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>IndexIVFFlatIPBounds</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 <a class="el" href="structfaiss_1_1IndexIVFFlatIPBounds.html#a32e550879d0bf5eecf0a939eb25b3c0c">fsize</a>)</td></tr>
|
|
<tr class="separator:ad0036dc8f970f28bb539ee6a3056383f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a938285c16dafe294775643b820637444"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a938285c16dafe294775643b820637444"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFFlatIPBounds.html#a938285c16dafe294775643b820637444">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) override</td></tr>
|
|
<tr class="memdesc:a938285c16dafe294775643b820637444"><td class="mdescLeft"> </td><td class="mdescRight">same as add_with_ids, with precomputed coarse quantizer <br/></td></tr>
|
|
<tr class="separator:a938285c16dafe294775643b820637444"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aac063e96413e0e90d87898df8a60088b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFFlatIPBounds.html#aac063e96413e0e90d87898df8a60088b">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:aac063e96413e0e90d87898df8a60088b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_structfaiss_1_1IndexIVFFlat"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structfaiss_1_1IndexIVFFlat')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="structfaiss_1_1IndexIVFFlat.html">faiss::IndexIVFFlat</a></td></tr>
|
|
<tr class="memitem:ad6aeb14ca27bdd344912ebf5da70ea47 inherit pub_methods_structfaiss_1_1IndexIVFFlat"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad6aeb14ca27bdd344912ebf5da70ea47"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>IndexIVFFlat</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 nlist_, <a class="el" href="namespacefaiss.html#afd12191c638da74760ff397cf319752c">MetricType</a>=METRIC_INNER_PRODUCT)</td></tr>
|
|
<tr class="separator:ad6aeb14ca27bdd344912ebf5da70ea47 inherit pub_methods_structfaiss_1_1IndexIVFFlat"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5f7356766632d3ce2838f285aa6b8e76 inherit pub_methods_structfaiss_1_1IndexIVFFlat"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5f7356766632d3ce2838f285aa6b8e76"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFFlat.html#a5f7356766632d3ce2838f285aa6b8e76">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="memdesc:a5f7356766632d3ce2838f285aa6b8e76 inherit pub_methods_structfaiss_1_1IndexIVFFlat"><td class="mdescLeft"> </td><td class="mdescRight">implemented for all IndexIVF* classes <br/></td></tr>
|
|
<tr class="separator:a5f7356766632d3ce2838f285aa6b8e76 inherit pub_methods_structfaiss_1_1IndexIVFFlat"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7a280ade19868bc3e0b7db6181a0e792 inherit pub_methods_structfaiss_1_1IndexIVFFlat"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7a280ade19868bc3e0b7db6181a0e792"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFFlat.html#a7a280ade19868bc3e0b7db6181a0e792">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>, float *distances, <a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> *labels) const </td></tr>
|
|
<tr class="memdesc:a7a280ade19868bc3e0b7db6181a0e792 inherit pub_methods_structfaiss_1_1IndexIVFFlat"><td class="mdescLeft"> </td><td class="mdescRight">perform search, without computing the assignment to the quantizer <br/></td></tr>
|
|
<tr class="separator:a7a280ade19868bc3e0b7db6181a0e792 inherit pub_methods_structfaiss_1_1IndexIVFFlat"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad2b306f160e153b5cfb572cf1d8ece24 inherit pub_methods_structfaiss_1_1IndexIVFFlat"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFFlat.html#ad2b306f160e153b5cfb572cf1d8ece24">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 override</td></tr>
|
|
<tr class="separator:ad2b306f160e153b5cfb572cf1d8ece24 inherit pub_methods_structfaiss_1_1IndexIVFFlat"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1d0a5285344c3302ba10bb79f4578a82 inherit pub_methods_structfaiss_1_1IndexIVFFlat"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFFlat.html#a1d0a5285344c3302ba10bb79f4578a82">copy_subset_to</a> (<a class="el" href="structfaiss_1_1IndexIVFFlat.html">IndexIVFFlat</a> &other, int subset_type, long a1, long a2) const </td></tr>
|
|
<tr class="separator:a1d0a5285344c3302ba10bb79f4578a82 inherit pub_methods_structfaiss_1_1IndexIVFFlat"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9df8b023486f54c8f2c5452787807360 inherit pub_methods_structfaiss_1_1IndexIVFFlat"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9df8b023486f54c8f2c5452787807360"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFFlat.html#a9df8b023486f54c8f2c5452787807360">reset</a> () override</td></tr>
|
|
<tr class="memdesc:a9df8b023486f54c8f2c5452787807360 inherit pub_methods_structfaiss_1_1IndexIVFFlat"><td class="mdescLeft"> </td><td class="mdescRight">removes all elements from the database. <br/></td></tr>
|
|
<tr class="separator:a9df8b023486f54c8f2c5452787807360 inherit pub_methods_structfaiss_1_1IndexIVFFlat"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a46ee62aabc316ec38882a3f54e594559 inherit pub_methods_structfaiss_1_1IndexIVFFlat"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFFlat.html#a46ee62aabc316ec38882a3f54e594559">remove_ids</a> (const <a class="el" href="structfaiss_1_1IDSelector.html">IDSelector</a> &sel) override</td></tr>
|
|
<tr class="separator:a46ee62aabc316ec38882a3f54e594559 inherit pub_methods_structfaiss_1_1IndexIVFFlat"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5ac4f051396a1535426baec8f401aa93 inherit pub_methods_structfaiss_1_1IndexIVFFlat"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5ac4f051396a1535426baec8f401aa93"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFFlat.html#a5ac4f051396a1535426baec8f401aa93">search_knn_inner_product</a> (size_t nx, const float *x, const long *keys, <a class="el" href="structfaiss_1_1HeapArray.html">float_minheap_array_t</a> *res) const </td></tr>
|
|
<tr class="memdesc:a5ac4f051396a1535426baec8f401aa93 inherit pub_methods_structfaiss_1_1IndexIVFFlat"><td class="mdescLeft"> </td><td class="mdescRight">Implementation of the search for the inner product metric. <br/></td></tr>
|
|
<tr class="separator:a5ac4f051396a1535426baec8f401aa93 inherit pub_methods_structfaiss_1_1IndexIVFFlat"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9ca8cc3ca71ff91f1e5e2db3b8ead615 inherit pub_methods_structfaiss_1_1IndexIVFFlat"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9ca8cc3ca71ff91f1e5e2db3b8ead615"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFFlat.html#a9ca8cc3ca71ff91f1e5e2db3b8ead615">search_knn_L2sqr</a> (size_t nx, const float *x, const long *keys, <a class="el" href="structfaiss_1_1HeapArray.html">float_maxheap_array_t</a> *res) const </td></tr>
|
|
<tr class="memdesc:a9ca8cc3ca71ff91f1e5e2db3b8ead615 inherit pub_methods_structfaiss_1_1IndexIVFFlat"><td class="mdescLeft"> </td><td class="mdescRight">Implementation of the search for the L2 metric. <br/></td></tr>
|
|
<tr class="separator:a9ca8cc3ca71ff91f1e5e2db3b8ead615 inherit pub_methods_structfaiss_1_1IndexIVFFlat"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2adc0b0002c32ddc01aec4ab96dd659f inherit pub_methods_structfaiss_1_1IndexIVFFlat"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFFlat.html#a2adc0b0002c32ddc01aec4ab96dd659f">update_vectors</a> (int nv, <a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> *idx, const float *v)</td></tr>
|
|
<tr class="separator:a2adc0b0002c32ddc01aec4ab96dd659f inherit pub_methods_structfaiss_1_1IndexIVFFlat"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af7aa8b40cae6d50317049a252df8fb44 inherit pub_methods_structfaiss_1_1IndexIVFFlat"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFFlat.html#af7aa8b40cae6d50317049a252df8fb44">reconstruct</a> (<a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> key, float *recons) const override</td></tr>
|
|
<tr class="separator:af7aa8b40cae6d50317049a252df8fb44 inherit pub_methods_structfaiss_1_1IndexIVFFlat"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8fc1695a87f33db1a16f8c50c3344cd3 inherit pub_methods_structfaiss_1_1IndexIVFFlat"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFFlat.html#a8fc1695a87f33db1a16f8c50c3344cd3">merge_from_residuals</a> (<a class="el" href="structfaiss_1_1IndexIVF.html">IndexIVF</a> &other) override</td></tr>
|
|
<tr class="separator:a8fc1695a87f33db1a16f8c50c3344cd3 inherit pub_methods_structfaiss_1_1IndexIVFFlat"><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:a567ef760fd09d09ce2ee4f4e6c2d7280 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#a567ef760fd09d09ce2ee4f4e6c2d7280">train_residual</a> (<a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> n, const float *x)</td></tr>
|
|
<tr class="separator:a567ef760fd09d09ce2ee4f4e6c2d7280 inherit pub_methods_structfaiss_1_1IndexIVF"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0f22cc237c30c935df5b6560aecf8f01 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#a0f22cc237c30c935df5b6560aecf8f01">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)</td></tr>
|
|
<tr class="separator:a0f22cc237c30c935df5b6560aecf8f01 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: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:a1936604fffe16b0ef2a3879305950738 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#a1936604fffe16b0ef2a3879305950738">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 </td></tr>
|
|
<tr class="separator:a1936604fffe16b0ef2a3879305950738 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:a32e550879d0bf5eecf0a939eb25b3c0c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a32e550879d0bf5eecf0a939eb25b3c0c"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFFlatIPBounds.html#a32e550879d0bf5eecf0a939eb25b3c0c">fsize</a></td></tr>
|
|
<tr class="memdesc:a32e550879d0bf5eecf0a939eb25b3c0c"><td class="mdescLeft"> </td><td class="mdescRight">nb of dimensions of pre-filter <br/></td></tr>
|
|
<tr class="separator:a32e550879d0bf5eecf0a939eb25b3c0c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a07b988f02cc2f6fc3eb951609bfc0817"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a07b988f02cc2f6fc3eb951609bfc0817"></a>
|
|
std::vector< std::vector< float > > </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFFlatIPBounds.html#a07b988f02cc2f6fc3eb951609bfc0817">part_norms</a></td></tr>
|
|
<tr class="memdesc:a07b988f02cc2f6fc3eb951609bfc0817"><td class="mdescLeft"> </td><td class="mdescRight">norm of remainder (dimensions fsize:d) <br/></td></tr>
|
|
<tr class="separator:a07b988f02cc2f6fc3eb951609bfc0817"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_attribs_structfaiss_1_1IndexIVFFlat"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_structfaiss_1_1IndexIVFFlat')"><img src="closed.png" alt="-"/> Public Attributes inherited from <a class="el" href="structfaiss_1_1IndexIVFFlat.html">faiss::IndexIVFFlat</a></td></tr>
|
|
<tr class="memitem:a52f87a2c6a9282b5b74a8615fef1b4b7 inherit pub_attribs_structfaiss_1_1IndexIVFFlat"><td class="memItemLeft" align="right" valign="top">std::vector< std::vector< float > > </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVFFlat.html#a52f87a2c6a9282b5b74a8615fef1b4b7">vecs</a></td></tr>
|
|
<tr class="separator:a52f87a2c6a9282b5b74a8615fef1b4b7 inherit pub_attribs_structfaiss_1_1IndexIVFFlat"><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:a23ee7f75f8be4472a17778f2b33875de inherit pub_attribs_structfaiss_1_1IndexIVF"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a23ee7f75f8be4472a17778f2b33875de"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexIVF.html#a23ee7f75f8be4472a17778f2b33875de">quantizer_trains_alone</a></td></tr>
|
|
<tr class="memdesc:a23ee7f75f8be4472a17778f2b33875de inherit pub_attribs_structfaiss_1_1IndexIVF"><td class="mdescLeft"> </td><td class="mdescRight">just pass over the trainset to quantizer <br/></td></tr>
|
|
<tr class="separator:a23ee7f75f8be4472a17778f2b33875de 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: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: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>Definition at line <a class="el" href="IndexIVF_8h_source.html#l00207">207</a> of file <a class="el" href="IndexIVF_8h_source.html">IndexIVF.h</a>.</p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="aac063e96413e0e90d87898df8a60088b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void faiss::IndexIVFFlatIPBounds::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>query n vectors of dimension d to the index.</p>
|
|
<p>return at most k vectors. If there are not enough results for a query, the result array is padded with -1s.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">x</td><td>input vectors to search, size n * d </td></tr>
|
|
<tr><td class="paramname">labels</td><td>output labels of the NNs, size n*k </td></tr>
|
|
<tr><td class="paramname">distances</td><td>output pairwise distances, size n*k </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="structfaiss_1_1IndexIVFFlat.html#acd2bdb06fcbe9d1f5799cf78aa6cdf0d">faiss::IndexIVFFlat</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="IndexIVF_8cpp_source.html#l00693">693</a> of file <a class="el" href="IndexIVF_8cpp_source.html">IndexIVF.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct was generated from the following files:<ul>
|
|
<li>/data/users/matthijs/github_faiss/faiss/<a class="el" href="IndexIVF_8h_source.html">IndexIVF.h</a></li>
|
|
<li>/data/users/matthijs/github_faiss/faiss/<a class="el" href="IndexIVF_8cpp_source.html">IndexIVF.cpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.5
|
|
</small></address>
|
|
</body>
|
|
</html>
|