blob: cb81d7e5cec6d158f97e84ff73d888b894b43e4c [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.6" name="generator"/>
<title>mxnet: mxnet::Context Struct 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/search.js" type="text/javascript"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 style="padding-left: 0.5em;">
<div id="projectname">mxnet
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<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()">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a></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="structmxnet_1_1Context.html">Context</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="#pub-static-attribs">Static Public Attributes</a> |
<a href="structmxnet_1_1Context-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mxnet::Context Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="structmxnet_1_1Context.html" title="Context information about the execution environment. ">Context</a> information about the execution environment.
<a href="structmxnet_1_1Context.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="base_8h_source.html">base.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for mxnet::Context:</div>
<div class="dyncontent">
<div class="center"><img alt="Collaboration graph" border="0" src="structmxnet_1_1Context__coll__graph.png" usemap="#mxnet_1_1Context_coll__map"/></div>
<map id="mxnet_1_1Context_coll__map" name="mxnet_1_1Context_coll__map">
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a611c227b5e04a2777c3e4507bb76f60e"><td align="right" class="memItemLeft" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Context.html#a611c227b5e04a2777c3e4507bb76f60e">DeviceType</a> { <a class="el" href="structmxnet_1_1Context.html#a611c227b5e04a2777c3e4507bb76f60ea1aced5778bb0d64d4ce6bd4c0a86d140">kCPU</a> = cpu::kDevMask,
<a class="el" href="structmxnet_1_1Context.html#a611c227b5e04a2777c3e4507bb76f60eab21bed4d5cee411db15283d7529f28cf">kGPU</a> = gpu::kDevMask,
<a class="el" href="structmxnet_1_1Context.html#a611c227b5e04a2777c3e4507bb76f60eaa2e12b86e0f957dc14d45863eaa47f34">kCPUPinned</a> = 3,
<a class="el" href="structmxnet_1_1Context.html#a611c227b5e04a2777c3e4507bb76f60ea80c6f8f13908c5805cf12784fca77e78">kCPUShared</a> = 5
}</td></tr>
<tr class="memdesc:a611c227b5e04a2777c3e4507bb76f60e"><td class="mdescLeft"> </td><td class="mdescRight">Type of device. <a href="structmxnet_1_1Context.html#a611c227b5e04a2777c3e4507bb76f60e">More...</a><br/></td></tr>
<tr class="separator:a611c227b5e04a2777c3e4507bb76f60e"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:a290642a21363bef82bcb32cf7f98b884"><td align="right" class="memItemLeft" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Context.html#a290642a21363bef82bcb32cf7f98b884">Context</a> ()</td></tr>
<tr class="memdesc:a290642a21363bef82bcb32cf7f98b884"><td class="mdescLeft"> </td><td class="mdescRight">default constructor <a href="#a290642a21363bef82bcb32cf7f98b884">More...</a><br/></td></tr>
<tr class="separator:a290642a21363bef82bcb32cf7f98b884"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a07c6092f42393d543460f766a7a3b6df"><td align="right" class="memItemLeft" valign="top"><a class="el" href="structmxnet_1_1Context.html#a611c227b5e04a2777c3e4507bb76f60e">DeviceType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Context.html#a07c6092f42393d543460f766a7a3b6df">dev_mask</a> () const </td></tr>
<tr class="memdesc:a07c6092f42393d543460f766a7a3b6df"><td class="mdescLeft"> </td><td class="mdescRight">Get corresponding device mask. <a href="#a07c6092f42393d543460f766a7a3b6df">More...</a><br/></td></tr>
<tr class="separator:a07c6092f42393d543460f766a7a3b6df"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ada4cad693c928562d0fd74fba5ddcde3"><td align="right" class="memItemLeft" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Context.html#ada4cad693c928562d0fd74fba5ddcde3">real_dev_id</a> () const </td></tr>
<tr class="memdesc:ada4cad693c928562d0fd74fba5ddcde3"><td class="mdescLeft"> </td><td class="mdescRight">Returns dev_id for kGPU, 0 otherwise. <a href="#ada4cad693c928562d0fd74fba5ddcde3">More...</a><br/></td></tr>
<tr class="separator:ada4cad693c928562d0fd74fba5ddcde3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1862b54dcfd20332eb2365451f47c678"><td align="right" class="memItemLeft" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Context.html#a1862b54dcfd20332eb2365451f47c678">operator&lt;</a> (const <a class="el" href="structmxnet_1_1Context.html">Context</a> &amp;b) const </td></tr>
<tr class="memdesc:a1862b54dcfd20332eb2365451f47c678"><td class="mdescLeft"> </td><td class="mdescRight">Comparator, used to enable <a class="el" href="structmxnet_1_1Context.html" title="Context information about the execution environment. ">Context</a> as std::map key. <a href="#a1862b54dcfd20332eb2365451f47c678">More...</a><br/></td></tr>
<tr class="separator:a1862b54dcfd20332eb2365451f47c678"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad59267de7b56e3aebe86a6d0e9fca2f0"><td align="right" class="memItemLeft" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Context.html#ad59267de7b56e3aebe86a6d0e9fca2f0">operator==</a> (const <a class="el" href="structmxnet_1_1Context.html">Context</a> &amp;b) const </td></tr>
<tr class="memdesc:ad59267de7b56e3aebe86a6d0e9fca2f0"><td class="mdescLeft"> </td><td class="mdescRight">check if current context equals another one <a href="#ad59267de7b56e3aebe86a6d0e9fca2f0">More...</a><br/></td></tr>
<tr class="separator:ad59267de7b56e3aebe86a6d0e9fca2f0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a10fded12664afacb95f75c07bb77bfe6"><td align="right" class="memItemLeft" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Context.html#a10fded12664afacb95f75c07bb77bfe6">operator!=</a> (const <a class="el" href="structmxnet_1_1Context.html">Context</a> &amp;b) const </td></tr>
<tr class="memdesc:a10fded12664afacb95f75c07bb77bfe6"><td class="mdescLeft"> </td><td class="mdescRight">check if current context not equals another one <a href="#a10fded12664afacb95f75c07bb77bfe6">More...</a><br/></td></tr>
<tr class="separator:a10fded12664afacb95f75c07bb77bfe6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a90542e0930244392f9a81ed0f206b612"><td align="right" class="memItemLeft" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Context.html#a90542e0930244392f9a81ed0f206b612">Save</a> (dmlc::Stream *strm) const </td></tr>
<tr class="memdesc:a90542e0930244392f9a81ed0f206b612"><td class="mdescLeft"> </td><td class="mdescRight">save the content into binary stream <a href="#a90542e0930244392f9a81ed0f206b612">More...</a><br/></td></tr>
<tr class="separator:a90542e0930244392f9a81ed0f206b612"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a882305327a53b9b9a82f5802b4b013e3"><td align="right" class="memItemLeft" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Context.html#a882305327a53b9b9a82f5802b4b013e3">Load</a> (dmlc::Stream *strm)</td></tr>
<tr class="memdesc:a882305327a53b9b9a82f5802b4b013e3"><td class="mdescLeft"> </td><td class="mdescRight">load the content from binary stream <a href="#a882305327a53b9b9a82f5802b4b013e3">More...</a><br/></td></tr>
<tr class="separator:a882305327a53b9b9a82f5802b4b013e3"><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:a7cea13406ae21ae557d3455f54670a4a"><td align="right" class="memItemLeft" valign="top">static <a class="el" href="structmxnet_1_1Context.html">Context</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Context.html#a7cea13406ae21ae557d3455f54670a4a">Create</a> (<a class="el" href="structmxnet_1_1Context.html#a611c227b5e04a2777c3e4507bb76f60e">DeviceType</a> <a class="el" href="structmxnet_1_1Context.html#a66040df23c2a5663f29bc50aa0bbace3">dev_type</a>, int32_t <a class="el" href="structmxnet_1_1Context.html#a8486dcc599dffe447e2f098b170d3db9">dev_id</a>=-1)</td></tr>
<tr class="memdesc:a7cea13406ae21ae557d3455f54670a4a"><td class="mdescLeft"> </td><td class="mdescRight">Create a new context. <a href="#a7cea13406ae21ae557d3455f54670a4a">More...</a><br/></td></tr>
<tr class="separator:a7cea13406ae21ae557d3455f54670a4a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4bb231d70623fde216de51589347e513"><td align="right" class="memItemLeft" valign="top">static <a class="el" href="structmxnet_1_1Context.html">Context</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Context.html#a4bb231d70623fde216de51589347e513">CPU</a> (int32_t <a class="el" href="structmxnet_1_1Context.html#a8486dcc599dffe447e2f098b170d3db9">dev_id</a>=0)</td></tr>
<tr class="separator:a4bb231d70623fde216de51589347e513"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a39d1a2b59bce135da127475995a58671"><td align="right" class="memItemLeft" valign="top">static <a class="el" href="structmxnet_1_1Context.html">Context</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Context.html#a39d1a2b59bce135da127475995a58671">GPU</a> (int32_t <a class="el" href="structmxnet_1_1Context.html#a8486dcc599dffe447e2f098b170d3db9">dev_id</a>=-1)</td></tr>
<tr class="separator:a39d1a2b59bce135da127475995a58671"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a420d4e662a5129b202507f42c991391c"><td align="right" class="memItemLeft" valign="top">static <a class="el" href="structmxnet_1_1Context.html">Context</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Context.html#a420d4e662a5129b202507f42c991391c">CPUPinned</a> (int32_t <a class="el" href="structmxnet_1_1Context.html#a8486dcc599dffe447e2f098b170d3db9">dev_id</a>=-1)</td></tr>
<tr class="separator:a420d4e662a5129b202507f42c991391c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8e090b1fcc96b682512bcc22fc521f80"><td align="right" class="memItemLeft" valign="top">static <a class="el" href="structmxnet_1_1Context.html">Context</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Context.html#a8e090b1fcc96b682512bcc22fc521f80">CPUShared</a> (int32_t <a class="el" href="structmxnet_1_1Context.html#a8486dcc599dffe447e2f098b170d3db9">dev_id</a>=0)</td></tr>
<tr class="separator:a8e090b1fcc96b682512bcc22fc521f80"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac58071fc1c0647bcab7aca4a39ae6a29"><td align="right" class="memItemLeft" valign="top">static <a class="el" href="structmxnet_1_1Context.html">Context</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Context.html#ac58071fc1c0647bcab7aca4a39ae6a29">FromString</a> (std::string str)</td></tr>
<tr class="separator:ac58071fc1c0647bcab7aca4a39ae6a29"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a66040df23c2a5663f29bc50aa0bbace3"><td align="right" class="memItemLeft" valign="top"><a class="el" href="structmxnet_1_1Context.html#a611c227b5e04a2777c3e4507bb76f60e">DeviceType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Context.html#a66040df23c2a5663f29bc50aa0bbace3">dev_type</a></td></tr>
<tr class="memdesc:a66040df23c2a5663f29bc50aa0bbace3"><td class="mdescLeft"> </td><td class="mdescRight">the device type we run the op on <a href="#a66040df23c2a5663f29bc50aa0bbace3">More...</a><br/></td></tr>
<tr class="separator:a66040df23c2a5663f29bc50aa0bbace3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8486dcc599dffe447e2f098b170d3db9"><td align="right" class="memItemLeft" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Context.html#a8486dcc599dffe447e2f098b170d3db9">dev_id</a></td></tr>
<tr class="memdesc:a8486dcc599dffe447e2f098b170d3db9"><td class="mdescLeft"> </td><td class="mdescRight">device id we are going to run it on <a href="#a8486dcc599dffe447e2f098b170d3db9">More...</a><br/></td></tr>
<tr class="separator:a8486dcc599dffe447e2f098b170d3db9"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a7433936d1daf38f7dced0de49fbe6a4b"><td align="right" class="memItemLeft" valign="top">static const int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Context.html#a7433936d1daf38f7dced0de49fbe6a4b">kMaxDevType</a> = 6</td></tr>
<tr class="memdesc:a7433936d1daf38f7dced0de49fbe6a4b"><td class="mdescLeft"> </td><td class="mdescRight">the maximal device type <a href="#a7433936d1daf38f7dced0de49fbe6a4b">More...</a><br/></td></tr>
<tr class="separator:a7433936d1daf38f7dced0de49fbe6a4b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a958219ae412395685ef1d82af0dbbe67"><td align="right" class="memItemLeft" valign="top">static const int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1Context.html#a958219ae412395685ef1d82af0dbbe67">kMaxDevID</a> = 16</td></tr>
<tr class="memdesc:a958219ae412395685ef1d82af0dbbe67"><td class="mdescLeft"> </td><td class="mdescRight">the maximal device index <a href="#a958219ae412395685ef1d82af0dbbe67">More...</a><br/></td></tr>
<tr class="separator:a958219ae412395685ef1d82af0dbbe67"><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="structmxnet_1_1Context.html" title="Context information about the execution environment. ">Context</a> information about the execution environment. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a class="anchor" id="a611c227b5e04a2777c3e4507bb76f60e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="structmxnet_1_1Context.html#a611c227b5e04a2777c3e4507bb76f60e">mxnet::Context::DeviceType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Type of device. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a611c227b5e04a2777c3e4507bb76f60ea1aced5778bb0d64d4ce6bd4c0a86d140"></a>kCPU</em> </td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a611c227b5e04a2777c3e4507bb76f60eab21bed4d5cee411db15283d7529f28cf"></a>kGPU</em> </td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a611c227b5e04a2777c3e4507bb76f60eaa2e12b86e0f957dc14d45863eaa47f34"></a>kCPUPinned</em> </td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a611c227b5e04a2777c3e4507bb76f60ea80c6f8f13908c5805cf12784fca77e78"></a>kCPUShared</em> </td><td class="fielddoc">
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a290642a21363bef82bcb32cf7f98b884"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">mxnet::Context::Context </td>
<td>(</td>
<td class="paramname"></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>default constructor </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a4bb231d70623fde216de51589347e513"></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="structmxnet_1_1Context.html">Context</a> mxnet::Context::CPU </td>
<td>(</td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>dev_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">
<dl class="section return"><dt>Returns</dt><dd>CPU <a class="el" href="structmxnet_1_1Context.html" title="Context information about the execution environment. ">Context</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a420d4e662a5129b202507f42c991391c"></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="structmxnet_1_1Context.html">Context</a> mxnet::Context::CPUPinned </td>
<td>(</td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>dev_id</em> = <code>-1</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>Create a pinned CPU context. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dev_id</td><td>the device id for corresponding GPU. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pinned CPU context. -1 for current GPU. </dd></dl>
</div>
</div>
<a class="anchor" id="a8e090b1fcc96b682512bcc22fc521f80"></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="structmxnet_1_1Context.html">Context</a> mxnet::Context::CPUShared </td>
<td>(</td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>dev_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>Create a CPU shared memory context. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dev_id</td><td>dummy device id. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>CPU shared memory context. </dd></dl>
</div>
</div>
<a class="anchor" id="a7cea13406ae21ae557d3455f54670a4a"></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="structmxnet_1_1Context.html">Context</a> mxnet::Context::Create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmxnet_1_1Context.html#a611c227b5e04a2777c3e4507bb76f60e">DeviceType</a> </td>
<td class="paramname"><em>dev_type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>dev_id</em> = <code>-1</code> </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 class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new context. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dev_type</td><td>device type. </td></tr>
<tr><td class="paramname">dev_id</td><td>device id. -1 for current device. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a07c6092f42393d543460f766a7a3b6df"></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="structmxnet_1_1Context.html#a611c227b5e04a2777c3e4507bb76f60e">DeviceType</a> mxnet::Context::dev_mask </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">
<p>Get corresponding device mask. </p>
<dl class="section return"><dt>Returns</dt><dd>cpu::kDevMask or gpu::kDevMask </dd></dl>
</div>
</div>
<a class="anchor" id="ac58071fc1c0647bcab7aca4a39ae6a29"></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="structmxnet_1_1Context.html">Context</a> mxnet::Context::FromString </td>
<td>(</td>
<td class="paramtype">std::string </td>
<td class="paramname"><em>str</em></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>Create a context from string of the format [cpu|gpu|cpu_pinned](n) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>the string pattern </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="structmxnet_1_1Context.html" title="Context information about the execution environment. ">Context</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a39d1a2b59bce135da127475995a58671"></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="structmxnet_1_1Context.html">Context</a> mxnet::Context::GPU </td>
<td>(</td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>dev_id</em> = <code>-1</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>Create a GPU context. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dev_id</td><td>the device id. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>GPU <a class="el" href="structmxnet_1_1Context.html" title="Context information about the execution environment. ">Context</a>. -1 for current GPU. </dd></dl>
</div>
</div>
<a class="anchor" id="a882305327a53b9b9a82f5802b4b013e3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool mxnet::Context::Load </td>
<td>(</td>
<td class="paramtype">dmlc::Stream * </td>
<td class="paramname"><em>strm</em></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>load the content from binary stream </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">strm</td><td>the output stream </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>whether the load is successful </dd></dl>
</div>
</div>
<a class="anchor" id="a10fded12664afacb95f75c07bb77bfe6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool mxnet::Context::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structmxnet_1_1Context.html">Context</a> &amp; </td>
<td class="paramname"><em>b</em></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">
<p>check if current context not equals another one </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">b</td><td>another context to compare </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>whether they are not the same </dd></dl>
</div>
</div>
<a class="anchor" id="a1862b54dcfd20332eb2365451f47c678"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool mxnet::Context::operator&lt; </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structmxnet_1_1Context.html">Context</a> &amp; </td>
<td class="paramname"><em>b</em></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">
<p>Comparator, used to enable <a class="el" href="structmxnet_1_1Context.html" title="Context information about the execution environment. ">Context</a> as std::map key. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">b</td><td>another context to compare </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>compared result </dd></dl>
</div>
</div>
<a class="anchor" id="ad59267de7b56e3aebe86a6d0e9fca2f0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool mxnet::Context::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structmxnet_1_1Context.html">Context</a> &amp; </td>
<td class="paramname"><em>b</em></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">
<p>check if current context equals another one </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">b</td><td>another context to compare </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>whether dev mask and id are same </dd></dl>
</div>
</div>
<a class="anchor" id="ada4cad693c928562d0fd74fba5ddcde3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int mxnet::Context::real_dev_id </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">
<p>Returns dev_id for kGPU, 0 otherwise. </p>
</div>
</div>
<a class="anchor" id="a90542e0930244392f9a81ed0f206b612"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void mxnet::Context::Save </td>
<td>(</td>
<td class="paramtype">dmlc::Stream * </td>
<td class="paramname"><em>strm</em></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">
<p>save the content into binary stream </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">strm</td><td>the output stream </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a8486dcc599dffe447e2f098b170d3db9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t mxnet::Context::dev_id</td>
</tr>
</table>
</div><div class="memdoc">
<p>device id we are going to run it on </p>
</div>
</div>
<a class="anchor" id="a66040df23c2a5663f29bc50aa0bbace3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structmxnet_1_1Context.html#a611c227b5e04a2777c3e4507bb76f60e">DeviceType</a> mxnet::Context::dev_type</td>
</tr>
</table>
</div><div class="memdoc">
<p>the device type we run the op on </p>
</div>
</div>
<a class="anchor" id="a958219ae412395685ef1d82af0dbbe67"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const int32_t mxnet::Context::kMaxDevID = 16</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>the maximal device index </p>
</div>
</div>
<a class="anchor" id="a7433936d1daf38f7dced0de49fbe6a4b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const int32_t mxnet::Context::kMaxDevType = 6</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>the maximal device type </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/mxnet/<a class="el" href="base_8h_source.html">base.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 27 2018 08:29:36 for mxnet by  <a href="http://www.doxygen.org/index.html">
<img alt="doxygen" class="footer" src="doxygen.png"/>
</a> 1.8.6
</small></address>
</body>
</html>