blob: 9519a21c210db0f20eed29e3bb6b579450b9cb0f [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 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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>mxnet: /work/mxnet/3rdparty/dmlc-core/include/dmlc/input_split_shuffle.h Source File</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.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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="dir_8cab8f464681f7cc51cee77e79a434cd.html">3rdparty</a></li><li class="navelem"><a class="el" href="dir_82e31a22178767beedddc7597fd1ecb6.html">dmlc-core</a></li><li class="navelem"><a class="el" href="dir_7dd5b88db83ff474628c03c453739a90.html">include</a></li><li class="navelem"><a class="el" href="dir_e30967e3ab51f65ad4b50dd298ccf4e7.html">dmlc</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">input_split_shuffle.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="input__split__shuffle_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;</div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#ifndef DMLC_INPUT_SPLIT_SHUFFLE_H_</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#define DMLC_INPUT_SPLIT_SHUFFLE_H_</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;</div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#include &lt;cstdio&gt;</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &lt;cstring&gt;</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#include &lt;algorithm&gt;</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#include &lt;memory&gt;</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacedmlc.html">dmlc</a> {</div><div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="classdmlc_1_1InputSplitShuffle.html"> 19</a></span>&#160;<span class="keyword">class </span><a class="code" href="classdmlc_1_1InputSplitShuffle.html">InputSplitShuffle</a> : <span class="keyword">public</span> <a class="code" href="classdmlc_1_1InputSplit.html">InputSplit</a> {</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; <span class="comment">// destructor</span></div><div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="classdmlc_1_1InputSplitShuffle.html#afbce8f23fe731fb5ae087020f6274ab4"> 22</a></span>&#160; <span class="keyword">virtual</span> <a class="code" href="classdmlc_1_1InputSplitShuffle.html#afbce8f23fe731fb5ae087020f6274ab4">~InputSplitShuffle</a>(<span class="keywordtype">void</span>) { source_.reset(); }</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="comment">// implement BeforeFirst</span></div><div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="classdmlc_1_1InputSplitShuffle.html#af3f6ae9b61f4d18494d4bfbda0fab9c8"> 24</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classdmlc_1_1InputSplitShuffle.html#af3f6ae9b61f4d18494d4bfbda0fab9c8">BeforeFirst</a>(<span class="keywordtype">void</span>) {</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="keywordflow">if</span> (num_shuffle_parts_ &gt; 1) {</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; std::shuffle(shuffle_indexes_.begin(), shuffle_indexes_.end(), trnd_);</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keywordtype">int</span> idx = shuffle_indexes_[0] + part_index_ * num_shuffle_parts_;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; source_-&gt;ResetPartition(idx, num_parts_ * num_shuffle_parts_);</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; cur_shuffle_idx_ = 0;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; } <span class="keywordflow">else</span> {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; source_-&gt;BeforeFirst();</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; }</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; }</div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classdmlc_1_1InputSplitShuffle.html#a491c4e5c44919e24d32403caeecdf468"> 34</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classdmlc_1_1InputSplitShuffle.html#a491c4e5c44919e24d32403caeecdf468">HintChunkSize</a>(<span class="keywordtype">size_t</span> chunk_size) {</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; source_-&gt;HintChunkSize(chunk_size);</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; }</div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classdmlc_1_1InputSplitShuffle.html#a768b224c5dad3d7cef5af3c5cbd08263"> 37</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="classdmlc_1_1InputSplitShuffle.html#a768b224c5dad3d7cef5af3c5cbd08263">GetTotalSize</a>(<span class="keywordtype">void</span>) {</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keywordflow">return</span> source_-&gt;GetTotalSize();</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; }</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="comment">// implement next record</span></div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="classdmlc_1_1InputSplitShuffle.html#ab8812c94aa95744a475a1549b2b6f6a6"> 41</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classdmlc_1_1InputSplitShuffle.html#ab8812c94aa95744a475a1549b2b6f6a6">NextRecord</a>(<a class="code" href="structdmlc_1_1InputSplit_1_1Blob.html">Blob</a> *out_rec) {</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keywordflow">if</span> (num_shuffle_parts_ &gt; 1) {</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordflow">if</span> (!source_-&gt;NextRecord(out_rec)) {</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keywordflow">if</span> (cur_shuffle_idx_ == num_shuffle_parts_ - 1) {</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; }</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; ++cur_shuffle_idx_;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keywordtype">int</span> idx =</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; shuffle_indexes_[cur_shuffle_idx_] + part_index_ * num_shuffle_parts_;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; source_-&gt;ResetPartition(idx, num_parts_ * num_shuffle_parts_);</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classdmlc_1_1InputSplitShuffle.html#ab8812c94aa95744a475a1549b2b6f6a6">NextRecord</a>(out_rec);</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; } <span class="keywordflow">else</span> {</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; }</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; } <span class="keywordflow">else</span> {</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keywordflow">return</span> source_-&gt;NextRecord(out_rec);</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; }</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; }</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="comment">// implement next chunk</span></div><div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="classdmlc_1_1InputSplitShuffle.html#a88433138b96bc4c00d3e3bc8f2856025"> 60</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classdmlc_1_1InputSplitShuffle.html#a88433138b96bc4c00d3e3bc8f2856025">NextChunk</a>(<a class="code" href="structdmlc_1_1InputSplit_1_1Blob.html">Blob</a>* out_chunk) {</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keywordflow">if</span> (num_shuffle_parts_ &gt; 1) {</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keywordflow">if</span> (!source_-&gt;NextChunk(out_chunk)) {</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keywordflow">if</span> (cur_shuffle_idx_ == num_shuffle_parts_ - 1) {</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; }</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; ++cur_shuffle_idx_;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keywordtype">int</span> idx =</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; shuffle_indexes_[cur_shuffle_idx_] + part_index_ * num_shuffle_parts_;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; source_-&gt;ResetPartition(idx, num_parts_ * num_shuffle_parts_);</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classdmlc_1_1InputSplitShuffle.html#a88433138b96bc4c00d3e3bc8f2856025">NextChunk</a>(out_chunk);</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; } <span class="keywordflow">else</span> {</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; }</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; } <span class="keywordflow">else</span> {</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="keywordflow">return</span> source_-&gt;NextChunk(out_chunk);</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; }</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; }</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="comment">// implement ResetPartition.</span></div><div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="classdmlc_1_1InputSplitShuffle.html#a2e3056434b2605d42f935b242d0e4a3d"> 79</a></span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classdmlc_1_1InputSplitShuffle.html#a2e3056434b2605d42f935b242d0e4a3d">ResetPartition</a>(<span class="keywordtype">unsigned</span> rank, <span class="keywordtype">unsigned</span> nsplit) {</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; CHECK(nsplit == num_parts_) &lt;&lt; <span class="stringliteral">&quot;num_parts is not consistent!&quot;</span>;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="keywordtype">int</span> idx = shuffle_indexes_[0] + rank * num_shuffle_parts_;</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; source_-&gt;ResetPartition(idx, nsplit * num_shuffle_parts_);</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; cur_shuffle_idx_ = 0;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; }</div><div class="line"><a name="l00100"></a><span class="lineno"><a class="line" href="classdmlc_1_1InputSplitShuffle.html#a036d26e7c95b13e65ff8accbf6fdb80e"> 100</a></span>&#160; <a class="code" href="classdmlc_1_1InputSplitShuffle.html#a036d26e7c95b13e65ff8accbf6fdb80e">InputSplitShuffle</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* uri,</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; <span class="keywordtype">unsigned</span> part_index,</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; <span class="keywordtype">unsigned</span> num_parts,</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* type,</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; <span class="keywordtype">unsigned</span> num_shuffle_parts,</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; <span class="keywordtype">int</span> shuffle_seed)</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; : part_index_(part_index),</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; num_parts_(num_parts),</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; num_shuffle_parts_(num_shuffle_parts),</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; cur_shuffle_idx_(0) {</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> i = 0; i &lt; num_shuffle_parts_; i++) {</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; shuffle_indexes_.push_back(i);</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; }</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; trnd_.seed(kRandMagic_ + part_index_ + num_parts_ + num_shuffle_parts_ +</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; shuffle_seed);</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; std::shuffle(shuffle_indexes_.begin(), shuffle_indexes_.end(), trnd_);</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; <span class="keywordtype">int</span> idx = shuffle_indexes_[cur_shuffle_idx_] + part_index_ * num_shuffle_parts_;</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; source_.reset(</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; <a class="code" href="classdmlc_1_1InputSplit.html#a118dc34dbd121d5ff80cd904adee4c24">InputSplit::Create</a>(uri, idx , num_parts_ * num_shuffle_parts_, type));</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; }</div><div class="line"><a name="l00138"></a><span class="lineno"><a class="line" href="classdmlc_1_1InputSplitShuffle.html#aa0277fb979b7466ba9afa7da86c0bfb6"> 138</a></span>&#160; <span class="keyword">static</span> <a class="code" href="classdmlc_1_1InputSplit.html">InputSplit</a>* <a class="code" href="classdmlc_1_1InputSplitShuffle.html#aa0277fb979b7466ba9afa7da86c0bfb6">Create</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* uri,</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; <span class="keywordtype">unsigned</span> part_index,</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; <span class="keywordtype">unsigned</span> num_parts,</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* type,</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; <span class="keywordtype">unsigned</span> num_shuffle_parts,</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160; <span class="keywordtype">int</span> shuffle_seed) {</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; CHECK(num_shuffle_parts &gt; 0) &lt;&lt; <span class="stringliteral">&quot;number of shuffle parts should be greater than zero!&quot;</span>;</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160; <span class="keywordflow">return</span> <span class="keyword">new</span> <a class="code" href="classdmlc_1_1InputSplitShuffle.html#a036d26e7c95b13e65ff8accbf6fdb80e">InputSplitShuffle</a>(</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160; uri, part_index, num_parts, type, num_shuffle_parts, shuffle_seed);</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; }</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160;</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160; <span class="comment">// magic nyumber for seed</span></div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> kRandMagic_ = 666;</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160; std::mt19937 trnd_;</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160; std::unique_ptr&lt;InputSplit&gt; source_;</div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160; <span class="keywordtype">unsigned</span> part_index_;</div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160; <span class="keywordtype">unsigned</span> num_parts_;</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160; <span class="keywordtype">unsigned</span> num_shuffle_parts_;</div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160; <span class="keywordtype">unsigned</span> cur_shuffle_idx_;</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160; std::vector&lt;int&gt; shuffle_indexes_;</div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160;};</div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160;} <span class="comment">// namespace dmlc</span></div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160;<span class="preprocessor">#endif // DMLC_INPUT_SPLIT_SHUFFLE_H_</span></div><div class="ttc" id="classdmlc_1_1InputSplitShuffle_html_aa0277fb979b7466ba9afa7da86c0bfb6"><div class="ttname"><a href="classdmlc_1_1InputSplitShuffle.html#aa0277fb979b7466ba9afa7da86c0bfb6">dmlc::InputSplitShuffle::Create</a></div><div class="ttdeci">static InputSplit * Create(const char *uri, unsigned part_index, unsigned num_parts, const char *type, unsigned num_shuffle_parts, int shuffle_seed)</div><div class="ttdoc">factory function: create input split with chunk shuffling given a uri </div><div class="ttdef"><b>Definition:</b> input_split_shuffle.h:138</div></div>
<div class="ttc" id="classdmlc_1_1InputSplitShuffle_html_a491c4e5c44919e24d32403caeecdf468"><div class="ttname"><a href="classdmlc_1_1InputSplitShuffle.html#a491c4e5c44919e24d32403caeecdf468">dmlc::InputSplitShuffle::HintChunkSize</a></div><div class="ttdeci">virtual void HintChunkSize(size_t chunk_size)</div><div class="ttdoc">hint the inputsplit how large the chunk size it should return when implementing NextChunk this is a h...</div><div class="ttdef"><b>Definition:</b> input_split_shuffle.h:34</div></div>
<div class="ttc" id="structdmlc_1_1InputSplit_1_1Blob_html"><div class="ttname"><a href="structdmlc_1_1InputSplit_1_1Blob.html">dmlc::InputSplit::Blob</a></div><div class="ttdoc">a blob of memory region </div><div class="ttdef"><b>Definition:</b> io.h:158</div></div>
<div class="ttc" id="classdmlc_1_1InputSplitShuffle_html_af3f6ae9b61f4d18494d4bfbda0fab9c8"><div class="ttname"><a href="classdmlc_1_1InputSplitShuffle.html#af3f6ae9b61f4d18494d4bfbda0fab9c8">dmlc::InputSplitShuffle::BeforeFirst</a></div><div class="ttdeci">virtual void BeforeFirst(void)</div><div class="ttdoc">reset the position of InputSplit to beginning </div><div class="ttdef"><b>Definition:</b> input_split_shuffle.h:24</div></div>
<div class="ttc" id="classdmlc_1_1InputSplitShuffle_html"><div class="ttname"><a href="classdmlc_1_1InputSplitShuffle.html">dmlc::InputSplitShuffle</a></div><div class="ttdoc">class to construct input split with global shuffling </div><div class="ttdef"><b>Definition:</b> input_split_shuffle.h:19</div></div>
<div class="ttc" id="classdmlc_1_1InputSplitShuffle_html_a036d26e7c95b13e65ff8accbf6fdb80e"><div class="ttname"><a href="classdmlc_1_1InputSplitShuffle.html#a036d26e7c95b13e65ff8accbf6fdb80e">dmlc::InputSplitShuffle::InputSplitShuffle</a></div><div class="ttdeci">InputSplitShuffle(const char *uri, unsigned part_index, unsigned num_parts, const char *type, unsigned num_shuffle_parts, int shuffle_seed)</div><div class="ttdoc">constructor </div><div class="ttdef"><b>Definition:</b> input_split_shuffle.h:100</div></div>
<div class="ttc" id="classdmlc_1_1InputSplitShuffle_html_a88433138b96bc4c00d3e3bc8f2856025"><div class="ttname"><a href="classdmlc_1_1InputSplitShuffle.html#a88433138b96bc4c00d3e3bc8f2856025">dmlc::InputSplitShuffle::NextChunk</a></div><div class="ttdeci">virtual bool NextChunk(Blob *out_chunk)</div><div class="ttdoc">get a chunk of memory that can contain multiple records, the caller needs to parse the content of the...</div><div class="ttdef"><b>Definition:</b> input_split_shuffle.h:60</div></div>
<div class="ttc" id="classdmlc_1_1InputSplitShuffle_html_afbce8f23fe731fb5ae087020f6274ab4"><div class="ttname"><a href="classdmlc_1_1InputSplitShuffle.html#afbce8f23fe731fb5ae087020f6274ab4">dmlc::InputSplitShuffle::~InputSplitShuffle</a></div><div class="ttdeci">virtual ~InputSplitShuffle(void)</div><div class="ttdef"><b>Definition:</b> input_split_shuffle.h:22</div></div>
<div class="ttc" id="namespacedmlc_html"><div class="ttname"><a href="namespacedmlc.html">dmlc</a></div><div class="ttdoc">namespace for dmlc </div><div class="ttdef"><b>Definition:</b> array_view.h:12</div></div>
<div class="ttc" id="classdmlc_1_1InputSplitShuffle_html_a768b224c5dad3d7cef5af3c5cbd08263"><div class="ttname"><a href="classdmlc_1_1InputSplitShuffle.html#a768b224c5dad3d7cef5af3c5cbd08263">dmlc::InputSplitShuffle::GetTotalSize</a></div><div class="ttdeci">virtual size_t GetTotalSize(void)</div><div class="ttdoc">get the total size of the InputSplit </div><div class="ttdef"><b>Definition:</b> input_split_shuffle.h:37</div></div>
<div class="ttc" id="classdmlc_1_1InputSplit_html_a118dc34dbd121d5ff80cd904adee4c24"><div class="ttname"><a href="classdmlc_1_1InputSplit.html#a118dc34dbd121d5ff80cd904adee4c24">dmlc::InputSplit::Create</a></div><div class="ttdeci">static InputSplit * Create(const char *uri, unsigned part_index, unsigned num_parts, const char *type)</div><div class="ttdoc">factory function: create input split given a uri </div></div>
<div class="ttc" id="classdmlc_1_1InputSplit_html"><div class="ttname"><a href="classdmlc_1_1InputSplit.html">dmlc::InputSplit</a></div><div class="ttdoc">input split creates that allows reading of records from split of data, independent part that covers a...</div><div class="ttdef"><b>Definition:</b> io.h:155</div></div>
<div class="ttc" id="classdmlc_1_1InputSplitShuffle_html_ab8812c94aa95744a475a1549b2b6f6a6"><div class="ttname"><a href="classdmlc_1_1InputSplitShuffle.html#ab8812c94aa95744a475a1549b2b6f6a6">dmlc::InputSplitShuffle::NextRecord</a></div><div class="ttdeci">virtual bool NextRecord(Blob *out_rec)</div><div class="ttdoc">get the next record, the returning value is valid until next call to NextRecord, NextChunk or NextBat...</div><div class="ttdef"><b>Definition:</b> input_split_shuffle.h:41</div></div>
<div class="ttc" id="classdmlc_1_1InputSplitShuffle_html_a2e3056434b2605d42f935b242d0e4a3d"><div class="ttname"><a href="classdmlc_1_1InputSplitShuffle.html#a2e3056434b2605d42f935b242d0e4a3d">dmlc::InputSplitShuffle::ResetPartition</a></div><div class="ttdeci">virtual void ResetPartition(unsigned rank, unsigned nsplit)</div><div class="ttdoc">reset the Input split to a certain part id, The InputSplit will be pointed to the head of the new spe...</div><div class="ttdef"><b>Definition:</b> input_split_shuffle.h:79</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 5 2023 00:58:42 for mxnet by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>