<!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::WorkerThread 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_1WorkerThread.html">WorkerThread</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classfaiss_1_1gpu_1_1WorkerThread-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">faiss::gpu::WorkerThread Class 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:ac1a9c44f38ea5345a650da04b032d41b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1WorkerThread.html#ac1a9c44f38ea5345a650da04b032d41b">~WorkerThread</a> ()</td></tr>
<tr class="separator:ac1a9c44f38ea5345a650da04b032d41b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a68963d8c18822d7736c96e82367f2f12"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a68963d8c18822d7736c96e82367f2f12"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1WorkerThread.html#a68963d8c18822d7736c96e82367f2f12">stop</a> ()</td></tr>
<tr class="memdesc:a68963d8c18822d7736c96e82367f2f12"><td class="mdescLeft"> </td><td class="mdescRight">Request that the worker thread stop itself. <br/></td></tr>
<tr class="separator:a68963d8c18822d7736c96e82367f2f12"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa7fd80a803f543a2027ea74e81db677a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1WorkerThread.html#aa7fd80a803f543a2027ea74e81db677a">waitForThreadExit</a> ()</td></tr>
<tr class="separator:aa7fd80a803f543a2027ea74e81db677a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeddb3e9911373019dbd04b7e8a9762cf"><td class="memItemLeft" align="right" valign="top">std::future< bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="classfaiss_1_1gpu_1_1WorkerThread.html#aeddb3e9911373019dbd04b7e8a9762cf">add</a> (std::function< void()> f)</td></tr>
<tr class="separator:aeddb3e9911373019dbd04b7e8a9762cf"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p>Definition at line <a class="el" href="WorkerThread_8h_source.html#l00021">21</a> of file <a class="el" href="WorkerThread_8h_source.html">WorkerThread.h</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="ac1a9c44f38ea5345a650da04b032d41b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">faiss::gpu::WorkerThread::~WorkerThread </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Stops and waits for the worker thread to exit, flushing all pending lambdas </p>
<p>Definition at line <a class="el" href="WorkerThread_8cpp_source.html#l00025">25</a> of file <a class="el" href="WorkerThread_8cpp_source.html">WorkerThread.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aeddb3e9911373019dbd04b7e8a9762cf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::future< bool > faiss::gpu::WorkerThread::add </td>
<td>(</td>
<td class="paramtype">std::function< void()> </td>
<td class="paramname"><em>f</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds a lambda to run on the worker thread; returns a future that can be used to block on its completion. Future status is <code>true</code> if the lambda was run in the worker thread; <code>false</code> if it was not run, because the worker thread is exiting or has exited. </p>
<p>Definition at line <a class="el" href="WorkerThread_8cpp_source.html#l00044">44</a> of file <a class="el" href="WorkerThread_8cpp_source.html">WorkerThread.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aa7fd80a803f543a2027ea74e81db677a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void faiss::gpu::WorkerThread::waitForThreadExit </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Blocking waits in the current thread for the worker thread to stop </p>
<p>Definition at line <a class="el" href="WorkerThread_8cpp_source.html#l00107">107</a> of file <a class="el" href="WorkerThread_8cpp_source.html">WorkerThread.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>/data/users/matthijs/github_faiss/faiss/gpu/utils/<a class="el" href="WorkerThread_8h_source.html">WorkerThread.h</a></li>
<li>/data/users/matthijs/github_faiss/faiss/gpu/utils/<a class="el" href="WorkerThread_8cpp_source.html">WorkerThread.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>