| <!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.6"/> |
| <title>mxnet: src/common/utils.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/search.js"></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 cellspacing="0" cellpadding="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 id="navrow1" class="tabs"> |
| <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><a href="annotated.html"><span>Classes</span></a></li> |
| <li class="current"><a href="files.html"><span>Files</span></a></li> |
| <li> |
| <div id="MSearchBox" class="MSearchBoxInactive"> |
| <span class="left"> |
| <img id="MSearchSelect" src="search/mag_sel.png" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| alt=""/> |
| <input type="text" id="MSearchField" value="Search" accesskey="S" |
| onfocus="searchBox.OnSearchFieldFocus(true)" |
| onblur="searchBox.OnSearchFieldFocus(false)" |
| onkeyup="searchBox.OnSearchFieldChange(event)"/> |
| </span><span class="right"> |
| <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> |
| </span> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div id="navrow2" class="tabs2"> |
| <ul class="tablist"> |
| <li><a href="files.html"><span>File List</span></a></li> |
| <li><a href="globals.html"><span>File Members</span></a></li> |
| </ul> |
| </div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| <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 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_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_fdedb0aba14d44ce9d99bc100e026e6a.html">common</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">utils.h</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="utils_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> </div> |
| <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#ifndef MXNET_COMMON_UTILS_H_</span></div> |
| <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor"></span><span class="preprocessor">#define MXNET_COMMON_UTILS_H_</span></div> |
| <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#if DMLC_USE_CXX11</span></div> |
| <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor"></span><span class="preprocessor">#include <memory></span></div> |
| <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include <vector></span></div> |
| <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include <type_traits></span></div> |
| <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <utility></span></div> |
| <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <random></span></div> |
| <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <thread></span></div> |
| <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <algorithm></span></div> |
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#endif // DMLC_USE_CXX11</span></div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include <dmlc/logging.h></span></div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <<a class="code" href="engine_8h.html">mxnet/engine.h</a>></span></div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">namespace </span>mxnet {</div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">namespace </span>common {</div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#if DMLC_USE_CXX11</span></div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor"></span><span class="comment">// heuristic to dermine number of threads per GPU</span></div> |
| <div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="namespacemxnet_1_1common.html#abc7580a95e3de5cf38d5bc2617c6d541"> 27</a></span> <span class="keyword">inline</span> <span class="keywordtype">int</span> <a class="code" href="namespacemxnet_1_1common.html#abc7580a95e3de5cf38d5bc2617c6d541">GetNumThreadPerGPU</a>() {</div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="comment">// This is resource efficient option.</span></div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keywordflow">return</span> dmlc::GetEnv(<span class="stringliteral">"MXNET_GPU_WORKER_NTHREADS"</span>, 2);</div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> }</div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">// heuristic to get number of matching colors.</span></div> |
| <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">// this decides how much parallelism we can get in each GPU.</span></div> |
| <div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="namespacemxnet_1_1common.html#a56555edcc52c5b25bed90bd05e00b5fa"> 34</a></span> <span class="keyword">inline</span> <span class="keywordtype">int</span> <a class="code" href="namespacemxnet_1_1common.html#a56555edcc52c5b25bed90bd05e00b5fa">GetExecNumMatchColor</a>() {</div> |
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="comment">// This is resource efficient option.</span></div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keywordtype">int</span> num_match_color = dmlc::GetEnv(<span class="stringliteral">"MXNET_EXEC_NUM_TEMP"</span>, 1);</div> |
| <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keywordflow">return</span> std::min(num_match_color, <a class="code" href="namespacemxnet_1_1common.html#abc7580a95e3de5cf38d5bc2617c6d541">GetNumThreadPerGPU</a>());</div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> }</div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div> |
| <div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="namespacemxnet_1_1common.html#aceba8f2d6de65796966d7f1d341dcf33"> 43</a></span> <span class="keyword">typedef</span> std::mt19937 <a class="code" href="namespacemxnet_1_1common.html#aceba8f2d6de65796966d7f1d341dcf33">RANDOM_ENGINE</a>;</div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div> |
| <div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="namespacemxnet_1_1common_1_1helper.html"> 48</a></span> <span class="keyword">namespace </span>helper {</div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div> |
| <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="keyword">template</span> <<span class="keyword">class</span> T></div> |
| <div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="structmxnet_1_1common_1_1helper_1_1UniqueIf.html"> 54</a></span> <span class="keyword">struct </span><a class="code" href="structmxnet_1_1common_1_1helper_1_1UniqueIf.html">UniqueIf</a> {</div> |
| <div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="structmxnet_1_1common_1_1helper_1_1UniqueIf.html#a98153aaeb43a71efa85b5cf753505cac"> 58</a></span>  <span class="keyword">using</span> <a class="code" href="structmxnet_1_1common_1_1helper_1_1UniqueIf.html#a98153aaeb43a71efa85b5cf753505cac">SingleObject</a> = std::unique_ptr<T>;</div> |
| <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> };</div> |
| <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div> |
| <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="keyword">template</span> <<span class="keyword">class</span> T></div> |
| <div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="structmxnet_1_1common_1_1helper_1_1UniqueIf_3_01T[]_4.html"> 65</a></span> <span class="keyword">struct </span><a class="code" href="structmxnet_1_1common_1_1helper_1_1UniqueIf.html">UniqueIf</a><T[]> {</div> |
| <div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="structmxnet_1_1common_1_1helper_1_1UniqueIf_3_01T[]_4.html#a0cf05a5a2f3e1ac49ebdef497701055c"> 69</a></span>  <span class="keyword">using</span> <a class="code" href="structmxnet_1_1common_1_1helper_1_1UniqueIf_3_01T[]_4.html#a0cf05a5a2f3e1ac49ebdef497701055c">UnknownBound</a> = std::unique_ptr<T[]>;</div> |
| <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> };</div> |
| <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div> |
| <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="keyword">template</span> <<span class="keyword">class</span> T, <span class="keywordtype">size_t</span> kSize></div> |
| <div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="structmxnet_1_1common_1_1helper_1_1UniqueIf_3_01T[kSize]_4.html"> 76</a></span> <span class="keyword">struct </span><a class="code" href="structmxnet_1_1common_1_1helper_1_1UniqueIf.html">UniqueIf</a><T[kSize]> {</div> |
| <div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="structmxnet_1_1common_1_1helper_1_1UniqueIf_3_01T[kSize]_4.html#af31c1728c4b497d304680d69d4e61421"> 80</a></span>  <span class="keyword">using</span> <a class="code" href="structmxnet_1_1common_1_1helper_1_1UniqueIf_3_01T[kSize]_4.html#af31c1728c4b497d304680d69d4e61421">KnownBound</a> = void;</div> |
| <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> };</div> |
| <div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div> |
| <div class="line"><a name="l00083"></a><span class="lineno"> 83</span> } <span class="comment">// namespace helper</span></div> |
| <div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div> |
| <div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="keyword">template</span> <<span class="keyword">class </span>T, <span class="keyword">class</span>... Args></div> |
| <div class="line"><a name="l00097"></a><span class="lineno"><a class="line" href="namespacemxnet_1_1common.html#a6ca270747bb7ab942c61d364f14f3042"> 97</a></span> <span class="keyword">typename</span> <a class="code" href="structmxnet_1_1common_1_1helper_1_1UniqueIf.html#a98153aaeb43a71efa85b5cf753505cac">helper::UniqueIf<T>::SingleObject</a> <a class="code" href="namespacemxnet_1_1common.html#a9d9abe40c84b9924e51d5d57b3f0b7d6">MakeUnique</a>(Args&&... args) {</div> |
| <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keywordflow">return</span> std::unique_ptr<T>(<span class="keyword">new</span> T(std::forward<Args>(args)...));</div> |
| <div class="line"><a name="l00099"></a><span class="lineno"> 99</span> }</div> |
| <div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div> |
| <div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="keyword">template</span> <<span class="keyword">class</span> T></div> |
| <div class="line"><a name="l00111"></a><span class="lineno"><a class="line" href="namespacemxnet_1_1common.html#a39b3453302aa3aa56230fbc88005861d"> 111</a></span> <span class="keyword">typename</span> <a class="code" href="structmxnet_1_1common_1_1helper_1_1UniqueIf.html">helper::UniqueIf<T>::UnknownBound</a> <a class="code" href="namespacemxnet_1_1common.html#a9d9abe40c84b9924e51d5d57b3f0b7d6">MakeUnique</a>(<span class="keywordtype">size_t</span> n) {</div> |
| <div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="keyword">using</span> U = <span class="keyword">typename</span> std::remove_extent<T>::type;</div> |
| <div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keywordflow">return</span> std::unique_ptr<T>(<span class="keyword">new</span> U[n]{});</div> |
| <div class="line"><a name="l00114"></a><span class="lineno"> 114</span> }</div> |
| <div class="line"><a name="l00115"></a><span class="lineno"> 115</span> </div> |
| <div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="keyword">template</span> <<span class="keyword">class </span>T, <span class="keyword">class</span>... Args></div> |
| <div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="keyword">typename</span> helper::UniqueIf<T>::KnownBound <a class="code" href="namespacemxnet_1_1common.html#a9d9abe40c84b9924e51d5d57b3f0b7d6">MakeUnique</a>(Args&&... args) = <span class="keyword">delete</span>;</div> |
| <div class="line"><a name="l00126"></a><span class="lineno"> 126</span> </div> |
| <div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="preprocessor">#endif // DMLC_USE_CXX11</span></div> |
| <div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00129"></a><span class="lineno"> 129</span> } <span class="comment">// namespace common</span></div> |
| <div class="line"><a name="l00130"></a><span class="lineno"> 130</span> } <span class="comment">// namespace mxnet</span></div> |
| <div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="preprocessor">#endif // MXNET_COMMON_UTILS_H_</span></div> |
| <div class="ttc" id="engine_8h_html"><div class="ttname"><a href="engine_8h.html">engine.h</a></div><div class="ttdoc">Engine that schedules all the operations according to dependency. </div></div> |
| <div class="ttc" id="structmxnet_1_1common_1_1helper_1_1UniqueIf_3_01T[kSize]_4_html_af31c1728c4b497d304680d69d4e61421"><div class="ttname"><a href="structmxnet_1_1common_1_1helper_1_1UniqueIf_3_01T[kSize]_4.html#af31c1728c4b497d304680d69d4e61421">mxnet::common::helper::UniqueIf< T[kSize]>::KnownBound</a></div><div class="ttdeci">void KnownBound</div><div class="ttdoc">Type of T. </div><div class="ttdef"><b>Definition:</b> utils.h:80</div></div> |
| <div class="ttc" id="namespacemxnet_1_1common_html_abc7580a95e3de5cf38d5bc2617c6d541"><div class="ttname"><a href="namespacemxnet_1_1common.html#abc7580a95e3de5cf38d5bc2617c6d541">mxnet::common::GetNumThreadPerGPU</a></div><div class="ttdeci">int GetNumThreadPerGPU()</div><div class="ttdef"><b>Definition:</b> utils.h:27</div></div> |
| <div class="ttc" id="namespacemxnet_1_1common_html_aceba8f2d6de65796966d7f1d341dcf33"><div class="ttname"><a href="namespacemxnet_1_1common.html#aceba8f2d6de65796966d7f1d341dcf33">mxnet::common::RANDOM_ENGINE</a></div><div class="ttdeci">std::mt19937 RANDOM_ENGINE</div><div class="ttdoc">Random Engine. </div><div class="ttdef"><b>Definition:</b> utils.h:43</div></div> |
| <div class="ttc" id="structmxnet_1_1common_1_1helper_1_1UniqueIf_html"><div class="ttname"><a href="structmxnet_1_1common_1_1helper_1_1UniqueIf.html">mxnet::common::helper::UniqueIf</a></div><div class="ttdoc">Helper for non-array type T. </div><div class="ttdef"><b>Definition:</b> utils.h:54</div></div> |
| <div class="ttc" id="structmxnet_1_1common_1_1helper_1_1UniqueIf_3_01T[]_4_html_a0cf05a5a2f3e1ac49ebdef497701055c"><div class="ttname"><a href="structmxnet_1_1common_1_1helper_1_1UniqueIf_3_01T[]_4.html#a0cf05a5a2f3e1ac49ebdef497701055c">mxnet::common::helper::UniqueIf< T[]>::UnknownBound</a></div><div class="ttdeci">std::unique_ptr< T[]> UnknownBound</div><div class="ttdoc">Type of T. </div><div class="ttdef"><b>Definition:</b> utils.h:69</div></div> |
| <div class="ttc" id="structmxnet_1_1common_1_1helper_1_1UniqueIf_html_a98153aaeb43a71efa85b5cf753505cac"><div class="ttname"><a href="structmxnet_1_1common_1_1helper_1_1UniqueIf.html#a98153aaeb43a71efa85b5cf753505cac">mxnet::common::helper::UniqueIf::SingleObject</a></div><div class="ttdeci">std::unique_ptr< T > SingleObject</div><div class="ttdoc">Type of T. </div><div class="ttdef"><b>Definition:</b> utils.h:58</div></div> |
| <div class="ttc" id="namespacemxnet_1_1common_html_a56555edcc52c5b25bed90bd05e00b5fa"><div class="ttname"><a href="namespacemxnet_1_1common.html#a56555edcc52c5b25bed90bd05e00b5fa">mxnet::common::GetExecNumMatchColor</a></div><div class="ttdeci">int GetExecNumMatchColor()</div><div class="ttdef"><b>Definition:</b> utils.h:34</div></div> |
| <div class="ttc" id="namespacemxnet_1_1common_html_a9d9abe40c84b9924e51d5d57b3f0b7d6"><div class="ttname"><a href="namespacemxnet_1_1common.html#a9d9abe40c84b9924e51d5d57b3f0b7d6">mxnet::common::MakeUnique</a></div><div class="ttdeci">helper::UniqueIf< T >::SingleObject MakeUnique(Args &&...args)</div><div class="ttdoc">Constructs an object of type T and wraps it in a std::unique_ptr. </div><div class="ttdef"><b>Definition:</b> utils.h:97</div></div> |
| </div><!-- fragment --></div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Sun Aug 6 2017 07:14:31 for mxnet by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.6 |
| </small></address> |
| </body> |
| </html> |
