blob: c87f72cddc33ab13d81724f324c02d557838522a [file] [log] [blame]
<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>mxnet: /work/mxnet/3rdparty/dmlc-core/include/dmlc/threadediter.h File 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/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">mxnet
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</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="dir_8cab8f464681f7cc51cee77e79a434cd.html">3rdparty</a></li><li class="navelem"><a class="el" href="dir_82e31a22178767beedddc7597fd1ecb6.html">dmlc-core</a></li><li class="navelem"><a class="el" href="dir_7dd5b88db83ff474628c03c453739a90.html">include</a></li><li class="navelem"><a class="el" href="dir_e30967e3ab51f65ad4b50dd298ccf4e7.html">dmlc</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#namespaces">Namespaces</a> </div>
<div class="headertitle">
<div class="title">threadediter.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>thread backed iterator that can be used to implement general thread-based pipeline such as prefetch and pre-computation To use the functions in this header, C++11 is required
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="3rdparty_2dmlc-core_2include_2dmlc_2base_8h_source.html">./base.h</a>&quot;</code><br />
<code>#include &lt;condition_variable&gt;</code><br />
<code>#include &lt;functional&gt;</code><br />
<code>#include &lt;mutex&gt;</code><br />
<code>#include &lt;queue&gt;</code><br />
<code>#include &lt;atomic&gt;</code><br />
<code>#include &lt;thread&gt;</code><br />
<code>#include &lt;utility&gt;</code><br />
<code>#include &lt;memory&gt;</code><br />
<code>#include &quot;<a class="el" href="data_8h_source.html">./data.h</a>&quot;</code><br />
<code>#include &quot;./logging.h&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for threadediter.h:</div>
<div class="dyncontent">
<div class="center"><img src="threadediter_8h__incl.png" border="0" usemap="#_2work_2mxnet_23rdparty_2dmlc-core_2include_2dmlc_2threadediter_8h" alt=""/></div>
<map name="_2work_2mxnet_23rdparty_2dmlc-core_2include_2dmlc_2threadediter_8h" id="_2work_2mxnet_23rdparty_2dmlc-core_2include_2dmlc_2threadediter_8h">
<area shape="rect" id="node2" href="3rdparty_2dmlc-core_2include_2dmlc_2base_8h.html" title="./base.h" alt="" coords="565,483,638,509"/>
<area shape="rect" id="node16" href="data_8h.html" title="defines common input data structure, and interface for handling the input data " alt="" coords="1465,109,1535,136"/>
<area shape="rect" id="node7" href="build__config__default_8h.html" title="Default detection logic for fopen64 and other symbols. May be overriden by CMake. ..." alt="" coords="431,557,633,584"/>
<area shape="rect" id="node18" href="3rdparty_2dmlc-core_2include_2dmlc_2io_8h.html" title="./io.h" alt="" coords="651,259,706,285"/>
<area shape="rect" id="node34" href="3rdparty_2dmlc-core_2include_2dmlc_2registry_8h.html" title="./registry.h" alt="" coords="1607,184,1697,211"/>
<area shape="rect" id="node25" href="serializer_8h.html" title="serializer template class that helps serialization. This file do not need to be directly used by most..." alt="" coords="833,333,935,360"/>
<area shape="rect" id="node29" href="type__traits_8h.html" title="type traits information header " alt="" coords="2001,408,2113,435"/>
<area shape="rect" id="node31" href="endian_8h.html" title="Endian testing, need c++11. " alt="" coords="477,408,563,435"/>
<area shape="rect" id="node35" href="parameter_8h.html" title="Provide lightweight util to do parameter setup and checking. " alt="" coords="1748,259,1857,285"/>
<area shape="rect" id="node47" href="json_8h.html" title="Lightweight JSON Reader/Writer that read save into C++ data structs. This includes STL composites and..." alt="" coords="1476,333,1545,360"/>
<area shape="rect" id="node49" href="optional_8h.html" title="Container to hold optional data. " alt="" coords="1755,333,1850,360"/>
<area shape="rect" id="node50" href="strtonum_8h.html" title="A faster implementation of strtof and strtod. " alt="" coords="2653,333,2755,360"/>
</map>
</div>
</div>
<p><a href="threadediter_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ScopedThread.html">dmlc::ScopedThread</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper class to manage std::thread; uses RAII pattern to automatically join std::thread upon destruction. <a href="classdmlc_1_1ScopedThread.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ThreadedIter.html">dmlc::ThreadedIter&lt; DType &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">a iterator that was backed by a thread to pull data eagerly from a single producer into a bounded buffer the consumer can pull the data at its own rate <a href="classdmlc_1_1ThreadedIter.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1ThreadedIter_1_1Producer.html">dmlc::ThreadedIter&lt; DType &gt;::Producer</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">producer class interface that threaditer used as source to preduce the content <a href="classdmlc_1_1ThreadedIter_1_1Producer.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespacedmlc"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacedmlc.html">dmlc</a></td></tr>
<tr class="memdesc:namespacedmlc"><td class="mdescLeft">&#160;</td><td class="mdescRight">namespace for dmlc <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>thread backed iterator that can be used to implement general thread-based pipeline such as prefetch and pre-computation To use the functions in this header, C++11 is required </p>
<p>Copyright (c) 2015 by Contributors</p>
<dl class="section author"><dt>Author</dt><dd>Tianqi Chen </dd></dl>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 5 2023 00:58:42 for mxnet by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>