versions/1.6.0/api/cpp/docs/api/lib__api_8h.html - mxnet-site - Git at Google

 <!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.11"/>
 <title>mxnet: /work/mxnet/include/mxnet/lib_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>
 <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 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.11 -->
 <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&#160;Page</span></a></li>
       <li><a href="modules.html"><span>Modules</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&#160;List</span></a></li>
       <li><a href="globals.html"><span>File&#160;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)">
 </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>  </ul>
 </div>
 </div><!-- top -->
 <div class="header">
   <div class="summary">
 <a href="#define-members">Macros</a> &#124;
 <a href="#typedef-members">Typedefs</a> &#124;
 <a href="#func-members">Functions</a>  </div>
   <div class="headertitle">
 <div class="title">lib_api.h File Reference</div>  </div>
 </div><!--header-->
 <div class="contents">

 <p>APIs to interact with libraries.
 <a href="#details">More...</a></p>

 <p><a href="lib__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="define-members"></a>
 Macros</h2></td></tr>
 <tr class="memitem:ad5405711bcd25d56b2fc2a3fd827ea3c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="lib__api_8h.html#ad5405711bcd25d56b2fc2a3fd827ea3c">MXLIB_INITIALIZE_STR</a>&#160;&#160;&#160;&quot;initialize&quot;</td></tr>
 <tr class="memdesc:ad5405711bcd25d56b2fc2a3fd827ea3c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Following are the APIs implemented in the external library Each API has a #define string that is used to lookup the function in the library Followed by the function declaration.  <a href="#ad5405711bcd25d56b2fc2a3fd827ea3c">More...</a><br /></td></tr>
 <tr class="separator:ad5405711bcd25d56b2fc2a3fd827ea3c"><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:ac522f869f1eb963b6499f710aad4b905"><td class="memItemLeft" align="right" valign="top">typedef int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="lib__api_8h.html#ac522f869f1eb963b6499f710aad4b905">initialize_t</a>) (int)</td></tr>
 <tr class="separator:ac522f869f1eb963b6499f710aad4b905"><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:a4fb97a64ba101e754b009ab8e1e1057e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="lib__api_8h.html#a4fb97a64ba101e754b009ab8e1e1057e">initialize</a> (int)</td></tr>
 <tr class="memdesc:a4fb97a64ba101e754b009ab8e1e1057e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if the MXNet version is supported by the library. If supported, initializes the library.  <a href="#a4fb97a64ba101e754b009ab8e1e1057e">More...</a><br /></td></tr>
 <tr class="separator:a4fb97a64ba101e754b009ab8e1e1057e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 <div class="textblock"><p>APIs to interact with libraries. </p>
 <p>Copyright (c) 2015 by Contributors </p>
 </div><h2 class="groupheader">Macro Definition Documentation</h2>
 <a class="anchor" id="ad5405711bcd25d56b2fc2a3fd827ea3c"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">#define MXLIB_INITIALIZE_STR&#160;&#160;&#160;&quot;initialize&quot;</td>
         </tr>
       </table>
 </div><div class="memdoc">

 <p>Following are the APIs implemented in the external library Each API has a #define string that is used to lookup the function in the library Followed by the function declaration. </p>

 </div>
 </div>
 <h2 class="groupheader">Typedef Documentation</h2>
 <a class="anchor" id="ac522f869f1eb963b6499f710aad4b905"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">typedef int(* initialize_t) (int)</td>
         </tr>
       </table>
 </div><div class="memdoc">

 </div>
 </div>
 <h2 class="groupheader">Function Documentation</h2>
 <a class="anchor" id="a4fb97a64ba101e754b009ab8e1e1057e"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">int initialize </td>
           <td>(</td>
           <td class="paramtype">int&#160;</td>
           <td class="paramname"></td><td>)</td>
           <td></td>
         </tr>
       </table>
 </div><div class="memdoc">

 <p>Checks if the MXNet version is supported by the library. If supported, initializes the library. </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">version</td><td>MXNet version number passed to library and defined as: MXNET_VERSION = (MXNET_MAJOR*10000 + MXNET_MINOR*100 + MXNET_PATCH) </td></tr>
   </table>
   </dd>
 </dl>
 <dl class="section return"><dt>Returns</dt><dd>Non-zero value on error i.e. library incompatible with passed MXNet version </dd></dl>

 </div>
 </div>
 </div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
 Generated on Sat Mar 28 2020 00:52:30 for mxnet by &#160;<a href="http://www.doxygen.org/index.html">
 <img class="footer" src="doxygen.png" alt="doxygen"/>
 </a> 1.8.11
 </small></address>
 </body>
 </html>
	<!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.11"/>
	<title>mxnet: /work/mxnet/include/mxnet/lib_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>
	<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 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.11 -->
	<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="modules.html"><span>Modules</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)">
	</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> </ul>
	</div>
	</div><!-- top -->
	<div class="header">
	<div class="summary">
	<a href="#define-members">Macros</a> \|
	<a href="#typedef-members">Typedefs</a> \|
	<a href="#func-members">Functions</a> </div>
	<div class="headertitle">
	<div class="title">lib_api.h File Reference</div> </div>
	</div><!--header-->
	<div class="contents">

	<p>APIs to interact with libraries.
	<a href="#details">More...</a></p>

	<p><a href="lib__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="define-members"></a>
	Macros</h2></td></tr>
	<tr class="memitem:ad5405711bcd25d56b2fc2a3fd827ea3c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="lib__api_8h.html#ad5405711bcd25d56b2fc2a3fd827ea3c">MXLIB_INITIALIZE_STR</a>   "initialize"</td></tr>
	<tr class="memdesc:ad5405711bcd25d56b2fc2a3fd827ea3c"><td class="mdescLeft"> </td><td class="mdescRight">Following are the APIs implemented in the external library Each API has a #define string that is used to lookup the function in the library Followed by the function declaration. <a href="#ad5405711bcd25d56b2fc2a3fd827ea3c">More...</a><br /></td></tr>
	<tr class="separator:ad5405711bcd25d56b2fc2a3fd827ea3c"><td class="memSeparator" colspan="2"> </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:ac522f869f1eb963b6499f710aad4b905"><td class="memItemLeft" align="right" valign="top">typedef int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="lib__api_8h.html#ac522f869f1eb963b6499f710aad4b905">initialize_t</a>) (int)</td></tr>
	<tr class="separator:ac522f869f1eb963b6499f710aad4b905"><td class="memSeparator" colspan="2"> </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:a4fb97a64ba101e754b009ab8e1e1057e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="lib__api_8h.html#a4fb97a64ba101e754b009ab8e1e1057e">initialize</a> (int)</td></tr>
	<tr class="memdesc:a4fb97a64ba101e754b009ab8e1e1057e"><td class="mdescLeft"> </td><td class="mdescRight">Checks if the MXNet version is supported by the library. If supported, initializes the library. <a href="#a4fb97a64ba101e754b009ab8e1e1057e">More...</a><br /></td></tr>
	<tr class="separator:a4fb97a64ba101e754b009ab8e1e1057e"><td class="memSeparator" colspan="2"> </td></tr>
	</table>
	<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
	<div class="textblock"><p>APIs to interact with libraries. </p>
	<p>Copyright (c) 2015 by Contributors </p>
	</div><h2 class="groupheader">Macro Definition Documentation</h2>
	<a class="anchor" id="ad5405711bcd25d56b2fc2a3fd827ea3c"></a>
	<div class="memitem">
	<div class="memproto">
	<table class="memname">
	<tr>
	<td class="memname">#define MXLIB_INITIALIZE_STR   "initialize"</td>
	</tr>
	</table>
	</div><div class="memdoc">

	<p>Following are the APIs implemented in the external library Each API has a #define string that is used to lookup the function in the library Followed by the function declaration. </p>

	</div>
	</div>
	<h2 class="groupheader">Typedef Documentation</h2>
	<a class="anchor" id="ac522f869f1eb963b6499f710aad4b905"></a>
	<div class="memitem">
	<div class="memproto">
	<table class="memname">
	<tr>
	<td class="memname">typedef int(* initialize_t) (int)</td>
	</tr>
	</table>
	</div><div class="memdoc">

	</div>
	</div>
	<h2 class="groupheader">Function Documentation</h2>
	<a class="anchor" id="a4fb97a64ba101e754b009ab8e1e1057e"></a>
	<div class="memitem">
	<div class="memproto">
	<table class="memname">
	<tr>
	<td class="memname">int initialize </td>
	<td>(</td>
	<td class="paramtype">int </td>
	<td class="paramname"></td><td>)</td>
	<td></td>
	</tr>
	</table>
	</div><div class="memdoc">

	<p>Checks if the MXNet version is supported by the library. If supported, initializes the library. </p>
	<dl class="params"><dt>Parameters</dt><dd>
	<table class="params">
	<tr><td class="paramname">version</td><td>MXNet version number passed to library and defined as: MXNET_VERSION = (MXNET_MAJOR10000 + MXNET_MINOR100 + MXNET_PATCH) </td></tr>
	</table>
	</dd>
	</dl>
	<dl class="section return"><dt>Returns</dt><dd>Non-zero value on error i.e. library incompatible with passed MXNet version </dd></dl>

	</div>
	</div>
	</div><!-- contents -->
	<!-- start footer part -->
	<hr class="footer"/><address class="footer"><small>
	Generated on Sat Mar 28 2020 00:52:30 for mxnet by  <a href="http://www.doxygen.org/index.html">
	<img class="footer" src="doxygen.png" alt="doxygen"/>
	</a> 1.8.11
	</small></address>
	</body>
	</html>