235 lines
15 KiB
HTML
235 lines
15 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::WarpSelect< K, V, Dir, Comp, NumWarpQ, NumThreadQ, ThreadsPerBlock > Struct 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 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="structfaiss_1_1gpu_1_1WarpSelect.html">WarpSelect</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
|
<a href="#pub-static-attribs">Static Public Attributes</a> |
|
|
<a href="structfaiss_1_1gpu_1_1WarpSelect-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">faiss::gpu::WarpSelect< K, V, Dir, Comp, NumWarpQ, NumThreadQ, ThreadsPerBlock > Struct Template Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<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:aed58f35593253c8b3132e43832c78948"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aed58f35593253c8b3132e43832c78948"></a>
|
|
__device__ </td><td class="memItemRight" valign="bottom"><b>WarpSelect</b> (K initK, V initV, int k)</td></tr>
|
|
<tr class="separator:aed58f35593253c8b3132e43832c78948"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad3b53044e56ed6a0527b8f9e75e5791f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad3b53044e56ed6a0527b8f9e75e5791f"></a>
|
|
__device__ void </td><td class="memItemRight" valign="bottom"><b>addThreadQ</b> (K k, V v)</td></tr>
|
|
<tr class="separator:ad3b53044e56ed6a0527b8f9e75e5791f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a97a0595db52dfe8bf443a5ee08603e74"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a97a0595db52dfe8bf443a5ee08603e74"></a>
|
|
__device__ void </td><td class="memItemRight" valign="bottom"><b>checkThreadQ</b> ()</td></tr>
|
|
<tr class="separator:a97a0595db52dfe8bf443a5ee08603e74"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a408cbf9a09094078cb62018400f30076"><td class="memItemLeft" align="right" valign="top">__device__ void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1gpu_1_1WarpSelect.html#a408cbf9a09094078cb62018400f30076">mergeWarpQ</a> ()</td></tr>
|
|
<tr class="separator:a408cbf9a09094078cb62018400f30076"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab516c923a93dda2c846ecb57b29227fd"><td class="memItemLeft" align="right" valign="top">__device__ void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1gpu_1_1WarpSelect.html#ab516c923a93dda2c846ecb57b29227fd">add</a> (K k, V v)</td></tr>
|
|
<tr class="separator:ab516c923a93dda2c846ecb57b29227fd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab6334beddb1485f27cc1e68bc89d0483"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab6334beddb1485f27cc1e68bc89d0483"></a>
|
|
__device__ void </td><td class="memItemRight" valign="bottom"><b>reduce</b> ()</td></tr>
|
|
<tr class="separator:ab6334beddb1485f27cc1e68bc89d0483"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1cd82964e633531a95d5d095e012acb5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1cd82964e633531a95d5d095e012acb5"></a>
|
|
__device__ void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfaiss_1_1gpu_1_1WarpSelect.html#a1cd82964e633531a95d5d095e012acb5">writeOut</a> (K *outK, V *outV, int k)</td></tr>
|
|
<tr class="memdesc:a1cd82964e633531a95d5d095e012acb5"><td class="mdescLeft"> </td><td class="mdescRight">Dump final k selected values for this warp out. <br/></td></tr>
|
|
<tr class="separator:a1cd82964e633531a95d5d095e012acb5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
|
|
Public Attributes</h2></td></tr>
|
|
<tr class="memitem:a0d9ad170672eed8554c43d30103544d2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0d9ad170672eed8554c43d30103544d2"></a>
|
|
K </td><td class="memItemRight" valign="bottom"><b>threadK</b> [NumThreadQ]</td></tr>
|
|
<tr class="separator:a0d9ad170672eed8554c43d30103544d2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae0818cdd556dd4d1109eb790da762aa5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae0818cdd556dd4d1109eb790da762aa5"></a>
|
|
V </td><td class="memItemRight" valign="bottom"><b>threadV</b> [NumThreadQ]</td></tr>
|
|
<tr class="separator:ae0818cdd556dd4d1109eb790da762aa5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a10e34528abe23cfff1b05117578478eb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a10e34528abe23cfff1b05117578478eb"></a>
|
|
K </td><td class="memItemRight" valign="bottom"><b>warpK</b> [kNumWarpQRegisters]</td></tr>
|
|
<tr class="separator:a10e34528abe23cfff1b05117578478eb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a87c88003dbccac77047e32821b2ecf30"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a87c88003dbccac77047e32821b2ecf30"></a>
|
|
V </td><td class="memItemRight" valign="bottom"><b>warpV</b> [kNumWarpQRegisters]</td></tr>
|
|
<tr class="separator:a87c88003dbccac77047e32821b2ecf30"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af140f45e68252bde8d138b61c6eecbee"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af140f45e68252bde8d138b61c6eecbee"></a>
|
|
K </td><td class="memItemRight" valign="bottom"><b>warpKTop</b></td></tr>
|
|
<tr class="separator:af140f45e68252bde8d138b61c6eecbee"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aea027fde101097bdd872854fd77a17a6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aea027fde101097bdd872854fd77a17a6"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>kLane</b></td></tr>
|
|
<tr class="separator:aea027fde101097bdd872854fd77a17a6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
|
|
Static Public Attributes</h2></td></tr>
|
|
<tr class="memitem:a95726a02c37a515b4e9cf144caeb38ec"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a95726a02c37a515b4e9cf144caeb38ec"></a>
|
|
static constexpr int </td><td class="memItemRight" valign="bottom"><b>kNumWarpQRegisters</b> = NumWarpQ / kWarpSize</td></tr>
|
|
<tr class="separator:a95726a02c37a515b4e9cf144caeb38ec"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><h3>template<typename K, typename V, bool Dir, typename Comp, int NumWarpQ, int NumThreadQ, int ThreadsPerBlock><br/>
|
|
struct faiss::gpu::WarpSelect< K, V, Dir, Comp, NumWarpQ, NumThreadQ, ThreadsPerBlock ></h3>
|
|
|
|
|
|
<p>Definition at line <a class="el" href="Select_8cuh_source.html#l00371">371</a> of file <a class="el" href="Select_8cuh_source.html">Select.cuh</a>.</p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="ab516c923a93dda2c846ecb57b29227fd"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename K , typename V , bool Dir, typename Comp , int NumWarpQ, int NumThreadQ, int ThreadsPerBlock> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">__device__ void <a class="el" href="structfaiss_1_1gpu_1_1WarpSelect.html">faiss::gpu::WarpSelect</a>< K, V, Dir, Comp, NumWarpQ, NumThreadQ, ThreadsPerBlock >::add </td>
|
|
<td>(</td>
|
|
<td class="paramtype">K </td>
|
|
<td class="paramname"><em>k</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">V </td>
|
|
<td class="paramname"><em>v</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">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>WARNING: all threads in a warp must participate in this. Otherwise, you must call the constituent parts separately. </p>
|
|
|
|
<p>Definition at line <a class="el" href="Select_8cuh_source.html#l00476">476</a> of file <a class="el" href="Select_8cuh_source.html">Select.cuh</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a408cbf9a09094078cb62018400f30076"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename K , typename V , bool Dir, typename Comp , int NumWarpQ, int NumThreadQ, int ThreadsPerBlock> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">__device__ void <a class="el" href="structfaiss_1_1gpu_1_1WarpSelect.html">faiss::gpu::WarpSelect</a>< K, V, Dir, Comp, NumWarpQ, NumThreadQ, ThreadsPerBlock >::mergeWarpQ </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>This function handles sorting and merging together the per-thread queues with the warp-wide queue, creating a sorted list across both </p>
|
|
|
|
<p>Definition at line <a class="el" href="Select_8cuh_source.html#l00442">442</a> of file <a class="el" href="Select_8cuh_source.html">Select.cuh</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct was generated from the following file:<ul>
|
|
<li>/data/users/matthijs/github_faiss/faiss/gpu/utils/<a class="el" href="Select_8cuh_source.html">Select.cuh</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>
|