Google Git
Sign in
apache / mxnet-site / d5c5a235eef72f64ccaf224b834a20ef3287469b / . / versions / 1.9.1 / api / cpp / docs / api / c__runtime__api_8h.html
blob: 4d6271184f4fd4e8116c8c848e416d47b470e658 [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/include/mxnet/runtime/c_runtime_api.h File Reference</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_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_1143c7affb9ebd026cb6818dd282def7.html">mxnet</a></li><li class="navelem"><a class="el" href="dir_8e7a93613ef4c7e7d673effa691c1739.html">runtime</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">c_runtime_api.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;<a class="el" href="dlpack_8h_source.html">dlpack/dlpack.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="include_2mxnet_2c__api_8h_source.html">mxnet/c_api.h</a>&gt;</code><br />
<code>#include &lt;stdint.h&gt;</code><br />
<code>#include &lt;stddef.h&gt;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for c_runtime_api.h:</div>
<div class="dyncontent">
<div class="center"><img src="c__runtime__api_8h__incl.png" border="0" usemap="#_2work_2mxnet_2include_2mxnet_2runtime_2c__runtime__api_8h" alt=""/></div>
<map name="_2work_2mxnet_2include_2mxnet_2runtime_2c__runtime__api_8h" id="_2work_2mxnet_2include_2mxnet_2runtime_2c__runtime__api_8h">
<area shape="rect" id="node2" href="dlpack_8h.html" title="The common header of DLPack. " alt="" coords="195,95,319,121"/>
<area shape="rect" id="node5" href="include_2mxnet_2c__api_8h.html" title="mxnet/c_api.h" alt="" coords="5,95,120,121"/>
</map>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="c__runtime__api_8h__dep__incl.png" border="0" usemap="#_2work_2mxnet_2include_2mxnet_2runtime_2c__runtime__api_8hdep" alt=""/></div>
<map name="_2work_2mxnet_2include_2mxnet_2runtime_2c__runtime__api_8hdep" id="_2work_2mxnet_2include_2mxnet_2runtime_2c__runtime__api_8hdep">
<area shape="rect" id="node2" href="packed__func_8h.html" title="Type&#45;erased function used across MXNET API. " alt="" coords="442,913,617,969"/>
<area shape="rect" id="node5" href="object_8h.html" title="A managed object in MXNet runtime. " alt="" coords="424,95,603,136"/>
<area shape="rect" id="node28" href="include_2mxnet_2node_2node_8h.html" title="/work/mxnet/include\l/mxnet/node/node.h" alt="" coords="183,273,337,315"/>
<area shape="rect" id="node32" href="data__type_8h.html" title="/work/mxnet/include\l/mxnet/runtime/data\l_type.h" alt="" coords="350,363,506,419"/>
<area shape="rect" id="node3" href="include_2mxnet_2runtime_2registry_8h.html" title="/work/mxnet/include\l/mxnet/runtime/registry.h" alt="" coords="436,1017,623,1059"/>
<area shape="rect" id="node4" href="api__registry_8h.html" title="This file contains utilities related to the MXNet&#39;s global function registry. " alt="" coords="450,1107,609,1148"/>
<area shape="rect" id="node6" href="include_2mxnet_2tuple_8h.html" title="Data structure Tuple and TShape to store dynamic sized shapes. " alt="" coords="668,556,823,597"/>
<area shape="rect" id="node25" href="ffi__helper_8h.html" title="/work/mxnet/include\l/mxnet/runtime/ffi_helper.h" alt="" coords="631,370,830,411"/>
<area shape="rect" id="node26" href="expr_8h.html" title="Base expr nodes in MXNet. " alt="" coords="327,467,481,508"/>
<area shape="rect" id="node30" href="runtime_2container_8h.html" title="/work/mxnet/include\l/mxnet/runtime/container.h" alt="" coords="513,273,711,315"/>
<area shape="rect" id="node31" href="include_2mxnet_2runtime_2memory_8h.html" title="Runtime memory management. " alt="" coords="564,184,756,225"/>
<area shape="rect" id="node7" href="include_2mxnet_2base_8h.html" title="/work/mxnet/include\l/mxnet/base.h" alt="" coords="1240,645,1395,687"/>
<area shape="rect" id="node8" href="engine_8h.html" title="Engine that schedules all the operations according to dependency. " alt="" coords="1412,735,1567,776"/>
<area shape="rect" id="node9" href="include_2mxnet_2ndarray_8h.html" title="/work/mxnet/include\l/mxnet/ndarray.h" alt="" coords="1132,824,1287,865"/>
<area shape="rect" id="node10" href="include_2mxnet_2executor_8h.html" title="/work/mxnet/include\l/mxnet/executor.h" alt="" coords="1792,1107,1947,1148"/>
<area shape="rect" id="node11" href="include_2mxnet_2op__attr__types_8h.html" title="/work/mxnet/include\l/mxnet/op_attr_types.h" alt="" coords="1352,921,1525,962"/>
<area shape="rect" id="node12" href="include_2mxnet_2operator_8h.html" title="/work/mxnet/include\l/mxnet/operator.h" alt="" coords="1701,1017,1856,1059"/>
<area shape="rect" id="node13" href="operator__util_8h.html" title="Utility functions and registries to help quickly build new operators. [Deprecated] Use the register f..." alt="" coords="1601,1107,1767,1148"/>
<area shape="rect" id="node18" href="include_2mxnet_2io_8h.html" title="/work/mxnet/include\l/mxnet/io.h" alt="" coords="843,921,997,962"/>
<area shape="rect" id="node20" href="resource_8h.html" title="Global resource allocation handling. " alt="" coords="1665,824,1820,865"/>
<area shape="rect" id="node21" href="storage_8h.html" title="Storage manager across multiple devices. " alt="" coords="1183,735,1337,776"/>
<area shape="rect" id="node22" href="random__generator_8h.html" title="Parallel random number generator. " alt="" coords="1641,735,1844,776"/>
<area shape="rect" id="node23" href="rtc_8h.html" title="/work/mxnet/include\l/mxnet/rtc.h" alt="" coords="719,735,873,776"/>
<area shape="rect" id="node24" href="tensor__blob_8h.html" title="TBlob class that holds common representation of arbirary dimension tensor, can be used to transformed..." alt="" coords="897,735,1057,776"/>
<area shape="rect" id="node16" href="utils_8h.html" title="Basic utilility functions. " alt="" coords="1246,1196,1434,1237"/>
<area shape="rect" id="node15" href="imperative_8h.html" title="/work/mxnet/include\l/mxnet/imperative.h" alt="" coords="1139,1107,1293,1148"/>
<area shape="rect" id="node19" href="include_2mxnet_2kvstore_8h.html" title="/work/mxnet/include\l/mxnet/kvstore.h" alt="" coords="1123,921,1277,962"/>
<area shape="rect" id="node14" href="include_2mxnet_2graph__attr__types_8h.html" title="/work/mxnet/include\l/mxnet/graph_attr_types.h" alt="" coords="1243,1017,1437,1059"/>
<area shape="rect" id="node17" href="exec__utils_8h.html" title="Common utility functions for executors. " alt="" coords="1246,1285,1434,1327"/>
<area shape="rect" id="node27" href="expr__operator_8h.html" title="Common operators defined for Expr. " alt="" coords="317,556,491,597"/>
<area shape="rect" id="node29" href="node_2container_8h.html" title="/work/mxnet/include\l/mxnet/node/container.h" alt="" coords="94,370,274,411"/>
</map>
</div>
</div>
<p><a href="c__runtime__api_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">union &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="unionMXNetValue.html">MXNetValue</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Union type of values being passed through API and function calls. <a href="unionMXNetValue.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMXNetByteArray.html">MXNetByteArray</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Byte array type used to pass in byte array When kBytes is used as data type. <a href="structMXNetByteArray.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:abe4da652882a4e6c478727da7971c167"><td class="memItemLeft" align="right" valign="top">typedef void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="c__runtime__api_8h.html#abe4da652882a4e6c478727da7971c167">MXNetFunctionHandle</a></td></tr>
<tr class="memdesc:abe4da652882a4e6c478727da7971c167"><td class="mdescLeft">&#160;</td><td class="mdescRight">Handle to packed function handle. <a href="#abe4da652882a4e6c478727da7971c167">More...</a><br /></td></tr>
<tr class="separator:abe4da652882a4e6c478727da7971c167"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a80d606e7a0b9f57099b1ac25aacf227c"><td class="memItemLeft" align="right" valign="top">typedef void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="c__runtime__api_8h.html#a80d606e7a0b9f57099b1ac25aacf227c">MXNetObjectHandle</a></td></tr>
<tr class="memdesc:a80d606e7a0b9f57099b1ac25aacf227c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Handle to Object. <a href="#a80d606e7a0b9f57099b1ac25aacf227c">More...</a><br /></td></tr>
<tr class="separator:a80d606e7a0b9f57099b1ac25aacf227c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a0cbf903877c151937a6a5facb54db663"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="c__runtime__api_8h.html#a0cbf903877c151937a6a5facb54db663">MXNetTypeCode</a> { <br />
&#160;&#160;<a class="el" href="c__runtime__api_8h.html#a0cbf903877c151937a6a5facb54db663a9d53cd5a7c2e7bc5f00f6ffff9898c3e">kHandle</a> = 3U,
<a class="el" href="c__runtime__api_8h.html#a0cbf903877c151937a6a5facb54db663a654bc36fd07532aad8ba6c7e6769f233">kNull</a> = 4U,
<a class="el" href="c__runtime__api_8h.html#a0cbf903877c151937a6a5facb54db663a0cc768bfcacf5e4acab46cb277b4bd58">kMXNetType</a> = 5U,
<a class="el" href="c__runtime__api_8h.html#a0cbf903877c151937a6a5facb54db663a21a358e40ca0d1fd6f88dba9444fb564">kMXNetContext</a> = 6U,
<br />
&#160;&#160;<a class="el" href="c__runtime__api_8h.html#a0cbf903877c151937a6a5facb54db663a82ccd6fb0416c816de0ea7978e6b701f">kArrayHandle</a> = 7U,
<a class="el" href="c__runtime__api_8h.html#a0cbf903877c151937a6a5facb54db663af4331b9eddb0ae826d0258a7a6b19170">kObjectHandle</a> = 8U,
<a class="el" href="c__runtime__api_8h.html#a0cbf903877c151937a6a5facb54db663a57e21fc58c58ec5cce657c9d796e8cc4">kModuleHandle</a> = 9U,
<a class="el" href="c__runtime__api_8h.html#a0cbf903877c151937a6a5facb54db663a24b846037d322505803892e7c6a28376">kFuncHandle</a> = 10U,
<br />
&#160;&#160;<a class="el" href="c__runtime__api_8h.html#a0cbf903877c151937a6a5facb54db663a0a20f739fae1210d0484c6db219c1a6d">kStr</a> = 11U,
<a class="el" href="c__runtime__api_8h.html#a0cbf903877c151937a6a5facb54db663a6ad04061bd5addc254a46376ac7e1154">kBytes</a> = 12U,
<a class="el" href="c__runtime__api_8h.html#a0cbf903877c151937a6a5facb54db663a8f13cd948ca4fc12446d1e1e11f7f437">kNDArrayContainer</a> = 13U,
<a class="el" href="c__runtime__api_8h.html#a0cbf903877c151937a6a5facb54db663a93b51f5cf5ce1582b75918585a6403ad">kNDArrayHandle</a> = 14U,
<br />
&#160;&#160;<a class="el" href="c__runtime__api_8h.html#a0cbf903877c151937a6a5facb54db663afb01073981efe779cd6c14eba1b84a62">kExtBegin</a> = 15U,
<a class="el" href="c__runtime__api_8h.html#a0cbf903877c151937a6a5facb54db663aa404d8153909445ee96722e324759424">kNNVMFirst</a> = 16U,
<a class="el" href="c__runtime__api_8h.html#a0cbf903877c151937a6a5facb54db663a82836e2c980d9b7714c1acdb9b387deb">kNNVMLast</a> = 20U,
<a class="el" href="c__runtime__api_8h.html#a0cbf903877c151937a6a5facb54db663a265497154b8a782dfe1eb26f94359b4e">kExtReserveEnd</a> = 64U,
<br />
&#160;&#160;<a class="el" href="c__runtime__api_8h.html#a0cbf903877c151937a6a5facb54db663a19b4adb0533cd8c8c28bf67529c0c989">kExtEnd</a> = 128U,
<a class="el" href="c__runtime__api_8h.html#a0cbf903877c151937a6a5facb54db663a91a8ac1d3182ed9f9e52fc0dda71a5ce">kCustomBegin</a> = 129U
<br />
}<tr class="memdesc:a0cbf903877c151937a6a5facb54db663"><td class="mdescLeft">&#160;</td><td class="mdescRight">The type code in MXNetType. <a href="c__runtime__api_8h.html#a0cbf903877c151937a6a5facb54db663">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a0cbf903877c151937a6a5facb54db663"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a7fd771716e28ea422239744ae2733d71"><td class="memItemLeft" align="right" valign="top"><a class="el" href="c__predict__api_8h.html#a5b0e47dde55f9b2f58b99fab92d1e0ac">MXNET_DLL</a> int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="c__runtime__api_8h.html#a7fd771716e28ea422239744ae2733d71">MXNetFuncFree</a> (<a class="el" href="c__runtime__api_8h.html#abe4da652882a4e6c478727da7971c167">MXNetFunctionHandle</a> func)</td></tr>
<tr class="memdesc:a7fd771716e28ea422239744ae2733d71"><td class="mdescLeft">&#160;</td><td class="mdescRight">Free the function when it is no longer needed. <a href="#a7fd771716e28ea422239744ae2733d71">More...</a><br /></td></tr>
<tr class="separator:a7fd771716e28ea422239744ae2733d71"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1e3688a4beef5f2407a7dcfdd90a846"><td class="memItemLeft" align="right" valign="top"><a class="el" href="c__predict__api_8h.html#a5b0e47dde55f9b2f58b99fab92d1e0ac">MXNET_DLL</a> int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="c__runtime__api_8h.html#aa1e3688a4beef5f2407a7dcfdd90a846">MXNetFuncCall</a> (<a class="el" href="c__runtime__api_8h.html#abe4da652882a4e6c478727da7971c167">MXNetFunctionHandle</a> func, <a class="el" href="unionMXNetValue.html">MXNetValue</a> *arg_values, int *type_codes, int num_args, <a class="el" href="unionMXNetValue.html">MXNetValue</a> *ret_val, int *ret_type_code)</td></tr>
<tr class="memdesc:aa1e3688a4beef5f2407a7dcfdd90a846"><td class="mdescLeft">&#160;</td><td class="mdescRight">Call a Packed MXNet Function. <a href="#aa1e3688a4beef5f2407a7dcfdd90a846">More...</a><br /></td></tr>
<tr class="separator:aa1e3688a4beef5f2407a7dcfdd90a846"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a453f724d7c95c2bc54fa6e58cb371388"><td class="memItemLeft" align="right" valign="top"><a class="el" href="c__predict__api_8h.html#a5b0e47dde55f9b2f58b99fab92d1e0ac">MXNET_DLL</a> int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="c__runtime__api_8h.html#a453f724d7c95c2bc54fa6e58cb371388">MXNetFuncGetGlobal</a> (const char *name, <a class="el" href="c__runtime__api_8h.html#abe4da652882a4e6c478727da7971c167">MXNetFunctionHandle</a> *out)</td></tr>
<tr class="memdesc:a453f724d7c95c2bc54fa6e58cb371388"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a global function. <a href="#a453f724d7c95c2bc54fa6e58cb371388">More...</a><br /></td></tr>
<tr class="separator:a453f724d7c95c2bc54fa6e58cb371388"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4300e7198411eb1048e0470b9d39c361"><td class="memItemLeft" align="right" valign="top"><a class="el" href="c__predict__api_8h.html#a5b0e47dde55f9b2f58b99fab92d1e0ac">MXNET_DLL</a> int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="c__runtime__api_8h.html#a4300e7198411eb1048e0470b9d39c361">MXNetFuncListGlobalNames</a> (int *out_size, const char ***out_array)</td></tr>
<tr class="memdesc:a4300e7198411eb1048e0470b9d39c361"><td class="mdescLeft">&#160;</td><td class="mdescRight">List all the globally registered function name. <a href="#a4300e7198411eb1048e0470b9d39c361">More...</a><br /></td></tr>
<tr class="separator:a4300e7198411eb1048e0470b9d39c361"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0fbda9f8d3b3db7d5868a7110c6f052d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="c__predict__api_8h.html#a5b0e47dde55f9b2f58b99fab92d1e0ac">MXNET_DLL</a> int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="c__runtime__api_8h.html#a0fbda9f8d3b3db7d5868a7110c6f052d">MXNetObjectFree</a> (<a class="el" href="c__runtime__api_8h.html#a80d606e7a0b9f57099b1ac25aacf227c">MXNetObjectHandle</a> obj)</td></tr>
<tr class="memdesc:a0fbda9f8d3b3db7d5868a7110c6f052d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Free the object. <a href="#a0fbda9f8d3b3db7d5868a7110c6f052d">More...</a><br /></td></tr>
<tr class="separator:a0fbda9f8d3b3db7d5868a7110c6f052d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="abe4da652882a4e6c478727da7971c167"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe4da652882a4e6c478727da7971c167">&#9670;&nbsp;</a></span>MXNetFunctionHandle</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void* <a class="el" href="c__runtime__api_8h.html#abe4da652882a4e6c478727da7971c167">MXNetFunctionHandle</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Handle to packed function handle. </p>
</div>
</div>
<a id="a80d606e7a0b9f57099b1ac25aacf227c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a80d606e7a0b9f57099b1ac25aacf227c">&#9670;&nbsp;</a></span>MXNetObjectHandle</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void* <a class="el" href="c__runtime__api_8h.html#a80d606e7a0b9f57099b1ac25aacf227c">MXNetObjectHandle</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Handle to Object. </p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a0cbf903877c151937a6a5facb54db663"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0cbf903877c151937a6a5facb54db663">&#9670;&nbsp;</a></span>MXNetTypeCode</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="c__runtime__api_8h.html#a0cbf903877c151937a6a5facb54db663">MXNetTypeCode</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>The type code in MXNetType. </p>
<dl class="section note"><dt>Note</dt><dd>MXNetType is used in two places. </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a0cbf903877c151937a6a5facb54db663a9d53cd5a7c2e7bc5f00f6ffff9898c3e"></a>kHandle&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a0cbf903877c151937a6a5facb54db663a654bc36fd07532aad8ba6c7e6769f233"></a>kNull&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a0cbf903877c151937a6a5facb54db663a0cc768bfcacf5e4acab46cb277b4bd58"></a>kMXNetType&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a0cbf903877c151937a6a5facb54db663a21a358e40ca0d1fd6f88dba9444fb564"></a>kMXNetContext&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a0cbf903877c151937a6a5facb54db663a82ccd6fb0416c816de0ea7978e6b701f"></a>kArrayHandle&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a0cbf903877c151937a6a5facb54db663af4331b9eddb0ae826d0258a7a6b19170"></a>kObjectHandle&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a0cbf903877c151937a6a5facb54db663a57e21fc58c58ec5cce657c9d796e8cc4"></a>kModuleHandle&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a0cbf903877c151937a6a5facb54db663a24b846037d322505803892e7c6a28376"></a>kFuncHandle&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a0cbf903877c151937a6a5facb54db663a0a20f739fae1210d0484c6db219c1a6d"></a>kStr&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a0cbf903877c151937a6a5facb54db663a6ad04061bd5addc254a46376ac7e1154"></a>kBytes&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a0cbf903877c151937a6a5facb54db663a8f13cd948ca4fc12446d1e1e11f7f437"></a>kNDArrayContainer&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a0cbf903877c151937a6a5facb54db663a93b51f5cf5ce1582b75918585a6403ad"></a>kNDArrayHandle&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a0cbf903877c151937a6a5facb54db663afb01073981efe779cd6c14eba1b84a62"></a>kExtBegin&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a0cbf903877c151937a6a5facb54db663aa404d8153909445ee96722e324759424"></a>kNNVMFirst&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a0cbf903877c151937a6a5facb54db663a82836e2c980d9b7714c1acdb9b387deb"></a>kNNVMLast&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a0cbf903877c151937a6a5facb54db663a265497154b8a782dfe1eb26f94359b4e"></a>kExtReserveEnd&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a0cbf903877c151937a6a5facb54db663a19b4adb0533cd8c8c28bf67529c0c989"></a>kExtEnd&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a0cbf903877c151937a6a5facb54db663a91a8ac1d3182ed9f9e52fc0dda71a5ce"></a>kCustomBegin&#160;</td><td class="fielddoc"></td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="aa1e3688a4beef5f2407a7dcfdd90a846"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa1e3688a4beef5f2407a7dcfdd90a846">&#9670;&nbsp;</a></span>MXNetFuncCall()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="c__predict__api_8h.html#a5b0e47dde55f9b2f58b99fab92d1e0ac">MXNET_DLL</a> int MXNetFuncCall </td>
<td>(</td>
<td class="paramtype"><a class="el" href="c__runtime__api_8h.html#abe4da652882a4e6c478727da7971c167">MXNetFunctionHandle</a>&#160;</td>
<td class="paramname"><em>func</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="unionMXNetValue.html">MXNetValue</a> *&#160;</td>
<td class="paramname"><em>arg_values</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int *&#160;</td>
<td class="paramname"><em>type_codes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>num_args</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="unionMXNetValue.html">MXNetValue</a> *&#160;</td>
<td class="paramname"><em>ret_val</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int *&#160;</td>
<td class="paramname"><em>ret_type_code</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call a Packed MXNet Function. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">func</td><td>node handle of the function. </td></tr>
<tr><td class="paramname">arg_values</td><td>The arguments </td></tr>
<tr><td class="paramname">type_codes</td><td>The type codes of the arguments </td></tr>
<tr><td class="paramname">num_args</td><td>Number of arguments.</td></tr>
<tr><td class="paramname">ret_val</td><td>The return value. </td></tr>
<tr><td class="paramname">ret_type_code</td><td>the type code of return value.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 when success, -1 when failure happens </dd></dl>
<dl class="section note"><dt>Note</dt><dd>MXNet calls always exchanges with type bits=64, lanes=1</dd>
<dd>
API calls always exchanges with type bits=64, lanes=1 If API call returns container handles (e.g. FunctionHandle) these handles should be managed by the front-end. The front-end need to call free function (e.g. MXNetFuncFree) to free these handles. </dd></dl>
</div>
</div>
<a id="a7fd771716e28ea422239744ae2733d71"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7fd771716e28ea422239744ae2733d71">&#9670;&nbsp;</a></span>MXNetFuncFree()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="c__predict__api_8h.html#a5b0e47dde55f9b2f58b99fab92d1e0ac">MXNET_DLL</a> int MXNetFuncFree </td>
<td>(</td>
<td class="paramtype"><a class="el" href="c__runtime__api_8h.html#abe4da652882a4e6c478727da7971c167">MXNetFunctionHandle</a>&#160;</td>
<td class="paramname"><em>func</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free the function when it is no longer needed. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">func</td><td>The function handle </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 when success, -1 when failure happens </dd></dl>
</div>
</div>
<a id="a453f724d7c95c2bc54fa6e58cb371388"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a453f724d7c95c2bc54fa6e58cb371388">&#9670;&nbsp;</a></span>MXNetFuncGetGlobal()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="c__predict__api_8h.html#a5b0e47dde55f9b2f58b99fab92d1e0ac">MXNET_DLL</a> int MXNetFuncGetGlobal </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="c__runtime__api_8h.html#abe4da652882a4e6c478727da7971c167">MXNetFunctionHandle</a> *&#160;</td>
<td class="paramname"><em>out</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a global function. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The name of the function. </td></tr>
<tr><td class="paramname">out</td><td>the result function pointer, NULL if it does not exist.</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>The function handle of global function is managed by MXNet runtime, So MXNetFuncFree is should not be called when it get deleted. </dd></dl>
</div>
</div>
<a id="a4300e7198411eb1048e0470b9d39c361"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4300e7198411eb1048e0470b9d39c361">&#9670;&nbsp;</a></span>MXNetFuncListGlobalNames()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="c__predict__api_8h.html#a5b0e47dde55f9b2f58b99fab92d1e0ac">MXNET_DLL</a> int MXNetFuncListGlobalNames </td>
<td>(</td>
<td class="paramtype">int *&#160;</td>
<td class="paramname"><em>out_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char ***&#160;</td>
<td class="paramname"><em>out_array</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>List all the globally registered function name. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">out_size</td><td>The number of functions </td></tr>
<tr><td class="paramname">out_array</td><td>The array of function names. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 when success, -1 when failure happens </dd></dl>
</div>
</div>
<a id="a0fbda9f8d3b3db7d5868a7110c6f052d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0fbda9f8d3b3db7d5868a7110c6f052d">&#9670;&nbsp;</a></span>MXNetObjectFree()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="c__predict__api_8h.html#a5b0e47dde55f9b2f58b99fab92d1e0ac">MXNET_DLL</a> int MXNetObjectFree </td>
<td>(</td>
<td class="paramtype"><a class="el" href="c__runtime__api_8h.html#a80d606e7a0b9f57099b1ac25aacf227c">MXNetObjectHandle</a>&#160;</td>
<td class="paramname"><em>obj</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free the object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">obj</td><td>The object handle. </td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>Internally we decrease the reference counter of the object. The object will be freed when every reference to the object are removed. </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>0 when success, -1 when failure happens </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 5 2023 00:58:43 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>