mirrors
/
faiss
mirror of https://github.com/facebookresearch/faiss.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
faiss/docs/html/classfaiss_1_1IndexReplicas...

490 lines
34 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>Faiss: faiss::IndexReplicasTemplate&lt; IndexT &gt; Class Template 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&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Friends</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacefaiss.html">faiss</a></li><li class="navelem"><a class="el" href="classfaiss_1_1IndexReplicasTemplate.html">IndexReplicasTemplate</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="classfaiss_1_1IndexReplicasTemplate-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">faiss::IndexReplicasTemplate&lt; IndexT &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="IndexReplicas_8h_source.html">IndexReplicas.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for faiss::IndexReplicasTemplate&lt; IndexT &gt;:</div>
<div class="dyncontent">
<div class="center">
<img src="classfaiss_1_1IndexReplicasTemplate.png" usemap="#faiss::IndexReplicasTemplate&lt; IndexT &gt;_map" alt=""/>
<map id="faiss::IndexReplicasTemplate&lt; IndexT &gt;_map" name="faiss::IndexReplicasTemplate&lt; IndexT &gt;_map">
<area href="classfaiss_1_1ThreadedIndex.html" alt="faiss::ThreadedIndex&lt; IndexT &gt;" shape="rect" coords="0,56,233,80"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ae8b631f7c3200cf1a02cd6e4397a50c9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae8b631f7c3200cf1a02cd6e4397a50c9"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>idx_t</b> = typename IndexT::idx_t</td></tr>
<tr class="separator:ae8b631f7c3200cf1a02cd6e4397a50c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa2482e6d6245830bad1cd29551262793"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa2482e6d6245830bad1cd29551262793"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>component_t</b> = typename IndexT::component_t</td></tr>
<tr class="separator:aa2482e6d6245830bad1cd29551262793"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33eb25784833dd8dbb24544d8043eec0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a33eb25784833dd8dbb24544d8043eec0"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>distance_t</b> = typename IndexT::distance_t</td></tr>
<tr class="separator:a33eb25784833dd8dbb24544d8043eec0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a29d851d995abc011c759a855ae0057ae"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1IndexReplicasTemplate.html#a29d851d995abc011c759a855ae0057ae">IndexReplicasTemplate</a> (bool threaded=true)</td></tr>
<tr class="separator:a29d851d995abc011c759a855ae0057ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ada9226643e1a48e45c65ffecc57b7391"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1IndexReplicasTemplate.html#ada9226643e1a48e45c65ffecc57b7391">IndexReplicasTemplate</a> (idx_t d, bool threaded=true)</td></tr>
<tr class="separator:ada9226643e1a48e45c65ffecc57b7391"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adbad834789bb985ce8c99a82dc020248"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1IndexReplicasTemplate.html#adbad834789bb985ce8c99a82dc020248">IndexReplicasTemplate</a> (int d, bool threaded=true)</td></tr>
<tr class="separator:adbad834789bb985ce8c99a82dc020248"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a34bf1c7e890c2e5a57307fd3ee5b980b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a34bf1c7e890c2e5a57307fd3ee5b980b"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1IndexReplicasTemplate.html#a34bf1c7e890c2e5a57307fd3ee5b980b">add_replica</a> (IndexT *index)</td></tr>
<tr class="memdesc:a34bf1c7e890c2e5a57307fd3ee5b980b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Alias for <a class="el" href="classfaiss_1_1ThreadedIndex.html#a9a11a672369d48f45cf1dd1bfe0dad87">addIndex()</a> <br/></td></tr>
<tr class="separator:a34bf1c7e890c2e5a57307fd3ee5b980b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:affcfc49402a7c3d5604689bfbab00326"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="affcfc49402a7c3d5604689bfbab00326"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1IndexReplicasTemplate.html#affcfc49402a7c3d5604689bfbab00326">remove_replica</a> (IndexT *index)</td></tr>
<tr class="memdesc:affcfc49402a7c3d5604689bfbab00326"><td class="mdescLeft">&#160;</td><td class="mdescRight">Alias for <a class="el" href="classfaiss_1_1ThreadedIndex.html#a21604d6b8b8d42e6cc78c26e85564027">removeIndex()</a> <br/></td></tr>
<tr class="separator:affcfc49402a7c3d5604689bfbab00326"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5cdb2a340a3b4f45ec244d5398a29005"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1IndexReplicasTemplate.html#a5cdb2a340a3b4f45ec244d5398a29005">train</a> (idx_t n, const component_t *x) override</td></tr>
<tr class="separator:a5cdb2a340a3b4f45ec244d5398a29005"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b110e7efab3d01be7ae7cb346d9fbf9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1IndexReplicasTemplate.html#a6b110e7efab3d01be7ae7cb346d9fbf9">add</a> (idx_t n, const component_t *x) override</td></tr>
<tr class="separator:a6b110e7efab3d01be7ae7cb346d9fbf9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad6382e3ebaaca61607ad90fc80cdbd3c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1IndexReplicasTemplate.html#ad6382e3ebaaca61607ad90fc80cdbd3c">search</a> (idx_t n, const component_t *x, idx_t k, distance_t *distances, idx_t *labels) const override</td></tr>
<tr class="separator:ad6382e3ebaaca61607ad90fc80cdbd3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9fb6804492c12359b5cc2aa26fe6a6d6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9fb6804492c12359b5cc2aa26fe6a6d6"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1IndexReplicasTemplate.html#a9fb6804492c12359b5cc2aa26fe6a6d6">reconstruct</a> (idx_t, component_t *v) const override</td></tr>
<tr class="memdesc:a9fb6804492c12359b5cc2aa26fe6a6d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">reconstructs from the first index <br/></td></tr>
<tr class="separator:a9fb6804492c12359b5cc2aa26fe6a6d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classfaiss_1_1ThreadedIndex"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classfaiss_1_1ThreadedIndex')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classfaiss_1_1ThreadedIndex.html">faiss::ThreadedIndex&lt; IndexT &gt;</a></td></tr>
<tr class="memitem:ac603a659e678e154a49722bc428538e9 inherit pub_methods_classfaiss_1_1ThreadedIndex"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac603a659e678e154a49722bc428538e9"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>ThreadedIndex</b> (bool threaded)</td></tr>
<tr class="separator:ac603a659e678e154a49722bc428538e9 inherit pub_methods_classfaiss_1_1ThreadedIndex"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a52a2c216ed16feb3be6a57e15253b368 inherit pub_methods_classfaiss_1_1ThreadedIndex"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a52a2c216ed16feb3be6a57e15253b368"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>ThreadedIndex</b> (int d, bool threaded)</td></tr>
<tr class="separator:a52a2c216ed16feb3be6a57e15253b368 inherit pub_methods_classfaiss_1_1ThreadedIndex"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9a11a672369d48f45cf1dd1bfe0dad87 inherit pub_methods_classfaiss_1_1ThreadedIndex"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1ThreadedIndex.html#a9a11a672369d48f45cf1dd1bfe0dad87">addIndex</a> (IndexT *index)</td></tr>
<tr class="separator:a9a11a672369d48f45cf1dd1bfe0dad87 inherit pub_methods_classfaiss_1_1ThreadedIndex"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a21604d6b8b8d42e6cc78c26e85564027 inherit pub_methods_classfaiss_1_1ThreadedIndex"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1ThreadedIndex.html#a21604d6b8b8d42e6cc78c26e85564027">removeIndex</a> (IndexT *index)</td></tr>
<tr class="separator:a21604d6b8b8d42e6cc78c26e85564027 inherit pub_methods_classfaiss_1_1ThreadedIndex"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a30ade89dc4e571868cf121e5592d6687 inherit pub_methods_classfaiss_1_1ThreadedIndex"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1ThreadedIndex.html#a30ade89dc4e571868cf121e5592d6687">runOnIndex</a> (std::function&lt; void(int, IndexT *)&gt; f)</td></tr>
<tr class="separator:a30ade89dc4e571868cf121e5592d6687 inherit pub_methods_classfaiss_1_1ThreadedIndex"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ada80f2e3319c96d9b0efb0259c8bbd5e inherit pub_methods_classfaiss_1_1ThreadedIndex"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ada80f2e3319c96d9b0efb0259c8bbd5e"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>runOnIndex</b> (std::function&lt; void(int, const IndexT *)&gt; f) const </td></tr>
<tr class="separator:ada80f2e3319c96d9b0efb0259c8bbd5e inherit pub_methods_classfaiss_1_1ThreadedIndex"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4536f6e7a8cce1f79bebc420ae1e909b inherit pub_methods_classfaiss_1_1ThreadedIndex"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1ThreadedIndex.html#a4536f6e7a8cce1f79bebc420ae1e909b">reset</a> () override</td></tr>
<tr class="separator:a4536f6e7a8cce1f79bebc420ae1e909b inherit pub_methods_classfaiss_1_1ThreadedIndex"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a25aac2b3024e7f900687f85f625afaba inherit pub_methods_classfaiss_1_1ThreadedIndex"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a25aac2b3024e7f900687f85f625afaba"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1ThreadedIndex.html#a25aac2b3024e7f900687f85f625afaba">count</a> () const </td></tr>
<tr class="memdesc:a25aac2b3024e7f900687f85f625afaba inherit pub_methods_classfaiss_1_1ThreadedIndex"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of sub-indices. <br/></td></tr>
<tr class="separator:a25aac2b3024e7f900687f85f625afaba inherit pub_methods_classfaiss_1_1ThreadedIndex"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d150a2d26d97b703af2a78e0c564c0e inherit pub_methods_classfaiss_1_1ThreadedIndex"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9d150a2d26d97b703af2a78e0c564c0e"></a>
IndexT *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1ThreadedIndex.html#a9d150a2d26d97b703af2a78e0c564c0e">at</a> (int i)</td></tr>
<tr class="memdesc:a9d150a2d26d97b703af2a78e0c564c0e inherit pub_methods_classfaiss_1_1ThreadedIndex"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the i-th sub-index. <br/></td></tr>
<tr class="separator:a9d150a2d26d97b703af2a78e0c564c0e inherit pub_methods_classfaiss_1_1ThreadedIndex"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae84b4b14209700f372b9a82b78123f1a inherit pub_methods_classfaiss_1_1ThreadedIndex"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae84b4b14209700f372b9a82b78123f1a"></a>
const IndexT *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1ThreadedIndex.html#ae84b4b14209700f372b9a82b78123f1a">at</a> (int i) const </td></tr>
<tr class="memdesc:ae84b4b14209700f372b9a82b78123f1a inherit pub_methods_classfaiss_1_1ThreadedIndex"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the i-th sub-index (const version) <br/></td></tr>
<tr class="separator:ae84b4b14209700f372b9a82b78123f1a inherit pub_methods_classfaiss_1_1ThreadedIndex"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a4fd98a5ba105391bfb3e490d84d26b27"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4fd98a5ba105391bfb3e490d84d26b27"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1IndexReplicasTemplate.html#a4fd98a5ba105391bfb3e490d84d26b27">onAfterAddIndex</a> (IndexT *index) override</td></tr>
<tr class="memdesc:a4fd98a5ba105391bfb3e490d84d26b27"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called just after an index is added. <br/></td></tr>
<tr class="separator:a4fd98a5ba105391bfb3e490d84d26b27"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_methods_classfaiss_1_1ThreadedIndex"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classfaiss_1_1ThreadedIndex')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classfaiss_1_1ThreadedIndex.html">faiss::ThreadedIndex&lt; IndexT &gt;</a></td></tr>
<tr class="memitem:a3bfc1a3002a150d850b20dc40c5d31fe inherit pro_methods_classfaiss_1_1ThreadedIndex"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3bfc1a3002a150d850b20dc40c5d31fe"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1ThreadedIndex.html#a3bfc1a3002a150d850b20dc40c5d31fe">onAfterRemoveIndex</a> (IndexT *index)</td></tr>
<tr class="memdesc:a3bfc1a3002a150d850b20dc40c5d31fe inherit pro_methods_classfaiss_1_1ThreadedIndex"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called just after an index is removed. <br/></td></tr>
<tr class="separator:a3bfc1a3002a150d850b20dc40c5d31fe inherit pro_methods_classfaiss_1_1ThreadedIndex"><td class="memSeparator" colspan="2">&#160;</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_attribs_classfaiss_1_1ThreadedIndex"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classfaiss_1_1ThreadedIndex')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="classfaiss_1_1ThreadedIndex.html">faiss::ThreadedIndex&lt; IndexT &gt;</a></td></tr>
<tr class="memitem:a33201cb008802a729f61c76d519cb58a inherit pub_attribs_classfaiss_1_1ThreadedIndex"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a33201cb008802a729f61c76d519cb58a"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1ThreadedIndex.html#a33201cb008802a729f61c76d519cb58a">own_fields</a></td></tr>
<tr class="memdesc:a33201cb008802a729f61c76d519cb58a inherit pub_attribs_classfaiss_1_1ThreadedIndex"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether or not we are responsible for deleting our contained indices. <br/></td></tr>
<tr class="separator:a33201cb008802a729f61c76d519cb58a inherit pub_attribs_classfaiss_1_1ThreadedIndex"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_static_methods_classfaiss_1_1ThreadedIndex"><td colspan="2" onclick="javascript:toggleInherit('pro_static_methods_classfaiss_1_1ThreadedIndex')"><img src="closed.png" alt="-"/>&#160;Static Protected Member Functions inherited from <a class="el" href="classfaiss_1_1ThreadedIndex.html">faiss::ThreadedIndex&lt; IndexT &gt;</a></td></tr>
<tr class="memitem:a26c2b3a37f612f8654a855831ad828a6 inherit pro_static_methods_classfaiss_1_1ThreadedIndex"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a26c2b3a37f612f8654a855831ad828a6"></a>
static void&#160;</td><td class="memItemRight" valign="bottom"><b>waitAndHandleFutures</b> (std::vector&lt; std::future&lt; bool &gt;&gt; &amp;v)</td></tr>
<tr class="separator:a26c2b3a37f612f8654a855831ad828a6 inherit pro_static_methods_classfaiss_1_1ThreadedIndex"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_classfaiss_1_1ThreadedIndex"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classfaiss_1_1ThreadedIndex')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classfaiss_1_1ThreadedIndex.html">faiss::ThreadedIndex&lt; IndexT &gt;</a></td></tr>
<tr class="memitem:acb0dc6a321ad80636d5fef5cc7edd05b inherit pro_attribs_classfaiss_1_1ThreadedIndex"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acb0dc6a321ad80636d5fef5cc7edd05b"></a>
std::vector&lt; std::pair&lt; IndexT <br class="typebreak"/>
*, std::unique_ptr<br class="typebreak"/>
&lt; <a class="el" href="classfaiss_1_1WorkerThread.html">WorkerThread</a> &gt; &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1ThreadedIndex.html#acb0dc6a321ad80636d5fef5cc7edd05b">indices_</a></td></tr>
<tr class="memdesc:acb0dc6a321ad80636d5fef5cc7edd05b inherit pro_attribs_classfaiss_1_1ThreadedIndex"><td class="mdescLeft">&#160;</td><td class="mdescRight">Collection of <a class="el" href="structfaiss_1_1Index.html">Index</a> instances, with their managing worker thread if any. <br/></td></tr>
<tr class="separator:acb0dc6a321ad80636d5fef5cc7edd05b inherit pro_attribs_classfaiss_1_1ThreadedIndex"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1031b2c900e9ba53573e617539b3c488 inherit pro_attribs_classfaiss_1_1ThreadedIndex"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1031b2c900e9ba53573e617539b3c488"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1ThreadedIndex.html#a1031b2c900e9ba53573e617539b3c488">isThreaded_</a></td></tr>
<tr class="memdesc:a1031b2c900e9ba53573e617539b3c488 inherit pro_attribs_classfaiss_1_1ThreadedIndex"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is this index multi-threaded? <br/></td></tr>
<tr class="separator:a1031b2c900e9ba53573e617539b3c488 inherit pro_attribs_classfaiss_1_1ThreadedIndex"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename IndexT&gt;<br/>
class faiss::IndexReplicasTemplate&lt; IndexT &gt;</h3>
<p>Takes individual <a class="el" href="structfaiss_1_1Index.html">faiss::Index</a> instances, and splits queries for sending to each <a class="el" href="structfaiss_1_1Index.html">Index</a> instance, and joins the results together when done. Each index is managed by a separate CPU thread. </p>
<p>Definition at line <a class="el" href="IndexReplicas_8h_source.html#l00021">21</a> of file <a class="el" href="IndexReplicas_8h_source.html">IndexReplicas.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a29d851d995abc011c759a855ae0057ae"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename IndexT &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classfaiss_1_1IndexReplicasTemplate.html">faiss::IndexReplicasTemplate</a>&lt; IndexT &gt;::<a class="el" href="classfaiss_1_1IndexReplicasTemplate.html">IndexReplicasTemplate</a> </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>threaded</em> = <code>true</code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The dimension that all sub-indices must share will be the dimension of the first sub-index added </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">threaded</td><td>do we use one thread per sub-index or do queries sequentially? </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="IndexReplicas_8cpp_source.html#l00014">14</a> of file <a class="el" href="IndexReplicas_8cpp_source.html">IndexReplicas.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ada9226643e1a48e45c65ffecc57b7391"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename IndexT &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classfaiss_1_1IndexReplicasTemplate.html">faiss::IndexReplicasTemplate</a>&lt; IndexT &gt;::<a class="el" href="classfaiss_1_1IndexReplicasTemplate.html">IndexReplicasTemplate</a> </td>
<td>(</td>
<td class="paramtype">idx_t&#160;</td>
<td class="paramname"><em>d</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>threaded</em> = <code>true</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">d</td><td>the dimension that all sub-indices must share </td></tr>
<tr><td class="paramname">threaded</td><td>do we use one thread per sub index or do queries sequentially? </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="IndexReplicas_8cpp_source.html#l00019">19</a> of file <a class="el" href="IndexReplicas_8cpp_source.html">IndexReplicas.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="adbad834789bb985ce8c99a82dc020248"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename IndexT &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classfaiss_1_1IndexReplicasTemplate.html">faiss::IndexReplicasTemplate</a>&lt; IndexT &gt;::<a class="el" href="classfaiss_1_1IndexReplicasTemplate.html">IndexReplicasTemplate</a> </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>d</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>threaded</em> = <code>true</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>int version due to the implicit bool conversion ambiguity of int as dimension </p>
<p>Definition at line <a class="el" href="IndexReplicas_8cpp_source.html#l00024">24</a> of file <a class="el" href="IndexReplicas_8cpp_source.html">IndexReplicas.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a6b110e7efab3d01be7ae7cb346d9fbf9"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename IndexT &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classfaiss_1_1IndexReplicasTemplate.html">faiss::IndexReplicasTemplate</a>&lt; IndexT &gt;::add </td>
<td>(</td>
<td class="paramtype">idx_t&#160;</td>
<td class="paramname"><em>n</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const component_t *&#160;</td>
<td class="paramname"><em>x</em>&#160;</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="structfaiss_1_1Index.html">faiss::Index</a> API All indices receive the same call </p>
<p>Definition at line <a class="el" href="IndexReplicas_8cpp_source.html#l00063">63</a> of file <a class="el" href="IndexReplicas_8cpp_source.html">IndexReplicas.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ad6382e3ebaaca61607ad90fc80cdbd3c"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename IndexT &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classfaiss_1_1IndexReplicasTemplate.html">faiss::IndexReplicasTemplate</a>&lt; IndexT &gt;::search </td>
<td>(</td>
<td class="paramtype">idx_t&#160;</td>
<td class="paramname"><em>n</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const component_t *&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">idx_t&#160;</td>
<td class="paramname"><em>k</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">distance_t *&#160;</td>
<td class="paramname"><em>distances</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">idx_t *&#160;</td>
<td class="paramname"><em>labels</em>&#160;</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="structfaiss_1_1Index.html">faiss::Index</a> API Query is partitioned into a slice for each sub-index split by ceil(n / #indices) for our sub-indices </p>
<p>Definition at line <a class="el" href="IndexReplicas_8cpp_source.html#l00079">79</a> of file <a class="el" href="IndexReplicas_8cpp_source.html">IndexReplicas.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5cdb2a340a3b4f45ec244d5398a29005"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename IndexT &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classfaiss_1_1IndexReplicasTemplate.html">faiss::IndexReplicasTemplate</a>&lt; IndexT &gt;::train </td>
<td>(</td>
<td class="paramtype">idx_t&#160;</td>
<td class="paramname"><em>n</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const component_t *&#160;</td>
<td class="paramname"><em>x</em>&#160;</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="structfaiss_1_1Index.html">faiss::Index</a> API All indices receive the same call </p>
<p>Definition at line <a class="el" href="IndexReplicas_8cpp_source.html#l00057">57</a> of file <a class="el" href="IndexReplicas_8cpp_source.html">IndexReplicas.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>/data/users/hoss/faiss/<a class="el" href="IndexReplicas_8h_source.html">IndexReplicas.h</a></li>
<li>/data/users/hoss/faiss/<a class="el" href="IndexReplicas_8cpp_source.html">IndexReplicas.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink