Google Git
Sign in
apache / mxnet-test / refs/heads/asf-site / . / versions / master / doxygen / io_8h.html
blob: 8dd454349fbf63343771c3e6f30dda6c9af6e907 [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.6"/>
<title>mxnet: include/mxnet/io.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/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">mxnet
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><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="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</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="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_1143c7affb9ebd026cb6818dd282def7.html">mxnet</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#namespaces">Namespaces</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> </div>
<div class="headertitle">
<div class="title">io.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>mxnet io data structure and data iterator
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;dmlc/data.h&gt;</code><br/>
<code>#include &lt;dmlc/registry.h&gt;</code><br/>
<code>#include &lt;vector&gt;</code><br/>
<code>#include &lt;string&gt;</code><br/>
<code>#include &lt;utility&gt;</code><br/>
<code>#include &lt;queue&gt;</code><br/>
<code>#include &quot;<a class="el" href="base_8h_source.html">./base.h</a>&quot;</code><br/>
<code>#include &quot;<a class="el" href="ndarray_8h_source.html">./ndarray.h</a>&quot;</code><br/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for io.h:</div>
<div class="dyncontent">
<div class="center"><img src="io_8h__incl.png" border="0" usemap="#include_2mxnet_2io_8h" alt=""/></div>
<map name="include_2mxnet_2io_8h" id="include_2mxnet_2io_8h">
<area shape="rect" id="node8" href="base_8h.html" title="configuation of mxnet as well as basic data structure. " alt="" coords="739,229,812,256"/><area shape="rect" id="node17" href="ndarray_8h.html" title="NDArray interface that handles array arithematics. " alt="" coords="774,80,863,107"/><area shape="rect" id="node22" href="storage_8h.html" title="Storage manager across multiple devices. " alt="" coords="579,155,669,181"/><area shape="rect" id="node23" href="engine_8h.html" title="Engine that schedules all the operations according to dependency. " alt="" coords="419,155,504,181"/></map>
</div>
</div>
<p><a href="io_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="classmxnet_1_1IIterator.html">mxnet::IIterator&lt; DType &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">iterator type <a href="classmxnet_1_1IIterator.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">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1DataInst.html">mxnet::DataInst</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">a single data instance <a href="structmxnet_1_1DataInst.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">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1DataBatch.html">mxnet::DataBatch</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="structmxnet_1_1DataBatch.html" title="DataBatch of NDArray, returned by Iterator. ">DataBatch</a> of <a class="el" href="classmxnet_1_1NDArray.html" title="ndarray interface ">NDArray</a>, returned by Iterator. <a href="structmxnet_1_1DataBatch.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">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1DataIteratorReg.html">mxnet::DataIteratorReg</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registry entry for DataIterator factory functions. <a href="structmxnet_1_1DataIteratorReg.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:namespacemxnet"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet.html">mxnet</a></td></tr>
<tr class="memdesc:namespacemxnet"><td class="mdescLeft">&#160;</td><td class="mdescRight">namespace of mxnet <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="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ad3d0e409cb072cac4a1eb93ee390077b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="io_8h.html#ad3d0e409cb072cac4a1eb93ee390077b">MXNET_REGISTER_IO_ITER</a>(name)&#160;&#160;&#160;DMLC_REGISTRY_REGISTER(::<a class="el" href="structmxnet_1_1DataIteratorReg.html">mxnet::DataIteratorReg</a>, DataIteratorReg, name)</td></tr>
<tr class="memdesc:ad3d0e409cb072cac4a1eb93ee390077b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Macro to register Iterators. <a href="#ad3d0e409cb072cac4a1eb93ee390077b">More...</a><br/></td></tr>
<tr class="separator:ad3d0e409cb072cac4a1eb93ee390077b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a6dca73c81706d54b0ddb0ef967d1e132"><td class="memItemLeft" align="right" valign="top">typedef std::function<br class="typebreak"/>
&lt; IIterator&lt; DataBatch &gt; *()&gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet.html#a6dca73c81706d54b0ddb0ef967d1e132">mxnet::DataIteratorFactory</a></td></tr>
<tr class="memdesc:a6dca73c81706d54b0ddb0ef967d1e132"><td class="mdescLeft">&#160;</td><td class="mdescRight">typedef the factory function of data iterator <a href="#a6dca73c81706d54b0ddb0ef967d1e132">More...</a><br/></td></tr>
<tr class="separator:a6dca73c81706d54b0ddb0ef967d1e132"><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>mxnet io data structure and data iterator </p>
<p>Copyright (c) 2015 by Contributors </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ad3d0e409cb072cac4a1eb93ee390077b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MXNET_REGISTER_IO_ITER</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">name</td><td>)</td>
<td>&#160;&#160;&#160;DMLC_REGISTRY_REGISTER(::<a class="el" href="structmxnet_1_1DataIteratorReg.html">mxnet::DataIteratorReg</a>, DataIteratorReg, name)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Macro to register Iterators. </p>
<div class="fragment"><div class="line"><span class="comment">// example of registering a mnist iterator</span></div>
<div class="line">REGISTER_IO_ITE(MNISTIter)</div>
<div class="line">.describe(<span class="stringliteral">&quot;Mnist data iterator&quot;</span>)</div>
<div class="line">.set_body([]() {</div>
<div class="line"> <span class="keywordflow">return</span> <span class="keyword">new</span> PrefetcherIter(<span class="keyword">new</span> MNISTIter());</div>
<div class="line"> });</div>
</div><!-- fragment -->
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Aug 6 2017 07:14:31 for mxnet by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>