Google Git
Sign in
apache / mxnet-site / d5c5a235eef72f64ccaf224b834a20ef3287469b / . / versions / 1.9.1 / api / cpp / docs / api / structmxnet_1_1cpp_1_1Shape.html
blob: 7f172353381b3e2103449a5ad1cc9b13331be684 [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::cpp::Shape 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 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_1cpp.html">cpp</a></li><li class="navelem"><a class="el" href="structmxnet_1_1cpp_1_1Shape.html">Shape</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="structmxnet_1_1cpp_1_1Shape-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mxnet::cpp::Shape Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>dynamic shape class that can hold shape of arbirary dimension
<a href="structmxnet_1_1cpp_1_1Shape.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="shape_8h_source.html">shape.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for mxnet::cpp::Shape:</div>
<div class="dyncontent">
<div class="center"><img src="structmxnet_1_1cpp_1_1Shape__coll__graph.png" border="0" usemap="#mxnet_1_1cpp_1_1Shape_coll__map" alt="Collaboration graph"/></div>
<map name="mxnet_1_1cpp_1_1Shape_coll__map" id="mxnet_1_1cpp_1_1Shape_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:a2e31331beab6e555ee9924aecf063df1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1cpp_1_1Shape.html#a2e31331beab6e555ee9924aecf063df1">Shape</a> ()</td></tr>
<tr class="memdesc:a2e31331beab6e555ee9924aecf063df1"><td class="mdescLeft">&#160;</td><td class="mdescRight">constructor <a href="#a2e31331beab6e555ee9924aecf063df1">More...</a><br /></td></tr>
<tr class="separator:a2e31331beab6e555ee9924aecf063df1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a09dd7d8a2c93f806fb6846ccdea572b0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1cpp_1_1Shape.html#a09dd7d8a2c93f806fb6846ccdea572b0">Shape</a> (const std::vector&lt; <a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a> &gt; &amp;v)</td></tr>
<tr class="memdesc:a09dd7d8a2c93f806fb6846ccdea572b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">constructor from a vector of index_t <a href="#a09dd7d8a2c93f806fb6846ccdea572b0">More...</a><br /></td></tr>
<tr class="separator:a09dd7d8a2c93f806fb6846ccdea572b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ca1c0d97901dc85445ae4ce6b723cbb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1cpp_1_1Shape.html#a7ca1c0d97901dc85445ae4ce6b723cbb">Shape</a> (<a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a> s1)</td></tr>
<tr class="memdesc:a7ca1c0d97901dc85445ae4ce6b723cbb"><td class="mdescLeft">&#160;</td><td class="mdescRight">constructor one dimmension shape <a href="#a7ca1c0d97901dc85445ae4ce6b723cbb">More...</a><br /></td></tr>
<tr class="separator:a7ca1c0d97901dc85445ae4ce6b723cbb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4ff6496d0851078c0dfd858071071b38"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1cpp_1_1Shape.html#a4ff6496d0851078c0dfd858071071b38">Shape</a> (<a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a> s1, <a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a> s2)</td></tr>
<tr class="memdesc:a4ff6496d0851078c0dfd858071071b38"><td class="mdescLeft">&#160;</td><td class="mdescRight">constructor two dimmension shape <a href="#a4ff6496d0851078c0dfd858071071b38">More...</a><br /></td></tr>
<tr class="separator:a4ff6496d0851078c0dfd858071071b38"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6738d274c9a538f8c8d8d1e42f42cf5a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1cpp_1_1Shape.html#a6738d274c9a538f8c8d8d1e42f42cf5a">Shape</a> (<a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a> s1, <a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a> s2, <a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a> s3)</td></tr>
<tr class="memdesc:a6738d274c9a538f8c8d8d1e42f42cf5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">constructor three dimmension shape <a href="#a6738d274c9a538f8c8d8d1e42f42cf5a">More...</a><br /></td></tr>
<tr class="separator:a6738d274c9a538f8c8d8d1e42f42cf5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a39ba6d035cd970723338679ae6fb9c59"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1cpp_1_1Shape.html#a39ba6d035cd970723338679ae6fb9c59">Shape</a> (<a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a> s1, <a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a> s2, <a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a> s3, <a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a> s4)</td></tr>
<tr class="memdesc:a39ba6d035cd970723338679ae6fb9c59"><td class="mdescLeft">&#160;</td><td class="mdescRight">constructor four dimmension shape <a href="#a39ba6d035cd970723338679ae6fb9c59">More...</a><br /></td></tr>
<tr class="separator:a39ba6d035cd970723338679ae6fb9c59"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4544d5b908324655145641189ec30f60"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1cpp_1_1Shape.html#a4544d5b908324655145641189ec30f60">Shape</a> (<a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a> s1, <a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a> s2, <a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a> s3, <a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a> s4, <a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a> s5)</td></tr>
<tr class="memdesc:a4544d5b908324655145641189ec30f60"><td class="mdescLeft">&#160;</td><td class="mdescRight">constructor five dimmension shape <a href="#a4544d5b908324655145641189ec30f60">More...</a><br /></td></tr>
<tr class="separator:a4544d5b908324655145641189ec30f60"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a89eb750d34a8dcb29279d4484dd3245f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1cpp_1_1Shape.html#a89eb750d34a8dcb29279d4484dd3245f">Shape</a> (const <a class="el" href="structmxnet_1_1cpp_1_1Shape.html">Shape</a> &amp;s)</td></tr>
<tr class="memdesc:a89eb750d34a8dcb29279d4484dd3245f"><td class="mdescLeft">&#160;</td><td class="mdescRight">constructor from <a class="el" href="structmxnet_1_1cpp_1_1Shape.html" title="dynamic shape class that can hold shape of arbirary dimension ">Shape</a> <a href="#a89eb750d34a8dcb29279d4484dd3245f">More...</a><br /></td></tr>
<tr class="separator:a89eb750d34a8dcb29279d4484dd3245f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a40b67a6c7bdb73e18bc6b281e32584fb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1cpp_1_1Shape.html#a40b67a6c7bdb73e18bc6b281e32584fb">~Shape</a> ()</td></tr>
<tr class="memdesc:a40b67a6c7bdb73e18bc6b281e32584fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">destructor <a href="#a40b67a6c7bdb73e18bc6b281e32584fb">More...</a><br /></td></tr>
<tr class="separator:a40b67a6c7bdb73e18bc6b281e32584fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c82429ac9f09103642649f3c4e45970"><td class="memTemplParams" colspan="2">template&lt;typename RandomAccessIterator &gt; </td></tr>
<tr class="memitem:a2c82429ac9f09103642649f3c4e45970"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structmxnet_1_1cpp_1_1Shape.html#a2c82429ac9f09103642649f3c4e45970">CopyFrom</a> (RandomAccessIterator begin, RandomAccessIterator end)</td></tr>
<tr class="memdesc:a2c82429ac9f09103642649f3c4e45970"><td class="mdescLeft">&#160;</td><td class="mdescRight">copy shape from content betwen two iterators <a href="#a2c82429ac9f09103642649f3c4e45970">More...</a><br /></td></tr>
<tr class="separator:a2c82429ac9f09103642649f3c4e45970"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa78ab91eaa0f30085656bb0274ec623d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmxnet_1_1cpp_1_1Shape.html">Shape</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1cpp_1_1Shape.html#aa78ab91eaa0f30085656bb0274ec623d">operator=</a> (const <a class="el" href="structmxnet_1_1cpp_1_1Shape.html">Shape</a> &amp;shape)</td></tr>
<tr class="memdesc:aa78ab91eaa0f30085656bb0274ec623d"><td class="mdescLeft">&#160;</td><td class="mdescRight">assignment from shape <a href="#aa78ab91eaa0f30085656bb0274ec623d">More...</a><br /></td></tr>
<tr class="separator:aa78ab91eaa0f30085656bb0274ec623d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aee63406a6d35e9ebd54f0096dbcc63b9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmxnet_1_1cpp_1_1Shape.html">Shape</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1cpp_1_1Shape.html#aee63406a6d35e9ebd54f0096dbcc63b9">operator=</a> (const std::vector&lt; <a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a> &gt; &amp;shape)</td></tr>
<tr class="memdesc:aee63406a6d35e9ebd54f0096dbcc63b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">assignment from vector <a href="#aee63406a6d35e9ebd54f0096dbcc63b9">More...</a><br /></td></tr>
<tr class="separator:aee63406a6d35e9ebd54f0096dbcc63b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4c1d1d860562bf40cc93edef2db83a01"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1cpp_1_1Shape.html#a4c1d1d860562bf40cc93edef2db83a01">data</a> () const</td></tr>
<tr class="separator:a4c1d1d860562bf40cc93edef2db83a01"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3b1ab42010d804d352e363cf85c823c8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1cpp_1_1Shape.html#a3b1ab42010d804d352e363cf85c823c8">data</a> ()</td></tr>
<tr class="separator:a3b1ab42010d804d352e363cf85c823c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5767fc5e3582f5f3d1f8282ed812401b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1cpp_1_1Shape.html#a5767fc5e3582f5f3d1f8282ed812401b">ndim</a> (void) const</td></tr>
<tr class="memdesc:a5767fc5e3582f5f3d1f8282ed812401b"><td class="mdescLeft">&#160;</td><td class="mdescRight">return number of dimension of the tensor inside <a href="#a5767fc5e3582f5f3d1f8282ed812401b">More...</a><br /></td></tr>
<tr class="separator:a5767fc5e3582f5f3d1f8282ed812401b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa4ce78dda6d9cee806f35a0af1953eab"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1cpp_1_1Shape.html#aa4ce78dda6d9cee806f35a0af1953eab">operator[]</a> (<a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a> i)</td></tr>
<tr class="memdesc:aa4ce78dda6d9cee806f35a0af1953eab"><td class="mdescLeft">&#160;</td><td class="mdescRight">get corresponding index <a href="#aa4ce78dda6d9cee806f35a0af1953eab">More...</a><br /></td></tr>
<tr class="separator:aa4ce78dda6d9cee806f35a0af1953eab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a35c322878d7db5b01c1b8a6f6afa7303"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1cpp_1_1Shape.html#a35c322878d7db5b01c1b8a6f6afa7303">operator[]</a> (<a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a> i) const</td></tr>
<tr class="memdesc:a35c322878d7db5b01c1b8a6f6afa7303"><td class="mdescLeft">&#160;</td><td class="mdescRight">get corresponding index <a href="#a35c322878d7db5b01c1b8a6f6afa7303">More...</a><br /></td></tr>
<tr class="separator:a35c322878d7db5b01c1b8a6f6afa7303"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a948c5bec0e06f42b7db54bde3167af99"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1cpp_1_1Shape.html#a948c5bec0e06f42b7db54bde3167af99">Size</a> (void) const</td></tr>
<tr class="memdesc:a948c5bec0e06f42b7db54bde3167af99"><td class="mdescLeft">&#160;</td><td class="mdescRight">total number of elements in the tensor <a href="#a948c5bec0e06f42b7db54bde3167af99">More...</a><br /></td></tr>
<tr class="separator:a948c5bec0e06f42b7db54bde3167af99"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a82b28f0e28976067e26212f7f00be508"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1cpp_1_1Shape.html#a82b28f0e28976067e26212f7f00be508">operator==</a> (const <a class="el" href="structmxnet_1_1cpp_1_1Shape.html">Shape</a> &amp;s) const</td></tr>
<tr class="separator:a82b28f0e28976067e26212f7f00be508"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a138b0895f2aa961e2c6c8ced4aaea223"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1cpp_1_1Shape.html#a138b0895f2aa961e2c6c8ced4aaea223">operator!=</a> (const <a class="el" href="structmxnet_1_1cpp_1_1Shape.html">Shape</a> &amp;s) const</td></tr>
<tr class="separator:a138b0895f2aa961e2c6c8ced4aaea223"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a4702299639c1d7f1652b77f11011b379"><td class="memItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1cpp_1_1Shape.html#a4702299639c1d7f1652b77f11011b379">operator&lt;&lt;</a> (std::ostream &amp;os, const <a class="el" href="structmxnet_1_1cpp_1_1Shape.html">Shape</a> &amp;shape)</td></tr>
<tr class="memdesc:a4702299639c1d7f1652b77f11011b379"><td class="mdescLeft">&#160;</td><td class="mdescRight">allow string printing of the shape <a href="#a4702299639c1d7f1652b77f11011b379">More...</a><br /></td></tr>
<tr class="separator:a4702299639c1d7f1652b77f11011b379"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad1d046fe5cabf346028e574e84812256"><td class="memItemLeft" align="right" valign="top">std::istream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmxnet_1_1cpp_1_1Shape.html#ad1d046fe5cabf346028e574e84812256">operator&gt;&gt;</a> (std::istream &amp;is, <a class="el" href="structmxnet_1_1cpp_1_1Shape.html">Shape</a> &amp;shape)</td></tr>
<tr class="memdesc:ad1d046fe5cabf346028e574e84812256"><td class="mdescLeft">&#160;</td><td class="mdescRight">read shape from the istream <a href="#ad1d046fe5cabf346028e574e84812256">More...</a><br /></td></tr>
<tr class="separator:ad1d046fe5cabf346028e574e84812256"><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>dynamic shape class that can hold shape of arbirary dimension </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a2e31331beab6e555ee9924aecf063df1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2e31331beab6e555ee9924aecf063df1">&#9670;&nbsp;</a></span>Shape() <span class="overload">[1/8]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">mxnet::cpp::Shape::Shape </td>
<td>(</td>
<td class="paramtype">void&#160;</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>constructor </p>
</div>
</div>
<a id="a09dd7d8a2c93f806fb6846ccdea572b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a09dd7d8a2c93f806fb6846ccdea572b0">&#9670;&nbsp;</a></span>Shape() <span class="overload">[2/8]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">mxnet::cpp::Shape::Shape </td>
<td>(</td>
<td class="paramtype">const std::vector&lt; <a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a> &gt; &amp;&#160;</td>
<td class="paramname"><em>v</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>constructor from a vector of index_t </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">v</td><td>the vector </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a7ca1c0d97901dc85445ae4ce6b723cbb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ca1c0d97901dc85445ae4ce6b723cbb">&#9670;&nbsp;</a></span>Shape() <span class="overload">[3/8]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">mxnet::cpp::Shape::Shape </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a>&#160;</td>
<td class="paramname"><em>s1</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>constructor one dimmension shape </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s1</td><td>size of the first dimmension </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a4ff6496d0851078c0dfd858071071b38"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4ff6496d0851078c0dfd858071071b38">&#9670;&nbsp;</a></span>Shape() <span class="overload">[4/8]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">mxnet::cpp::Shape::Shape </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a>&#160;</td>
<td class="paramname"><em>s1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a>&#160;</td>
<td class="paramname"><em>s2</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">
<p>constructor two dimmension shape </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s1</td><td>size of the first dimmension </td></tr>
<tr><td class="paramname">s2</td><td>size of the second dimmension </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a6738d274c9a538f8c8d8d1e42f42cf5a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6738d274c9a538f8c8d8d1e42f42cf5a">&#9670;&nbsp;</a></span>Shape() <span class="overload">[5/8]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">mxnet::cpp::Shape::Shape </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a>&#160;</td>
<td class="paramname"><em>s1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a>&#160;</td>
<td class="paramname"><em>s2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a>&#160;</td>
<td class="paramname"><em>s3</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">
<p>constructor three dimmension shape </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s1</td><td>size of the first dimmension </td></tr>
<tr><td class="paramname">s2</td><td>size of the second dimmension </td></tr>
<tr><td class="paramname">s3</td><td>size of the third dimmension </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a39ba6d035cd970723338679ae6fb9c59"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a39ba6d035cd970723338679ae6fb9c59">&#9670;&nbsp;</a></span>Shape() <span class="overload">[6/8]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">mxnet::cpp::Shape::Shape </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a>&#160;</td>
<td class="paramname"><em>s1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a>&#160;</td>
<td class="paramname"><em>s2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a>&#160;</td>
<td class="paramname"><em>s3</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a>&#160;</td>
<td class="paramname"><em>s4</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">
<p>constructor four dimmension shape </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s1</td><td>size of the first dimmension </td></tr>
<tr><td class="paramname">s2</td><td>size of the second dimmension </td></tr>
<tr><td class="paramname">s3</td><td>size of the third dimmension </td></tr>
<tr><td class="paramname">s4</td><td>size of the fourth dimmension </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a4544d5b908324655145641189ec30f60"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4544d5b908324655145641189ec30f60">&#9670;&nbsp;</a></span>Shape() <span class="overload">[7/8]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">mxnet::cpp::Shape::Shape </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a>&#160;</td>
<td class="paramname"><em>s1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a>&#160;</td>
<td class="paramname"><em>s2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a>&#160;</td>
<td class="paramname"><em>s3</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a>&#160;</td>
<td class="paramname"><em>s4</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a>&#160;</td>
<td class="paramname"><em>s5</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">
<p>constructor five dimmension shape </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s1</td><td>size of the first dimmension </td></tr>
<tr><td class="paramname">s2</td><td>size of the second dimmension </td></tr>
<tr><td class="paramname">s3</td><td>size of the third dimmension </td></tr>
<tr><td class="paramname">s4</td><td>size of the fourth dimmension </td></tr>
<tr><td class="paramname">s5</td><td>size of the fifth dimmension </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a89eb750d34a8dcb29279d4484dd3245f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a89eb750d34a8dcb29279d4484dd3245f">&#9670;&nbsp;</a></span>Shape() <span class="overload">[8/8]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">mxnet::cpp::Shape::Shape </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structmxnet_1_1cpp_1_1Shape.html">Shape</a> &amp;&#160;</td>
<td class="paramname"><em>s</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>constructor from <a class="el" href="structmxnet_1_1cpp_1_1Shape.html" title="dynamic shape class that can hold shape of arbirary dimension ">Shape</a> </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>the source shape </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a40b67a6c7bdb73e18bc6b281e32584fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a40b67a6c7bdb73e18bc6b281e32584fb">&#9670;&nbsp;</a></span>~Shape()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">mxnet::cpp::Shape::~Shape </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>destructor </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a2c82429ac9f09103642649f3c4e45970"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c82429ac9f09103642649f3c4e45970">&#9670;&nbsp;</a></span>CopyFrom()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename RandomAccessIterator &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void mxnet::cpp::Shape::CopyFrom </td>
<td>(</td>
<td class="paramtype">RandomAccessIterator&#160;</td>
<td class="paramname"><em>begin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">RandomAccessIterator&#160;</td>
<td class="paramname"><em>end</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">
<p>copy shape from content betwen two iterators </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">begin</td><td>the beginning of iterator </td></tr>
<tr><td class="paramname">end</td><td>the end of the iterator </td></tr>
</table>
</dd>
</dl>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">RandomAccessIterator</td><td>iterator type </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a4c1d1d860562bf40cc93edef2db83a01"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4c1d1d860562bf40cc93edef2db83a01">&#9670;&nbsp;</a></span>data() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a>* mxnet::cpp::Shape::data </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 data content of the shape </dd></dl>
</div>
</div>
<a id="a3b1ab42010d804d352e363cf85c823c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b1ab42010d804d352e363cf85c823c8">&#9670;&nbsp;</a></span>data() <span class="overload">[2/2]</span></h2>
<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#ae3c39bf39510741647c969f5409bb5d4">index_t</a>* mxnet::cpp::Shape::data </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">
<dl class="section return"><dt>Returns</dt><dd>the data content of the shape </dd></dl>
</div>
</div>
<a id="a5767fc5e3582f5f3d1f8282ed812401b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5767fc5e3582f5f3d1f8282ed812401b">&#9670;&nbsp;</a></span>ndim()</h2>
<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#ae3c39bf39510741647c969f5409bb5d4">index_t</a> mxnet::cpp::Shape::ndim </td>
<td>(</td>
<td class="paramtype">void&#160;</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>return number of dimension of the tensor inside </p>
</div>
</div>
<a id="a138b0895f2aa961e2c6c8ced4aaea223"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a138b0895f2aa961e2c6c8ced4aaea223">&#9670;&nbsp;</a></span>operator!=()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool mxnet::cpp::Shape::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structmxnet_1_1cpp_1_1Shape.html">Shape</a> &amp;&#160;</td>
<td class="paramname"><em>s</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">
<dl class="section return"><dt>Returns</dt><dd>whether two shape not equals </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>the shape to compare against </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa78ab91eaa0f30085656bb0274ec623d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa78ab91eaa0f30085656bb0274ec623d">&#9670;&nbsp;</a></span>operator=() <span class="overload">[1/2]</span></h2>
<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_1cpp_1_1Shape.html">Shape</a>&amp; mxnet::cpp::Shape::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structmxnet_1_1cpp_1_1Shape.html">Shape</a> &amp;&#160;</td>
<td class="paramname"><em>shape</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>assignment from shape </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">shape</td><td>source shape </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>reference of self </dd></dl>
</div>
</div>
<a id="aee63406a6d35e9ebd54f0096dbcc63b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aee63406a6d35e9ebd54f0096dbcc63b9">&#9670;&nbsp;</a></span>operator=() <span class="overload">[2/2]</span></h2>
<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_1cpp_1_1Shape.html">Shape</a>&amp; mxnet::cpp::Shape::operator= </td>
<td>(</td>
<td class="paramtype">const std::vector&lt; <a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a> &gt; &amp;&#160;</td>
<td class="paramname"><em>shape</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>assignment from vector </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">shape</td><td>source shape </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>reference of self </dd></dl>
</div>
</div>
<a id="a82b28f0e28976067e26212f7f00be508"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a82b28f0e28976067e26212f7f00be508">&#9670;&nbsp;</a></span>operator==()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool mxnet::cpp::Shape::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structmxnet_1_1cpp_1_1Shape.html">Shape</a> &amp;&#160;</td>
<td class="paramname"><em>s</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">
<dl class="section return"><dt>Returns</dt><dd>whether two shape equals </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>the shape to compare against </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa4ce78dda6d9cee806f35a0af1953eab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa4ce78dda6d9cee806f35a0af1953eab">&#9670;&nbsp;</a></span>operator[]() <span class="overload">[1/2]</span></h2>
<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#ae3c39bf39510741647c969f5409bb5d4">index_t</a>&amp; mxnet::cpp::Shape::operator[] </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a>&#160;</td>
<td class="paramname"><em>i</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 corresponding index </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">i</td><td>dimension index </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the corresponding dimension size </dd></dl>
</div>
</div>
<a id="a35c322878d7db5b01c1b8a6f6afa7303"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a35c322878d7db5b01c1b8a6f6afa7303">&#9670;&nbsp;</a></span>operator[]() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a>&amp; mxnet::cpp::Shape::operator[] </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacemxnet_1_1cpp.html#ae3c39bf39510741647c969f5409bb5d4">index_t</a>&#160;</td>
<td class="paramname"><em>i</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>get corresponding index </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">i</td><td>dimension index </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the corresponding dimension size </dd></dl>
</div>
</div>
<a id="a948c5bec0e06f42b7db54bde3167af99"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a948c5bec0e06f42b7db54bde3167af99">&#9670;&nbsp;</a></span>Size()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t mxnet::cpp::Shape::Size </td>
<td>(</td>
<td class="paramtype">void&#160;</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>total number of elements in the tensor </p>
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="a4702299639c1d7f1652b77f11011b379"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4702299639c1d7f1652b77f11011b379">&#9670;&nbsp;</a></span>operator<<</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::ostream&amp; operator&lt;&lt; </td>
<td>(</td>
<td class="paramtype">std::ostream &amp;&#160;</td>
<td class="paramname"><em>os</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structmxnet_1_1cpp_1_1Shape.html">Shape</a> &amp;&#160;</td>
<td class="paramname"><em>shape</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">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>allow string printing of the shape </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">os</td><td>the output stream </td></tr>
<tr><td class="paramname">shape</td><td>the shape </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the ostream </dd></dl>
</div>
</div>
<a id="ad1d046fe5cabf346028e574e84812256"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad1d046fe5cabf346028e574e84812256">&#9670;&nbsp;</a></span>operator>></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::istream&amp; operator&gt;&gt; </td>
<td>(</td>
<td class="paramtype">std::istream &amp;&#160;</td>
<td class="paramname"><em>is</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structmxnet_1_1cpp_1_1Shape.html">Shape</a> &amp;&#160;</td>
<td class="paramname"><em>shape</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">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>read shape from the istream </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">is</td><td>the input stream </td></tr>
<tr><td class="paramname">shape</td><td>the shape </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the istream </dd></dl>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>/work/mxnet/cpp-package/include/mxnet-cpp/<a class="el" href="shape_8h_source.html">shape.h</a></li>
</ul>
</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>