Google Git
Sign in
apache / mxnet-site / d609d06f3665aa621073cbe7aa8beac783051a9c / . / api / cpp / docs / api / classmxnet_1_1cpp_1_1DataBatch.html
blob: fba61da7c71948ea4fabdbb3e0908681a5b775c7 [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::DataBatch 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_1DataBatch.html">DataBatch</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<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 src="classmxnet_1_1cpp_1_1DataBatch__coll__graph.png" border="0" usemap="#mxnet_1_1cpp_1_1DataBatch_coll__map" alt="Collaboration graph"/></div>
<!-- MAP 0 -->
</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 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_1DataBatch.html#ae124b5d84fea9ad475e35e73dd8d289e">data</a></td></tr>
<tr class="separator:ae124b5d84fea9ad475e35e73dd8d289e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4053743d9b862ca70fe553872beae483"><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_1DataBatch.html#a4053743d9b862ca70fe553872beae483">label</a></td></tr>
<tr class="separator:a4053743d9b862ca70fe553872beae483"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f7c42b7ff92721665309a9199fb7ec5"><td class="memItemLeft" align="right" valign="top">int&#160;</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">&#160;</td></tr>
<tr class="memitem:ac941426722e822f13a2c32df359d6143"><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_1DataBatch.html#ac941426722e822f13a2c32df359d6143">index</a></td></tr>
<tr class="separator:ac941426722e822f13a2c32df359d6143"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="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 id="ae124b5d84fea9ad475e35e73dd8d289e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae124b5d84fea9ad475e35e73dd8d289e">&#9670;&nbsp;</a></span>data</h2>
<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 id="ac941426722e822f13a2c32df359d6143"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac941426722e822f13a2c32df359d6143">&#9670;&nbsp;</a></span>index</h2>
<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 id="a4053743d9b862ca70fe553872beae483"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4053743d9b862ca70fe553872beae483">&#9670;&nbsp;</a></span>label</h2>
<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 id="a8f7c42b7ff92721665309a9199fb7ec5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8f7c42b7ff92721665309a9199fb7ec5">&#9670;&nbsp;</a></span>pad_num</h2>
<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>/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 Fri Nov 11 2022 01:13:58 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>