| <!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: mxnet::cpp::Context Class Reference</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 class="current"><a href="annotated.html"><span>Classes</span></a></li> |
| <li><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="annotated.html"><span>Class List</span></a></li> |
| <li><a href="classes.html"><span>Class Index</span></a></li> |
| <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> |
| <li><a href="functions.html"><span>Class 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="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 alt="Collaboration graph" border="0" src="classmxnet_1_1cpp_1_1Context__coll__graph.png" usemap="#mxnet_1_1cpp_1_1Context_coll__map"/></div> |
| <map id="mxnet_1_1cpp_1_1Context_coll__map" name="mxnet_1_1cpp_1_1Context_coll__map"> |
| </map> |
| </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 align="right" class="memItemLeft" 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="#a54525e6f30f0239107fb23578ba042d8">More...</a><br/></td></tr> |
| <tr class="separator:a54525e6f30f0239107fb23578ba042d8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6bffb0f2869b2968440e3ed20480ea62"><td align="right" class="memItemLeft" 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#a6bffb0f2869b2968440e3ed20480ea62">GetDeviceType</a> () const </td></tr> |
| <tr class="separator:a6bffb0f2869b2968440e3ed20480ea62"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa8fa947447033e822ac0a61bd116993d"><td align="right" class="memItemLeft" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1cpp_1_1Context.html#aa8fa947447033e822ac0a61bd116993d">GetDeviceId</a> () const </td></tr> |
| <tr class="separator:aa8fa947447033e822ac0a61bd116993d"><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 align="right" class="memItemLeft" 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="#a785da03b56244e288752ee117f238ecf">More...</a><br/></td></tr> |
| <tr class="separator:a785da03b56244e288752ee117f238ecf"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a65ef083b6e4901816b69aa18e5bfe80e"><td align="right" class="memItemLeft" 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="#a65ef083b6e4901816b69aa18e5bfe80e">More...</a><br/></td></tr> |
| <tr class="separator:a65ef083b6e4901816b69aa18e5bfe80e"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a id="details" name="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 class="anchor" id="a54525e6f30f0239107fb23578ba042d8"></a> |
| <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 class="anchor" id="a65ef083b6e4901816b69aa18e5bfe80e"></a> |
| <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 class="anchor" id="aa8fa947447033e822ac0a61bd116993d"></a> |
| <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 class="anchor" id="a6bffb0f2869b2968440e3ed20480ea62"></a> |
| <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 class="anchor" id="a785da03b56244e288752ee117f238ecf"></a> |
| <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>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 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> |
