| <!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: /work/mxnet/3rdparty/dmlc-core/include/dmlc/common.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.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="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">common.h</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="common_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 DMLC_COMMON_H_</span></div> |
| <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#define DMLC_COMMON_H_</span></div> |
| <div class="line"><a name="l00008"></a><span class="lineno"> 8</span>  </div> |
| <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include <vector></span></div> |
| <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include <string></span></div> |
| <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include <sstream></span></div> |
| <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include <mutex></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 "./logging.h"</span></div> |
| <div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  </div> |
| <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="keyword">namespace </span><a class="code" href="namespacedmlc.html">dmlc</a> {</div> |
| <div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="namespacedmlc.html#a3a28a7405b2f734090912c073434091c"> 23</a></span> <span class="keyword">inline</span> std::vector<std::string> <a class="code" href="namespacedmlc.html#a3a28a7405b2f734090912c073434091c">Split</a>(<span class="keyword">const</span> std::string& s, <span class="keywordtype">char</span> delim) {</div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  std::string item;</div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  std::istringstream is(s);</div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  std::vector<std::string> ret;</div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="keywordflow">while</span> (std::getline(is, item, delim)) {</div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  ret.push_back(item);</div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  }</div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keywordflow">return</span> ret;</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>  </div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">template</span><<span class="keyword">typename</span> T></div> |
| <div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="namespacedmlc.html#a8620a9c7572cd3aab1ed3135b7a8e137"> 37</a></span> <span class="keyword">inline</span> <span class="keywordtype">size_t</span> <a class="code" href="namespacedmlc.html#a8620a9c7572cd3aab1ed3135b7a8e137">HashCombine</a>(<span class="keywordtype">size_t</span> key, <span class="keyword">const</span> T& value) {</div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  std::hash<T> hash_func;</div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordflow">return</span> key ^ (hash_func(value) + 0x9e3779b9 + (key << 6) + (key >> 2));</div> |
| <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> }</div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  </div> |
| <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">template</span><></div> |
| <div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="namespacedmlc.html#a0be2b34771107606d968712e54b25ce6"> 46</a></span> <span class="keyword">inline</span> <span class="keywordtype">size_t</span> <a class="code" href="namespacedmlc.html#a0be2b34771107606d968712e54b25ce6">HashCombine<size_t></a>(<span class="keywordtype">size_t</span> key, <span class="keyword">const</span> <span class="keywordtype">size_t</span>& value) {</div> |
| <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordflow">return</span> key ^ (value + 0x9e3779b9 + (key << 6) + (key >> 2));</div> |
| <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> }</div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  </div> |
| <div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="classdmlc_1_1OMPException.html"> 53</a></span> <span class="keyword">class </span><a class="code" href="classdmlc_1_1OMPException.html">OMPException</a> {</div> |
| <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">private</span>:</div> |
| <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="comment">// exception_ptr member to store the exception</span></div> |
| <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  std::exception_ptr omp_exception_;</div> |
| <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="comment">// mutex to be acquired during catch to set the exception_ptr</span></div> |
| <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  std::mutex mutex_;</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>  <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> Function, <span class="keyword">typename</span>... Parameters></div> |
| <div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="classdmlc_1_1OMPException.html#af5b9dec8699cd604f89537de6d6e66d9"> 65</a></span>  <span class="keywordtype">void</span> <a class="code" href="classdmlc_1_1OMPException.html#af5b9dec8699cd604f89537de6d6e66d9">Run</a>(Function f, Parameters... params) {</div> |
| <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordflow">try</span> {</div> |
| <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  f(params...);</div> |
| <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  } <span class="keywordflow">catch</span> (dmlc::Error &ex) {</div> |
| <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  std::lock_guard<std::mutex> <a class="code" href="namespacemxnet_1_1common_1_1cuda_1_1rtc.html#aef7cd83e7f0216b689f5f9d4191d9f8b">lock</a>(mutex_);</div> |
| <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordflow">if</span> (!omp_exception_) {</div> |
| <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  omp_exception_ = std::current_exception();</div> |
| <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  }</div> |
| <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  } <span class="keywordflow">catch</span> (std::exception &ex) {</div> |
| <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  std::lock_guard<std::mutex> <a class="code" href="namespacemxnet_1_1common_1_1cuda_1_1rtc.html#aef7cd83e7f0216b689f5f9d4191d9f8b">lock</a>(mutex_);</div> |
| <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordflow">if</span> (!omp_exception_) {</div> |
| <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  omp_exception_ = std::current_exception();</div> |
| <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  }</div> |
| <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  }</div> |
| <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  }</div> |
| <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  </div> |
| <div class="line"><a name="l00084"></a><span class="lineno"><a class="line" href="classdmlc_1_1OMPException.html#a4695aa81fd59aa36a31593fb3ec8cee5"> 84</a></span>  <span class="keywordtype">void</span> <a class="code" href="classdmlc_1_1OMPException.html#a4695aa81fd59aa36a31593fb3ec8cee5">Rethrow</a>() {</div> |
| <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordflow">if</span> (this->omp_exception_) std::rethrow_exception(this->omp_exception_);</div> |
| <div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  }</div> |
| <div class="line"><a name="l00087"></a><span class="lineno"> 87</span> };</div> |
| <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  </div> |
| <div class="line"><a name="l00089"></a><span class="lineno"> 89</span> } <span class="comment">// namespace dmlc</span></div> |
| <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  </div> |
| <div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="preprocessor">#endif // DMLC_COMMON_H_</span></div> |
| </div><!-- fragment --></div><!-- contents --> |
| <div class="ttc" id="anamespacedmlc_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="anamespacedmlc_html_a0be2b34771107606d968712e54b25ce6"><div class="ttname"><a href="namespacedmlc.html#a0be2b34771107606d968712e54b25ce6">dmlc::HashCombine< size_t ></a></div><div class="ttdeci">size_t HashCombine< size_t >(size_t key, const size_t &value)</div><div class="ttdoc">specialize for size_t</div><div class="ttdef"><b>Definition:</b> common.h:46</div></div> |
| <div class="ttc" id="aclassdmlc_1_1OMPException_html_a4695aa81fd59aa36a31593fb3ec8cee5"><div class="ttname"><a href="classdmlc_1_1OMPException.html#a4695aa81fd59aa36a31593fb3ec8cee5">dmlc::OMPException::Rethrow</a></div><div class="ttdeci">void Rethrow()</div><div class="ttdoc">should be called from the main thread to rethrow the exception</div><div class="ttdef"><b>Definition:</b> common.h:84</div></div> |
| <div class="ttc" id="anamespacemxnet_1_1common_1_1cuda_1_1rtc_html_aef7cd83e7f0216b689f5f9d4191d9f8b"><div class="ttname"><a href="namespacemxnet_1_1common_1_1cuda_1_1rtc.html#aef7cd83e7f0216b689f5f9d4191d9f8b">mxnet::common::cuda::rtc::lock</a></div><div class="ttdeci">std::mutex lock</div></div> |
| <div class="ttc" id="anamespacedmlc_html_a8620a9c7572cd3aab1ed3135b7a8e137"><div class="ttname"><a href="namespacedmlc.html#a8620a9c7572cd3aab1ed3135b7a8e137">dmlc::HashCombine</a></div><div class="ttdeci">size_t HashCombine(size_t key, const T &value)</div><div class="ttdoc">hash an object and combines the key with previous keys</div><div class="ttdef"><b>Definition:</b> common.h:37</div></div> |
| <div class="ttc" id="aclassdmlc_1_1OMPException_html_af5b9dec8699cd604f89537de6d6e66d9"><div class="ttname"><a href="classdmlc_1_1OMPException.html#af5b9dec8699cd604f89537de6d6e66d9">dmlc::OMPException::Run</a></div><div class="ttdeci">void Run(Function f, Parameters... params)</div><div class="ttdoc">Parallel OMP blocks should be placed within Run to save exception.</div><div class="ttdef"><b>Definition:</b> common.h:65</div></div> |
| <div class="ttc" id="aclassdmlc_1_1OMPException_html"><div class="ttname"><a href="classdmlc_1_1OMPException.html">dmlc::OMPException</a></div><div class="ttdoc">OMP Exception class catches, saves and rethrows exception from OMP blocks.</div><div class="ttdef"><b>Definition:</b> common.h:53</div></div> |
| <div class="ttc" id="anamespacedmlc_html_a3a28a7405b2f734090912c073434091c"><div class="ttname"><a href="namespacedmlc.html#a3a28a7405b2f734090912c073434091c">dmlc::Split</a></div><div class="ttdeci">std::vector< std::string > Split(const std::string &s, char delim)</div><div class="ttdoc">Split a string by delimiter.</div><div class="ttdef"><b>Definition:</b> common.h:23</div></div> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Sat Nov 5 2022 01:16:56 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> |