blob: cfd67dc33fac99257c8c5c96adcc9ef564ffdca6 [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/base.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">base.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="cpp-package_2include_2mxnet-cpp_2base_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_BASE_H_</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#define MXNET_CPP_BASE_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;cstdlib&gt;</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include "<a class="code" href="c__api_8h.html">mxnet/c_api.h</a>"</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include "nnvm/c_api.h"</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">namespace </span><a class="code" href="namespacemxnet.html">mxnet</a> {</div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="namespacemxnet_1_1cpp.html"> 34</a></span> <span class="keyword">namespace </span>cpp {</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4"> 36</a></span> <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <a class="code" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a>;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="namespacemxnet_1_1cpp.html#ae1e49a337d45c7071defefda2ec91845"> 38</a></span> <span class="keyword">enum</span> <a class="code" href="namespacemxnet_1_1cpp.html#ae1e49a337d45c7071defefda2ec91845">OpReqType</a> {</div><div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="namespacemxnet_1_1cpp.html#ae1e49a337d45c7071defefda2ec91845aefc84e1f8e37df690eb120d7f85f2cb2"> 40</a></span>  <a class="code" href="namespacemxnet_1_1cpp.html#ae1e49a337d45c7071defefda2ec91845aefc84e1f8e37df690eb120d7f85f2cb2">kNullOp</a>,</div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="namespacemxnet_1_1cpp.html#ae1e49a337d45c7071defefda2ec91845aeeb7170b414b47800f504038816d5b68"> 42</a></span>  <a class="code" href="namespacemxnet_1_1cpp.html#ae1e49a337d45c7071defefda2ec91845aeeb7170b414b47800f504038816d5b68">kWriteTo</a>,</div><div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="namespacemxnet_1_1cpp.html#ae1e49a337d45c7071defefda2ec91845aae1754f69deaa9fe7d2d37479126d08d"> 48</a></span>  <a class="code" href="namespacemxnet_1_1cpp.html#ae1e49a337d45c7071defefda2ec91845aae1754f69deaa9fe7d2d37479126d08d">kWriteInplace</a>,</div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="namespacemxnet_1_1cpp.html#ae1e49a337d45c7071defefda2ec91845a00aae45e4e69f21765e2ff3ecea6ac81"> 50</a></span>  <a class="code" href="namespacemxnet_1_1cpp.html#ae1e49a337d45c7071defefda2ec91845a00aae45e4e69f21765e2ff3ecea6ac81">kAddTo</a></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> };</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> } <span class="comment">// namespace cpp</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> } <span class="comment">// namespace mxnet</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor">#endif // MXNET_CPP_BASE_H_</span></div><div class="ttc" id="c__api_8h_html"><div class="ttname"><a href="c__api_8h.html">c_api.h</a></div><div class="ttdoc">C API of mxnet. </div></div>
<div class="ttc" id="namespacemxnet_1_1cpp_html_ae1e49a337d45c7071defefda2ec91845a00aae45e4e69f21765e2ff3ecea6ac81"><div class="ttname"><a href="namespacemxnet_1_1cpp.html#ae1e49a337d45c7071defefda2ec91845a00aae45e4e69f21765e2ff3ecea6ac81">mxnet::cpp::kAddTo</a></div><div class="ttdoc">add to the provided space </div><div class="ttdef"><b>Definition:</b> base.h:50</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="namespacemxnet_1_1cpp_html_ae1e49a337d45c7071defefda2ec91845aeeb7170b414b47800f504038816d5b68"><div class="ttname"><a href="namespacemxnet_1_1cpp.html#ae1e49a337d45c7071defefda2ec91845aeeb7170b414b47800f504038816d5b68">mxnet::cpp::kWriteTo</a></div><div class="ttdoc">write gradient to provided space </div><div class="ttdef"><b>Definition:</b> base.h:42</div></div>
<div class="ttc" id="namespacemxnet_1_1cpp_html_ae1e49a337d45c7071defefda2ec91845"><div class="ttname"><a href="namespacemxnet_1_1cpp.html#ae1e49a337d45c7071defefda2ec91845">mxnet::cpp::OpReqType</a></div><div class="ttdeci">OpReqType</div><div class="ttdef"><b>Definition:</b> base.h:38</div></div>
<div class="ttc" id="namespacemxnet_1_1cpp_html_ae1e49a337d45c7071defefda2ec91845aae1754f69deaa9fe7d2d37479126d08d"><div class="ttname"><a href="namespacemxnet_1_1cpp.html#ae1e49a337d45c7071defefda2ec91845aae1754f69deaa9fe7d2d37479126d08d">mxnet::cpp::kWriteInplace</a></div><div class="ttdoc">perform an inplace write, Target shares memory with one of input arguments. This option only happen w...</div><div class="ttdef"><b>Definition:</b> base.h:48</div></div>
<div class="ttc" id="namespacemxnet_1_1cpp_html_ae1e49a337d45c7071defefda2ec91845aefc84e1f8e37df690eb120d7f85f2cb2"><div class="ttname"><a href="namespacemxnet_1_1cpp.html#ae1e49a337d45c7071defefda2ec91845aefc84e1f8e37df690eb120d7f85f2cb2">mxnet::cpp::kNullOp</a></div><div class="ttdoc">no operation, do not write anything </div><div class="ttdef"><b>Definition:</b> base.h:40</div></div>
<div class="ttc" id="namespacemxnet_1_1cpp_html_ae3c39bf39510741647c969f5409bb5d4"><div class="ttname"><a href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">mxnet::cpp::index_t</a></div><div class="ttdeci">unsigned index_t</div><div class="ttdef"><b>Definition:</b> base.h:36</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>