Google Git
Sign in
apache / mxnet-site / d5c5a235eef72f64ccaf224b834a20ef3287469b / . / versions / 1.9.1 / api / cpp / docs / api / classmxnet_1_1cpp_1_1DataIter.html
blob: 9ec66b8a3153a42510640032198fdb6138a2aa61 [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: mxnet::cpp::DataIter 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.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="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_1DataIter.html">DataIter</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_1DataIter-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mxnet::cpp::DataIter Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></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::DataIter:</div>
<div class="dyncontent">
<div class="center"><img src="classmxnet_1_1cpp_1_1DataIter__inherit__graph.png" border="0" usemap="#mxnet_1_1cpp_1_1DataIter_inherit__map" alt="Inheritance graph"/></div>
<map name="mxnet_1_1cpp_1_1DataIter_inherit__map" id="mxnet_1_1cpp_1_1DataIter_inherit__map">
<area shape="rect" id="node2" href="classmxnet_1_1cpp_1_1MXDataIter.html" title="{mxnet::cpp::MXDataIter\n||+ MXDataIter()\l+ MXDataIter()\l+ BeforeFirst()\l+ Next()\l+ GetData()\l+ GetLabel()\l+ GetPadNum()\l+ GetIndex()\l+ CreateDataIter()\l+ SetParam()\l}" alt="" coords="5,248,181,457"/>
</map>
</div>
<div class="dynheader">
Collaboration diagram for mxnet::cpp::DataIter:</div>
<div class="dyncontent">
<div class="center"><img src="classmxnet_1_1cpp_1_1DataIter__coll__graph.png" border="0" usemap="#mxnet_1_1cpp_1_1DataIter_coll__map" alt="Collaboration graph"/></div>
<map name="mxnet_1_1cpp_1_1DataIter_coll__map" id="mxnet_1_1cpp_1_1DataIter_coll__map">
</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:a2d44218b1010d2b62ea0c592de004ab7"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1DataIter.html#a2d44218b1010d2b62ea0c592de004ab7">BeforeFirst</a> (void)=0</td></tr>
<tr class="separator:a2d44218b1010d2b62ea0c592de004ab7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab0a887a97a69b4a8f6d1f54f7c9ba68f"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1DataIter.html#ab0a887a97a69b4a8f6d1f54f7c9ba68f">Next</a> (void)=0</td></tr>
<tr class="separator:ab0a887a97a69b4a8f6d1f54f7c9ba68f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aba3881f9d8359db4083508d4e399e8d3"><td class="memItemLeft" align="right" valign="top">virtual <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_1DataIter.html#aba3881f9d8359db4083508d4e399e8d3">GetData</a> (void)=0</td></tr>
<tr class="separator:aba3881f9d8359db4083508d4e399e8d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a85890c45d2783dab7f3493930514ff23"><td class="memItemLeft" align="right" valign="top">virtual <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_1DataIter.html#a85890c45d2783dab7f3493930514ff23">GetLabel</a> (void)=0</td></tr>
<tr class="separator:a85890c45d2783dab7f3493930514ff23"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a22b418ac5b862d064fd3c4c9c42340fe"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1DataIter.html#a22b418ac5b862d064fd3c4c9c42340fe">GetPadNum</a> (void)=0</td></tr>
<tr class="separator:a22b418ac5b862d064fd3c4c9c42340fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a32fa8d5d39e135797dbe6bc3849c3d73"><td class="memItemLeft" align="right" valign="top">virtual std::vector&lt; int &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1DataIter.html#a32fa8d5d39e135797dbe6bc3849c3d73">GetIndex</a> (void)=0</td></tr>
<tr class="separator:a32fa8d5d39e135797dbe6bc3849c3d73"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a49d4597309b648efa9f69992a8392ecb"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8113c66cf261ac92633be9a1798fedc2"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5906f5aa2be3e2d67ab7b9b784793d9d"><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"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a5906f5aa2be3e2d67ab7b9b784793d9d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5906f5aa2be3e2d67ab7b9b784793d9d">&#9670;&nbsp;</a></span>~DataIter()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual mxnet::cpp::DataIter::~DataIter </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 class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a2d44218b1010d2b62ea0c592de004ab7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d44218b1010d2b62ea0c592de004ab7">&#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">virtual void mxnet::cpp::DataIter::BeforeFirst </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classmxnet_1_1cpp_1_1MXDataIter.html#af225f42571d4bd2bc5238a977be6a6af">mxnet::cpp::MXDataIter</a>.</p>
</div>
</div>
<a id="aba3881f9d8359db4083508d4e399e8d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aba3881f9d8359db4083508d4e399e8d3">&#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">virtual <a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> mxnet::cpp::DataIter::GetData </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classmxnet_1_1cpp_1_1MXDataIter.html#a53288b5429781d18cf55fd8803918ad5">mxnet::cpp::MXDataIter</a>.</p>
</div>
</div>
<a id="a49d4597309b648efa9f69992a8392ecb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a49d4597309b648efa9f69992a8392ecb">&#9670;&nbsp;</a></span>GetDataBatch()</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_1DataBatch.html">DataBatch</a> mxnet::cpp::DataIter::GetDataBatch </td>
<td>(</td>
<td class="paramname"></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>
<a id="a32fa8d5d39e135797dbe6bc3849c3d73"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a32fa8d5d39e135797dbe6bc3849c3d73">&#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">virtual std::vector&lt;int&gt; mxnet::cpp::DataIter::GetIndex </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classmxnet_1_1cpp_1_1MXDataIter.html#aac0d6b2b7cfbc3ba83c769d9085a5dc7">mxnet::cpp::MXDataIter</a>.</p>
</div>
</div>
<a id="a85890c45d2783dab7f3493930514ff23"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a85890c45d2783dab7f3493930514ff23">&#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">virtual <a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> mxnet::cpp::DataIter::GetLabel </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classmxnet_1_1cpp_1_1MXDataIter.html#a208f539d7fe0ad893f4426c479bf308a">mxnet::cpp::MXDataIter</a>.</p>
</div>
</div>
<a id="a22b418ac5b862d064fd3c4c9c42340fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a22b418ac5b862d064fd3c4c9c42340fe">&#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">virtual int mxnet::cpp::DataIter::GetPadNum </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classmxnet_1_1cpp_1_1MXDataIter.html#ae2d25003be25379e5dbb236961d746b1">mxnet::cpp::MXDataIter</a>.</p>
</div>
</div>
<a id="ab0a887a97a69b4a8f6d1f54f7c9ba68f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab0a887a97a69b4a8f6d1f54f7c9ba68f">&#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">virtual bool mxnet::cpp::DataIter::Next </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classmxnet_1_1cpp_1_1MXDataIter.html#af29d681e0d8a7c1ea15837b53a24e4ca">mxnet::cpp::MXDataIter</a>.</p>
</div>
</div>
<a id="a8113c66cf261ac92633be9a1798fedc2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8113c66cf261ac92633be9a1798fedc2">&#9670;&nbsp;</a></span>Reset()</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::DataIter::Reset </td>
<td>(</td>
<td class="paramname"></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>
<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 00:58:44 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>