243 lines
31 KiB
HTML
243 lines
31 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::IndexHNSWPQ 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_1IndexHNSWPQ.html">IndexHNSWPQ</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="structfaiss_1_1IndexHNSWPQ-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">faiss::IndexHNSWPQ Struct Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code>#include <<a class="el" href="IndexHNSW_8h_source.html">IndexHNSW.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for faiss::IndexHNSWPQ:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="structfaiss_1_1IndexHNSWPQ.png" usemap="#faiss::IndexHNSWPQ_map" alt=""/>
|
|
<map id="faiss::IndexHNSWPQ_map" name="faiss::IndexHNSWPQ_map">
|
|
<area href="structfaiss_1_1IndexHNSW.html" alt="faiss::IndexHNSW" shape="rect" coords="0,56,129,80"/>
|
|
<area href="structfaiss_1_1Index.html" alt="faiss::Index" shape="rect" coords="0,0,129,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:a12e170ee06d954c267e5352b9b050bfd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a12e170ee06d954c267e5352b9b050bfd"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>IndexHNSWPQ</b> (int <a class="el" href="structfaiss_1_1Index.html#a2a002388d2c081c2dbab8508dcefe73d">d</a>, int pq_m, int M)</td></tr>
|
|
<tr class="separator:a12e170ee06d954c267e5352b9b050bfd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae99b976eeb25717d10055b1786aa011c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae99b976eeb25717d10055b1786aa011c"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexHNSWPQ.html#ae99b976eeb25717d10055b1786aa011c">train</a> (<a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> n, const float *x) override</td></tr>
|
|
<tr class="memdesc:ae99b976eeb25717d10055b1786aa011c"><td class="mdescLeft"> </td><td class="mdescRight">Trains the storage if needed. <br/></td></tr>
|
|
<tr class="separator:ae99b976eeb25717d10055b1786aa011c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a999f5459e91766a6165be0a112d96ced"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a999f5459e91766a6165be0a112d96ced"></a>
|
|
<a class="el" href="structfaiss_1_1HNSW_1_1DistanceComputer.html">HNSW::DistanceComputer</a> * </td><td class="memItemRight" valign="bottom"><b>get_distance_computer</b> () const override</td></tr>
|
|
<tr class="separator:a999f5459e91766a6165be0a112d96ced"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_structfaiss_1_1IndexHNSW"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structfaiss_1_1IndexHNSW')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="structfaiss_1_1IndexHNSW.html">faiss::IndexHNSW</a></td></tr>
|
|
<tr class="memitem:ac3096b022ac94a7d6016642942933928 inherit pub_methods_structfaiss_1_1IndexHNSW"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac3096b022ac94a7d6016642942933928"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>IndexHNSW</b> (int <a class="el" href="structfaiss_1_1Index.html#a2a002388d2c081c2dbab8508dcefe73d">d</a>=0, int M=32)</td></tr>
|
|
<tr class="separator:ac3096b022ac94a7d6016642942933928 inherit pub_methods_structfaiss_1_1IndexHNSW"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a74d1ec193f1749a55ec83b6c7779119c inherit pub_methods_structfaiss_1_1IndexHNSW"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a74d1ec193f1749a55ec83b6c7779119c"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>IndexHNSW</b> (<a class="el" href="structfaiss_1_1Index.html">Index</a> *storage, int M=32)</td></tr>
|
|
<tr class="separator:a74d1ec193f1749a55ec83b6c7779119c inherit pub_methods_structfaiss_1_1IndexHNSW"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a04a761ce17d0f9040b3bc8a77bd627d9 inherit pub_methods_structfaiss_1_1IndexHNSW"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexHNSW.html#a04a761ce17d0f9040b3bc8a77bd627d9">add</a> (<a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> n, const float *x) override</td></tr>
|
|
<tr class="separator:a04a761ce17d0f9040b3bc8a77bd627d9 inherit pub_methods_structfaiss_1_1IndexHNSW"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae0ddf6ab4a54239a25d6277e21e8548e inherit pub_methods_structfaiss_1_1IndexHNSW"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae0ddf6ab4a54239a25d6277e21e8548e"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexHNSW.html#ae0ddf6ab4a54239a25d6277e21e8548e">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="memdesc:ae0ddf6ab4a54239a25d6277e21e8548e inherit pub_methods_structfaiss_1_1IndexHNSW"><td class="mdescLeft"> </td><td class="mdescRight">entry point for search <br/></td></tr>
|
|
<tr class="separator:ae0ddf6ab4a54239a25d6277e21e8548e inherit pub_methods_structfaiss_1_1IndexHNSW"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a660e5c8de1ba9c71bf3fe1f3bf0c8812 inherit pub_methods_structfaiss_1_1IndexHNSW"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexHNSW.html#a660e5c8de1ba9c71bf3fe1f3bf0c8812">reconstruct</a> (<a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> key, float *recons) const override</td></tr>
|
|
<tr class="separator:a660e5c8de1ba9c71bf3fe1f3bf0c8812 inherit pub_methods_structfaiss_1_1IndexHNSW"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad4b9f97d42e2521e01f8b60012985396 inherit pub_methods_structfaiss_1_1IndexHNSW"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad4b9f97d42e2521e01f8b60012985396"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexHNSW.html#ad4b9f97d42e2521e01f8b60012985396">reset</a> () override</td></tr>
|
|
<tr class="memdesc:ad4b9f97d42e2521e01f8b60012985396 inherit pub_methods_structfaiss_1_1IndexHNSW"><td class="mdescLeft"> </td><td class="mdescRight">removes all elements from the database. <br/></td></tr>
|
|
<tr class="separator:ad4b9f97d42e2521e01f8b60012985396 inherit pub_methods_structfaiss_1_1IndexHNSW"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a37f79ff64b8aa13977c1b4dbccf3eec6 inherit pub_methods_structfaiss_1_1IndexHNSW"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a37f79ff64b8aa13977c1b4dbccf3eec6"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>shrink_level_0_neighbors</b> (int size)</td></tr>
|
|
<tr class="separator:a37f79ff64b8aa13977c1b4dbccf3eec6 inherit pub_methods_structfaiss_1_1IndexHNSW"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5b619a41ddd52f0377efb701829c1e43 inherit pub_methods_structfaiss_1_1IndexHNSW"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexHNSW.html#a5b619a41ddd52f0377efb701829c1e43">search_level_0</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 storage_idx_t *nearest, const float *nearest_d, float *distances, <a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> *labels, int nprobe=1, int search_type=1) const </td></tr>
|
|
<tr class="separator:a5b619a41ddd52f0377efb701829c1e43 inherit pub_methods_structfaiss_1_1IndexHNSW"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9a86c58212f3f9cf88394f5297cba525 inherit pub_methods_structfaiss_1_1IndexHNSW"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9a86c58212f3f9cf88394f5297cba525"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexHNSW.html#a9a86c58212f3f9cf88394f5297cba525">init_level_0_from_knngraph</a> (int k, const float *D, const <a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> *I)</td></tr>
|
|
<tr class="memdesc:a9a86c58212f3f9cf88394f5297cba525 inherit pub_methods_structfaiss_1_1IndexHNSW"><td class="mdescLeft"> </td><td class="mdescRight">alternative graph building <br/></td></tr>
|
|
<tr class="separator:a9a86c58212f3f9cf88394f5297cba525 inherit pub_methods_structfaiss_1_1IndexHNSW"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab9c75063090927f8f65d1896b6949af4 inherit pub_methods_structfaiss_1_1IndexHNSW"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab9c75063090927f8f65d1896b6949af4"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1IndexHNSW.html#ab9c75063090927f8f65d1896b6949af4">init_level_0_from_entry_points</a> (int npt, const storage_idx_t *points, const storage_idx_t *nearests)</td></tr>
|
|
<tr class="memdesc:ab9c75063090927f8f65d1896b6949af4 inherit pub_methods_structfaiss_1_1IndexHNSW"><td class="mdescLeft"> </td><td class="mdescRight">alternative graph building <br/></td></tr>
|
|
<tr class="separator:ab9c75063090927f8f65d1896b6949af4 inherit pub_methods_structfaiss_1_1IndexHNSW"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a949f66fe1ed3f6256d0d84cf532fade8 inherit pub_methods_structfaiss_1_1IndexHNSW"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a949f66fe1ed3f6256d0d84cf532fade8"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>reorder_links</b> ()</td></tr>
|
|
<tr class="separator:a949f66fe1ed3f6256d0d84cf532fade8 inherit pub_methods_structfaiss_1_1IndexHNSW"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2c0277b782f0f16ae33e30a1450bd8d3 inherit pub_methods_structfaiss_1_1IndexHNSW"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2c0277b782f0f16ae33e30a1450bd8d3"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>link_singletons</b> ()</td></tr>
|
|
<tr class="separator:a2c0277b782f0f16ae33e30a1450bd8d3 inherit pub_methods_structfaiss_1_1IndexHNSW"><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:a7b8cc435b5619d5d8382010a424bf67e inherit pub_methods_structfaiss_1_1Index"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7b8cc435b5619d5d8382010a424bf67e"></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_L2)</td></tr>
|
|
<tr class="separator:a7b8cc435b5619d5d8382010a424bf67e inherit pub_methods_structfaiss_1_1Index"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa6931dfe054b33b02c842ff75f7a0c7f 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#aa6931dfe054b33b02c842ff75f7a0c7f">add_with_ids</a> (<a class="el" href="structfaiss_1_1Index.html#a040c6aed1f224f3ea7bf58eebc0c31a4">idx_t</a> n, const float *x, const long *xids)</td></tr>
|
|
<tr class="separator:aa6931dfe054b33b02c842ff75f7a0c7f 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:af8bf7bd97aeed8ad5fc48b242379a68a inherit pub_methods_structfaiss_1_1Index"><td class="memItemLeft" align="right" valign="top">virtual long </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1Index.html#af8bf7bd97aeed8ad5fc48b242379a68a">remove_ids</a> (const <a class="el" href="structfaiss_1_1IDSelector.html">IDSelector</a> &sel)</td></tr>
|
|
<tr class="separator:af8bf7bd97aeed8ad5fc48b242379a68a 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:aa5b4e63e1064f9bf9c75625d114b353f 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#aa5b4e63e1064f9bf9c75625d114b353f">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 *recons) const </td></tr>
|
|
<tr class="separator:aa5b4e63e1064f9bf9c75625d114b353f 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="inherited"></a>
|
|
Additional Inherited Members</h2></td></tr>
|
|
<tr class="inherit_header pub_types_structfaiss_1_1IndexHNSW"><td colspan="2" onclick="javascript:toggleInherit('pub_types_structfaiss_1_1IndexHNSW')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="structfaiss_1_1IndexHNSW.html">faiss::IndexHNSW</a></td></tr>
|
|
<tr class="memitem:ad2da92276e4caf988c696f9a32981021 inherit pub_types_structfaiss_1_1IndexHNSW"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad2da92276e4caf988c696f9a32981021"></a>
|
|
typedef <a class="el" href="structfaiss_1_1HNSW.html#ae1342fc2f07c325598a73b733e88ee74">HNSW::storage_idx_t</a> </td><td class="memItemRight" valign="bottom"><b>storage_idx_t</b></td></tr>
|
|
<tr class="separator:ad2da92276e4caf988c696f9a32981021 inherit pub_types_structfaiss_1_1IndexHNSW"><td class="memSeparator" colspan="2"> </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>
|
|
<tr class="inherit_header pub_attribs_structfaiss_1_1IndexHNSW"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_structfaiss_1_1IndexHNSW')"><img src="closed.png" alt="-"/> Public Attributes inherited from <a class="el" href="structfaiss_1_1IndexHNSW.html">faiss::IndexHNSW</a></td></tr>
|
|
<tr class="memitem:a954090e224ed05cdec6f3ccab394c091 inherit pub_attribs_structfaiss_1_1IndexHNSW"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a954090e224ed05cdec6f3ccab394c091"></a>
|
|
<a class="el" href="structfaiss_1_1HNSW.html">HNSW</a> </td><td class="memItemRight" valign="bottom"><b>hnsw</b></td></tr>
|
|
<tr class="separator:a954090e224ed05cdec6f3ccab394c091 inherit pub_attribs_structfaiss_1_1IndexHNSW"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a96137d57aafb7275ebba0253d627a820 inherit pub_attribs_structfaiss_1_1IndexHNSW"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a96137d57aafb7275ebba0253d627a820"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>own_fields</b></td></tr>
|
|
<tr class="separator:a96137d57aafb7275ebba0253d627a820 inherit pub_attribs_structfaiss_1_1IndexHNSW"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2122830e5b8b02057bde264b74da6f00 inherit pub_attribs_structfaiss_1_1IndexHNSW"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2122830e5b8b02057bde264b74da6f00"></a>
|
|
<a class="el" href="structfaiss_1_1Index.html">Index</a> * </td><td class="memItemRight" valign="bottom"><b>storage</b></td></tr>
|
|
<tr class="separator:a2122830e5b8b02057bde264b74da6f00 inherit pub_attribs_structfaiss_1_1IndexHNSW"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeb9cbfc543b6d9f1cae90a49148aee69 inherit pub_attribs_structfaiss_1_1IndexHNSW"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeb9cbfc543b6d9f1cae90a49148aee69"></a>
|
|
<a class="el" href="structfaiss_1_1ReconstructFromNeighbors.html">ReconstructFromNeighbors</a> * </td><td class="memItemRight" valign="bottom"><b>reconstruct_from_neighbors</b></td></tr>
|
|
<tr class="separator:aeb9cbfc543b6d9f1cae90a49148aee69 inherit pub_attribs_structfaiss_1_1IndexHNSW"><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>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>PQ index topped with with a <a class="el" href="structfaiss_1_1HNSW.html">HNSW</a> structure to access elements more efficiently. </p>
|
|
|
|
<p>Definition at line <a class="el" href="IndexHNSW_8h_source.html#l00292">292</a> of file <a class="el" href="IndexHNSW_8h_source.html">IndexHNSW.h</a>.</p>
|
|
</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="IndexHNSW_8h_source.html">IndexHNSW.h</a></li>
|
|
<li>/data/users/matthijs/github_faiss/faiss/<a class="el" href="IndexHNSW_8cpp_source.html">IndexHNSW.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>
|