blob: 3dcc7144156fe47c14a3fc0a515ef97d21050cd3 [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: mxnet::common::cuda Namespace 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="namespacemxnet.html">mxnet</a></li><li class="navelem"><a class="el" href="namespacemxnet_1_1common.html">common</a></li><li class="navelem"><a class="el" href="namespacemxnet_1_1common_1_1cuda.html">cuda</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">mxnet::common::cuda Namespace Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>common utils for cuda
<a href="#details">More...</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">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1common_1_1cuda_1_1CublasType.html">CublasType</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts between C++ datatypes and enums/constants needed by cuBLAS. <a href="structmxnet_1_1common_1_1cuda_1_1CublasType.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="structmxnet_1_1common_1_1cuda_1_1CublasType_3_01double_01_4.html">CublasType&lt; double &gt;</a></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="structmxnet_1_1common_1_1cuda_1_1CublasType_3_01float_01_4.html">CublasType&lt; float &gt;</a></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="structmxnet_1_1common_1_1cuda_1_1CublasType_3_01int32__t_01_4.html">CublasType&lt; int32_t &gt;</a></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="structmxnet_1_1common_1_1cuda_1_1CublasType_3_01mshadow_1_1half_1_1half__t_01_4.html">CublasType&lt; mshadow::half::half_t &gt;</a></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="structmxnet_1_1common_1_1cuda_1_1CublasType_3_01uint8__t_01_4.html">CublasType&lt; uint8_t &gt;</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1common_1_1cuda_1_1DeviceStore.html">DeviceStore</a></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="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a9feee613a4f16a954dd68e55345a72ac"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1common_1_1cuda.html#a9feee613a4f16a954dd68e55345a72ac">CublasGetErrorString</a> (cublasStatus_t error)</td></tr>
<tr class="memdesc:a9feee613a4f16a954dd68e55345a72ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get string representation of cuBLAS errors. <a href="#a9feee613a4f16a954dd68e55345a72ac">More...</a><br /></td></tr>
<tr class="separator:a9feee613a4f16a954dd68e55345a72ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abf9bcb4cb696e9ae61b818510dac39c8"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1common_1_1cuda.html#abf9bcb4cb696e9ae61b818510dac39c8">CusolverGetErrorString</a> (cusolverStatus_t error)</td></tr>
<tr class="memdesc:abf9bcb4cb696e9ae61b818510dac39c8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get string representation of cuSOLVER errors. <a href="#abf9bcb4cb696e9ae61b818510dac39c8">More...</a><br /></td></tr>
<tr class="separator:abf9bcb4cb696e9ae61b818510dac39c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a97c06b2f4d26445a7386b0f54fae1feb"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1common_1_1cuda.html#a97c06b2f4d26445a7386b0f54fae1feb">CurandGetErrorString</a> (curandStatus_t status)</td></tr>
<tr class="memdesc:a97c06b2f4d26445a7386b0f54fae1feb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get string representation of cuRAND errors. <a href="#a97c06b2f4d26445a7386b0f54fae1feb">More...</a><br /></td></tr>
<tr class="separator:a97c06b2f4d26445a7386b0f54fae1feb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6f3ee04eb382c57e10916108db3efd80"><td class="memTemplParams" colspan="2">template&lt;typename DType &gt; </td></tr>
<tr class="memitem:a6f3ee04eb382c57e10916108db3efd80"><td class="memTemplItemLeft" align="right" valign="top">DType __device__&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1common_1_1cuda.html#a6f3ee04eb382c57e10916108db3efd80">CudaMax</a> (DType a, DType b)</td></tr>
<tr class="separator:a6f3ee04eb382c57e10916108db3efd80"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a03888f252f813f6d052ae84bf8801498"><td class="memTemplParams" colspan="2">template&lt;typename DType &gt; </td></tr>
<tr class="memitem:a03888f252f813f6d052ae84bf8801498"><td class="memTemplItemLeft" align="right" valign="top">DType __device__&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1common_1_1cuda.html#a03888f252f813f6d052ae84bf8801498">CudaMin</a> (DType a, DType b)</td></tr>
<tr class="separator:a03888f252f813f6d052ae84bf8801498"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa7e0a8f7264c65d8000560d84d7fc54d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1common_1_1cuda.html#aa7e0a8f7264c65d8000560d84d7fc54d">get_load_type</a> (size_t N)</td></tr>
<tr class="memdesc:aa7e0a8f7264c65d8000560d84d7fc54d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the largest datatype suitable to read requested number of bytes. <a href="#aa7e0a8f7264c65d8000560d84d7fc54d">More...</a><br /></td></tr>
<tr class="separator:aa7e0a8f7264c65d8000560d84d7fc54d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7608f1c1700694e453f37cfadfe9e30e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet_1_1common_1_1cuda.html#a7608f1c1700694e453f37cfadfe9e30e">get_rows_per_block</a> (size_t row_size, int num_threads_per_block)</td></tr>
<tr class="memdesc:a7608f1c1700694e453f37cfadfe9e30e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determine how many rows in a 2D matrix should a block of threads handle based on the row size and the number of threads in a block. <a href="#a7608f1c1700694e453f37cfadfe9e30e">More...</a><br /></td></tr>
<tr class="separator:a7608f1c1700694e453f37cfadfe9e30e"><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>common utils for cuda </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a9feee613a4f16a954dd68e55345a72ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9feee613a4f16a954dd68e55345a72ac">&#9670;&nbsp;</a></span>CublasGetErrorString()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const char* mxnet::common::cuda::CublasGetErrorString </td>
<td>(</td>
<td class="paramtype">cublasStatus_t&#160;</td>
<td class="paramname"><em>error</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>Get string representation of cuBLAS errors. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">error</td><td>The error. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>String representation. </dd></dl>
</div>
</div>
<a id="a6f3ee04eb382c57e10916108db3efd80"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6f3ee04eb382c57e10916108db3efd80">&#9670;&nbsp;</a></span>CudaMax()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename DType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">DType __device__ mxnet::common::cuda::CudaMax </td>
<td>(</td>
<td class="paramtype">DType&#160;</td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">DType&#160;</td>
<td class="paramname"><em>b</em>&#160;</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">
</div>
</div>
<a id="a03888f252f813f6d052ae84bf8801498"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a03888f252f813f6d052ae84bf8801498">&#9670;&nbsp;</a></span>CudaMin()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename DType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">DType __device__ mxnet::common::cuda::CudaMin </td>
<td>(</td>
<td class="paramtype">DType&#160;</td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">DType&#160;</td>
<td class="paramname"><em>b</em>&#160;</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">
</div>
</div>
<a id="a97c06b2f4d26445a7386b0f54fae1feb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a97c06b2f4d26445a7386b0f54fae1feb">&#9670;&nbsp;</a></span>CurandGetErrorString()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const char* mxnet::common::cuda::CurandGetErrorString </td>
<td>(</td>
<td class="paramtype">curandStatus_t&#160;</td>
<td class="paramname"><em>status</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>Get string representation of cuRAND errors. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">status</td><td>The status. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>String representation. </dd></dl>
</div>
</div>
<a id="abf9bcb4cb696e9ae61b818510dac39c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abf9bcb4cb696e9ae61b818510dac39c8">&#9670;&nbsp;</a></span>CusolverGetErrorString()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const char* mxnet::common::cuda::CusolverGetErrorString </td>
<td>(</td>
<td class="paramtype">cusolverStatus_t&#160;</td>
<td class="paramname"><em>error</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>Get string representation of cuSOLVER errors. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">error</td><td>The error. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>String representation. </dd></dl>
</div>
</div>
<a id="aa7e0a8f7264c65d8000560d84d7fc54d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa7e0a8f7264c65d8000560d84d7fc54d">&#9670;&nbsp;</a></span>get_load_type()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mxnet::common::cuda::get_load_type </td>
<td>(</td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>N</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the largest datatype suitable to read requested number of bytes. </p>
<p>Number of bytes to be read </p><dl class="section return"><dt>Returns</dt><dd>mshadow representation of type that could be used for reading </dd></dl>
</div>
</div>
<a id="a7608f1c1700694e453f37cfadfe9e30e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7608f1c1700694e453f37cfadfe9e30e">&#9670;&nbsp;</a></span>get_rows_per_block()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int mxnet::common::cuda::get_rows_per_block </td>
<td>(</td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>row_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>num_threads_per_block</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Determine how many rows in a 2D matrix should a block of threads handle based on the row size and the number of threads in a block. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">row_size</td><td>Size of the row expressed in the number of reads required to fully load it. For example, if the row has N elements, but each thread reads 2 elements with a single read, row_size should be N / 2. </td></tr>
<tr><td class="paramname">num_threads_per_block</td><td>Number of threads in a block. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of rows that should be handled by a single block. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 5 2023 00:58:44 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>