Google Git
Sign in
apache / mxnet-site / d5c5a235eef72f64ccaf224b834a20ef3287469b / . / versions / master / api / cpp / docs / api / include_2mxnet_2tuple_8h.html
blob: a754b4f76f0a12094f0456b8cfad0069fd79cec1 [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/tuple.h File 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.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> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#namespaces">Namespaces</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">tuple.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Data structure Tuple and TShape to store dynamic sized shapes.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;vector&gt;</code><br />
<code>#include &lt;type_traits&gt;</code><br />
<code>#include &lt;algorithm&gt;</code><br />
<code>#include &lt;utility&gt;</code><br />
<code>#include &lt;iostream&gt;</code><br />
<code>#include &lt;string&gt;</code><br />
<code>#include &quot;<a class="el" href="3rdparty_2tvm_2nnvm_2include_2nnvm_2op__attr__types_8h_source.html">nnvm/op_attr_types.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="3rdparty_2tvm_2nnvm_2include_2nnvm_2graph__attr__types_8h_source.html">nnvm/graph_attr_types.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="graph_8h_source.html">nnvm/graph.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="pass_8h_source.html">nnvm/pass.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="object_8h_source.html">runtime/object.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="ffi__helper_8h_source.html">runtime/ffi_helper.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="node_2container_8h_source.html">node/container.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="expr_8h_source.html">ir/expr.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for tuple.h:</div>
<div class="dyncontent">
<div class="center"><img src="include_2mxnet_2tuple_8h__incl.png" border="0" usemap="#_2work_2mxnet_2include_2mxnet_2tuple_8h" alt=""/></div>
<!-- MAP 0 -->
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="include_2mxnet_2tuple_8h__dep__incl.png" border="0" usemap="#_2work_2mxnet_2include_2mxnet_2tuple_8hdep" alt=""/></div>
<!-- MAP 1 -->
</div>
</div>
<p><a href="include_2mxnet_2tuple_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1Tuple.html">mxnet::Tuple&lt; ValueType &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A dynamic sized array data structure that is optimized for storing small number of elements with same type. <a href="classmxnet_1_1Tuple.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmxnet_1_1TShape.html">mxnet::TShape</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A Shape class that is used to represent shape of each tensor. <a href="classmxnet_1_1TShape.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structstd_1_1hash_3_01mxnet_1_1Tuple_3_01T_01_4_01_4.html">std::hash&lt; mxnet::Tuple&lt; T &gt; &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">hash function for Tuple. <a href="structstd_1_1hash_3_01mxnet_1_1Tuple_3_01T_01_4_01_4.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structstd_1_1hash_3_01mxnet_1_1TShape_01_4.html">std::hash&lt; mxnet::TShape &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">hash function for TShape. <a href="structstd_1_1hash_3_01mxnet_1_1TShape_01_4.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdmlc_1_1type__name__helper_3_01mxnet_1_1Tuple_3_01T_01_4_01_4.html">dmlc::type_name_helper&lt; mxnet::Tuple&lt; T &gt; &gt;</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespacemxnet"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet.html">mxnet</a></td></tr>
<tr class="memdesc:namespacemxnet"><td class="mdescLeft">&#160;</td><td class="mdescRight">namespace of mxnet <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespacestd"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacestd.html">std</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespacedmlc"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacedmlc.html">dmlc</a></td></tr>
<tr class="memdesc:namespacedmlc"><td class="mdescLeft">&#160;</td><td class="mdescRight">namespace for dmlc <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a87e1c30aafac389774c6f4d905c0e5ea"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet.html#a87e1c30aafac389774c6f4d905c0e5ea">mxnet::ShapeVector</a> = std::vector&lt; <a class="el" href="classmxnet_1_1TShape.html">mxnet::TShape</a> &gt;</td></tr>
<tr class="memdesc:a87e1c30aafac389774c6f4d905c0e5ea"><td class="mdescLeft">&#160;</td><td class="mdescRight">The result holder of shape of each NodeEntry in the graph. <a href="namespacemxnet.html#a87e1c30aafac389774c6f4d905c0e5ea">More...</a><br /></td></tr>
<tr class="separator:a87e1c30aafac389774c6f4d905c0e5ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad58e24850ee80ff4ccfe160fd1ffa6c1"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet.html#ad58e24850ee80ff4ccfe160fd1ffa6c1">mxnet::FInferShape</a> = <a class="el" href="namespacennvm.html#a4e51cf5506d5c8a9a70be11fa6a9d1e1">nnvm::FInferNodeEntryAttr</a>&lt; <a class="el" href="classmxnet_1_1TShape.html">mxnet::TShape</a> &gt;</td></tr>
<tr class="memdesc:ad58e24850ee80ff4ccfe160fd1ffa6c1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Shape inference function. Update the shapes given the input shape information. <a class="el" href="classmxnet_1_1Tuple.html#a6e0bdfe3f0f34693223f657ef676bef6">TShape.ndim()</a> == -1 means the shape is still unknown. <a href="namespacemxnet.html#ad58e24850ee80ff4ccfe160fd1ffa6c1">More...</a><br /></td></tr>
<tr class="separator:ad58e24850ee80ff4ccfe160fd1ffa6c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a429718781f8f77397f9437016511be6e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet.html#a429718781f8f77397f9437016511be6e">mxnet::ndim_is_known</a> (const int ndim)</td></tr>
<tr class="separator:a429718781f8f77397f9437016511be6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4ddc5fdc5ddb39296ad9606e99fdcd5a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet.html#a4ddc5fdc5ddb39296ad9606e99fdcd5a">mxnet::dim_size_is_known</a> (const <a class="el" href="include_2mxnet_2c__api_8h.html#ab15fcfeedbe50ea6db54a98b582d7eaf">dim_t</a> dim_size)</td></tr>
<tr class="separator:a4ddc5fdc5ddb39296ad9606e99fdcd5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb878a67c0368b32a9baf1ef654eb855"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet.html#afb878a67c0368b32a9baf1ef654eb855">mxnet::ndim_is_known</a> (const TShape &amp;x)</td></tr>
<tr class="separator:afb878a67c0368b32a9baf1ef654eb855"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abfa461d1d4f7eca161d63c5e60e7217f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet.html#abfa461d1d4f7eca161d63c5e60e7217f">mxnet::dim_size_is_known</a> (const TShape &amp;x, const int idx)</td></tr>
<tr class="separator:abfa461d1d4f7eca161d63c5e60e7217f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6c29d398f4166fdc0f95f63ce0ef66ee"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet.html#a6c29d398f4166fdc0f95f63ce0ef66ee">mxnet::shape_is_known</a> (const TShape &amp;x)</td></tr>
<tr class="separator:a6c29d398f4166fdc0f95f63ce0ef66ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae7f255485143a22ed0274d70598e562"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemxnet.html#aae7f255485143a22ed0274d70598e562">mxnet::shape_is_known</a> (const std::vector&lt; TShape &gt; &amp;shapes)</td></tr>
<tr class="separator:aae7f255485143a22ed0274d70598e562"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af0b1cf5c3dc47bf0e258fa888323a3d9"><td class="memTemplParams" colspan="2">template&lt;typename SrcIter , typename DstIter &gt; </td></tr>
<tr class="memitem:af0b1cf5c3dc47bf0e258fa888323a3d9"><td class="memTemplItemLeft" align="right" valign="top">DstIter&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacemxnet.html#af0b1cf5c3dc47bf0e258fa888323a3d9">mxnet::ShapeTypeCast</a> (const SrcIter begin, const SrcIter end, DstIter dst_begin)</td></tr>
<tr class="memdesc:af0b1cf5c3dc47bf0e258fa888323a3d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">helper function to cast type of container elements <a href="namespacemxnet.html#af0b1cf5c3dc47bf0e258fa888323a3d9">More...</a><br /></td></tr>
<tr class="separator:af0b1cf5c3dc47bf0e258fa888323a3d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae0aa7f65ef62500c7c978d4f577ff8bf"><td class="memTemplParams" colspan="2">template&lt;typename SrcIter &gt; </td></tr>
<tr class="memitem:ae0aa7f65ef62500c7c978d4f577ff8bf"><td class="memTemplItemLeft" align="right" valign="top">TShape&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacemxnet.html#ae0aa7f65ef62500c7c978d4f577ff8bf">mxnet::ShapeTypeCast</a> (const SrcIter begin, const SrcIter end)</td></tr>
<tr class="memdesc:ae0aa7f65ef62500c7c978d4f577ff8bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">helper function to transform a container to <a class="el" href="classmxnet_1_1TShape.html" title="A Shape class that is used to represent shape of each tensor.">TShape</a> with type cast <a href="namespacemxnet.html#ae0aa7f65ef62500c7c978d4f577ff8bf">More...</a><br /></td></tr>
<tr class="separator:ae0aa7f65ef62500c7c978d4f577ff8bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6f13d1bc9e12df076ed8f73ac0d11c5a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacedmlc.html#a6f13d1bc9e12df076ed8f73ac0d11c5a">dmlc::DMLC_DECLARE_TYPE_NAME</a> (optional&lt; <a class="el" href="classmxnet_1_1TShape.html">mxnet::TShape</a> &gt;, &quot;Shape or None&quot;)</td></tr>
<tr class="memdesc:a6f13d1bc9e12df076ed8f73ac0d11c5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">description for optional TShape <a href="namespacedmlc.html#a6f13d1bc9e12df076ed8f73ac0d11c5a">More...</a><br /></td></tr>
<tr class="separator:a6f13d1bc9e12df076ed8f73ac0d11c5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1fd8e239269862ad1ff453307e8dfc3a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacedmlc.html#a1fd8e239269862ad1ff453307e8dfc3a">dmlc::DMLC_DECLARE_TYPE_NAME</a> (optional&lt; <a class="el" href="classmxnet_1_1Tuple.html">mxnet::Tuple</a>&lt; int &gt;&gt;, &quot;Shape or None&quot;)</td></tr>
<tr class="separator:a1fd8e239269862ad1ff453307e8dfc3a"><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>Data structure Tuple and TShape to store dynamic sized shapes. </p>
</div></div><!-- contents -->
<!-- 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>