blob: aea4436250c6b1f08af244b9848654ce81628ae9 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>mxnet: mxnet::cpp::MXDataIter 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/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.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</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="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> &#124;
<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 src="classmxnet_1_1cpp_1_1MXDataIter__inherit__graph.png" border="0" usemap="#mxnet_1_1cpp_1_1MXDataIter_inherit__map" alt="Inheritance graph"/></div>
<!-- MAP 0 -->
</div>
<div class="dynheader">
Collaboration diagram for mxnet::cpp::MXDataIter:</div>
<div class="dyncontent">
<div class="center"><img src="classmxnet_1_1cpp_1_1MXDataIter__coll__graph.png" border="0" usemap="#mxnet_1_1cpp_1_1MXDataIter_coll__map" alt="Collaboration graph"/></div>
<!-- MAP 1 -->
</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 class="memItemLeft" align="right" valign="top">&#160;</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">&#160;</td></tr>
<tr class="memitem:afe4be15da6b1dd0e3516b587d58a610c"><td class="memItemLeft" align="right" valign="top">&#160;</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">&#160;</td></tr>
<tr class="memitem:af225f42571d4bd2bc5238a977be6a6af"><td class="memItemLeft" align="right" valign="top">void&#160;</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">&#160;</td></tr>
<tr class="memitem:af29d681e0d8a7c1ea15837b53a24e4ca"><td class="memItemLeft" align="right" valign="top">bool&#160;</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">&#160;</td></tr>
<tr class="memitem:a53288b5429781d18cf55fd8803918ad5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a>&#160;</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">&#160;</td></tr>
<tr class="memitem:a208f539d7fe0ad893f4426c479bf308a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a>&#160;</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">&#160;</td></tr>
<tr class="memitem:ae2d25003be25379e5dbb236961d746b1"><td class="memItemLeft" align="right" valign="top">int&#160;</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">&#160;</td></tr>
<tr class="memitem:aac0d6b2b7cfbc3ba83c769d9085a5dc7"><td class="memItemLeft" align="right" valign="top">std::vector&lt; int &gt;&#160;</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">&#160;</td></tr>
<tr class="memitem:a450ae84c43be154f94df7bf3bffc307e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmxnet_1_1cpp_1_1MXDataIter.html">MXDataIter</a>&#160;</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">&#160;</td></tr>
<tr class="memitem:afc96c9aae40d965685fdb7c0a18020c0"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:afc96c9aae40d965685fdb7c0a18020c0"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classmxnet_1_1cpp_1_1MXDataIter.html">MXDataIter</a> &amp;&#160;</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">&#160;</td><td class="mdescRight">set config parameters <a href="classmxnet_1_1cpp_1_1MXDataIter.html#afc96c9aae40d965685fdb7c0a18020c0">More...</a><br /></td></tr>
<tr class="separator:afc96c9aae40d965685fdb7c0a18020c0"><td class="memSeparator" colspan="2">&#160;</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 src="closed.png" alt="-"/>&#160;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 class="memItemLeft" align="right" valign="top"><a class="el" href="classmxnet_1_1cpp_1_1DataBatch.html">DataBatch</a>&#160;</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">&#160;</td></tr>
<tr class="memitem:a8113c66cf261ac92633be9a1798fedc2 inherit pub_methods_classmxnet_1_1cpp_1_1DataIter"><td class="memItemLeft" align="right" valign="top">void&#160;</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">&#160;</td></tr>
<tr class="memitem:a5906f5aa2be3e2d67ab7b9b784793d9d inherit pub_methods_classmxnet_1_1cpp_1_1DataIter"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1DataIter.html#a5906f5aa2be3e2d67ab7b9b784793d9d">~DataIter</a> ()=default</td></tr>
<tr class="separator:a5906f5aa2be3e2d67ab7b9b784793d9d inherit pub_methods_classmxnet_1_1cpp_1_1DataIter"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aa4ca276f3f007d16b3a6d8ccb31022fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa4ca276f3f007d16b3a6d8ccb31022fd">&#9670;&nbsp;</a></span>MXDataIter() <span class="overload">[1/2]</span></h2>
<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;&#160;</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 id="afe4be15da6b1dd0e3516b587d58a610c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afe4be15da6b1dd0e3516b587d58a610c">&#9670;&nbsp;</a></span>MXDataIter() <span class="overload">[2/2]</span></h2>
<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;&#160;</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 id="af225f42571d4bd2bc5238a977be6a6af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af225f42571d4bd2bc5238a977be6a6af">&#9670;&nbsp;</a></span>BeforeFirst()</h2>
<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 id="a450ae84c43be154f94df7bf3bffc307e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a450ae84c43be154f94df7bf3bffc307e">&#9670;&nbsp;</a></span>CreateDataIter()</h2>
<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 id="a53288b5429781d18cf55fd8803918ad5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a53288b5429781d18cf55fd8803918ad5">&#9670;&nbsp;</a></span>GetData()</h2>
<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 id="aac0d6b2b7cfbc3ba83c769d9085a5dc7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aac0d6b2b7cfbc3ba83c769d9085a5dc7">&#9670;&nbsp;</a></span>GetIndex()</h2>
<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 id="a208f539d7fe0ad893f4426c479bf308a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a208f539d7fe0ad893f4426c479bf308a">&#9670;&nbsp;</a></span>GetLabel()</h2>
<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 id="ae2d25003be25379e5dbb236961d746b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae2d25003be25379e5dbb236961d746b1">&#9670;&nbsp;</a></span>GetPadNum()</h2>
<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 id="af29d681e0d8a7c1ea15837b53a24e4ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af29d681e0d8a7c1ea15837b53a24e4ca">&#9670;&nbsp;</a></span>Next()</h2>
<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 id="afc96c9aae40d965685fdb7c0a18020c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afc96c9aae40d965685fdb7c0a18020c0">&#9670;&nbsp;</a></span>SetParam()</h2>
<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;&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const T &amp;&#160;</td>
<td class="paramname"><em>value</em>&#160;</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>/work/mxnet/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 Jan 5 2023 03:47:41 for mxnet by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>