blob: f173d8cc79ebc9496dcba3d5389657bf294a4413 [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 content="text/xhtml;charset=utf-8" http-equiv="Content-Type"/>
<meta content="IE=9" http-equiv="X-UA-Compatible"/>
<meta content="Doxygen 1.8.11" name="generator"/>
<title>mxnet: mxnet::cpp::MXDataIter Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script src="jquery.js" type="text/javascript"></script>
<script src="dynsections.js" type="text/javascript"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script src="search/searchdata.js" type="text/javascript"></script>
<script src="search/search.js" type="text/javascript"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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 cellpadding="0" cellspacing="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.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div class="tabs" id="navrow1">
<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 class="MSearchBoxInactive" id="MSearchBox">
<span class="left">
<img alt="" id="MSearchSelect" onmouseout="return searchBox.OnSearchSelectHide()" onmouseover="return searchBox.OnSearchSelectShow()" src="search/mag_sel.png"/>
<input accesskey="S" id="MSearchField" onblur="searchBox.OnSearchFieldFocus(false)" onfocus="searchBox.OnSearchFieldFocus(true)" onkeyup="searchBox.OnSearchFieldChange(event)" type="text" value="Search"/>
</span><span class="right">
<a href="javascript:searchBox.CloseResultsWindow()" id="MSearchClose"><img alt="" border="0" id="MSearchCloseImg" src="search/close.png"/></a>
</span>
</div>
</li>
</ul>
</div>
<div class="tabs2" id="navrow2">
<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="inherits.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" onkeydown="return searchBox.OnSearchSelectKey(event)" onmouseout="return searchBox.OnSearchSelectHide()" onmouseover="return searchBox.OnSearchSelectShow()">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe frameborder="0" id="MSearchResults" name="MSearchResults" src="javascript:void(0)">
</iframe>
</div>
<div class="navpath" id="nav-path">
<ul>
<li class="navelem"><a class="el" href="namespacemxnet.html">mxnet</a></li><li class="navelem"><a class="el" href="namespacemxnet_1_1cpp.html">cpp</a></li><li class="navelem"><a class="el" href="classmxnet_1_1cpp_1_1MXDataIter.html">MXDataIter</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classmxnet_1_1cpp_1_1MXDataIter-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mxnet::cpp::MXDataIter Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="cpp-package_2include_2mxnet-cpp_2io_8h_source.html">io.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for mxnet::cpp::MXDataIter:</div>
<div class="dyncontent">
<div class="center"><img alt="Inheritance graph" border="0" src="classmxnet_1_1cpp_1_1MXDataIter__inherit__graph.png" usemap="#mxnet_1_1cpp_1_1MXDataIter_inherit__map"/></div>
<map id="mxnet_1_1cpp_1_1MXDataIter_inherit__map" name="mxnet_1_1cpp_1_1MXDataIter_inherit__map">
<area alt="" coords="15,5,169,185" href="classmxnet_1_1cpp_1_1DataIter.html" id="node2" shape="rect" title="{mxnet::cpp::DataIter\n||+ BeforeFirst()\l+ Next()\l+ GetData()\l+ GetLabel()\l+ GetPadNum()\l+ GetIndex()\l+ GetDataBatch()\l+ Reset()\l}"/>
</map>
</div>
<div class="dynheader">
Collaboration diagram for mxnet::cpp::MXDataIter:</div>
<div class="dyncontent">
<div class="center"><img alt="Collaboration graph" border="0" src="classmxnet_1_1cpp_1_1MXDataIter__coll__graph.png" usemap="#mxnet_1_1cpp_1_1MXDataIter_coll__map"/></div>
<map id="mxnet_1_1cpp_1_1MXDataIter_coll__map" name="mxnet_1_1cpp_1_1MXDataIter_coll__map">
<area alt="" coords="15,5,169,185" href="classmxnet_1_1cpp_1_1DataIter.html" id="node2" shape="rect" title="{mxnet::cpp::DataIter\n||+ BeforeFirst()\l+ Next()\l+ GetData()\l+ GetLabel()\l+ GetPadNum()\l+ GetIndex()\l+ GetDataBatch()\l+ Reset()\l}"/>
</map>
</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:aa4ca276f3f007d16b3a6d8ccb31022fd"><td align="right" class="memItemLeft" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1MXDataIter.html#aa4ca276f3f007d16b3a6d8ccb31022fd">MXDataIter</a> (const std::string &amp;mxdataiter_type)</td></tr>
<tr class="separator:aa4ca276f3f007d16b3a6d8ccb31022fd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afe4be15da6b1dd0e3516b587d58a610c"><td align="right" class="memItemLeft" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1MXDataIter.html#afe4be15da6b1dd0e3516b587d58a610c">MXDataIter</a> (const <a class="el" href="classmxnet_1_1cpp_1_1MXDataIter.html">MXDataIter</a> &amp;other)</td></tr>
<tr class="separator:afe4be15da6b1dd0e3516b587d58a610c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af225f42571d4bd2bc5238a977be6a6af"><td align="right" class="memItemLeft" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1MXDataIter.html#af225f42571d4bd2bc5238a977be6a6af">BeforeFirst</a> ()</td></tr>
<tr class="separator:af225f42571d4bd2bc5238a977be6a6af"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af29d681e0d8a7c1ea15837b53a24e4ca"><td align="right" class="memItemLeft" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1MXDataIter.html#af29d681e0d8a7c1ea15837b53a24e4ca">Next</a> ()</td></tr>
<tr class="separator:af29d681e0d8a7c1ea15837b53a24e4ca"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a53288b5429781d18cf55fd8803918ad5"><td align="right" class="memItemLeft" valign="top"><a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1MXDataIter.html#a53288b5429781d18cf55fd8803918ad5">GetData</a> ()</td></tr>
<tr class="separator:a53288b5429781d18cf55fd8803918ad5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a208f539d7fe0ad893f4426c479bf308a"><td align="right" class="memItemLeft" valign="top"><a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1MXDataIter.html#a208f539d7fe0ad893f4426c479bf308a">GetLabel</a> ()</td></tr>
<tr class="separator:a208f539d7fe0ad893f4426c479bf308a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae2d25003be25379e5dbb236961d746b1"><td align="right" class="memItemLeft" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1MXDataIter.html#ae2d25003be25379e5dbb236961d746b1">GetPadNum</a> ()</td></tr>
<tr class="separator:ae2d25003be25379e5dbb236961d746b1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aac0d6b2b7cfbc3ba83c769d9085a5dc7"><td align="right" class="memItemLeft" valign="top">std::vector&lt; int &gt; </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1MXDataIter.html#aac0d6b2b7cfbc3ba83c769d9085a5dc7">GetIndex</a> ()</td></tr>
<tr class="separator:aac0d6b2b7cfbc3ba83c769d9085a5dc7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a450ae84c43be154f94df7bf3bffc307e"><td align="right" class="memItemLeft" valign="top"><a class="el" href="classmxnet_1_1cpp_1_1MXDataIter.html">MXDataIter</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1MXDataIter.html#a450ae84c43be154f94df7bf3bffc307e">CreateDataIter</a> ()</td></tr>
<tr class="separator:a450ae84c43be154f94df7bf3bffc307e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afc96c9aae40d965685fdb7c0a18020c0"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:afc96c9aae40d965685fdb7c0a18020c0"><td align="right" class="memTemplItemLeft" valign="top"><a class="el" href="classmxnet_1_1cpp_1_1MXDataIter.html">MXDataIter</a> &amp; </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1MXDataIter.html#afc96c9aae40d965685fdb7c0a18020c0">SetParam</a> (const std::string &amp;name, const T &amp;value)</td></tr>
<tr class="memdesc:afc96c9aae40d965685fdb7c0a18020c0"><td class="mdescLeft"> </td><td class="mdescRight">set config parameters <a href="#afc96c9aae40d965685fdb7c0a18020c0">More...</a><br/></td></tr>
<tr class="separator:afc96c9aae40d965685fdb7c0a18020c0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classmxnet_1_1cpp_1_1DataIter"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classmxnet_1_1cpp_1_1DataIter')"><img alt="-" src="closed.png"/> Public Member Functions inherited from <a class="el" href="classmxnet_1_1cpp_1_1DataIter.html">mxnet::cpp::DataIter</a></td></tr>
<tr class="memitem:a49d4597309b648efa9f69992a8392ecb inherit pub_methods_classmxnet_1_1cpp_1_1DataIter"><td align="right" class="memItemLeft" valign="top"><a class="el" href="classmxnet_1_1cpp_1_1DataBatch.html">DataBatch</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1DataIter.html#a49d4597309b648efa9f69992a8392ecb">GetDataBatch</a> ()</td></tr>
<tr class="separator:a49d4597309b648efa9f69992a8392ecb inherit pub_methods_classmxnet_1_1cpp_1_1DataIter"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8113c66cf261ac92633be9a1798fedc2 inherit pub_methods_classmxnet_1_1cpp_1_1DataIter"><td align="right" class="memItemLeft" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1DataIter.html#a8113c66cf261ac92633be9a1798fedc2">Reset</a> ()</td></tr>
<tr class="separator:a8113c66cf261ac92633be9a1798fedc2 inherit pub_methods_classmxnet_1_1cpp_1_1DataIter"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aa4ca276f3f007d16b3a6d8ccb31022fd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">mxnet::cpp::MXDataIter::MXDataIter </td>
<td>(</td>
<td class="paramtype">const std::string &amp; </td>
<td class="paramname"><em>mxdataiter_type</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="afe4be15da6b1dd0e3516b587d58a610c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">mxnet::cpp::MXDataIter::MXDataIter </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmxnet_1_1cpp_1_1MXDataIter.html">MXDataIter</a> &amp; </td>
<td class="paramname"><em>other</em></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">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="af225f42571d4bd2bc5238a977be6a6af"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void mxnet::cpp::MXDataIter::BeforeFirst </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classmxnet_1_1cpp_1_1DataIter.html#a2d44218b1010d2b62ea0c592de004ab7">mxnet::cpp::DataIter</a>.</p>
</div>
</div>
<a class="anchor" id="a450ae84c43be154f94df7bf3bffc307e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmxnet_1_1cpp_1_1MXDataIter.html">MXDataIter</a> mxnet::cpp::MXDataIter::CreateDataIter </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a53288b5429781d18cf55fd8803918ad5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> mxnet::cpp::MXDataIter::GetData </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classmxnet_1_1cpp_1_1DataIter.html#aba3881f9d8359db4083508d4e399e8d3">mxnet::cpp::DataIter</a>.</p>
</div>
</div>
<a class="anchor" id="aac0d6b2b7cfbc3ba83c769d9085a5dc7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;int&gt; mxnet::cpp::MXDataIter::GetIndex </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classmxnet_1_1cpp_1_1DataIter.html#a32fa8d5d39e135797dbe6bc3849c3d73">mxnet::cpp::DataIter</a>.</p>
</div>
</div>
<a class="anchor" id="a208f539d7fe0ad893f4426c479bf308a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> mxnet::cpp::MXDataIter::GetLabel </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classmxnet_1_1cpp_1_1DataIter.html#a85890c45d2783dab7f3493930514ff23">mxnet::cpp::DataIter</a>.</p>
</div>
</div>
<a class="anchor" id="ae2d25003be25379e5dbb236961d746b1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int mxnet::cpp::MXDataIter::GetPadNum </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classmxnet_1_1cpp_1_1DataIter.html#a22b418ac5b862d064fd3c4c9c42340fe">mxnet::cpp::DataIter</a>.</p>
</div>
</div>
<a class="anchor" id="af29d681e0d8a7c1ea15837b53a24e4ca"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool mxnet::cpp::MXDataIter::Next </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classmxnet_1_1cpp_1_1DataIter.html#ab0a887a97a69b4a8f6d1f54f7c9ba68f">mxnet::cpp::DataIter</a>.</p>
</div>
</div>
<a class="anchor" id="afc96c9aae40d965685fdb7c0a18020c0"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmxnet_1_1cpp_1_1MXDataIter.html">MXDataIter</a>&amp; mxnet::cpp::MXDataIter::SetParam </td>
<td>(</td>
<td class="paramtype">const std::string &amp; </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const T &amp; </td>
<td class="paramname"><em>value</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>set config parameters </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>name of the config parameter </td></tr>
<tr><td class="paramname">value</td><td>value of the config parameter </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>reference of self </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>cpp-package/include/mxnet-cpp/<a class="el" href="cpp-package_2include_2mxnet-cpp_2io_8h_source.html">io.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Sep 19 2019 13:11:20 for mxnet by  <a href="http://www.doxygen.org/index.html">
<img alt="doxygen" class="footer" src="doxygen.png"/>
</a> 1.8.11
</small></address>
</body>
</html>