blob: c17f173a28f72c417837c97f51f5f197155cc7f9 [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.6" name="generator"/>
<title>mxnet: mxnet::DataBatch Struct 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/search.js" type="text/javascript"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 style="padding-left: 0.5em;">
<div id="projectname">mxnet
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<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()">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a></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="structmxnet_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="structmxnet_1_1DataBatch-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mxnet::DataBatch Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="structmxnet_1_1DataBatch.html" title="DataBatch of NDArray, returned by Iterator. ">DataBatch</a> of <a class="el" href="classmxnet_1_1NDArray.html" title="ndarray interface ">NDArray</a>, returned by Iterator.
<a href="structmxnet_1_1DataBatch.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="io_8h_source.html">io.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for mxnet::DataBatch:</div>
<div class="dyncontent">
<div class="center"><img alt="Collaboration graph" border="0" src="structmxnet_1_1DataBatch__coll__graph.png" usemap="#mxnet_1_1DataBatch_coll__map"/></div>
<map id="mxnet_1_1DataBatch_coll__map" name="mxnet_1_1DataBatch_coll__map">
</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:acc98dd6f48816ca7462352a929e48959"><td align="right" class="memItemLeft" valign="top">std::vector&lt; <a class="el" href="classmxnet_1_1NDArray.html">NDArray</a> &gt; </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1DataBatch.html#acc98dd6f48816ca7462352a929e48959">data</a></td></tr>
<tr class="memdesc:acc98dd6f48816ca7462352a929e48959"><td class="mdescLeft"> </td><td class="mdescRight">content of dense data, if this <a class="el" href="structmxnet_1_1DataBatch.html" title="DataBatch of NDArray, returned by Iterator. ">DataBatch</a> is dense <a href="#acc98dd6f48816ca7462352a929e48959">More...</a><br/></td></tr>
<tr class="separator:acc98dd6f48816ca7462352a929e48959"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a26a2ca473161c2c2a914cbc7ae4eb74e"><td align="right" class="memItemLeft" valign="top">std::vector&lt; uint64_t &gt; </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1DataBatch.html#a26a2ca473161c2c2a914cbc7ae4eb74e">index</a></td></tr>
<tr class="memdesc:a26a2ca473161c2c2a914cbc7ae4eb74e"><td class="mdescLeft"> </td><td class="mdescRight">index of image data <a href="#a26a2ca473161c2c2a914cbc7ae4eb74e">More...</a><br/></td></tr>
<tr class="separator:a26a2ca473161c2c2a914cbc7ae4eb74e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2e9faeff00dd061f04a88c3ea5758aa2"><td align="right" class="memItemLeft" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1DataBatch.html#a2e9faeff00dd061f04a88c3ea5758aa2">extra_data</a></td></tr>
<tr class="memdesc:a2e9faeff00dd061f04a88c3ea5758aa2"><td class="mdescLeft"> </td><td class="mdescRight">extra data to be fed to the network <a href="#a2e9faeff00dd061f04a88c3ea5758aa2">More...</a><br/></td></tr>
<tr class="separator:a2e9faeff00dd061f04a88c3ea5758aa2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aad93df826690100bb16689952fc83558"><td align="right" class="memItemLeft" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1DataBatch.html#aad93df826690100bb16689952fc83558">num_batch_padd</a></td></tr>
<tr class="memdesc:aad93df826690100bb16689952fc83558"><td class="mdescLeft"> </td><td class="mdescRight">num of example padded to batch <a href="#aad93df826690100bb16689952fc83558">More...</a><br/></td></tr>
<tr class="separator:aad93df826690100bb16689952fc83558"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a id="details" name="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="structmxnet_1_1DataBatch.html" title="DataBatch of NDArray, returned by Iterator. ">DataBatch</a> of <a class="el" href="classmxnet_1_1NDArray.html" title="ndarray interface ">NDArray</a>, returned by Iterator. </p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="acc98dd6f48816ca7462352a929e48959"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;<a class="el" href="classmxnet_1_1NDArray.html">NDArray</a>&gt; mxnet::DataBatch::data</td>
</tr>
</table>
</div><div class="memdoc">
<p>content of dense data, if this <a class="el" href="structmxnet_1_1DataBatch.html" title="DataBatch of NDArray, returned by Iterator. ">DataBatch</a> is dense </p>
</div>
</div>
<a class="anchor" id="a2e9faeff00dd061f04a88c3ea5758aa2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string mxnet::DataBatch::extra_data</td>
</tr>
</table>
</div><div class="memdoc">
<p>extra data to be fed to the network </p>
</div>
</div>
<a class="anchor" id="a26a2ca473161c2c2a914cbc7ae4eb74e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;uint64_t&gt; mxnet::DataBatch::index</td>
</tr>
</table>
</div><div class="memdoc">
<p>index of image data </p>
</div>
</div>
<a class="anchor" id="aad93df826690100bb16689952fc83558"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mxnet::DataBatch::num_batch_padd</td>
</tr>
</table>
</div><div class="memdoc">
<p>num of example padded to batch </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/mxnet/<a class="el" href="io_8h_source.html">io.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Feb 14 2018 07:03:15 for mxnet by  <a href="http://www.doxygen.org/index.html">
<img alt="doxygen" class="footer" src="doxygen.png"/>
</a> 1.8.6
</small></address>
</body>
</html>