562 lines
59 KiB
HTML
562 lines
59 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::gpu::GpuIndexIVFPQ Class 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"><b>gpu</b></li><li class="navelem"><a class="el" href="classfaiss_1_1gpu_1_1GpuIndexIVFPQ.html">GpuIndexIVFPQ</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
|
<a href="classfaiss_1_1gpu_1_1GpuIndexIVFPQ-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">faiss::gpu::GpuIndexIVFPQ Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><a class="el" href="classfaiss_1_1gpu_1_1IVFPQ.html" title="Implementing class for IVFPQ on the GPU. ">IVFPQ</a> index for the GPU.
|
|
<a href="classfaiss_1_1gpu_1_1GpuIndexIVFPQ.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="GpuIndexIVFPQ_8h_source.html">GpuIndexIVFPQ.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for faiss::gpu::GpuIndexIVFPQ:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classfaiss_1_1gpu_1_1GpuIndexIVFPQ.png" usemap="#faiss::gpu::GpuIndexIVFPQ_map" alt=""/>
|
|
<map id="faiss::gpu::GpuIndexIVFPQ_map" name="faiss::gpu::GpuIndexIVFPQ_map">
|
|
<area href="classfaiss_1_1gpu_1_1GpuIndexIVF.html" alt="faiss::gpu::GpuIndexIVF" shape="rect" coords="0,112,162,136"/>
|
|
<area href="classfaiss_1_1gpu_1_1GpuIndex.html" alt="faiss::gpu::GpuIndex" shape="rect" coords="0,56,162,80"/>
|
|
<area href="structfaiss_1_1Index.html" alt="faiss::Index" shape="rect" coords="0,0,162,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:a56a552e8c2e29f33c39883145bd7629c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1GpuIndexIVFPQ.html#a56a552e8c2e29f33c39883145bd7629c">GpuIndexIVFPQ</a> (<a class="el" href="classfaiss_1_1gpu_1_1GpuResources.html">GpuResources</a> *resources, const <a class="el" href="structfaiss_1_1IndexIVFPQ.html">faiss::IndexIVFPQ</a> *index, <a class="el" href="structfaiss_1_1gpu_1_1GpuIndexIVFPQConfig.html">GpuIndexIVFPQConfig</a> config=<a class="el" href="structfaiss_1_1gpu_1_1GpuIndexIVFPQConfig.html">GpuIndexIVFPQConfig</a>())</td></tr>
|
|
<tr class="separator:a56a552e8c2e29f33c39883145bd7629c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a245ae251f48cb435c7db18258c627b0a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a245ae251f48cb435c7db18258c627b0a"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1GpuIndexIVFPQ.html#a245ae251f48cb435c7db18258c627b0a">GpuIndexIVFPQ</a> (<a class="el" href="classfaiss_1_1gpu_1_1GpuResources.html">GpuResources</a> *resources, int dims, int nlist, int subQuantizers, int bitsPerCode, <a class="el" href="namespacefaiss.html#afd12191c638da74760ff397cf319752c">faiss::MetricType</a> metric, <a class="el" href="structfaiss_1_1gpu_1_1GpuIndexIVFPQConfig.html">GpuIndexIVFPQConfig</a> config=<a class="el" href="structfaiss_1_1gpu_1_1GpuIndexIVFPQConfig.html">GpuIndexIVFPQConfig</a>())</td></tr>
|
|
<tr class="memdesc:a245ae251f48cb435c7db18258c627b0a"><td class="mdescLeft"> </td><td class="mdescRight">Construct an empty index. <br/></td></tr>
|
|
<tr class="separator:a245ae251f48cb435c7db18258c627b0a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8d48f79af9080b55706050244fc24f0e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1GpuIndexIVFPQ.html#a8d48f79af9080b55706050244fc24f0e">copyFrom</a> (const <a class="el" href="structfaiss_1_1IndexIVFPQ.html">faiss::IndexIVFPQ</a> *index)</td></tr>
|
|
<tr class="separator:a8d48f79af9080b55706050244fc24f0e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aad10de2407911e9adf42c1be5c5dd390"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1GpuIndexIVFPQ.html#aad10de2407911e9adf42c1be5c5dd390">copyTo</a> (<a class="el" href="structfaiss_1_1IndexIVFPQ.html">faiss::IndexIVFPQ</a> *index) const </td></tr>
|
|
<tr class="separator:aad10de2407911e9adf42c1be5c5dd390"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4e7d62e21f7e23fa4e94c69131389eea"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4e7d62e21f7e23fa4e94c69131389eea"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1GpuIndexIVFPQ.html#a4e7d62e21f7e23fa4e94c69131389eea">reserveMemory</a> (size_t numVecs)</td></tr>
|
|
<tr class="memdesc:a4e7d62e21f7e23fa4e94c69131389eea"><td class="mdescLeft"> </td><td class="mdescRight">Reserve GPU memory in our inverted lists for this number of vectors. <br/></td></tr>
|
|
<tr class="separator:a4e7d62e21f7e23fa4e94c69131389eea"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afda2894c0ce520e0d3d06eeca5ed5f0c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afda2894c0ce520e0d3d06eeca5ed5f0c"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1GpuIndexIVFPQ.html#afda2894c0ce520e0d3d06eeca5ed5f0c">setPrecomputedCodes</a> (bool enable)</td></tr>
|
|
<tr class="memdesc:afda2894c0ce520e0d3d06eeca5ed5f0c"><td class="mdescLeft"> </td><td class="mdescRight">Enable or disable pre-computed codes. <br/></td></tr>
|
|
<tr class="separator:afda2894c0ce520e0d3d06eeca5ed5f0c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a679b0aaa229d571aeb842673e3493cc5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a679b0aaa229d571aeb842673e3493cc5"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1GpuIndexIVFPQ.html#a679b0aaa229d571aeb842673e3493cc5">getPrecomputedCodes</a> () const </td></tr>
|
|
<tr class="memdesc:a679b0aaa229d571aeb842673e3493cc5"><td class="mdescLeft"> </td><td class="mdescRight">Are pre-computed codes enabled? <br/></td></tr>
|
|
<tr class="separator:a679b0aaa229d571aeb842673e3493cc5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3869ea7898487334fb67ee499f38988d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3869ea7898487334fb67ee499f38988d"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1GpuIndexIVFPQ.html#a3869ea7898487334fb67ee499f38988d">getNumSubQuantizers</a> () const </td></tr>
|
|
<tr class="memdesc:a3869ea7898487334fb67ee499f38988d"><td class="mdescLeft"> </td><td class="mdescRight">Return the number of sub-quantizers we are using. <br/></td></tr>
|
|
<tr class="separator:a3869ea7898487334fb67ee499f38988d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af87058de254e1430587a16b76f1e4377"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af87058de254e1430587a16b76f1e4377"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1GpuIndexIVFPQ.html#af87058de254e1430587a16b76f1e4377">getBitsPerCode</a> () const </td></tr>
|
|
<tr class="memdesc:af87058de254e1430587a16b76f1e4377"><td class="mdescLeft"> </td><td class="mdescRight">Return the number of bits per PQ code. <br/></td></tr>
|
|
<tr class="separator:af87058de254e1430587a16b76f1e4377"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2f50e79af6727962cd89534438d4769e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2f50e79af6727962cd89534438d4769e"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1GpuIndexIVFPQ.html#a2f50e79af6727962cd89534438d4769e">getCentroidsPerSubQuantizer</a> () const </td></tr>
|
|
<tr class="memdesc:a2f50e79af6727962cd89534438d4769e"><td class="mdescLeft"> </td><td class="mdescRight">Return the number of centroids per PQ code (2^bits per code) <br/></td></tr>
|
|
<tr class="separator:a2f50e79af6727962cd89534438d4769e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a83831088d9593f753560965172ccb0a0"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1GpuIndexIVFPQ.html#a83831088d9593f753560965172ccb0a0">reclaimMemory</a> ()</td></tr>
|
|
<tr class="separator:a83831088d9593f753560965172ccb0a0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3a43a70461e09ef87bdb7b48ec420dd2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1GpuIndexIVFPQ.html#a3a43a70461e09ef87bdb7b48ec420dd2">reset</a> () override</td></tr>
|
|
<tr class="separator:a3a43a70461e09ef87bdb7b48ec420dd2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac4814acafa4bc340a4c4bdcafd469b56"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1GpuIndexIVFPQ.html#ac4814acafa4bc340a4c4bdcafd469b56">train</a> (<a class="el" href="structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea">Index::idx_t</a> n, const float *x) override</td></tr>
|
|
<tr class="separator:ac4814acafa4bc340a4c4bdcafd469b56"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab7f77961857e560b4dbb81888a8c8bf8"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1GpuIndexIVFPQ.html#ab7f77961857e560b4dbb81888a8c8bf8">getListLength</a> (int listId) const </td></tr>
|
|
<tr class="separator:ab7f77961857e560b4dbb81888a8c8bf8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a98f0000872701f9f23ac2073723a0aa7"><td class="memItemLeft" align="right" valign="top">std::vector< unsigned char > </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1GpuIndexIVFPQ.html#a98f0000872701f9f23ac2073723a0aa7">getListCodes</a> (int listId) const </td></tr>
|
|
<tr class="separator:a98f0000872701f9f23ac2073723a0aa7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5235cf241ef98e6012fd01907ec705d0"><td class="memItemLeft" align="right" valign="top">std::vector< long > </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1GpuIndexIVFPQ.html#a5235cf241ef98e6012fd01907ec705d0">getListIndices</a> (int listId) const </td></tr>
|
|
<tr class="separator:a5235cf241ef98e6012fd01907ec705d0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classfaiss_1_1gpu_1_1GpuIndexIVF"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classfaiss_1_1gpu_1_1GpuIndexIVF')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classfaiss_1_1gpu_1_1GpuIndexIVF.html">faiss::gpu::GpuIndexIVF</a></td></tr>
|
|
<tr class="memitem:a46a559961d36eef8ee930bb5b4aba85a inherit pub_methods_classfaiss_1_1gpu_1_1GpuIndexIVF"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a46a559961d36eef8ee930bb5b4aba85a"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>GpuIndexIVF</b> (<a class="el" href="classfaiss_1_1gpu_1_1GpuResources.html">GpuResources</a> *resources, int dims, <a class="el" href="namespacefaiss.html#afd12191c638da74760ff397cf319752c">faiss::MetricType</a> metric, int nlist, <a class="el" href="structfaiss_1_1gpu_1_1GpuIndexIVFConfig.html">GpuIndexIVFConfig</a> config=<a class="el" href="structfaiss_1_1gpu_1_1GpuIndexIVFConfig.html">GpuIndexIVFConfig</a>())</td></tr>
|
|
<tr class="separator:a46a559961d36eef8ee930bb5b4aba85a inherit pub_methods_classfaiss_1_1gpu_1_1GpuIndexIVF"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a94c2c171f9a2d27085dea9101067bdf2 inherit pub_methods_classfaiss_1_1gpu_1_1GpuIndexIVF"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a94c2c171f9a2d27085dea9101067bdf2"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1GpuIndexIVF.html#a94c2c171f9a2d27085dea9101067bdf2">copyFrom</a> (const <a class="el" href="structfaiss_1_1IndexIVF.html">faiss::IndexIVF</a> *index)</td></tr>
|
|
<tr class="memdesc:a94c2c171f9a2d27085dea9101067bdf2 inherit pub_methods_classfaiss_1_1gpu_1_1GpuIndexIVF"><td class="mdescLeft"> </td><td class="mdescRight">Copy what we need from the CPU equivalent. <br/></td></tr>
|
|
<tr class="separator:a94c2c171f9a2d27085dea9101067bdf2 inherit pub_methods_classfaiss_1_1gpu_1_1GpuIndexIVF"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1db0a796b8b2917d989952c5f07fbe55 inherit pub_methods_classfaiss_1_1gpu_1_1GpuIndexIVF"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1db0a796b8b2917d989952c5f07fbe55"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1GpuIndexIVF.html#a1db0a796b8b2917d989952c5f07fbe55">copyTo</a> (<a class="el" href="structfaiss_1_1IndexIVF.html">faiss::IndexIVF</a> *index) const </td></tr>
|
|
<tr class="memdesc:a1db0a796b8b2917d989952c5f07fbe55 inherit pub_methods_classfaiss_1_1gpu_1_1GpuIndexIVF"><td class="mdescLeft"> </td><td class="mdescRight">Copy what we have to the CPU equivalent. <br/></td></tr>
|
|
<tr class="separator:a1db0a796b8b2917d989952c5f07fbe55 inherit pub_methods_classfaiss_1_1gpu_1_1GpuIndexIVF"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a43a63e93d55b79eac38173f219743ddf inherit pub_methods_classfaiss_1_1gpu_1_1GpuIndexIVF"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a43a63e93d55b79eac38173f219743ddf"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1GpuIndexIVF.html#a43a63e93d55b79eac38173f219743ddf">getNumLists</a> () const </td></tr>
|
|
<tr class="memdesc:a43a63e93d55b79eac38173f219743ddf inherit pub_methods_classfaiss_1_1gpu_1_1GpuIndexIVF"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of inverted lists we're managing. <br/></td></tr>
|
|
<tr class="separator:a43a63e93d55b79eac38173f219743ddf inherit pub_methods_classfaiss_1_1gpu_1_1GpuIndexIVF"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afe6eb789377072b309d7a385aa0d1c5e inherit pub_methods_classfaiss_1_1gpu_1_1GpuIndexIVF"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afe6eb789377072b309d7a385aa0d1c5e"></a>
|
|
<a class="el" href="classfaiss_1_1gpu_1_1GpuIndexFlat.html">GpuIndexFlat</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1GpuIndexIVF.html#afe6eb789377072b309d7a385aa0d1c5e">getQuantizer</a> ()</td></tr>
|
|
<tr class="memdesc:afe6eb789377072b309d7a385aa0d1c5e inherit pub_methods_classfaiss_1_1gpu_1_1GpuIndexIVF"><td class="mdescLeft"> </td><td class="mdescRight">Return the quantizer we're using. <br/></td></tr>
|
|
<tr class="separator:afe6eb789377072b309d7a385aa0d1c5e inherit pub_methods_classfaiss_1_1gpu_1_1GpuIndexIVF"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1efac4b9801d57fa6d0085d6aed9c1f2 inherit pub_methods_classfaiss_1_1gpu_1_1GpuIndexIVF"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1efac4b9801d57fa6d0085d6aed9c1f2"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1GpuIndexIVF.html#a1efac4b9801d57fa6d0085d6aed9c1f2">setNumProbes</a> (int nprobe)</td></tr>
|
|
<tr class="memdesc:a1efac4b9801d57fa6d0085d6aed9c1f2 inherit pub_methods_classfaiss_1_1gpu_1_1GpuIndexIVF"><td class="mdescLeft"> </td><td class="mdescRight">Sets the number of list probes per query. <br/></td></tr>
|
|
<tr class="separator:a1efac4b9801d57fa6d0085d6aed9c1f2 inherit pub_methods_classfaiss_1_1gpu_1_1GpuIndexIVF"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a13bce124f8acada641daf60d6edddb33 inherit pub_methods_classfaiss_1_1gpu_1_1GpuIndexIVF"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a13bce124f8acada641daf60d6edddb33"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1GpuIndexIVF.html#a13bce124f8acada641daf60d6edddb33">getNumProbes</a> () const </td></tr>
|
|
<tr class="memdesc:a13bce124f8acada641daf60d6edddb33 inherit pub_methods_classfaiss_1_1gpu_1_1GpuIndexIVF"><td class="mdescLeft"> </td><td class="mdescRight">Returns our current number of list probes per query. <br/></td></tr>
|
|
<tr class="separator:a13bce124f8acada641daf60d6edddb33 inherit pub_methods_classfaiss_1_1gpu_1_1GpuIndexIVF"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classfaiss_1_1gpu_1_1GpuIndex"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classfaiss_1_1gpu_1_1GpuIndex')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classfaiss_1_1gpu_1_1GpuIndex.html">faiss::gpu::GpuIndex</a></td></tr>
|
|
<tr class="memitem:a9bd06bc3c4ac62195b80389ce8fd1f28 inherit pub_methods_classfaiss_1_1gpu_1_1GpuIndex"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9bd06bc3c4ac62195b80389ce8fd1f28"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>GpuIndex</b> (<a class="el" href="classfaiss_1_1gpu_1_1GpuResources.html">GpuResources</a> *resources, int dims, <a class="el" href="namespacefaiss.html#afd12191c638da74760ff397cf319752c">faiss::MetricType</a> metric, <a class="el" href="structfaiss_1_1gpu_1_1GpuIndexConfig.html">GpuIndexConfig</a> config)</td></tr>
|
|
<tr class="separator:a9bd06bc3c4ac62195b80389ce8fd1f28 inherit pub_methods_classfaiss_1_1gpu_1_1GpuIndex"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a88b10d410c10fa8667c394ee7fbfbdbc inherit pub_methods_classfaiss_1_1gpu_1_1GpuIndex"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a88b10d410c10fa8667c394ee7fbfbdbc"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>getDevice</b> () const </td></tr>
|
|
<tr class="separator:a88b10d410c10fa8667c394ee7fbfbdbc inherit pub_methods_classfaiss_1_1gpu_1_1GpuIndex"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa40dd7a62abea6f8e8a7afdaf1e81cef inherit pub_methods_classfaiss_1_1gpu_1_1GpuIndex"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa40dd7a62abea6f8e8a7afdaf1e81cef"></a>
|
|
<a class="el" href="classfaiss_1_1gpu_1_1GpuResources.html">GpuResources</a> * </td><td class="memItemRight" valign="bottom"><b>getResources</b> ()</td></tr>
|
|
<tr class="separator:aa40dd7a62abea6f8e8a7afdaf1e81cef inherit pub_methods_classfaiss_1_1gpu_1_1GpuIndex"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6c82cbea6b02cc996d634f822c1d310b inherit pub_methods_classfaiss_1_1gpu_1_1GpuIndex"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1GpuIndex.html#a6c82cbea6b02cc996d634f822c1d310b">setMinPagingSize</a> (size_t size)</td></tr>
|
|
<tr class="separator:a6c82cbea6b02cc996d634f822c1d310b inherit pub_methods_classfaiss_1_1gpu_1_1GpuIndex"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adbdc96814ff2d4390dfd860bd5918203 inherit pub_methods_classfaiss_1_1gpu_1_1GpuIndex"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adbdc96814ff2d4390dfd860bd5918203"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1GpuIndex.html#adbdc96814ff2d4390dfd860bd5918203">getMinPagingSize</a> () const </td></tr>
|
|
<tr class="memdesc:adbdc96814ff2d4390dfd860bd5918203 inherit pub_methods_classfaiss_1_1gpu_1_1GpuIndex"><td class="mdescLeft"> </td><td class="mdescRight">Returns the current minimum data size for paged searches. <br/></td></tr>
|
|
<tr class="separator:adbdc96814ff2d4390dfd860bd5918203 inherit pub_methods_classfaiss_1_1gpu_1_1GpuIndex"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af576341f6996b0e80e26b9748db51eb7 inherit pub_methods_classfaiss_1_1gpu_1_1GpuIndex"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1GpuIndex.html#af576341f6996b0e80e26b9748db51eb7">add</a> (<a class="el" href="structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea">faiss::Index::idx_t</a>, const float *x) override</td></tr>
|
|
<tr class="separator:af576341f6996b0e80e26b9748db51eb7 inherit pub_methods_classfaiss_1_1gpu_1_1GpuIndex"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a47f6969fe60d82b8e3407557ba9eec88 inherit pub_methods_classfaiss_1_1gpu_1_1GpuIndex"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1GpuIndex.html#a47f6969fe60d82b8e3407557ba9eec88">add_with_ids</a> (<a class="el" href="structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea">Index::idx_t</a> n, const float *x, const <a class="el" href="structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea">Index::idx_t</a> *ids) override</td></tr>
|
|
<tr class="separator:a47f6969fe60d82b8e3407557ba9eec88 inherit pub_methods_classfaiss_1_1gpu_1_1GpuIndex"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4564ff946e4339156173b39449562971 inherit pub_methods_classfaiss_1_1gpu_1_1GpuIndex"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1GpuIndex.html#a4564ff946e4339156173b39449562971">search</a> (<a class="el" href="structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea">Index::idx_t</a> n, const float *x, <a class="el" href="structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea">Index::idx_t</a> k, float *distances, <a class="el" href="structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea">Index::idx_t</a> *labels) const override</td></tr>
|
|
<tr class="separator:a4564ff946e4339156173b39449562971 inherit pub_methods_classfaiss_1_1gpu_1_1GpuIndex"><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#ad3f0d3071f987baabbdd3da4500c87ea">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: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#ad3f0d3071f987baabbdd3da4500c87ea">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#ad3f0d3071f987baabbdd3da4500c87ea">idx_t</a> n, const float *x, <a class="el" href="structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea">idx_t</a> *labels, <a class="el" href="structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea">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:aaef6f4132b1f390121ebb11058baf190 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#aaef6f4132b1f390121ebb11058baf190">reconstruct</a> (<a class="el" href="structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea">idx_t</a> key, float *recons) const </td></tr>
|
|
<tr class="separator:aaef6f4132b1f390121ebb11058baf190 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#ad3f0d3071f987baabbdd3da4500c87ea">idx_t</a> i0, <a class="el" href="structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea">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#ad3f0d3071f987baabbdd3da4500c87ea">idx_t</a> n, const float *x, <a class="el" href="structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea">idx_t</a> k, float *distances, <a class="el" href="structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea">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#ad3f0d3071f987baabbdd3da4500c87ea">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="pro-methods"></a>
|
|
Protected Member Functions</h2></td></tr>
|
|
<tr class="memitem:aa0468cf70921073b3ba798fe753531eb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa0468cf70921073b3ba798fe753531eb"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1GpuIndexIVFPQ.html#aa0468cf70921073b3ba798fe753531eb">addImpl_</a> (int n, const float *x, const <a class="el" href="structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea">Index::idx_t</a> *ids) override</td></tr>
|
|
<tr class="memdesc:aa0468cf70921073b3ba798fe753531eb"><td class="mdescLeft"> </td><td class="mdescRight">Called from <a class="el" href="classfaiss_1_1gpu_1_1GpuIndex.html">GpuIndex</a> for add/add_with_ids. <br/></td></tr>
|
|
<tr class="separator:aa0468cf70921073b3ba798fe753531eb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a73a06501e87117e5f620bb07d7c1e54d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a73a06501e87117e5f620bb07d7c1e54d"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1GpuIndexIVFPQ.html#a73a06501e87117e5f620bb07d7c1e54d">searchImpl_</a> (int n, const float *x, int k, float *distances, <a class="el" href="structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea">Index::idx_t</a> *labels) const override</td></tr>
|
|
<tr class="memdesc:a73a06501e87117e5f620bb07d7c1e54d"><td class="mdescLeft"> </td><td class="mdescRight">Called from <a class="el" href="classfaiss_1_1gpu_1_1GpuIndex.html">GpuIndex</a> for search. <br/></td></tr>
|
|
<tr class="separator:a73a06501e87117e5f620bb07d7c1e54d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pro_methods_classfaiss_1_1gpu_1_1GpuIndexIVF"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classfaiss_1_1gpu_1_1GpuIndexIVF')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classfaiss_1_1gpu_1_1GpuIndexIVF.html">faiss::gpu::GpuIndexIVF</a></td></tr>
|
|
<tr class="memitem:a69731ab85d119127e1fe603757b28400 inherit pro_methods_classfaiss_1_1gpu_1_1GpuIndexIVF"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1GpuIndexIVF.html#a69731ab85d119127e1fe603757b28400">addImplRequiresIDs_</a> () const override</td></tr>
|
|
<tr class="separator:a69731ab85d119127e1fe603757b28400 inherit pro_methods_classfaiss_1_1gpu_1_1GpuIndexIVF"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8d590e207ff158c1d17df627891f21c4 inherit pro_methods_classfaiss_1_1gpu_1_1GpuIndexIVF"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8d590e207ff158c1d17df627891f21c4"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>trainQuantizer_</b> (<a class="el" href="structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea">faiss::Index::idx_t</a> n, const float *x)</td></tr>
|
|
<tr class="separator:a8d590e207ff158c1d17df627891f21c4 inherit pro_methods_classfaiss_1_1gpu_1_1GpuIndexIVF"><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:ad3f0d3071f987baabbdd3da4500c87ea inherit pub_types_structfaiss_1_1Index"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad3f0d3071f987baabbdd3da4500c87ea"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea">idx_t</a> = long</td></tr>
|
|
<tr class="memdesc:ad3f0d3071f987baabbdd3da4500c87ea inherit pub_types_structfaiss_1_1Index"><td class="mdescLeft"> </td><td class="mdescRight">all indices are this type <br/></td></tr>
|
|
<tr class="separator:ad3f0d3071f987baabbdd3da4500c87ea inherit pub_types_structfaiss_1_1Index"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af317cb1e2ad0bd145f716f2243b693eb inherit pub_types_structfaiss_1_1Index"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af317cb1e2ad0bd145f716f2243b693eb"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><b>component_t</b> = float</td></tr>
|
|
<tr class="separator:af317cb1e2ad0bd145f716f2243b693eb inherit pub_types_structfaiss_1_1Index"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1c60d7a12bf3ad27054963df8cccd93f inherit pub_types_structfaiss_1_1Index"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1c60d7a12bf3ad27054963df8cccd93f"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><b>distance_t</b> = float</td></tr>
|
|
<tr class="separator:a1c60d7a12bf3ad27054963df8cccd93f inherit pub_types_structfaiss_1_1Index"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_attribs_classfaiss_1_1gpu_1_1GpuIndexIVF"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classfaiss_1_1gpu_1_1GpuIndexIVF')"><img src="closed.png" alt="-"/> Public Attributes inherited from <a class="el" href="classfaiss_1_1gpu_1_1GpuIndexIVF.html">faiss::gpu::GpuIndexIVF</a></td></tr>
|
|
<tr class="memitem:a520803e209b44c904b876d6b8dad23c9 inherit pub_attribs_classfaiss_1_1gpu_1_1GpuIndexIVF"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structfaiss_1_1ClusteringParameters.html">ClusteringParameters</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1GpuIndexIVF.html#a520803e209b44c904b876d6b8dad23c9">cp</a></td></tr>
|
|
<tr class="separator:a520803e209b44c904b876d6b8dad23c9 inherit pub_attribs_classfaiss_1_1gpu_1_1GpuIndexIVF"><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#ad3f0d3071f987baabbdd3da4500c87ea">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>
|
|
<tr class="inherit_header pro_attribs_classfaiss_1_1gpu_1_1GpuIndexIVF"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classfaiss_1_1gpu_1_1GpuIndexIVF')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classfaiss_1_1gpu_1_1GpuIndexIVF.html">faiss::gpu::GpuIndexIVF</a></td></tr>
|
|
<tr class="memitem:afef2728938dadaaa02e8aa24a8c11014 inherit pro_attribs_classfaiss_1_1gpu_1_1GpuIndexIVF"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afef2728938dadaaa02e8aa24a8c11014"></a>
|
|
<a class="el" href="structfaiss_1_1gpu_1_1GpuIndexIVFConfig.html">GpuIndexIVFConfig</a> </td><td class="memItemRight" valign="bottom"><b>ivfConfig_</b></td></tr>
|
|
<tr class="separator:afef2728938dadaaa02e8aa24a8c11014 inherit pro_attribs_classfaiss_1_1gpu_1_1GpuIndexIVF"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aba606c141e714fab843493cc58167494 inherit pro_attribs_classfaiss_1_1gpu_1_1GpuIndexIVF"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aba606c141e714fab843493cc58167494"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1GpuIndexIVF.html#aba606c141e714fab843493cc58167494">nlist_</a></td></tr>
|
|
<tr class="memdesc:aba606c141e714fab843493cc58167494 inherit pro_attribs_classfaiss_1_1gpu_1_1GpuIndexIVF"><td class="mdescLeft"> </td><td class="mdescRight">Number of inverted lists that we manage. <br/></td></tr>
|
|
<tr class="separator:aba606c141e714fab843493cc58167494 inherit pro_attribs_classfaiss_1_1gpu_1_1GpuIndexIVF"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a187bdcbbac02bf8fd0e6bb40a1c0426b inherit pro_attribs_classfaiss_1_1gpu_1_1GpuIndexIVF"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a187bdcbbac02bf8fd0e6bb40a1c0426b"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1GpuIndexIVF.html#a187bdcbbac02bf8fd0e6bb40a1c0426b">nprobe_</a></td></tr>
|
|
<tr class="memdesc:a187bdcbbac02bf8fd0e6bb40a1c0426b inherit pro_attribs_classfaiss_1_1gpu_1_1GpuIndexIVF"><td class="mdescLeft"> </td><td class="mdescRight">Number of inverted list probes per query. <br/></td></tr>
|
|
<tr class="separator:a187bdcbbac02bf8fd0e6bb40a1c0426b inherit pro_attribs_classfaiss_1_1gpu_1_1GpuIndexIVF"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaa7dd748e3cbd7ef68f2e384ac503eab inherit pro_attribs_classfaiss_1_1gpu_1_1GpuIndexIVF"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaa7dd748e3cbd7ef68f2e384ac503eab"></a>
|
|
<a class="el" href="classfaiss_1_1gpu_1_1GpuIndexFlat.html">GpuIndexFlat</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1GpuIndexIVF.html#aaa7dd748e3cbd7ef68f2e384ac503eab">quantizer_</a></td></tr>
|
|
<tr class="memdesc:aaa7dd748e3cbd7ef68f2e384ac503eab inherit pro_attribs_classfaiss_1_1gpu_1_1GpuIndexIVF"><td class="mdescLeft"> </td><td class="mdescRight">Quantizer for inverted lists. <br/></td></tr>
|
|
<tr class="separator:aaa7dd748e3cbd7ef68f2e384ac503eab inherit pro_attribs_classfaiss_1_1gpu_1_1GpuIndexIVF"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pro_attribs_classfaiss_1_1gpu_1_1GpuIndex"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classfaiss_1_1gpu_1_1GpuIndex')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classfaiss_1_1gpu_1_1GpuIndex.html">faiss::gpu::GpuIndex</a></td></tr>
|
|
<tr class="memitem:a17b82a8a11783da6eb1b07c9aab98c36 inherit pro_attribs_classfaiss_1_1gpu_1_1GpuIndex"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a17b82a8a11783da6eb1b07c9aab98c36"></a>
|
|
<a class="el" href="classfaiss_1_1gpu_1_1GpuResources.html">GpuResources</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1GpuIndex.html#a17b82a8a11783da6eb1b07c9aab98c36">resources_</a></td></tr>
|
|
<tr class="memdesc:a17b82a8a11783da6eb1b07c9aab98c36 inherit pro_attribs_classfaiss_1_1gpu_1_1GpuIndex"><td class="mdescLeft"> </td><td class="mdescRight">Manages streams, cuBLAS handles and scratch memory for devices. <br/></td></tr>
|
|
<tr class="separator:a17b82a8a11783da6eb1b07c9aab98c36 inherit pro_attribs_classfaiss_1_1gpu_1_1GpuIndex"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a67750633faa35677ee505a1e61cfe142 inherit pro_attribs_classfaiss_1_1gpu_1_1GpuIndex"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a67750633faa35677ee505a1e61cfe142"></a>
|
|
const int </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1GpuIndex.html#a67750633faa35677ee505a1e61cfe142">device_</a></td></tr>
|
|
<tr class="memdesc:a67750633faa35677ee505a1e61cfe142 inherit pro_attribs_classfaiss_1_1gpu_1_1GpuIndex"><td class="mdescLeft"> </td><td class="mdescRight">The GPU device we are resident on. <br/></td></tr>
|
|
<tr class="separator:a67750633faa35677ee505a1e61cfe142 inherit pro_attribs_classfaiss_1_1gpu_1_1GpuIndex"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af304169eac7781b573f76d545f37b7d9 inherit pro_attribs_classfaiss_1_1gpu_1_1GpuIndex"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af304169eac7781b573f76d545f37b7d9"></a>
|
|
const MemorySpace </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1GpuIndex.html#af304169eac7781b573f76d545f37b7d9">memorySpace_</a></td></tr>
|
|
<tr class="memdesc:af304169eac7781b573f76d545f37b7d9 inherit pro_attribs_classfaiss_1_1gpu_1_1GpuIndex"><td class="mdescLeft"> </td><td class="mdescRight">The memory space of our primary storage on the GPU. <br/></td></tr>
|
|
<tr class="separator:af304169eac7781b573f76d545f37b7d9 inherit pro_attribs_classfaiss_1_1gpu_1_1GpuIndex"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a32a08664fc4dca2f9405e07ea5bc206f inherit pro_attribs_classfaiss_1_1gpu_1_1GpuIndex"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a32a08664fc4dca2f9405e07ea5bc206f"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1GpuIndex.html#a32a08664fc4dca2f9405e07ea5bc206f">minPagedSize_</a></td></tr>
|
|
<tr class="memdesc:a32a08664fc4dca2f9405e07ea5bc206f inherit pro_attribs_classfaiss_1_1gpu_1_1GpuIndex"><td class="mdescLeft"> </td><td class="mdescRight">Size above which we page copies from the CPU to GPU. <br/></td></tr>
|
|
<tr class="separator:a32a08664fc4dca2f9405e07ea5bc206f inherit pro_attribs_classfaiss_1_1gpu_1_1GpuIndex"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p><a class="el" href="classfaiss_1_1gpu_1_1IVFPQ.html" title="Implementing class for IVFPQ on the GPU. ">IVFPQ</a> index for the GPU. </p>
|
|
|
|
<p>Definition at line <a class="el" href="GpuIndexIVFPQ_8h_source.html#l00038">38</a> of file <a class="el" href="GpuIndexIVFPQ_8h_source.html">GpuIndexIVFPQ.h</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="a56a552e8c2e29f33c39883145bd7629c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">faiss::gpu::GpuIndexIVFPQ::GpuIndexIVFPQ </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classfaiss_1_1gpu_1_1GpuResources.html">GpuResources</a> * </td>
|
|
<td class="paramname"><em>resources</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="structfaiss_1_1IndexIVFPQ.html">faiss::IndexIVFPQ</a> * </td>
|
|
<td class="paramname"><em>index</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structfaiss_1_1gpu_1_1GpuIndexIVFPQConfig.html">GpuIndexIVFPQConfig</a> </td>
|
|
<td class="paramname"><em>config</em> = <code><a class="el" href="structfaiss_1_1gpu_1_1GpuIndexIVFPQConfig.html">GpuIndexIVFPQConfig</a>()</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Construct from a pre-existing <a class="el" href="structfaiss_1_1IndexIVFPQ.html">faiss::IndexIVFPQ</a> instance, copying data over to the given GPU, if the input index is trained. </p>
|
|
|
|
<p>Definition at line <a class="el" href="GpuIndexIVFPQ_8cu_source.html#l00023">23</a> of file <a class="el" href="GpuIndexIVFPQ_8cu_source.html">GpuIndexIVFPQ.cu</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a8d48f79af9080b55706050244fc24f0e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void faiss::gpu::GpuIndexIVFPQ::copyFrom </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structfaiss_1_1IndexIVFPQ.html">faiss::IndexIVFPQ</a> * </td>
|
|
<td class="paramname"><em>index</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Reserve space on the GPU for the inverted lists for <code>num</code> vectors, assumed equally distributed among Initialize ourselves from the given CPU index; will overwrite all data in ourselves </p>
|
|
|
|
<p>Definition at line <a class="el" href="GpuIndexIVFPQ_8cu_source.html#l00078">78</a> of file <a class="el" href="GpuIndexIVFPQ_8cu_source.html">GpuIndexIVFPQ.cu</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aad10de2407911e9adf42c1be5c5dd390"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void faiss::gpu::GpuIndexIVFPQ::copyTo </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structfaiss_1_1IndexIVFPQ.html">faiss::IndexIVFPQ</a> * </td>
|
|
<td class="paramname"><em>index</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Copy ourselves to the given CPU index; will overwrite all data in the index instance </p>
|
|
|
|
<p>Definition at line <a class="el" href="GpuIndexIVFPQ_8cu_source.html#l00142">142</a> of file <a class="el" href="GpuIndexIVFPQ_8cu_source.html">GpuIndexIVFPQ.cu</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a98f0000872701f9f23ac2073723a0aa7"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::vector< unsigned char > faiss::gpu::GpuIndexIVFPQ::getListCodes </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>listId</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>For debugging purposes, return the list codes of a particular list </p>
|
|
|
|
<p>Definition at line <a class="el" href="GpuIndexIVFPQ_8cu_source.html#l00371">371</a> of file <a class="el" href="GpuIndexIVFPQ_8cu_source.html">GpuIndexIVFPQ.cu</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a5235cf241ef98e6012fd01907ec705d0"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::vector< long > faiss::gpu::GpuIndexIVFPQ::getListIndices </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>listId</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>For debugging purposes, return the list indices of a particular list </p>
|
|
|
|
<p>Definition at line <a class="el" href="GpuIndexIVFPQ_8cu_source.html#l00379">379</a> of file <a class="el" href="GpuIndexIVFPQ_8cu_source.html">GpuIndexIVFPQ.cu</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab7f77961857e560b4dbb81888a8c8bf8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int faiss::gpu::GpuIndexIVFPQ::getListLength </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>listId</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>For debugging purposes, return the list length of a particular list </p>
|
|
|
|
<p>Definition at line <a class="el" href="GpuIndexIVFPQ_8cu_source.html#l00365">365</a> of file <a class="el" href="GpuIndexIVFPQ_8cu_source.html">GpuIndexIVFPQ.cu</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a83831088d9593f753560965172ccb0a0"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t faiss::gpu::GpuIndexIVFPQ::reclaimMemory </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>After adding vectors, one can call this to reclaim device memory to exactly the amount needed. Returns space reclaimed in bytes </p>
|
|
|
|
<p>Definition at line <a class="el" href="GpuIndexIVFPQ_8cu_source.html#l00236">236</a> of file <a class="el" href="GpuIndexIVFPQ_8cu_source.html">GpuIndexIVFPQ.cu</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a3a43a70461e09ef87bdb7b48ec420dd2"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void faiss::gpu::GpuIndexIVFPQ::reset </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Clears out all inverted lists, but retains the coarse and product centroid information </p>
|
|
|
|
<p>Implements <a class="el" href="structfaiss_1_1Index.html#a849361f5f0ab0aba8d419c86f2594191">faiss::Index</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="GpuIndexIVFPQ_8cu_source.html#l00246">246</a> of file <a class="el" href="GpuIndexIVFPQ_8cu_source.html">GpuIndexIVFPQ.cu</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac4814acafa4bc340a4c4bdcafd469b56"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void faiss::gpu::GpuIndexIVFPQ::train </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea">Index::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></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Perform training on a representative set of vectors</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">n</td><td>nb of training vectors </td></tr>
|
|
<tr><td class="paramname">x</td><td>training vecors, size n * d </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="structfaiss_1_1Index.html#abf601502bdbfa02b9d7bcd7b3671b71d">faiss::Index</a>.</p>
|
|
|
|
<p>Definition at line <a class="el" href="GpuIndexIVFPQ_8cu_source.html#l00302">302</a> of file <a class="el" href="GpuIndexIVFPQ_8cu_source.html">GpuIndexIVFPQ.cu</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>/data/users/hoss/faiss/gpu/<a class="el" href="GpuIndexIVFPQ_8h_source.html">GpuIndexIVFPQ.h</a></li>
|
|
<li>/data/users/hoss/faiss/gpu/<a class="el" href="GpuIndexIVFPQ_8cu_source.html">GpuIndexIVFPQ.cu</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>
|