| <!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: dmlc::DataIter< DType > Class Template 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&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&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="namespacedmlc.html">dmlc</a></li><li class="navelem"><a class="el" href="classdmlc_1_1DataIter.html">DataIter</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classdmlc_1_1DataIter-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">dmlc::DataIter< DType > Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>data iterator interface this is not a C++ style iterator, but nice for data pulling:) This interface is used to pull in the data The system can do some useful tricks for you like pre-fetching from disk and pre-computation. |
| <a href="classdmlc_1_1DataIter.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="data_8h_source.html">data.h</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for dmlc::DataIter< DType >:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classdmlc_1_1DataIter__inherit__graph.png" border="0" usemap="#dmlc_1_1DataIter_3_01DType_01_4_inherit__map" alt="Inheritance graph"/></div> |
| <!-- MAP 0 --> |
| </div> |
| <div class="dynheader"> |
| Collaboration diagram for dmlc::DataIter< DType >:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classdmlc_1_1DataIter__coll__graph.png" border="0" usemap="#dmlc_1_1DataIter_3_01DType_01_4_coll__map" alt="Collaboration graph"/></div> |
| <!-- MAP 1 --> |
| </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:aef4acbc5a49dd71edb360149a2b19ee2"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1DataIter.html#aef4acbc5a49dd71edb360149a2b19ee2">~DataIter</a> (void) <a class="el" href="3rdparty_2dmlc-core_2include_2dmlc_2base_8h.html#a80bde16113dc79e7adb7953e006d6b60">DMLC_THROW_EXCEPTION</a></td></tr> |
| <tr class="memdesc:aef4acbc5a49dd71edb360149a2b19ee2"><td class="mdescLeft"> </td><td class="mdescRight">destructor <a href="classdmlc_1_1DataIter.html#aef4acbc5a49dd71edb360149a2b19ee2">More...</a><br /></td></tr> |
| <tr class="separator:aef4acbc5a49dd71edb360149a2b19ee2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a77735f53af4bb7490009315607ab9135"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1DataIter.html#a77735f53af4bb7490009315607ab9135">BeforeFirst</a> (void)=0</td></tr> |
| <tr class="memdesc:a77735f53af4bb7490009315607ab9135"><td class="mdescLeft"> </td><td class="mdescRight">set before first of the item <a href="classdmlc_1_1DataIter.html#a77735f53af4bb7490009315607ab9135">More...</a><br /></td></tr> |
| <tr class="separator:a77735f53af4bb7490009315607ab9135"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1f07f4d4f87485d1de4b6ba1af4d7b5b"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1DataIter.html#a1f07f4d4f87485d1de4b6ba1af4d7b5b">Next</a> (void)=0</td></tr> |
| <tr class="memdesc:a1f07f4d4f87485d1de4b6ba1af4d7b5b"><td class="mdescLeft"> </td><td class="mdescRight">move to next item <a href="classdmlc_1_1DataIter.html#a1f07f4d4f87485d1de4b6ba1af4d7b5b">More...</a><br /></td></tr> |
| <tr class="separator:a1f07f4d4f87485d1de4b6ba1af4d7b5b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2695f02f824a515b60d4fb0af6c4e6d6"><td class="memItemLeft" align="right" valign="top">virtual const DType & </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1DataIter.html#a2695f02f824a515b60d4fb0af6c4e6d6">Value</a> (void) const =0</td></tr> |
| <tr class="memdesc:a2695f02f824a515b60d4fb0af6c4e6d6"><td class="mdescLeft"> </td><td class="mdescRight">get current data <a href="classdmlc_1_1DataIter.html#a2695f02f824a515b60d4fb0af6c4e6d6">More...</a><br /></td></tr> |
| <tr class="separator:a2695f02f824a515b60d4fb0af6c4e6d6"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><h3>template<typename DType><br /> |
| class dmlc::DataIter< DType ></h3> |
| |
| <p>data iterator interface this is not a C++ style iterator, but nice for data pulling:) This interface is used to pull in the data The system can do some useful tricks for you like pre-fetching from disk and pre-computation. </p> |
| <p>Usage example: </p><div class="fragment"><div class="line">itr->BeforeFirst();</div> |
| <div class="line"><span class="keywordflow">while</span> (itr->Next()) {</div> |
| <div class="line"> <span class="keyword">const</span> DType &batch = itr->Value();</div> |
| <div class="line"> <span class="comment">// some computations</span></div> |
| <div class="line">}</div> |
| </div><!-- fragment --> <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">DType</td><td>the data type </td></tr> |
| </table> |
| </dd> |
| </dl> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="aef4acbc5a49dd71edb360149a2b19ee2"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aef4acbc5a49dd71edb360149a2b19ee2">◆ </a></span>~DataIter()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename DType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual <a class="el" href="classdmlc_1_1DataIter.html">dmlc::DataIter</a>< DType >::~<a class="el" href="classdmlc_1_1DataIter.html">DataIter</a> </td> |
| <td>(</td> |
| <td class="paramtype">void </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 class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>destructor </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a77735f53af4bb7490009315607ab9135"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a77735f53af4bb7490009315607ab9135">◆ </a></span>BeforeFirst()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename DType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void <a class="el" href="classdmlc_1_1DataIter.html">dmlc::DataIter</a>< DType >::BeforeFirst </td> |
| <td>(</td> |
| <td class="paramtype">void </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>set before first of the item </p> |
| |
| <p>Implemented in <a class="el" href="classmxnet_1_1IIterator.html#a37fc8b163cd0158686183cc0f319529a">mxnet::IIterator< DType ></a>, and <a class="el" href="classdmlc_1_1ThreadedIter.html#a1fa325280288777b5b9dcf15e424fdec">dmlc::ThreadedIter< DType ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="a1f07f4d4f87485d1de4b6ba1af4d7b5b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a1f07f4d4f87485d1de4b6ba1af4d7b5b">◆ </a></span>Next()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename DType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual bool <a class="el" href="classdmlc_1_1DataIter.html">dmlc::DataIter</a>< DType >::Next </td> |
| <td>(</td> |
| <td class="paramtype">void </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>move to next item </p> |
| |
| <p>Implemented in <a class="el" href="classmxnet_1_1IIterator.html#ac02dda5d191a7bc629aaa93e5abab3d5">mxnet::IIterator< DType ></a>, and <a class="el" href="classdmlc_1_1ThreadedIter.html#a415c711bacb0cd45a4445383ab97c270">dmlc::ThreadedIter< DType ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="a2695f02f824a515b60d4fb0af6c4e6d6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2695f02f824a515b60d4fb0af6c4e6d6">◆ </a></span>Value()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename DType > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual const DType& <a class="el" href="classdmlc_1_1DataIter.html">dmlc::DataIter</a>< DType >::Value </td> |
| <td>(</td> |
| <td class="paramtype">void </td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</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>get current data </p> |
| |
| <p>Implemented in <a class="el" href="classmxnet_1_1IIterator.html#aef2e0b74766cd0283849300c8a081929">mxnet::IIterator< DType ></a>, and <a class="el" href="classdmlc_1_1ThreadedIter.html#a618e846cc4b7e86d4758450dca016311">dmlc::ThreadedIter< DType ></a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>/work/mxnet/3rdparty/dmlc-core/include/dmlc/<a class="el" href="data_8h_source.html">data.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 5 2023 03:47:40 for mxnet by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.17 |
| </small></address> |
| </body> |
| </html> |
