| <!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: DLTensor Struct 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><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-attribs">Public Attributes</a> | |
| <a href="structDLTensor-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">DLTensor Struct Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Plain C Tensor object, does not manage memory. |
| <a href="structDLTensor.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="dlpack_8h_source.html">dlpack.h</a>></code></p> |
| <div class="dynheader"> |
| Collaboration diagram for DLTensor:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="structDLTensor__coll__graph.png" border="0" usemap="#DLTensor_coll__map" alt="Collaboration graph"/></div> |
| <map name="DLTensor_coll__map" id="DLTensor_coll__map"> |
| <area shape="rect" id="node2" href="structDLContext.html" title="A Device context for Tensor and operator. " alt="" coords="5,13,121,105"/> |
| <area shape="rect" id="node3" href="structDLDataType.html" title="The data type the tensor can hold. " alt="" coords="145,5,245,112"/> |
| </map> |
| </div> |
| <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:a8a6408813fe13f1985379f022ade0947"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structDLTensor.html#a8a6408813fe13f1985379f022ade0947">data</a></td></tr> |
| <tr class="memdesc:a8a6408813fe13f1985379f022ade0947"><td class="mdescLeft"> </td><td class="mdescRight">The opaque data pointer points to the allocated data. This will be CUDA device pointer or cl_mem handle in OpenCL. This pointer is always aligned to 256 bytes as in CUDA. <a href="#a8a6408813fe13f1985379f022ade0947">More...</a><br /></td></tr> |
| <tr class="separator:a8a6408813fe13f1985379f022ade0947"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a552ca85f7d04138c876c636e25b3c484"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structDLContext.html">DLContext</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structDLTensor.html#a552ca85f7d04138c876c636e25b3c484">ctx</a></td></tr> |
| <tr class="memdesc:a552ca85f7d04138c876c636e25b3c484"><td class="mdescLeft"> </td><td class="mdescRight">The device context of the tensor. <a href="#a552ca85f7d04138c876c636e25b3c484">More...</a><br /></td></tr> |
| <tr class="separator:a552ca85f7d04138c876c636e25b3c484"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8b28a3876c4d157ccea80956f3ec18f5"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structDLTensor.html#a8b28a3876c4d157ccea80956f3ec18f5">ndim</a></td></tr> |
| <tr class="memdesc:a8b28a3876c4d157ccea80956f3ec18f5"><td class="mdescLeft"> </td><td class="mdescRight">Number of dimensions. <a href="#a8b28a3876c4d157ccea80956f3ec18f5">More...</a><br /></td></tr> |
| <tr class="separator:a8b28a3876c4d157ccea80956f3ec18f5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae0cf02d1a8b19118838670b3b3d857f5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structDLDataType.html">DLDataType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structDLTensor.html#ae0cf02d1a8b19118838670b3b3d857f5">dtype</a></td></tr> |
| <tr class="memdesc:ae0cf02d1a8b19118838670b3b3d857f5"><td class="mdescLeft"> </td><td class="mdescRight">The data type of the pointer. <a href="#ae0cf02d1a8b19118838670b3b3d857f5">More...</a><br /></td></tr> |
| <tr class="separator:ae0cf02d1a8b19118838670b3b3d857f5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac982d47788a5251f1cd97375a1a2e49f"><td class="memItemLeft" align="right" valign="top">int64_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="structDLTensor.html#ac982d47788a5251f1cd97375a1a2e49f">shape</a></td></tr> |
| <tr class="memdesc:ac982d47788a5251f1cd97375a1a2e49f"><td class="mdescLeft"> </td><td class="mdescRight">The shape of the tensor. <a href="#ac982d47788a5251f1cd97375a1a2e49f">More...</a><br /></td></tr> |
| <tr class="separator:ac982d47788a5251f1cd97375a1a2e49f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa1a066fbde828cf415f77e5dbf962c2e"><td class="memItemLeft" align="right" valign="top">int64_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="structDLTensor.html#aa1a066fbde828cf415f77e5dbf962c2e">strides</a></td></tr> |
| <tr class="memdesc:aa1a066fbde828cf415f77e5dbf962c2e"><td class="mdescLeft"> </td><td class="mdescRight">strides of the tensor (in number of elements, not bytes) can be NULL, indicating tensor is compact and row-majored. <a href="#aa1a066fbde828cf415f77e5dbf962c2e">More...</a><br /></td></tr> |
| <tr class="separator:aa1a066fbde828cf415f77e5dbf962c2e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a647dfbb2a3b976c4e9d1e17740dca568"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structDLTensor.html#a647dfbb2a3b976c4e9d1e17740dca568">byte_offset</a></td></tr> |
| <tr class="memdesc:a647dfbb2a3b976c4e9d1e17740dca568"><td class="mdescLeft"> </td><td class="mdescRight">The offset in bytes to the beginning pointer to data. <a href="#a647dfbb2a3b976c4e9d1e17740dca568">More...</a><br /></td></tr> |
| <tr class="separator:a647dfbb2a3b976c4e9d1e17740dca568"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Plain C Tensor object, does not manage memory. </p> |
| </div><h2 class="groupheader">Member Data Documentation</h2> |
| <a id="a647dfbb2a3b976c4e9d1e17740dca568"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a647dfbb2a3b976c4e9d1e17740dca568">◆ </a></span>byte_offset</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">uint64_t DLTensor::byte_offset</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>The offset in bytes to the beginning pointer to data. </p> |
| |
| </div> |
| </div> |
| <a id="a552ca85f7d04138c876c636e25b3c484"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a552ca85f7d04138c876c636e25b3c484">◆ </a></span>ctx</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="structDLContext.html">DLContext</a> DLTensor::ctx</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>The device context of the tensor. </p> |
| |
| </div> |
| </div> |
| <a id="a8a6408813fe13f1985379f022ade0947"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8a6408813fe13f1985379f022ade0947">◆ </a></span>data</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void * DLTensor::data</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>The opaque data pointer points to the allocated data. This will be CUDA device pointer or cl_mem handle in OpenCL. This pointer is always aligned to 256 bytes as in CUDA. </p> |
| <p>The opaque data pointer points to the allocated data. This will be CUDA device pointer or cl_mem handle in OpenCL. This pointer is always aligns to 256 bytes as in CUDA.</p> |
| <p>For given <a class="el" href="structDLTensor.html" title="Plain C Tensor object, does not manage memory. ">DLTensor</a>, the size of memory required to store the contents of data is calculated as follows:</p> |
| <div class="fragment"><div class="line"><span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">size_t</span> GetDataSize(<span class="keyword">const</span> <a class="code" href="structDLTensor.html">DLTensor</a>* t) {</div><div class="line"> <span class="keywordtype">size_t</span> size = 1;</div><div class="line"> <span class="keywordflow">for</span> (tvm_index_t i = 0; i < t-><a class="code" href="structDLTensor.html#a8b28a3876c4d157ccea80956f3ec18f5">ndim</a>; ++i) {</div><div class="line"> size *= t-><a class="code" href="structDLTensor.html#ac982d47788a5251f1cd97375a1a2e49f">shape</a>[i];</div><div class="line"> }</div><div class="line"> size *= (t-><a class="code" href="structDLTensor.html#ae0cf02d1a8b19118838670b3b3d857f5">dtype</a>.<a class="code" href="structDLDataType.html#a412e36fa9c58e808a2333e9044c5d9b5">bits</a> * t-><a class="code" href="structDLTensor.html#ae0cf02d1a8b19118838670b3b3d857f5">dtype</a>.<a class="code" href="structDLDataType.html#a24de092fe56d358c1582e41499862594">lanes</a> + 7) / 8;</div><div class="line"> <span class="keywordflow">return</span> size;</div><div class="line">}</div></div><!-- fragment --> |
| </div> |
| </div> |
| <a id="ae0cf02d1a8b19118838670b3b3d857f5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae0cf02d1a8b19118838670b3b3d857f5">◆ </a></span>dtype</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="structDLDataType.html">DLDataType</a> DLTensor::dtype</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>The data type of the pointer. </p> |
| |
| </div> |
| </div> |
| <a id="a8b28a3876c4d157ccea80956f3ec18f5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8b28a3876c4d157ccea80956f3ec18f5">◆ </a></span>ndim</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int DLTensor::ndim</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Number of dimensions. </p> |
| |
| </div> |
| </div> |
| <a id="ac982d47788a5251f1cd97375a1a2e49f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac982d47788a5251f1cd97375a1a2e49f">◆ </a></span>shape</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int64_t * DLTensor::shape</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>The shape of the tensor. </p> |
| |
| </div> |
| </div> |
| <a id="aa1a066fbde828cf415f77e5dbf962c2e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa1a066fbde828cf415f77e5dbf962c2e">◆ </a></span>strides</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int64_t * DLTensor::strides</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>strides of the tensor (in number of elements, not bytes) can be NULL, indicating tensor is compact and row-majored. </p> |
| <p>strides of the tensor (in number of elements, not bytes) can be nullptr, indicating tensor is compact and row-majored. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this struct was generated from the following files:<ul> |
| <li>/work/mxnet/3rdparty/dlpack/include/dlpack/<a class="el" href="dlpack_8h_source.html">dlpack.h</a></li> |
| <li>/work/mxnet/include/mxnet/<a class="el" href="lib__api_8h_source.html">lib_api.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 5 2023 00:58:43 for mxnet by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.13 |
| </small></address> |
| </body> |
| </html> |
