| <!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: mxnet::cpp::Context Class 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.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="namespacemxnet.html">mxnet</a></li><li class="navelem"><a class="el" href="namespacemxnet_1_1cpp.html">cpp</a></li><li class="navelem"><a class="el" href="classmxnet_1_1cpp_1_1Context.html">Context</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="classmxnet_1_1cpp_1_1Context-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">mxnet::cpp::Context Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><a class="el" href="classmxnet_1_1cpp_1_1Context.html" title="Context interface.">Context</a> interface. |
| <a href="classmxnet_1_1cpp_1_1Context.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="cpp-package_2include_2mxnet-cpp_2ndarray_8h_source.html">ndarray.h</a>></code></p> |
| <div class="dynheader"> |
| Collaboration diagram for mxnet::cpp::Context:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classmxnet_1_1cpp_1_1Context__coll__graph.png" border="0" usemap="#mxnet_1_1cpp_1_1Context_coll__map" alt="Collaboration graph"/></div> |
| <!-- MAP 0 --> |
| </div> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a54525e6f30f0239107fb23578ba042d8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Context.html#a54525e6f30f0239107fb23578ba042d8">Context</a> (const <a class="el" href="namespacemxnet_1_1cpp.html#a65c3def958cbb9d09c7f56082a5257d6">DeviceType</a> &type, int id)</td></tr> |
| <tr class="memdesc:a54525e6f30f0239107fb23578ba042d8"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classmxnet_1_1cpp_1_1Context.html" title="Context interface.">Context</a> constructor. <a href="classmxnet_1_1cpp_1_1Context.html#a54525e6f30f0239107fb23578ba042d8">More...</a><br /></td></tr> |
| <tr class="separator:a54525e6f30f0239107fb23578ba042d8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8add8595e07f3bb4951cf7283b894412"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacemxnet_1_1cpp.html#a65c3def958cbb9d09c7f56082a5257d6">DeviceType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Context.html#a8add8595e07f3bb4951cf7283b894412">GetDeviceType</a> () const</td></tr> |
| <tr class="separator:a8add8595e07f3bb4951cf7283b894412"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8e118667bd0ed970d508a52c3b771d6d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Context.html#a8e118667bd0ed970d508a52c3b771d6d">GetDeviceId</a> () const</td></tr> |
| <tr class="separator:a8e118667bd0ed970d508a52c3b771d6d"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:a785da03b56244e288752ee117f238ecf"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classmxnet_1_1cpp_1_1Context.html">Context</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Context.html#a785da03b56244e288752ee117f238ecf">gpu</a> (int device_id=0)</td></tr> |
| <tr class="memdesc:a785da03b56244e288752ee117f238ecf"><td class="mdescLeft"> </td><td class="mdescRight">Return a GPU context. <a href="classmxnet_1_1cpp_1_1Context.html#a785da03b56244e288752ee117f238ecf">More...</a><br /></td></tr> |
| <tr class="separator:a785da03b56244e288752ee117f238ecf"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a65ef083b6e4901816b69aa18e5bfe80e"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classmxnet_1_1cpp_1_1Context.html">Context</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Context.html#a65ef083b6e4901816b69aa18e5bfe80e">cpu</a> (int device_id=0)</td></tr> |
| <tr class="memdesc:a65ef083b6e4901816b69aa18e5bfe80e"><td class="mdescLeft"> </td><td class="mdescRight">Return a CPU context. <a href="classmxnet_1_1cpp_1_1Context.html#a65ef083b6e4901816b69aa18e5bfe80e">More...</a><br /></td></tr> |
| <tr class="separator:a65ef083b6e4901816b69aa18e5bfe80e"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p><a class="el" href="classmxnet_1_1cpp_1_1Context.html" title="Context interface.">Context</a> interface. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a54525e6f30f0239107fb23578ba042d8"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a54525e6f30f0239107fb23578ba042d8">◆ </a></span>Context()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">mxnet::cpp::Context::Context </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="namespacemxnet_1_1cpp.html#a65c3def958cbb9d09c7f56082a5257d6">DeviceType</a> & </td> |
| <td class="paramname"><em>type</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>id</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p><a class="el" href="classmxnet_1_1cpp_1_1Context.html" title="Context interface.">Context</a> constructor. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">type</td><td>type of the device </td></tr> |
| <tr><td class="paramname">id</td><td>id of the device </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a65ef083b6e4901816b69aa18e5bfe80e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a65ef083b6e4901816b69aa18e5bfe80e">◆ </a></span>cpu()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="classmxnet_1_1cpp_1_1Context.html">Context</a> mxnet::cpp::Context::cpu </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>device_id</em> = <code>0</code></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Return a CPU context. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">device_id</td><td>id of the device. this is not needed by CPU </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the corresponding CPU context </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a8e118667bd0ed970d508a52c3b771d6d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8e118667bd0ed970d508a52c3b771d6d">◆ </a></span>GetDeviceId()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int mxnet::cpp::Context::GetDeviceId </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section return"><dt>Returns</dt><dd>the id of the device </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a8add8595e07f3bb4951cf7283b894412"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8add8595e07f3bb4951cf7283b894412">◆ </a></span>GetDeviceType()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="namespacemxnet_1_1cpp.html#a65c3def958cbb9d09c7f56082a5257d6">DeviceType</a> mxnet::cpp::Context::GetDeviceType </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section return"><dt>Returns</dt><dd>the type of the device </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a785da03b56244e288752ee117f238ecf"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a785da03b56244e288752ee117f238ecf">◆ </a></span>gpu()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="classmxnet_1_1cpp_1_1Context.html">Context</a> mxnet::cpp::Context::gpu </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>device_id</em> = <code>0</code></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Return a GPU context. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">device_id</td><td>id of the device </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the corresponding GPU context </dd></dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>/work/mxnet/cpp-package/include/mxnet-cpp/<a class="el" href="cpp-package_2include_2mxnet-cpp_2ndarray_8h_source.html">ndarray.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 5 2023 03:47:41 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> |
