blob: 8b1d81d270aaef2a9ef4804a44c6f70774ff9827 [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::DataBatch 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_1DataBatch.html">DataBatch</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> |
<a href="classmxnet_1_1cpp_1_1DataBatch-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mxnet::cpp::DataBatch Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Default object for holding a mini-batch of data and related information.
<a href="classmxnet_1_1cpp_1_1DataBatch.html#details">More...</a></p>
<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">
Collaboration diagram for mxnet::cpp::DataBatch:</div>
<div class="dyncontent">
<div class="center"><img alt="Collaboration graph" border="0" src="classmxnet_1_1cpp_1_1DataBatch__coll__graph.png" usemap="#mxnet_1_1cpp_1_1DataBatch_coll__map"/></div>
<map id="mxnet_1_1cpp_1_1DataBatch_coll__map" name="mxnet_1_1cpp_1_1DataBatch_coll__map">
<area alt="" coords="13,5,169,347" href="classmxnet_1_1cpp_1_1NDArray.html" id="node2" shape="rect" title="NDArray interface. "/>
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ae124b5d84fea9ad475e35e73dd8d289e"><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_1DataBatch.html#ae124b5d84fea9ad475e35e73dd8d289e">data</a></td></tr>
<tr class="separator:ae124b5d84fea9ad475e35e73dd8d289e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4053743d9b862ca70fe553872beae483"><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_1DataBatch.html#a4053743d9b862ca70fe553872beae483">label</a></td></tr>
<tr class="separator:a4053743d9b862ca70fe553872beae483"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8f7c42b7ff92721665309a9199fb7ec5"><td align="right" class="memItemLeft" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1DataBatch.html#a8f7c42b7ff92721665309a9199fb7ec5">pad_num</a></td></tr>
<tr class="separator:a8f7c42b7ff92721665309a9199fb7ec5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac941426722e822f13a2c32df359d6143"><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_1DataBatch.html#ac941426722e822f13a2c32df359d6143">index</a></td></tr>
<tr class="separator:ac941426722e822f13a2c32df359d6143"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a id="details" name="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Default object for holding a mini-batch of data and related information. </p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="ae124b5d84fea9ad475e35e73dd8d289e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> mxnet::cpp::DataBatch::data</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ac941426722e822f13a2c32df359d6143"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;int&gt; mxnet::cpp::DataBatch::index</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a4053743d9b862ca70fe553872beae483"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmxnet_1_1cpp_1_1NDArray.html">NDArray</a> mxnet::cpp::DataBatch::label</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a8f7c42b7ff92721665309a9199fb7ec5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mxnet::cpp::DataBatch::pad_num</td>
</tr>
</table>
</div><div class="memdoc">
</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>