Google Git
Sign in
apache / mxnet-site / d5c5a235eef72f64ccaf224b834a20ef3287469b / . / versions / master / api / cpp / docs / api / ndarray__handle_8h_source.html
blob: e4ae11bf8ed73a12f042fffbe9ba1428055d6fab [file] [log] [blame]
<!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: /work/mxnet/include/mxnet/runtime/ndarray_handle.h Source File</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&amp;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&amp;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="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_1143c7affb9ebd026cb6818dd282def7.html">mxnet</a></li><li class="navelem"><a class="el" href="dir_8e7a93613ef4c7e7d673effa691c1739.html">runtime</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">ndarray_handle.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="ndarray__handle_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * distributed with this work for additional information</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * &quot;License&quot;); you may not use this file except in compliance</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * with the License. You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * software distributed under the License is distributed on an</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * KIND, either express or implied. See the License for the</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> * specific language governing permissions and limitations</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> * under the License.</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#ifndef MXNET_RUNTIME_NDARRAY_HANDLE_H_</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#define MXNET_RUNTIME_NDARRAY_HANDLE_H_</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="include_2mxnet_2ndarray_8h.html">mxnet/ndarray.h</a>&gt;</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="object_8h.html">mxnet/runtime/object.h</a>&gt;</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacemxnet.html">mxnet</a> {</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; </div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="classmxnet_1_1NDArrayHandleObj.html"> 31</a></span>&#160;<span class="keyword">class </span><a class="code" href="classmxnet_1_1NDArrayHandleObj.html">NDArrayHandleObj</a> : <span class="keyword">public</span> <a class="code" href="classmxnet_1_1runtime_1_1Object.html">Object</a> {</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classmxnet_1_1NDArrayHandleObj.html#ac169bbd0dee02ca5b312b5c09c176b1c"> 34</a></span>&#160; <a class="code" href="classmxnet_1_1NDArray.html">NDArray</a> <a class="code" href="classmxnet_1_1NDArrayHandleObj.html#ac169bbd0dee02ca5b312b5c09c176b1c">value</a>;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; </div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classmxnet_1_1NDArrayHandleObj.html#a0de2632f4e5c2245508301764ad75d36"> 36</a></span>&#160; <span class="keyword">static</span> constexpr <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classmxnet_1_1NDArrayHandleObj.html#a0de2632f4e5c2245508301764ad75d36">_type_key</a> = <span class="stringliteral">&quot;MXNet.NDArrayHandle&quot;</span>;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <a class="code" href="object_8h.html#aff0db99c23ecb5cbf6c5b9134076a0f3">MXNET_DECLARE_FINAL_OBJECT_INFO</a>(<a class="code" href="classmxnet_1_1NDArrayHandleObj.html">NDArrayHandleObj</a>, <a class="code" href="classmxnet_1_1runtime_1_1Object.html">Object</a>)</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;};</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; </div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="classmxnet_1_1NDArrayHandle.html"> 40</a></span>&#160;<span class="keyword">class </span><a class="code" href="classmxnet_1_1NDArrayHandle.html">NDArrayHandle</a> : <span class="keyword">public</span> <a class="code" href="classmxnet_1_1runtime_1_1ObjectRef.html">ObjectRef</a> {</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classmxnet_1_1NDArrayHandle.html#acef9c8837bc863e7a634880971e207e0"> 42</a></span>&#160; <span class="keyword">explicit</span> <a class="code" href="classmxnet_1_1NDArrayHandle.html#acef9c8837bc863e7a634880971e207e0">NDArrayHandle</a>(<a class="code" href="classmxnet_1_1NDArray.html">NDArray</a>* value) {</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <a class="code" href="classmxnet_1_1runtime_1_1ObjectPtr.html">runtime::ObjectPtr&lt;NDArrayHandleObj&gt;</a> node = make_object&lt;NDArrayHandleObj&gt;();</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; node-&gt;value = *value;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <a class="code" href="classmxnet_1_1runtime_1_1ObjectRef.html#a5009d0661d741e4b105402b3126663e9">data_</a> = std::move(node);</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; }</div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classmxnet_1_1NDArrayHandle.html#a619852d172f0c62b7e46803378ee06ac"> 47</a></span>&#160; <span class="keyword">inline</span> <a class="code" href="classmxnet_1_1NDArray.html">NDArray</a>* <a class="code" href="classmxnet_1_1NDArrayHandle.html#a619852d172f0c62b7e46803378ee06ac">getArray</a>()<span class="keyword"> const </span>{</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keywordflow">return</span> <span class="keyword">static_cast&lt;</span><a class="code" href="classmxnet_1_1NDArray.html">NDArray</a>*<span class="keyword">&gt;</span>(&amp;(<span class="keyword">static_cast&lt;</span><a class="code" href="classmxnet_1_1NDArrayHandleObj.html">NDArrayHandleObj</a>*<span class="keyword">&gt;</span>(<a class="code" href="classmxnet_1_1runtime_1_1ObjectRef.html#a5009d0661d741e4b105402b3126663e9">data_</a>.get())-&gt;value));</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; }</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <a class="code" href="object_8h.html#a3bbe3c8205ea8d2660b25c519306f04f">MXNET_DEFINE_OBJECT_REF_METHODS</a>(<a class="code" href="classmxnet_1_1NDArrayHandle.html">NDArrayHandle</a>, <a class="code" href="classmxnet_1_1runtime_1_1ObjectRef.html">ObjectRef</a>, <a class="code" href="classmxnet_1_1NDArrayHandleObj.html">NDArrayHandleObj</a>)</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;};</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; </div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;}; <span class="comment">// namespace mxnet</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="preprocessor">#endif // MXNET_RUNTIME_NDARRAY_HANDLE_H_</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="anamespacemxnet_html"><div class="ttname"><a href="namespacemxnet.html">mxnet</a></div><div class="ttdoc">namespace of mxnet</div><div class="ttdef"><b>Definition:</b> api_registry.h:33</div></div>
<div class="ttc" id="aclassmxnet_1_1runtime_1_1Object_html"><div class="ttname"><a href="classmxnet_1_1runtime_1_1Object.html">mxnet::runtime::Object</a></div><div class="ttdoc">base class of all object containers.</div><div class="ttdef"><b>Definition:</b> object.h:151</div></div>
<div class="ttc" id="aclassmxnet_1_1runtime_1_1ObjectPtr_html"><div class="ttname"><a href="classmxnet_1_1runtime_1_1ObjectPtr.html">mxnet::runtime::ObjectPtr</a></div><div class="ttdoc">A custom smart pointer for Object.</div><div class="ttdef"><b>Definition:</b> object.h:346</div></div>
<div class="ttc" id="aobject_8h_html_aff0db99c23ecb5cbf6c5b9134076a0f3"><div class="ttname"><a href="object_8h.html#aff0db99c23ecb5cbf6c5b9134076a0f3">MXNET_DECLARE_FINAL_OBJECT_INFO</a></div><div class="ttdeci">#define MXNET_DECLARE_FINAL_OBJECT_INFO(TypeName, ParentType)</div><div class="ttdoc">helper macro to declare type information in a final class.</div><div class="ttdef"><b>Definition:</b> object.h:668</div></div>
<div class="ttc" id="aclassmxnet_1_1NDArrayHandle_html_acef9c8837bc863e7a634880971e207e0"><div class="ttname"><a href="classmxnet_1_1NDArrayHandle.html#acef9c8837bc863e7a634880971e207e0">mxnet::NDArrayHandle::NDArrayHandle</a></div><div class="ttdeci">NDArrayHandle(NDArray *value)</div><div class="ttdef"><b>Definition:</b> ndarray_handle.h:42</div></div>
<div class="ttc" id="aclassmxnet_1_1NDArrayHandleObj_html_a0de2632f4e5c2245508301764ad75d36"><div class="ttname"><a href="classmxnet_1_1NDArrayHandleObj.html#a0de2632f4e5c2245508301764ad75d36">mxnet::NDArrayHandleObj::_type_key</a></div><div class="ttdeci">static constexpr const char * _type_key</div><div class="ttdef"><b>Definition:</b> ndarray_handle.h:36</div></div>
<div class="ttc" id="aclassmxnet_1_1NDArrayHandleObj_html"><div class="ttname"><a href="classmxnet_1_1NDArrayHandleObj.html">mxnet::NDArrayHandleObj</a></div><div class="ttdef"><b>Definition:</b> ndarray_handle.h:31</div></div>
<div class="ttc" id="aclassmxnet_1_1NDArray_html"><div class="ttname"><a href="classmxnet_1_1NDArray.html">mxnet::NDArray</a></div><div class="ttdoc">ndarray interface</div><div class="ttdef"><b>Definition:</b> ndarray.h:82</div></div>
<div class="ttc" id="aclassmxnet_1_1NDArrayHandleObj_html_ac169bbd0dee02ca5b312b5c09c176b1c"><div class="ttname"><a href="classmxnet_1_1NDArrayHandleObj.html#ac169bbd0dee02ca5b312b5c09c176b1c">mxnet::NDArrayHandleObj::value</a></div><div class="ttdeci">NDArray value</div><div class="ttdoc">the Internal value.</div><div class="ttdef"><b>Definition:</b> ndarray_handle.h:34</div></div>
<div class="ttc" id="aclassmxnet_1_1runtime_1_1ObjectRef_html_a5009d0661d741e4b105402b3126663e9"><div class="ttname"><a href="classmxnet_1_1runtime_1_1ObjectRef.html#a5009d0661d741e4b105402b3126663e9">mxnet::runtime::ObjectRef::data_</a></div><div class="ttdeci">ObjectPtr&lt; Object &gt; data_</div><div class="ttdoc">Internal pointer that backs the reference.</div><div class="ttdef"><b>Definition:</b> object.h:575</div></div>
<div class="ttc" id="aclassmxnet_1_1NDArrayHandle_html"><div class="ttname"><a href="classmxnet_1_1NDArrayHandle.html">mxnet::NDArrayHandle</a></div><div class="ttdef"><b>Definition:</b> ndarray_handle.h:40</div></div>
<div class="ttc" id="aclassmxnet_1_1NDArrayHandle_html_a619852d172f0c62b7e46803378ee06ac"><div class="ttname"><a href="classmxnet_1_1NDArrayHandle.html#a619852d172f0c62b7e46803378ee06ac">mxnet::NDArrayHandle::getArray</a></div><div class="ttdeci">NDArray * getArray() const</div><div class="ttdef"><b>Definition:</b> ndarray_handle.h:47</div></div>
<div class="ttc" id="aclassmxnet_1_1runtime_1_1ObjectRef_html"><div class="ttname"><a href="classmxnet_1_1runtime_1_1ObjectRef.html">mxnet::runtime::ObjectRef</a></div><div class="ttdoc">Base class of all object reference.</div><div class="ttdef"><b>Definition:</b> object.h:500</div></div>
<div class="ttc" id="aobject_8h_html_a3bbe3c8205ea8d2660b25c519306f04f"><div class="ttname"><a href="object_8h.html#a3bbe3c8205ea8d2660b25c519306f04f">MXNET_DEFINE_OBJECT_REF_METHODS</a></div><div class="ttdeci">#define MXNET_DEFINE_OBJECT_REF_METHODS(TypeName, ParentType, ObjectName)</div><div class="ttdef"><b>Definition:</b> object.h:689</div></div>
<div class="ttc" id="ainclude_2mxnet_2ndarray_8h_html"><div class="ttname"><a href="include_2mxnet_2ndarray_8h.html">ndarray.h</a></div><div class="ttdoc">NDArray interface that handles array arithematics.</div></div>
<div class="ttc" id="aobject_8h_html"><div class="ttname"><a href="object_8h.html">object.h</a></div><div class="ttdoc">A managed object in MXNet runtime.</div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 5 2023 03:47:40 for mxnet by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>