blob: b436ce0477d2b0f58128952cf715d11db9ffe69d [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/cpp-package/include/mxnet-cpp/io.h Source File</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_c9bbcf2f7c4ed40b1b23631ec8abffa6.html">cpp-package</a></li><li class="navelem"><a class="el" href="dir_eb07344824255b98f70969533c25e736.html">include</a></li><li class="navelem"><a class="el" href="dir_0327d24fd86e9ce22567ad8f859e5290.html">mxnet-cpp</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">io.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="cpp-package_2include_2mxnet-cpp_2io_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * distributed with this work for additional information</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * &quot;License&quot;); you may not use this file except in compliance</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * with the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * software distributed under the License is distributed on an</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * KIND, either express or implied. See the License for the</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> * specific language governing permissions and limitations</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> * under the License.</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#ifndef MXNET_CPP_IO_H_</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#define MXNET_CPP_IO_H_</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#include &lt;map&gt;</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="preprocessor">#include &lt;sstream&gt;</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="cpp-package_2include_2mxnet-cpp_2base_8h.html">mxnet-cpp/base.h</a>&quot;</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="cpp-package_2include_2mxnet-cpp_2ndarray_8h.html">mxnet-cpp/ndarray.h</a>&quot;</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="preprocessor">#include &quot;dmlc/logging.h&quot;</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacemxnet.html">mxnet</a> {</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="keyword">namespace </span>cpp {</div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classmxnet_1_1cpp_1_1DataBatch.html"> 42</a></span>&#160;<span class="keyword">class </span><a class="code" href="classmxnet_1_1cpp_1_1DataBatch.html">DataBatch</a> {</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classmxnet_1_1cpp_1_1DataBatch.html#ae124b5d84fea9ad475e35e73dd8d289e"> 44</a></span>&#160; <a class="code" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> <a class="code" href="classmxnet_1_1cpp_1_1DataBatch.html#ae124b5d84fea9ad475e35e73dd8d289e">data</a>;</div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classmxnet_1_1cpp_1_1DataBatch.html#a4053743d9b862ca70fe553872beae483"> 45</a></span>&#160; <a class="code" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> <a class="code" href="classmxnet_1_1cpp_1_1DataBatch.html#a4053743d9b862ca70fe553872beae483">label</a>;</div><div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="classmxnet_1_1cpp_1_1DataBatch.html#a8f7c42b7ff92721665309a9199fb7ec5"> 46</a></span>&#160; <span class="keywordtype">int</span> <a class="code" href="classmxnet_1_1cpp_1_1DataBatch.html#a8f7c42b7ff92721665309a9199fb7ec5">pad_num</a>;</div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classmxnet_1_1cpp_1_1DataBatch.html#ac941426722e822f13a2c32df359d6143"> 47</a></span>&#160; std::vector&lt;int&gt; <a class="code" href="classmxnet_1_1cpp_1_1DataBatch.html#ac941426722e822f13a2c32df359d6143">index</a>;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;};</div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="classmxnet_1_1cpp_1_1DataIter.html"> 49</a></span>&#160;<span class="keyword">class </span><a class="code" href="classmxnet_1_1cpp_1_1DataIter.html">DataIter</a> {</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> BeforeFirst(<span class="keywordtype">void</span>) = 0;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> Next(<span class="keywordtype">void</span>) = 0;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="keyword">virtual</span> <a class="code" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> GetData(<span class="keywordtype">void</span>) = 0;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keyword">virtual</span> <a class="code" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> GetLabel(<span class="keywordtype">void</span>) = 0;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">int</span> GetPadNum(<span class="keywordtype">void</span>) = 0;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keyword">virtual</span> std::vector&lt;int&gt; GetIndex(<span class="keywordtype">void</span>) = 0;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;</div><div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="classmxnet_1_1cpp_1_1DataIter.html#a49d4597309b648efa9f69992a8392ecb"> 58</a></span>&#160; <a class="code" href="classmxnet_1_1cpp_1_1DataBatch.html">DataBatch</a> <a class="code" href="classmxnet_1_1cpp_1_1DataIter.html#a49d4597309b648efa9f69992a8392ecb">GetDataBatch</a>() {</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classmxnet_1_1cpp_1_1DataBatch.html">DataBatch</a>{GetData(), GetLabel(), GetPadNum(), GetIndex()};</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; }</div><div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="classmxnet_1_1cpp_1_1DataIter.html#a8113c66cf261ac92633be9a1798fedc2"> 61</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classmxnet_1_1cpp_1_1DataIter.html#a8113c66cf261ac92633be9a1798fedc2">Reset</a>() { BeforeFirst(); }</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keyword">virtual</span> ~<a class="code" href="classmxnet_1_1cpp_1_1DataIter.html">DataIter</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;};</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;</div><div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="classmxnet_1_1cpp_1_1MXDataIterMap.html"> 66</a></span>&#160;<span class="keyword">class </span><a class="code" href="classmxnet_1_1cpp_1_1MXDataIterMap.html">MXDataIterMap</a> {</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="classmxnet_1_1cpp_1_1MXDataIterMap.html#a72c1176296d403c81bada8982f4a64a9"> 68</a></span>&#160; <span class="keyword">inline</span> <a class="code" href="classmxnet_1_1cpp_1_1MXDataIterMap.html#a72c1176296d403c81bada8982f4a64a9">MXDataIterMap</a>() {</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <a class="code" href="include_2mxnet_2c__api_8h.html#a3438cf44a22968b254a78032ca0c2c59">mx_uint</a> num_data_iter_creators = 0;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <a class="code" href="include_2mxnet_2c__api_8h.html#a0b9b13ccb06a6a4f05d211261fa883dd">DataIterCreator</a> *data_iter_creators = <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="keywordtype">int</span> r = <a class="code" href="include_2mxnet_2c__api_8h.html#aa9b6a48e69cb2c877a90ebc4bc1661f3">MXListDataIters</a>(&amp;num_data_iter_creators, &amp;data_iter_creators);</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; CHECK_EQ(r, 0);</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="keywordflow">for</span> (<a class="code" href="include_2mxnet_2c__api_8h.html#a3438cf44a22968b254a78032ca0c2c59">mx_uint</a> i = 0; i &lt; num_data_iter_creators; i++) {</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> *name;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> *description;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <a class="code" href="include_2mxnet_2c__api_8h.html#a3438cf44a22968b254a78032ca0c2c59">mx_uint</a> num_args;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> **arg_names;</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> **arg_type_infos;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> **arg_descriptions;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; r = <a class="code" href="include_2mxnet_2c__api_8h.html#ac34f2e69e264b30fa6adeb1a2c505053">MXDataIterGetIterInfo</a>(data_iter_creators[i], &amp;name, &amp;description,</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; &amp;num_args, &amp;arg_names, &amp;arg_type_infos,</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; &amp;arg_descriptions);</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; CHECK_EQ(r, 0);</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; mxdataiter_creators_[name] = data_iter_creators[i];</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; }</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; }</div><div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="classmxnet_1_1cpp_1_1MXDataIterMap.html#a37ef4e00a41ae1dcddce27fc10d7fe94"> 87</a></span>&#160; <span class="keyword">inline</span> <a class="code" href="include_2mxnet_2c__api_8h.html#a0b9b13ccb06a6a4f05d211261fa883dd">DataIterCreator</a> <a class="code" href="classmxnet_1_1cpp_1_1MXDataIterMap.html#a37ef4e00a41ae1dcddce27fc10d7fe94">GetMXDataIterCreator</a>(<span class="keyword">const</span> std::string &amp;name) {</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="keywordflow">return</span> mxdataiter_creators_[name];</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; }</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; std::map&lt;std::string, DataIterCreator&gt; mxdataiter_creators_;</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;};</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;</div><div class="line"><a name="l00095"></a><span class="lineno"><a class="line" href="structmxnet_1_1cpp_1_1MXDataIterBlob.html"> 95</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structmxnet_1_1cpp_1_1MXDataIterBlob.html">MXDataIterBlob</a> {</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00097"></a><span class="lineno"><a class="line" href="structmxnet_1_1cpp_1_1MXDataIterBlob.html#a893915f0151a10b623c3358d3b735bcb"> 97</a></span>&#160; <a class="code" href="structmxnet_1_1cpp_1_1MXDataIterBlob.html#a893915f0151a10b623c3358d3b735bcb">MXDataIterBlob</a>() : handle_(nullptr) {}</div><div class="line"><a name="l00098"></a><span class="lineno"><a class="line" href="structmxnet_1_1cpp_1_1MXDataIterBlob.html#a1762f84e036988f1745f9720af85e9e2"> 98</a></span>&#160; <span class="keyword">explicit</span> <a class="code" href="structmxnet_1_1cpp_1_1MXDataIterBlob.html#a1762f84e036988f1745f9720af85e9e2">MXDataIterBlob</a>(<a class="code" href="include_2mxnet_2c__api_8h.html#abce84fe05f55709d643bcfd0a4e4620b">DataIterHandle</a> handle) : handle_(handle) {}</div><div class="line"><a name="l00099"></a><span class="lineno"><a class="line" href="structmxnet_1_1cpp_1_1MXDataIterBlob.html#a8759d1ddb86fedd64b9643597dea4050"> 99</a></span>&#160; <a class="code" href="structmxnet_1_1cpp_1_1MXDataIterBlob.html#a8759d1ddb86fedd64b9643597dea4050">~MXDataIterBlob</a>() { <a class="code" href="include_2mxnet_2c__api_8h.html#a29e117922acfbc95828433e736bcc3af">MXDataIterFree</a>(handle_); }</div><div class="line"><a name="l00100"></a><span class="lineno"><a class="line" href="structmxnet_1_1cpp_1_1MXDataIterBlob.html#a90d3f6381459e542e865be2e010b3b27"> 100</a></span>&#160; <a class="code" href="include_2mxnet_2c__api_8h.html#abce84fe05f55709d643bcfd0a4e4620b">DataIterHandle</a> <a class="code" href="structmxnet_1_1cpp_1_1MXDataIterBlob.html#a90d3f6381459e542e865be2e010b3b27">handle_</a>;</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; <a class="code" href="structmxnet_1_1cpp_1_1MXDataIterBlob.html">MXDataIterBlob</a> &amp;operator=(<span class="keyword">const</span> <a class="code" href="structmxnet_1_1cpp_1_1MXDataIterBlob.html">MXDataIterBlob</a> &amp;);</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;};</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;</div><div class="line"><a name="l00106"></a><span class="lineno"><a class="line" href="classmxnet_1_1cpp_1_1MXDataIter.html"> 106</a></span>&#160;<span class="keyword">class </span><a class="code" href="classmxnet_1_1cpp_1_1MXDataIter.html">MXDataIter</a> : <span class="keyword">public</span> <a class="code" href="classmxnet_1_1cpp_1_1DataIter.html">DataIter</a> {</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; <span class="keyword">explicit</span> <a class="code" href="classmxnet_1_1cpp_1_1MXDataIter.html">MXDataIter</a>(<span class="keyword">const</span> std::string &amp;mxdataiter_type);</div><div class="line"><a name="l00109"></a><span class="lineno"><a class="line" href="classmxnet_1_1cpp_1_1MXDataIter.html#afe4be15da6b1dd0e3516b587d58a610c"> 109</a></span>&#160; <a class="code" href="classmxnet_1_1cpp_1_1MXDataIter.html#afe4be15da6b1dd0e3516b587d58a610c">MXDataIter</a>(<span class="keyword">const</span> <a class="code" href="classmxnet_1_1cpp_1_1MXDataIter.html">MXDataIter</a> &amp;other) {</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; creator_ = other.creator_;</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; params_ = other.params_;</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; blob_ptr_ = other.blob_ptr_;</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; }</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; <span class="keywordtype">void</span> BeforeFirst();</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; <span class="keywordtype">bool</span> Next();</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; <a class="code" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> GetData();</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; <a class="code" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> GetLabel();</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; <span class="keywordtype">int</span> GetPadNum();</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; std::vector&lt;int&gt; GetIndex();</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; <a class="code" href="classmxnet_1_1cpp_1_1MXDataIter.html">MXDataIter</a> CreateDataIter();</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div><div class="line"><a name="l00128"></a><span class="lineno"><a class="line" href="classmxnet_1_1cpp_1_1MXDataIter.html#afc96c9aae40d965685fdb7c0a18020c0"> 128</a></span>&#160; <a class="code" href="classmxnet_1_1cpp_1_1MXDataIter.html">MXDataIter</a> &amp;<a class="code" href="classmxnet_1_1cpp_1_1MXDataIter.html#afc96c9aae40d965685fdb7c0a18020c0">SetParam</a>(<span class="keyword">const</span> std::string &amp;name, <span class="keyword">const</span> T &amp;value) {</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; std::string value_str;</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; std::stringstream ss;</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; ss &lt;&lt; value;</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; ss &gt;&gt; value_str;</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160;</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; params_[name] = value_str;</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; <span class="keywordflow">return</span> *<span class="keyword">this</span>;</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; }</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160;</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; <a class="code" href="include_2mxnet_2c__api_8h.html#a0b9b13ccb06a6a4f05d211261fa883dd">DataIterCreator</a> creator_;</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; std::map&lt;std::string, std::string&gt; params_;</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; std::shared_ptr&lt;MXDataIterBlob&gt; blob_ptr_;</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; <span class="keyword">static</span> <a class="code" href="classmxnet_1_1cpp_1_1MXDataIterMap.html">MXDataIterMap</a>*&amp; mxdataiter_map();</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160;};</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160;} <span class="comment">// namespace cpp</span></div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160;} <span class="comment">// namespace mxnet</span></div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160;</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160;<span class="preprocessor">#endif // MXNET_CPP_IO_H_</span></div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160;</div><div class="ttc" id="structmxnet_1_1cpp_1_1MXDataIterBlob_html_a1762f84e036988f1745f9720af85e9e2"><div class="ttname"><a href="structmxnet_1_1cpp_1_1MXDataIterBlob.html#a1762f84e036988f1745f9720af85e9e2">mxnet::cpp::MXDataIterBlob::MXDataIterBlob</a></div><div class="ttdeci">MXDataIterBlob(DataIterHandle handle)</div><div class="ttdef"><b>Definition:</b> io.h:98</div></div>
<div class="ttc" id="include_2mxnet_2c__api_8h_html_a0b9b13ccb06a6a4f05d211261fa883dd"><div class="ttname"><a href="include_2mxnet_2c__api_8h.html#a0b9b13ccb06a6a4f05d211261fa883dd">DataIterCreator</a></div><div class="ttdeci">void * DataIterCreator</div><div class="ttdoc">handle a dataiter creator </div><div class="ttdef"><b>Definition:</b> c_api.h:80</div></div>
<div class="ttc" id="classmxnet_1_1cpp_1_1MXDataIter_html_afc96c9aae40d965685fdb7c0a18020c0"><div class="ttname"><a href="classmxnet_1_1cpp_1_1MXDataIter.html#afc96c9aae40d965685fdb7c0a18020c0">mxnet::cpp::MXDataIter::SetParam</a></div><div class="ttdeci">MXDataIter &amp; SetParam(const std::string &amp;name, const T &amp;value)</div><div class="ttdoc">set config parameters </div><div class="ttdef"><b>Definition:</b> io.h:128</div></div>
<div class="ttc" id="classmxnet_1_1cpp_1_1DataIter_html_a8113c66cf261ac92633be9a1798fedc2"><div class="ttname"><a href="classmxnet_1_1cpp_1_1DataIter.html#a8113c66cf261ac92633be9a1798fedc2">mxnet::cpp::DataIter::Reset</a></div><div class="ttdeci">void Reset()</div><div class="ttdef"><b>Definition:</b> io.h:61</div></div>
<div class="ttc" id="classmxnet_1_1cpp_1_1MXDataIterMap_html"><div class="ttname"><a href="classmxnet_1_1cpp_1_1MXDataIterMap.html">mxnet::cpp::MXDataIterMap</a></div><div class="ttdef"><b>Definition:</b> io.h:66</div></div>
<div class="ttc" id="namespacemxnet_html"><div class="ttname"><a href="namespacemxnet.html">mxnet</a></div><div class="ttdoc">namespace of mxnet </div><div class="ttdef"><b>Definition:</b> api_registry.h:33</div></div>
<div class="ttc" id="classmxnet_1_1cpp_1_1MXDataIterMap_html_a37ef4e00a41ae1dcddce27fc10d7fe94"><div class="ttname"><a href="classmxnet_1_1cpp_1_1MXDataIterMap.html#a37ef4e00a41ae1dcddce27fc10d7fe94">mxnet::cpp::MXDataIterMap::GetMXDataIterCreator</a></div><div class="ttdeci">DataIterCreator GetMXDataIterCreator(const std::string &amp;name)</div><div class="ttdef"><b>Definition:</b> io.h:87</div></div>
<div class="ttc" id="structmxnet_1_1cpp_1_1MXDataIterBlob_html_a8759d1ddb86fedd64b9643597dea4050"><div class="ttname"><a href="structmxnet_1_1cpp_1_1MXDataIterBlob.html#a8759d1ddb86fedd64b9643597dea4050">mxnet::cpp::MXDataIterBlob::~MXDataIterBlob</a></div><div class="ttdeci">~MXDataIterBlob()</div><div class="ttdef"><b>Definition:</b> io.h:99</div></div>
<div class="ttc" id="classmxnet_1_1cpp_1_1NDArray_html"><div class="ttname"><a href="classmxnet_1_1cpp_1_1NDArray.html">mxnet::cpp::NDArray</a></div><div class="ttdoc">NDArray interface. </div><div class="ttdef"><b>Definition:</b> ndarray.h:120</div></div>
<div class="ttc" id="classmxnet_1_1cpp_1_1MXDataIter_html"><div class="ttname"><a href="classmxnet_1_1cpp_1_1MXDataIter.html">mxnet::cpp::MXDataIter</a></div><div class="ttdef"><b>Definition:</b> io.h:106</div></div>
<div class="ttc" id="classmxnet_1_1cpp_1_1MXDataIter_html_afe4be15da6b1dd0e3516b587d58a610c"><div class="ttname"><a href="classmxnet_1_1cpp_1_1MXDataIter.html#afe4be15da6b1dd0e3516b587d58a610c">mxnet::cpp::MXDataIter::MXDataIter</a></div><div class="ttdeci">MXDataIter(const MXDataIter &amp;other)</div><div class="ttdef"><b>Definition:</b> io.h:109</div></div>
<div class="ttc" id="classmxnet_1_1cpp_1_1MXDataIterMap_html_a72c1176296d403c81bada8982f4a64a9"><div class="ttname"><a href="classmxnet_1_1cpp_1_1MXDataIterMap.html#a72c1176296d403c81bada8982f4a64a9">mxnet::cpp::MXDataIterMap::MXDataIterMap</a></div><div class="ttdeci">MXDataIterMap()</div><div class="ttdef"><b>Definition:</b> io.h:68</div></div>
<div class="ttc" id="cpp-package_2include_2mxnet-cpp_2ndarray_8h_html"><div class="ttname"><a href="cpp-package_2include_2mxnet-cpp_2ndarray_8h.html">ndarray.h</a></div></div>
<div class="ttc" id="classmxnet_1_1cpp_1_1DataBatch_html_ac941426722e822f13a2c32df359d6143"><div class="ttname"><a href="classmxnet_1_1cpp_1_1DataBatch.html#ac941426722e822f13a2c32df359d6143">mxnet::cpp::DataBatch::index</a></div><div class="ttdeci">std::vector&lt; int &gt; index</div><div class="ttdef"><b>Definition:</b> io.h:47</div></div>
<div class="ttc" id="classmxnet_1_1cpp_1_1DataBatch_html_a4053743d9b862ca70fe553872beae483"><div class="ttname"><a href="classmxnet_1_1cpp_1_1DataBatch.html#a4053743d9b862ca70fe553872beae483">mxnet::cpp::DataBatch::label</a></div><div class="ttdeci">NDArray label</div><div class="ttdef"><b>Definition:</b> io.h:45</div></div>
<div class="ttc" id="classmxnet_1_1cpp_1_1DataIter_html_a49d4597309b648efa9f69992a8392ecb"><div class="ttname"><a href="classmxnet_1_1cpp_1_1DataIter.html#a49d4597309b648efa9f69992a8392ecb">mxnet::cpp::DataIter::GetDataBatch</a></div><div class="ttdeci">DataBatch GetDataBatch()</div><div class="ttdef"><b>Definition:</b> io.h:58</div></div>
<div class="ttc" id="cpp-package_2include_2mxnet-cpp_2base_8h_html"><div class="ttname"><a href="cpp-package_2include_2mxnet-cpp_2base_8h.html">base.h</a></div></div>
<div class="ttc" id="include_2mxnet_2c__api_8h_html_ac34f2e69e264b30fa6adeb1a2c505053"><div class="ttname"><a href="include_2mxnet_2c__api_8h.html#ac34f2e69e264b30fa6adeb1a2c505053">MXDataIterGetIterInfo</a></div><div class="ttdeci">MXNET_DLL int MXDataIterGetIterInfo(DataIterCreator creator, const char **name, const char **description, uint32_t *num_args, const char ***arg_names, const char ***arg_type_infos, const char ***arg_descriptions)</div><div class="ttdoc">Get the detailed information about data iterator. </div></div>
<div class="ttc" id="classmxnet_1_1cpp_1_1DataIter_html"><div class="ttname"><a href="classmxnet_1_1cpp_1_1DataIter.html">mxnet::cpp::DataIter</a></div><div class="ttdef"><b>Definition:</b> io.h:49</div></div>
<div class="ttc" id="classmxnet_1_1cpp_1_1DataBatch_html_ae124b5d84fea9ad475e35e73dd8d289e"><div class="ttname"><a href="classmxnet_1_1cpp_1_1DataBatch.html#ae124b5d84fea9ad475e35e73dd8d289e">mxnet::cpp::DataBatch::data</a></div><div class="ttdeci">NDArray data</div><div class="ttdef"><b>Definition:</b> io.h:44</div></div>
<div class="ttc" id="structmxnet_1_1cpp_1_1MXDataIterBlob_html_a893915f0151a10b623c3358d3b735bcb"><div class="ttname"><a href="structmxnet_1_1cpp_1_1MXDataIterBlob.html#a893915f0151a10b623c3358d3b735bcb">mxnet::cpp::MXDataIterBlob::MXDataIterBlob</a></div><div class="ttdeci">MXDataIterBlob()</div><div class="ttdef"><b>Definition:</b> io.h:97</div></div>
<div class="ttc" id="include_2mxnet_2c__api_8h_html_aa9b6a48e69cb2c877a90ebc4bc1661f3"><div class="ttname"><a href="include_2mxnet_2c__api_8h.html#aa9b6a48e69cb2c877a90ebc4bc1661f3">MXListDataIters</a></div><div class="ttdeci">MXNET_DLL int MXListDataIters(uint32_t *out_size, DataIterCreator **out_array)</div><div class="ttdoc">List all the available iterator entries. </div></div>
<div class="ttc" id="classmxnet_1_1cpp_1_1DataBatch_html_a8f7c42b7ff92721665309a9199fb7ec5"><div class="ttname"><a href="classmxnet_1_1cpp_1_1DataBatch.html#a8f7c42b7ff92721665309a9199fb7ec5">mxnet::cpp::DataBatch::pad_num</a></div><div class="ttdeci">int pad_num</div><div class="ttdef"><b>Definition:</b> io.h:46</div></div>
<div class="ttc" id="include_2mxnet_2c__api_8h_html_abce84fe05f55709d643bcfd0a4e4620b"><div class="ttname"><a href="include_2mxnet_2c__api_8h.html#abce84fe05f55709d643bcfd0a4e4620b">DataIterHandle</a></div><div class="ttdeci">void * DataIterHandle</div><div class="ttdoc">handle to a DataIterator </div><div class="ttdef"><b>Definition:</b> c_api.h:82</div></div>
<div class="ttc" id="include_2mxnet_2c__api_8h_html_a29e117922acfbc95828433e736bcc3af"><div class="ttname"><a href="include_2mxnet_2c__api_8h.html#a29e117922acfbc95828433e736bcc3af">MXDataIterFree</a></div><div class="ttdeci">MXNET_DLL int MXDataIterFree(DataIterHandle handle)</div><div class="ttdoc">Free the handle to the IO module. </div></div>
<div class="ttc" id="structmxnet_1_1cpp_1_1MXDataIterBlob_html_a90d3f6381459e542e865be2e010b3b27"><div class="ttname"><a href="structmxnet_1_1cpp_1_1MXDataIterBlob.html#a90d3f6381459e542e865be2e010b3b27">mxnet::cpp::MXDataIterBlob::handle_</a></div><div class="ttdeci">DataIterHandle handle_</div><div class="ttdef"><b>Definition:</b> io.h:100</div></div>
<div class="ttc" id="classmxnet_1_1cpp_1_1DataBatch_html"><div class="ttname"><a href="classmxnet_1_1cpp_1_1DataBatch.html">mxnet::cpp::DataBatch</a></div><div class="ttdoc">Default object for holding a mini-batch of data and related information. </div><div class="ttdef"><b>Definition:</b> io.h:42</div></div>
<div class="ttc" id="include_2mxnet_2c__api_8h_html_a3438cf44a22968b254a78032ca0c2c59"><div class="ttname"><a href="include_2mxnet_2c__api_8h.html#a3438cf44a22968b254a78032ca0c2c59">mx_uint</a></div><div class="ttdeci">uint32_t mx_uint</div><div class="ttdoc">manually define unsigned int </div><div class="ttdef"><b>Definition:</b> c_api.h:57</div></div>
<div class="ttc" id="structmxnet_1_1cpp_1_1MXDataIterBlob_html"><div class="ttname"><a href="structmxnet_1_1cpp_1_1MXDataIterBlob.html">mxnet::cpp::MXDataIterBlob</a></div><div class="ttdef"><b>Definition:</b> io.h:95</div></div>
</div><!-- fragment --></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>