| <!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::IIterator< 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="namespacemxnet.html">mxnet</a></li><li class="navelem"><a class="el" href="classmxnet_1_1IIterator.html">IIterator</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-attribs">Public Attributes</a> | |
| <a href="classmxnet_1_1IIterator-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">mxnet::IIterator< DType > Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>iterator type |
| <a href="classmxnet_1_1IIterator.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="include_2mxnet_2io_8h_source.html">io.h</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for mxnet::IIterator< DType >:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classmxnet_1_1IIterator__inherit__graph.png" border="0" usemap="#mxnet_1_1IIterator_3_01DType_01_4_inherit__map" alt="Inheritance graph"/></div> |
| <!-- MAP 0 --> |
| </div> |
| <div class="dynheader"> |
| Collaboration diagram for mxnet::IIterator< DType >:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classmxnet_1_1IIterator__coll__graph.png" border="0" usemap="#mxnet_1_1IIterator_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:a774e490e5f3eee767fdc11b779bbd1fe"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1IIterator.html#a774e490e5f3eee767fdc11b779bbd1fe">Init</a> (const std::vector< std::pair< std::string, std::string > > &kwargs)=0</td></tr> |
| <tr class="memdesc:a774e490e5f3eee767fdc11b779bbd1fe"><td class="mdescLeft"> </td><td class="mdescRight">set the parameters and init iter <a href="classmxnet_1_1IIterator.html#a774e490e5f3eee767fdc11b779bbd1fe">More...</a><br /></td></tr> |
| <tr class="separator:a774e490e5f3eee767fdc11b779bbd1fe"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a37fc8b163cd0158686183cc0f319529a"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1IIterator.html#a37fc8b163cd0158686183cc0f319529a">BeforeFirst</a> (void)=0</td></tr> |
| <tr class="memdesc:a37fc8b163cd0158686183cc0f319529a"><td class="mdescLeft"> </td><td class="mdescRight">reset the iterator <a href="classmxnet_1_1IIterator.html#a37fc8b163cd0158686183cc0f319529a">More...</a><br /></td></tr> |
| <tr class="separator:a37fc8b163cd0158686183cc0f319529a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac02dda5d191a7bc629aaa93e5abab3d5"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1IIterator.html#ac02dda5d191a7bc629aaa93e5abab3d5">Next</a> (void)=0</td></tr> |
| <tr class="memdesc:ac02dda5d191a7bc629aaa93e5abab3d5"><td class="mdescLeft"> </td><td class="mdescRight">move to next item <a href="classmxnet_1_1IIterator.html#ac02dda5d191a7bc629aaa93e5abab3d5">More...</a><br /></td></tr> |
| <tr class="separator:ac02dda5d191a7bc629aaa93e5abab3d5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aef2e0b74766cd0283849300c8a081929"><td class="memItemLeft" align="right" valign="top">virtual const DType & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1IIterator.html#aef2e0b74766cd0283849300c8a081929">Value</a> (void) const =0</td></tr> |
| <tr class="memdesc:aef2e0b74766cd0283849300c8a081929"><td class="mdescLeft"> </td><td class="mdescRight">get current data <a href="classmxnet_1_1IIterator.html#aef2e0b74766cd0283849300c8a081929">More...</a><br /></td></tr> |
| <tr class="separator:aef2e0b74766cd0283849300c8a081929"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6e9049dca03b889bba0d18338e286070"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1IIterator.html#a6e9049dca03b889bba0d18338e286070">~IIterator</a> (void)</td></tr> |
| <tr class="memdesc:a6e9049dca03b889bba0d18338e286070"><td class="mdescLeft"> </td><td class="mdescRight">constructor <a href="classmxnet_1_1IIterator.html#a6e9049dca03b889bba0d18338e286070">More...</a><br /></td></tr> |
| <tr class="separator:a6e9049dca03b889bba0d18338e286070"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a79ed9023cf4e525c8b4a8c6fa96eea05"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1IIterator.html#a79ed9023cf4e525c8b4a8c6fa96eea05">SetDataName</a> (const std::string data_name)</td></tr> |
| <tr class="memdesc:a79ed9023cf4e525c8b4a8c6fa96eea05"><td class="mdescLeft"> </td><td class="mdescRight">set data name to each attribute of data <a href="classmxnet_1_1IIterator.html#a79ed9023cf4e525c8b4a8c6fa96eea05">More...</a><br /></td></tr> |
| <tr class="separator:a79ed9023cf4e525c8b4a8c6fa96eea05"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af037a6d4fc12399217961e71a4fd7723"><td class="memItemLeft" align="right" valign="top">virtual int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1IIterator.html#af037a6d4fc12399217961e71a4fd7723">GetLenHint</a> (void) const</td></tr> |
| <tr class="memdesc:af037a6d4fc12399217961e71a4fd7723"><td class="mdescLeft"> </td><td class="mdescRight">request iterator length hint for current epoch. Note that the returned value can be < 0, indicating that the length of iterator is unknown unless you went through all data. <a href="classmxnet_1_1IIterator.html#af037a6d4fc12399217961e71a4fd7723">More...</a><br /></td></tr> |
| <tr class="separator:af037a6d4fc12399217961e71a4fd7723"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_classdmlc_1_1DataIter"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classdmlc_1_1DataIter')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classdmlc_1_1DataIter.html">dmlc::DataIter< DType ></a></td></tr> |
| <tr class="memitem:aef4acbc5a49dd71edb360149a2b19ee2 inherit pub_methods_classdmlc_1_1DataIter"><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 inherit pub_methods_classdmlc_1_1DataIter"><td class="mdescLeft"> </td><td class="mdescRight">destructor <a href="classdmlc_1_1DataIter.html#aef4acbc5a49dd71edb360149a2b19ee2">More...</a><br /></td></tr> |
| <tr class="separator:aef4acbc5a49dd71edb360149a2b19ee2 inherit pub_methods_classdmlc_1_1DataIter"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><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:a65cd81ecf71d54a17a94ca65d27aa014"><td class="memItemLeft" align="right" valign="top">std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1IIterator.html#a65cd81ecf71d54a17a94ca65d27aa014">data_names</a></td></tr> |
| <tr class="memdesc:a65cd81ecf71d54a17a94ca65d27aa014"><td class="mdescLeft"> </td><td class="mdescRight">store the name of each data, it could be used for making NDArrays <a href="classmxnet_1_1IIterator.html#a65cd81ecf71d54a17a94ca65d27aa014">More...</a><br /></td></tr> |
| <tr class="separator:a65cd81ecf71d54a17a94ca65d27aa014"><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 mxnet::IIterator< DType ></h3> |
| |
| <p>iterator type </p> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">DType</td><td>data type </td></tr> |
| </table> |
| </dd> |
| </dl> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a6e9049dca03b889bba0d18338e286070"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6e9049dca03b889bba0d18338e286070">◆ </a></span>~IIterator()</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="classmxnet_1_1IIterator.html">mxnet::IIterator</a>< DType >::~<a class="el" href="classmxnet_1_1IIterator.html">IIterator</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>constructor </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a37fc8b163cd0158686183cc0f319529a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a37fc8b163cd0158686183cc0f319529a">◆ </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="classmxnet_1_1IIterator.html">mxnet::IIterator</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>reset the iterator </p> |
| |
| <p>Implements <a class="el" href="classdmlc_1_1DataIter.html#a77735f53af4bb7490009315607ab9135">dmlc::DataIter< DType ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="af037a6d4fc12399217961e71a4fd7723"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af037a6d4fc12399217961e71a4fd7723">◆ </a></span>GetLenHint()</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 int64_t <a class="el" href="classmxnet_1_1IIterator.html">mxnet::IIterator</a>< DType >::GetLenHint </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">inline</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>request iterator length hint for current epoch. Note that the returned value can be < 0, indicating that the length of iterator is unknown unless you went through all data. </p> |
| |
| </div> |
| </div> |
| <a id="a774e490e5f3eee767fdc11b779bbd1fe"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a774e490e5f3eee767fdc11b779bbd1fe">◆ </a></span>Init()</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="classmxnet_1_1IIterator.html">mxnet::IIterator</a>< DType >::Init </td> |
| <td>(</td> |
| <td class="paramtype">const std::vector< std::pair< std::string, std::string > > & </td> |
| <td class="paramname"><em>kwargs</em></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 the parameters and init iter </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">kwargs</td><td>key-value pairs </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="ac02dda5d191a7bc629aaa93e5abab3d5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac02dda5d191a7bc629aaa93e5abab3d5">◆ </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="classmxnet_1_1IIterator.html">mxnet::IIterator</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>Implements <a class="el" href="classdmlc_1_1DataIter.html#a1f07f4d4f87485d1de4b6ba1af4d7b5b">dmlc::DataIter< DType ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="a79ed9023cf4e525c8b4a8c6fa96eea05"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a79ed9023cf4e525c8b4a8c6fa96eea05">◆ </a></span>SetDataName()</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">void <a class="el" href="classmxnet_1_1IIterator.html">mxnet::IIterator</a>< DType >::SetDataName </td> |
| <td>(</td> |
| <td class="paramtype">const std::string </td> |
| <td class="paramname"><em>data_name</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>set data name to each attribute of data </p> |
| |
| </div> |
| </div> |
| <a id="aef2e0b74766cd0283849300c8a081929"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aef2e0b74766cd0283849300c8a081929">◆ </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="classmxnet_1_1IIterator.html">mxnet::IIterator</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>Implements <a class="el" href="classdmlc_1_1DataIter.html#a2695f02f824a515b60d4fb0af6c4e6d6">dmlc::DataIter< DType ></a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Data Documentation</h2> |
| <a id="a65cd81ecf71d54a17a94ca65d27aa014"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a65cd81ecf71d54a17a94ca65d27aa014">◆ </a></span>data_names</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename DType > </div> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::vector<std::string> <a class="el" href="classmxnet_1_1IIterator.html">mxnet::IIterator</a>< DType >::data_names</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>store the name of each data, it could be used for making NDArrays </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>/work/mxnet/include/mxnet/<a class="el" href="include_2mxnet_2io_8h_source.html">io.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 5 2023 03:47:41 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> |
