blob: bf73a256d7ce96089a29ddc60dbe591a8186c445 [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 content="text/xhtml;charset=utf-8" http-equiv="Content-Type"/>
<meta content="IE=9" http-equiv="X-UA-Compatible"/>
<meta content="Doxygen 1.8.11" name="generator"/>
<title>mxnet: cpp-package/include/mxnet-cpp/op_map.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script src="jquery.js" type="text/javascript"></script>
<script src="dynsections.js" type="text/javascript"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script src="search/searchdata.js" type="text/javascript"></script>
<script src="search/search.js" type="text/javascript"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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 cellpadding="0" cellspacing="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.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div class="tabs" id="navrow1">
<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 class="MSearchBoxInactive" id="MSearchBox">
<span class="left">
<img alt="" id="MSearchSelect" onmouseout="return searchBox.OnSearchSelectHide()" onmouseover="return searchBox.OnSearchSelectShow()" src="search/mag_sel.png"/>
<input accesskey="S" id="MSearchField" onblur="searchBox.OnSearchFieldFocus(false)" onfocus="searchBox.OnSearchFieldFocus(true)" onkeyup="searchBox.OnSearchFieldChange(event)" type="text" value="Search"/>
</span><span class="right">
<a href="javascript:searchBox.CloseResultsWindow()" id="MSearchClose"><img alt="" border="0" id="MSearchCloseImg" src="search/close.png"/></a>
</span>
</div>
</li>
</ul>
</div>
<div class="tabs2" id="navrow2">
<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" onkeydown="return searchBox.OnSearchSelectKey(event)" onmouseout="return searchBox.OnSearchSelectHide()" onmouseover="return searchBox.OnSearchSelectShow()">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe frameborder="0" id="MSearchResults" name="MSearchResults" src="javascript:void(0)">
</iframe>
</div>
<div class="navpath" id="nav-path">
<ul>
<li class="navelem"><a class="el" href="dir_c9bbcf2f7c4ed40b1b23631ec8abffa6.html">cpp-package</a></li><li class="navelem"><a class="el" href="dir_eb07344824255b98f70969533c25e736.html">include</a></li><li class="navelem"><a class="el" href="dir_0327d24fd86e9ce22567ad8f859e5290.html">mxnet-cpp</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">op_map.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="op__map_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> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * distributed with this work for additional information</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * "License"); you may not use this file except in compliance</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * with the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> *</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * software distributed under the License is distributed on an</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * KIND, either express or implied. See the License for the</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * specific language governing permissions and limitations</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * under the License.</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> */</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#ifndef MXNET_CPP_OP_MAP_H_</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#define MXNET_CPP_OP_MAP_H_</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include &lt;map&gt;</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include "<a class="code" href="cpp-package_2include_2mxnet-cpp_2base_8h.html">mxnet-cpp/base.h</a>"</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include "dmlc/logging.h"</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">namespace </span><a class="code" href="namespacemxnet.html">mxnet</a> {</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">namespace </span>cpp {</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classmxnet_1_1cpp_1_1OpMap.html"> 42</a></span> <span class="keyword">class </span><a class="code" href="classmxnet_1_1cpp_1_1OpMap.html">OpMap</a> {</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classmxnet_1_1cpp_1_1OpMap.html#acf1933f350883656aa9a0765cb746e79"> 47</a></span>  <span class="keyword">inline</span> <a class="code" href="classmxnet_1_1cpp_1_1OpMap.html#acf1933f350883656aa9a0765cb746e79">OpMap</a>() {</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <a class="code" href="c__api_8h.html#a796e7ef8260ef40b24af7d1082aa2d84">mx_uint</a> num_symbol_creators = 0;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="c__api_8h.html#aa2e96133f49cfdc1095da6cd08afbce0">AtomicSymbolCreator</a> *symbol_creators = <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordtype">int</span> r =</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <a class="code" href="c__api_8h.html#a6eb35d17154ef093856e60e416d354cc">MXSymbolListAtomicSymbolCreators</a>(&amp;num_symbol_creators, &amp;symbol_creators);</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  CHECK_EQ(r, 0);</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordflow">for</span> (<a class="code" href="c__api_8h.html#a796e7ef8260ef40b24af7d1082aa2d84">mx_uint</a> i = 0; i &lt; num_symbol_creators; i++) {</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *name;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *description;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <a class="code" href="c__api_8h.html#a796e7ef8260ef40b24af7d1082aa2d84">mx_uint</a> num_args;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> **arg_names;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> **arg_type_infos;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> **arg_descriptions;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *key_var_num_args;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  r = <a class="code" href="c__api_8h.html#aa46875e507a638bd6c8a6c891a8f5934">MXSymbolGetAtomicSymbolInfo</a>(symbol_creators[i], &amp;name, &amp;description,</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  &amp;num_args, &amp;arg_names, &amp;arg_type_infos,</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  &amp;arg_descriptions, &amp;key_var_num_args);</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  CHECK_EQ(r, 0);</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  symbol_creators_[name] = symbol_creators[i];</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  }</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  nn_uint num_ops;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> **op_names;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  r = NNListAllOpNames(&amp;num_ops, &amp;op_names);</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  CHECK_EQ(r, 0);</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordflow">for</span> (nn_uint i = 0; i &lt; num_ops; i++) {</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  OpHandle handle;</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  r = NNGetOpHandle(op_names[i], &amp;handle);</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  CHECK_EQ(r, 0);</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  op_handles_[op_names[i]] = handle;</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="l00086"></a><span class="lineno"><a class="line" href="classmxnet_1_1cpp_1_1OpMap.html#a8e18deae437612f90657629a938b5f77"> 86</a></span>  <span class="keyword">inline</span> <a class="code" href="c__api_8h.html#aa2e96133f49cfdc1095da6cd08afbce0">AtomicSymbolCreator</a> <a class="code" href="classmxnet_1_1cpp_1_1OpMap.html#a8e18deae437612f90657629a938b5f77">GetSymbolCreator</a>(<span class="keyword">const</span> std::string &amp;name) {</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordflow">if</span> (symbol_creators_.count(name) == 0)</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordflow">return</span> <a class="code" href="classmxnet_1_1cpp_1_1OpMap.html#a2ef55f9a72085d1a630f98612f0bd293">GetOpHandle</a>(name);</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordflow">return</span> symbol_creators_[name];</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> </div><div class="line"><a name="l00098"></a><span class="lineno"><a class="line" href="classmxnet_1_1cpp_1_1OpMap.html#a2ef55f9a72085d1a630f98612f0bd293"> 98</a></span>  <span class="keyword">inline</span> OpHandle <a class="code" href="classmxnet_1_1cpp_1_1OpMap.html#a2ef55f9a72085d1a630f98612f0bd293">GetOpHandle</a>(<span class="keyword">const</span> std::string &amp;name) {</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keywordflow">return</span> op_handles_[name];</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  }</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  std::map&lt;std::string, AtomicSymbolCreator&gt; symbol_creators_;</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  std::map&lt;std::string, OpHandle&gt; op_handles_;</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> };</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> } <span class="comment">// namespace cpp</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> } <span class="comment">// namespace mxnet</span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="preprocessor">#endif // MXNET_CPP_OP_MAP_H_</span></div><div class="ttc" id="classmxnet_1_1cpp_1_1OpMap_html_a2ef55f9a72085d1a630f98612f0bd293"><div class="ttname"><a href="classmxnet_1_1cpp_1_1OpMap.html#a2ef55f9a72085d1a630f98612f0bd293">mxnet::cpp::OpMap::GetOpHandle</a></div><div class="ttdeci">OpHandle GetOpHandle(const std::string &amp;name)</div><div class="ttdoc">Get an op handle with its name. </div><div class="ttdef"><b>Definition:</b> op_map.h:98</div></div>
<div class="ttc" id="c__api_8h_html_a6eb35d17154ef093856e60e416d354cc"><div class="ttname"><a href="c__api_8h.html#a6eb35d17154ef093856e60e416d354cc">MXSymbolListAtomicSymbolCreators</a></div><div class="ttdeci">MXNET_DLL int MXSymbolListAtomicSymbolCreators(mx_uint *out_size, AtomicSymbolCreator **out_array)</div><div class="ttdoc">list all the available AtomicSymbolEntry </div></div>
<div class="ttc" id="classmxnet_1_1cpp_1_1OpMap_html"><div class="ttname"><a href="classmxnet_1_1cpp_1_1OpMap.html">mxnet::cpp::OpMap</a></div><div class="ttdoc">OpMap instance holds a map of all the symbol creators so we can get symbol creators by name...</div><div class="ttdef"><b>Definition:</b> op_map.h:42</div></div>
<div class="ttc" id="namespacemxnet_html"><div class="ttname"><a href="namespacemxnet.html">mxnet</a></div><div class="ttdoc">namespace of mxnet </div><div class="ttdef"><b>Definition:</b> base.h:126</div></div>
<div class="ttc" id="c__api_8h_html_aa46875e507a638bd6c8a6c891a8f5934"><div class="ttname"><a href="c__api_8h.html#aa46875e507a638bd6c8a6c891a8f5934">MXSymbolGetAtomicSymbolInfo</a></div><div class="ttdeci">MXNET_DLL int MXSymbolGetAtomicSymbolInfo(AtomicSymbolCreator creator, const char **name, const char **description, mx_uint *num_args, const char ***arg_names, const char ***arg_type_infos, const char ***arg_descriptions, const char **key_var_num_args, const char **return_type DEFAULT(NULL))</div><div class="ttdoc">Get the detailed information about atomic symbol. </div></div>
<div class="ttc" id="classmxnet_1_1cpp_1_1OpMap_html_acf1933f350883656aa9a0765cb746e79"><div class="ttname"><a href="classmxnet_1_1cpp_1_1OpMap.html#acf1933f350883656aa9a0765cb746e79">mxnet::cpp::OpMap::OpMap</a></div><div class="ttdeci">OpMap()</div><div class="ttdoc">Create an Mxnet instance. </div><div class="ttdef"><b>Definition:</b> op_map.h:47</div></div>
<div class="ttc" id="c__api_8h_html_a796e7ef8260ef40b24af7d1082aa2d84"><div class="ttname"><a href="c__api_8h.html#a796e7ef8260ef40b24af7d1082aa2d84">mx_uint</a></div><div class="ttdeci">unsigned int mx_uint</div><div class="ttdoc">manually define unsigned int </div><div class="ttdef"><b>Definition:</b> c_api.h:57</div></div>
<div class="ttc" id="cpp-package_2include_2mxnet-cpp_2base_8h_html"><div class="ttname"><a href="cpp-package_2include_2mxnet-cpp_2base_8h.html">base.h</a></div></div>
<div class="ttc" id="c__api_8h_html_aa2e96133f49cfdc1095da6cd08afbce0"><div class="ttname"><a href="c__api_8h.html#aa2e96133f49cfdc1095da6cd08afbce0">AtomicSymbolCreator</a></div><div class="ttdeci">void * AtomicSymbolCreator</div><div class="ttdoc">handle to a function that takes param and creates symbol </div><div class="ttdef"><b>Definition:</b> c_api.h:68</div></div>
<div class="ttc" id="classmxnet_1_1cpp_1_1OpMap_html_a8e18deae437612f90657629a938b5f77"><div class="ttname"><a href="classmxnet_1_1cpp_1_1OpMap.html#a8e18deae437612f90657629a938b5f77">mxnet::cpp::OpMap::GetSymbolCreator</a></div><div class="ttdeci">AtomicSymbolCreator GetSymbolCreator(const std::string &amp;name)</div><div class="ttdoc">Get a symbol creator with its name. </div><div class="ttdef"><b>Definition:</b> op_map.h:86</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Sep 19 2019 13:11:20 for mxnet by  <a href="http://www.doxygen.org/index.html">
<img alt="doxygen" class="footer" src="doxygen.png"/>
</a> 1.8.11
</small></address>
</body>
</html>