Google Git
Sign in
apache / mxnet-site / d5c5a235eef72f64ccaf224b834a20ef3287469b / . / versions / 1.9.1 / api / cpp / docs / api / structmshadow_1_1Shape.html
blob: ff27abfd726e9487b2de50540e094366635948f7 [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: mshadow::Shape&lt; dimension &gt; Struct Template 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="namespacemshadow.html">mshadow</a></li><li class="navelem"><a class="el" href="structmshadow_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="#pub-attribs">Public Attributes</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="structmshadow_1_1Shape-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mshadow::Shape&lt; dimension &gt; Struct Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>shape of a tensor
<a href="structmshadow_1_1Shape.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="tensor_8h_source.html">tensor.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for mshadow::Shape&lt; dimension &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="structmshadow_1_1Shape__coll__graph.png" border="0" usemap="#mshadow_1_1Shape_3_01dimension_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="mshadow_1_1Shape_3_01dimension_01_4_coll__map" id="mshadow_1_1Shape_3_01dimension_01_4_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:a841dd46bcd4bc0abf0f8c124e4f3a607"><td class="memItemLeft" align="right" valign="top"><a class="el" href="3rdparty_2mshadow_2mshadow_2base_8h.html#af205b8ab4d8733133d590df7d2639d69">MSHADOW_XINLINE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmshadow_1_1Shape.html#a841dd46bcd4bc0abf0f8c124e4f3a607">Shape</a> (void)</td></tr>
<tr class="memdesc:a841dd46bcd4bc0abf0f8c124e4f3a607"><td class="mdescLeft">&#160;</td><td class="mdescRight">default constructor, do nothing <a href="#a841dd46bcd4bc0abf0f8c124e4f3a607">More...</a><br /></td></tr>
<tr class="separator:a841dd46bcd4bc0abf0f8c124e4f3a607"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9fe553a887023d1ef284dbb018456fe8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="3rdparty_2mshadow_2mshadow_2base_8h.html#af205b8ab4d8733133d590df7d2639d69">MSHADOW_XINLINE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmshadow_1_1Shape.html#a9fe553a887023d1ef284dbb018456fe8">Shape</a> (const <a class="el" href="structmshadow_1_1Shape.html">Shape</a>&lt; <a class="el" href="structmshadow_1_1Shape.html#a04b162e49196e5799465fd8201de04b1">kDimension</a> &gt; &amp;s)</td></tr>
<tr class="memdesc:a9fe553a887023d1ef284dbb018456fe8"><td class="mdescLeft">&#160;</td><td class="mdescRight">constuctor <a href="#a9fe553a887023d1ef284dbb018456fe8">More...</a><br /></td></tr>
<tr class="separator:a9fe553a887023d1ef284dbb018456fe8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec509cb541250181ba664a4db41896e9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="3rdparty_2mshadow_2mshadow_2base_8h.html#af205b8ab4d8733133d590df7d2639d69">MSHADOW_XINLINE</a> <a class="el" href="namespacemshadow.html#adcbc2e1131386fccb1474b0bdf045926">index_t</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmshadow_1_1Shape.html#aec509cb541250181ba664a4db41896e9">operator[]</a> (int idx)</td></tr>
<tr class="memdesc:aec509cb541250181ba664a4db41896e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">get corresponding index <a href="#aec509cb541250181ba664a4db41896e9">More...</a><br /></td></tr>
<tr class="separator:aec509cb541250181ba664a4db41896e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a250af849ef7ee71f440cb91366c43473"><td class="memItemLeft" align="right" valign="top"><a class="el" href="3rdparty_2mshadow_2mshadow_2base_8h.html#af205b8ab4d8733133d590df7d2639d69">MSHADOW_XINLINE</a> const <a class="el" href="namespacemshadow.html#adcbc2e1131386fccb1474b0bdf045926">index_t</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmshadow_1_1Shape.html#a250af849ef7ee71f440cb91366c43473">operator[]</a> (int idx) const</td></tr>
<tr class="memdesc:a250af849ef7ee71f440cb91366c43473"><td class="mdescLeft">&#160;</td><td class="mdescRight">get corresponding index <a href="#a250af849ef7ee71f440cb91366c43473">More...</a><br /></td></tr>
<tr class="separator:a250af849ef7ee71f440cb91366c43473"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac101e89c424c3f5d2c37a369d8d7bb79"><td class="memItemLeft" align="right" valign="top"><a class="el" href="3rdparty_2mshadow_2mshadow_2base_8h.html#af205b8ab4d8733133d590df7d2639d69">MSHADOW_XINLINE</a> bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmshadow_1_1Shape.html#ac101e89c424c3f5d2c37a369d8d7bb79">operator==</a> (const <a class="el" href="structmshadow_1_1Shape.html">Shape</a>&lt; <a class="el" href="structmshadow_1_1Shape.html#a04b162e49196e5799465fd8201de04b1">kDimension</a> &gt; &amp;s) const</td></tr>
<tr class="separator:ac101e89c424c3f5d2c37a369d8d7bb79"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a610750c35aa0c76bb987458fc3fce90b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="3rdparty_2mshadow_2mshadow_2base_8h.html#af205b8ab4d8733133d590df7d2639d69">MSHADOW_XINLINE</a> bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmshadow_1_1Shape.html#a610750c35aa0c76bb987458fc3fce90b">operator!=</a> (const <a class="el" href="structmshadow_1_1Shape.html">Shape</a>&lt; <a class="el" href="structmshadow_1_1Shape.html#a04b162e49196e5799465fd8201de04b1">kDimension</a> &gt; &amp;s) const</td></tr>
<tr class="separator:a610750c35aa0c76bb987458fc3fce90b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a09790c1034fa223d2782736a0d053a75"><td class="memItemLeft" align="right" valign="top"><a class="el" href="3rdparty_2mshadow_2mshadow_2base_8h.html#af205b8ab4d8733133d590df7d2639d69">MSHADOW_XINLINE</a> <a class="el" href="structmshadow_1_1Shape.html">Shape</a>&lt; 1 &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmshadow_1_1Shape.html#a09790c1034fa223d2782736a0d053a75">FlatTo1D</a> (void) const</td></tr>
<tr class="separator:a09790c1034fa223d2782736a0d053a75"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a91c0fd04c351199f119950b044ad9c99"><td class="memItemLeft" align="right" valign="top"><a class="el" href="3rdparty_2mshadow_2mshadow_2base_8h.html#af205b8ab4d8733133d590df7d2639d69">MSHADOW_XINLINE</a> <a class="el" href="structmshadow_1_1Shape.html">Shape</a>&lt; 2 &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmshadow_1_1Shape.html#a91c0fd04c351199f119950b044ad9c99">FlatTo2D</a> (void) const</td></tr>
<tr class="separator:a91c0fd04c351199f119950b044ad9c99"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac6d667fde1a8180b64f475f5d33ea58f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="3rdparty_2mshadow_2mshadow_2base_8h.html#af205b8ab4d8733133d590df7d2639d69">MSHADOW_XINLINE</a> <a class="el" href="namespacemshadow.html#adcbc2e1131386fccb1474b0bdf045926">index_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmshadow_1_1Shape.html#ac6d667fde1a8180b64f475f5d33ea58f">Size</a> (void) const</td></tr>
<tr class="separator:ac6d667fde1a8180b64f475f5d33ea58f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a437b236671a35475edcf7aa5df2c6360"><td class="memItemLeft" align="right" valign="top"><a class="el" href="3rdparty_2mshadow_2mshadow_2base_8h.html#af205b8ab4d8733133d590df7d2639d69">MSHADOW_XINLINE</a> <a class="el" href="namespacemshadow.html#adcbc2e1131386fccb1474b0bdf045926">index_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmshadow_1_1Shape.html#a437b236671a35475edcf7aa5df2c6360">ProdShape</a> (int dimstart, int dimend) const</td></tr>
<tr class="separator:a437b236671a35475edcf7aa5df2c6360"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a40f409ff54982ded075f373aec6147a2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="3rdparty_2mshadow_2mshadow_2base_8h.html#af205b8ab4d8733133d590df7d2639d69">MSHADOW_XINLINE</a> <a class="el" href="structmshadow_1_1Shape.html">Shape</a>&lt; <a class="el" href="structmshadow_1_1Shape.html#a67c9939bcaa6fa12f5dc949041a0ef58">kSubdim</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmshadow_1_1Shape.html#a40f409ff54982ded075f373aec6147a2">SubShape</a> (void) const</td></tr>
<tr class="memdesc:a40f409ff54982ded075f373aec6147a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">get subshape that takes off largest dimension v * <a href="#a40f409ff54982ded075f373aec6147a2">More...</a><br /></td></tr>
<tr class="separator:a40f409ff54982ded075f373aec6147a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9cb540dcf4dec5d78456140505763bfa"><td class="memTemplParams" colspan="2">template&lt;int dimstart, int dimend&gt; </td></tr>
<tr class="memitem:a9cb540dcf4dec5d78456140505763bfa"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="3rdparty_2mshadow_2mshadow_2base_8h.html#af205b8ab4d8733133d590df7d2639d69">MSHADOW_XINLINE</a> <a class="el" href="structmshadow_1_1Shape.html">Shape</a>&lt; dimend - dimstart &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structmshadow_1_1Shape.html#a9cb540dcf4dec5d78456140505763bfa">Slice</a> (void) const</td></tr>
<tr class="memdesc:a9cb540dcf4dec5d78456140505763bfa"><td class="mdescLeft">&#160;</td><td class="mdescRight">slice the shape from start to end <a href="#a9cb540dcf4dec5d78456140505763bfa">More...</a><br /></td></tr>
<tr class="separator:a9cb540dcf4dec5d78456140505763bfa"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a398d94165ccfbaf1ba0e8fcbedfe48c6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacemshadow.html#adcbc2e1131386fccb1474b0bdf045926">index_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmshadow_1_1Shape.html#a398d94165ccfbaf1ba0e8fcbedfe48c6">shape_</a> [<a class="el" href="structmshadow_1_1Shape.html#a04b162e49196e5799465fd8201de04b1">kDimension</a>]</td></tr>
<tr class="memdesc:a398d94165ccfbaf1ba0e8fcbedfe48c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">storing the dimension information <a href="#a398d94165ccfbaf1ba0e8fcbedfe48c6">More...</a><br /></td></tr>
<tr class="separator:a398d94165ccfbaf1ba0e8fcbedfe48c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a04b162e49196e5799465fd8201de04b1"><td class="memItemLeft" align="right" valign="top">static const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmshadow_1_1Shape.html#a04b162e49196e5799465fd8201de04b1">kDimension</a> = dimension</td></tr>
<tr class="memdesc:a04b162e49196e5799465fd8201de04b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">dimension of current shape <a href="#a04b162e49196e5799465fd8201de04b1">More...</a><br /></td></tr>
<tr class="separator:a04b162e49196e5799465fd8201de04b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a67c9939bcaa6fa12f5dc949041a0ef58"><td class="memItemLeft" align="right" valign="top">static const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmshadow_1_1Shape.html#a67c9939bcaa6fa12f5dc949041a0ef58">kSubdim</a> = dimension - 1</td></tr>
<tr class="memdesc:a67c9939bcaa6fa12f5dc949041a0ef58"><td class="mdescLeft">&#160;</td><td class="mdescRight">dimension of current shape minus one <a href="#a67c9939bcaa6fa12f5dc949041a0ef58">More...</a><br /></td></tr>
<tr class="separator:a67c9939bcaa6fa12f5dc949041a0ef58"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;int dimension&gt;<br />
struct mshadow::Shape&lt; dimension &gt;</h3>
<p>shape of a tensor </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">dimension</td><td>dimension of tensor </td></tr>
</table>
</dd>
</dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a841dd46bcd4bc0abf0f8c124e4f3a607"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a841dd46bcd4bc0abf0f8c124e4f3a607">&#9670;&nbsp;</a></span>Shape() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int dimension&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="3rdparty_2mshadow_2mshadow_2base_8h.html#af205b8ab4d8733133d590df7d2639d69">MSHADOW_XINLINE</a> <a class="el" href="structmshadow_1_1Shape.html">mshadow::Shape</a>&lt; dimension &gt;::<a class="el" href="structmshadow_1_1Shape.html">Shape</a> </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>default constructor, do nothing </p>
</div>
</div>
<a id="a9fe553a887023d1ef284dbb018456fe8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9fe553a887023d1ef284dbb018456fe8">&#9670;&nbsp;</a></span>Shape() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int dimension&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="3rdparty_2mshadow_2mshadow_2base_8h.html#af205b8ab4d8733133d590df7d2639d69">MSHADOW_XINLINE</a> <a class="el" href="structmshadow_1_1Shape.html">mshadow::Shape</a>&lt; dimension &gt;::<a class="el" href="structmshadow_1_1Shape.html">Shape</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structmshadow_1_1Shape.html">Shape</a>&lt; <a class="el" href="structmshadow_1_1Shape.html#a04b162e49196e5799465fd8201de04b1">kDimension</a> &gt; &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>constuctor </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a09790c1034fa223d2782736a0d053a75"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a09790c1034fa223d2782736a0d053a75">&#9670;&nbsp;</a></span>FlatTo1D()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int dimension&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="3rdparty_2mshadow_2mshadow_2base_8h.html#af205b8ab4d8733133d590df7d2639d69">MSHADOW_XINLINE</a> <a class="el" href="structmshadow_1_1Shape.html">Shape</a>&lt;1&gt; <a class="el" href="structmshadow_1_1Shape.html">mshadow::Shape</a>&lt; dimension &gt;::FlatTo1D </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>flatten the tensor, return a 1D shape </p><dl class="section return"><dt>Returns</dt><dd>the flat 1d shape </dd></dl>
</div>
</div>
<a id="a91c0fd04c351199f119950b044ad9c99"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a91c0fd04c351199f119950b044ad9c99">&#9670;&nbsp;</a></span>FlatTo2D()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int dimension&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="3rdparty_2mshadow_2mshadow_2base_8h.html#af205b8ab4d8733133d590df7d2639d69">MSHADOW_XINLINE</a> <a class="el" href="structmshadow_1_1Shape.html">Shape</a>&lt;2&gt; <a class="el" href="structmshadow_1_1Shape.html">mshadow::Shape</a>&lt; dimension &gt;::FlatTo2D </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>flatten the higher dimension to second dimension, return a 2D shape </p><dl class="section return"><dt>Returns</dt><dd>the flat 2d shape </dd></dl>
</div>
</div>
<a id="a610750c35aa0c76bb987458fc3fce90b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a610750c35aa0c76bb987458fc3fce90b">&#9670;&nbsp;</a></span>operator!=()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int dimension&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="3rdparty_2mshadow_2mshadow_2base_8h.html#af205b8ab4d8733133d590df7d2639d69">MSHADOW_XINLINE</a> bool <a class="el" href="structmshadow_1_1Shape.html">mshadow::Shape</a>&lt; dimension &gt;::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structmshadow_1_1Shape.html">Shape</a>&lt; <a class="el" href="structmshadow_1_1Shape.html#a04b162e49196e5799465fd8201de04b1">kDimension</a> &gt; &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 equal </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="ac101e89c424c3f5d2c37a369d8d7bb79"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac101e89c424c3f5d2c37a369d8d7bb79">&#9670;&nbsp;</a></span>operator==()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int dimension&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="3rdparty_2mshadow_2mshadow_2base_8h.html#af205b8ab4d8733133d590df7d2639d69">MSHADOW_XINLINE</a> bool <a class="el" href="structmshadow_1_1Shape.html">mshadow::Shape</a>&lt; dimension &gt;::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structmshadow_1_1Shape.html">Shape</a>&lt; <a class="el" href="structmshadow_1_1Shape.html#a04b162e49196e5799465fd8201de04b1">kDimension</a> &gt; &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="aec509cb541250181ba664a4db41896e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aec509cb541250181ba664a4db41896e9">&#9670;&nbsp;</a></span>operator[]() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int dimension&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="3rdparty_2mshadow_2mshadow_2base_8h.html#af205b8ab4d8733133d590df7d2639d69">MSHADOW_XINLINE</a> <a class="el" href="namespacemshadow.html#adcbc2e1131386fccb1474b0bdf045926">index_t</a>&amp; <a class="el" href="structmshadow_1_1Shape.html">mshadow::Shape</a>&lt; dimension &gt;::operator[] </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>idx</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">idx</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="a250af849ef7ee71f440cb91366c43473"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a250af849ef7ee71f440cb91366c43473">&#9670;&nbsp;</a></span>operator[]() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int dimension&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="3rdparty_2mshadow_2mshadow_2base_8h.html#af205b8ab4d8733133d590df7d2639d69">MSHADOW_XINLINE</a> const <a class="el" href="namespacemshadow.html#adcbc2e1131386fccb1474b0bdf045926">index_t</a>&amp; <a class="el" href="structmshadow_1_1Shape.html">mshadow::Shape</a>&lt; dimension &gt;::operator[] </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>idx</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">idx</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="a437b236671a35475edcf7aa5df2c6360"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a437b236671a35475edcf7aa5df2c6360">&#9670;&nbsp;</a></span>ProdShape()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int dimension&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="3rdparty_2mshadow_2mshadow_2base_8h.html#af205b8ab4d8733133d590df7d2639d69">MSHADOW_XINLINE</a> <a class="el" href="namespacemshadow.html#adcbc2e1131386fccb1474b0bdf045926">index_t</a> <a class="el" href="structmshadow_1_1Shape.html">mshadow::Shape</a>&lt; dimension &gt;::ProdShape </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>dimstart</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>dimend</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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>product shape in [dimstart,dimend) </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dimstart</td><td>start dimension </td></tr>
<tr><td class="paramname">dimend</td><td>end dimension </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac6d667fde1a8180b64f475f5d33ea58f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac6d667fde1a8180b64f475f5d33ea58f">&#9670;&nbsp;</a></span>Size()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int dimension&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="3rdparty_2mshadow_2mshadow_2base_8h.html#af205b8ab4d8733133d590df7d2639d69">MSHADOW_XINLINE</a> <a class="el" href="namespacemshadow.html#adcbc2e1131386fccb1474b0bdf045926">index_t</a> <a class="el" href="structmshadow_1_1Shape.html">mshadow::Shape</a>&lt; dimension &gt;::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">
<dl class="section return"><dt>Returns</dt><dd>number of valid elements </dd></dl>
</div>
</div>
<a id="a9cb540dcf4dec5d78456140505763bfa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9cb540dcf4dec5d78456140505763bfa">&#9670;&nbsp;</a></span>Slice()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int dimension&gt; </div>
<div class="memtemplate">
template&lt;int dimstart, int dimend&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="3rdparty_2mshadow_2mshadow_2base_8h.html#af205b8ab4d8733133d590df7d2639d69">MSHADOW_XINLINE</a> <a class="el" href="structmshadow_1_1Shape.html">Shape</a>&lt;dimend - dimstart&gt; <a class="el" href="structmshadow_1_1Shape.html">mshadow::Shape</a>&lt; dimension &gt;::Slice </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>slice the shape from start to end </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">dimstart</td><td>start dimension </td></tr>
<tr><td class="paramname">dimend</td><td>end dimension </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the sliced shape </dd></dl>
</div>
</div>
<a id="a40f409ff54982ded075f373aec6147a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a40f409ff54982ded075f373aec6147a2">&#9670;&nbsp;</a></span>SubShape()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int dimension&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="3rdparty_2mshadow_2mshadow_2base_8h.html#af205b8ab4d8733133d590df7d2639d69">MSHADOW_XINLINE</a> <a class="el" href="structmshadow_1_1Shape.html">Shape</a>&lt;<a class="el" href="structmshadow_1_1Shape.html#a67c9939bcaa6fa12f5dc949041a0ef58">kSubdim</a>&gt; <a class="el" href="structmshadow_1_1Shape.html">mshadow::Shape</a>&lt; dimension &gt;::SubShape </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>get subshape that takes off largest dimension v * </p>
<dl class="section return"><dt>Returns</dt><dd>subshape </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a04b162e49196e5799465fd8201de04b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a04b162e49196e5799465fd8201de04b1">&#9670;&nbsp;</a></span>kDimension</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int dimension&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const int <a class="el" href="structmshadow_1_1Shape.html">mshadow::Shape</a>&lt; dimension &gt;::kDimension = dimension</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>dimension of current shape </p>
</div>
</div>
<a id="a67c9939bcaa6fa12f5dc949041a0ef58"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a67c9939bcaa6fa12f5dc949041a0ef58">&#9670;&nbsp;</a></span>kSubdim</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int dimension&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const int <a class="el" href="structmshadow_1_1Shape.html">mshadow::Shape</a>&lt; dimension &gt;::kSubdim = dimension - 1</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>dimension of current shape minus one </p>
</div>
</div>
<a id="a398d94165ccfbaf1ba0e8fcbedfe48c6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a398d94165ccfbaf1ba0e8fcbedfe48c6">&#9670;&nbsp;</a></span>shape_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;int dimension&gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacemshadow.html#adcbc2e1131386fccb1474b0bdf045926">index_t</a> <a class="el" href="structmshadow_1_1Shape.html">mshadow::Shape</a>&lt; dimension &gt;::shape_[<a class="el" href="structmshadow_1_1Shape.html#a04b162e49196e5799465fd8201de04b1">kDimension</a>]</td>
</tr>
</table>
</div><div class="memdoc">
<p>storing the dimension information </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>/work/mxnet/3rdparty/mshadow/mshadow/<a class="el" href="tensor_8h_source.html">tensor.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 &#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>