Google Git
Sign in
apache / mxnet-site / d5c5a235eef72f64ccaf224b834a20ef3287469b / . / versions / master / api / cpp / docs / api / classdmlc_1_1parameter_1_1FieldEntry_3_01mxnet_1_1TShape_01_4.html
blob: 3a67fb63b7b85acdff03482b9e32d89114224261 [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: dmlc::parameter::FieldEntry&lt; mxnet::TShape &gt; Class 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="namespacedmlc.html">dmlc</a></li><li class="navelem"><a class="el" href="namespacedmlc_1_1parameter.html">parameter</a></li><li class="navelem"><a class="el" href="classdmlc_1_1parameter_1_1FieldEntry_3_01mxnet_1_1TShape_01_4.html">FieldEntry&lt; mxnet::TShape &gt;</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classdmlc_1_1parameter_1_1FieldEntry_3_01mxnet_1_1TShape_01_4-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">dmlc::parameter::FieldEntry&lt; mxnet::TShape &gt; Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="tensor__blob_8h_source.html">tensor_blob.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for dmlc::parameter::FieldEntry&lt; mxnet::TShape &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classdmlc_1_1parameter_1_1FieldEntry_3_01mxnet_1_1TShape_01_4__inherit__graph.png" border="0" usemap="#dmlc_1_1parameter_1_1FieldEntry_3_01mxnet_1_1TShape_01_4_inherit__map" alt="Inheritance graph"/></div>
<!-- MAP 0 -->
</div>
<div class="dynheader">
Collaboration diagram for dmlc::parameter::FieldEntry&lt; mxnet::TShape &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classdmlc_1_1parameter_1_1FieldEntry_3_01mxnet_1_1TShape_01_4__coll__graph.png" border="0" usemap="#dmlc_1_1parameter_1_1FieldEntry_3_01mxnet_1_1TShape_01_4_coll__map" alt="Collaboration graph"/></div>
<!-- MAP 1 -->
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ac6a42c993f66fceb5022b330e5672b6c"><td class="memItemLeft" align="right" valign="top">typedef FieldEntryBase&lt; <a class="el" href="classdmlc_1_1parameter_1_1FieldEntry_3_01mxnet_1_1TShape_01_4.html#a0755f0abe443e4b57da234ec7b49fde0">FieldEntry</a>&lt; <a class="el" href="classmxnet_1_1TShape.html">mxnet::TShape</a> &gt;, <a class="el" href="classmxnet_1_1TShape.html">mxnet::TShape</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1parameter_1_1FieldEntry_3_01mxnet_1_1TShape_01_4.html#ac6a42c993f66fceb5022b330e5672b6c">Parent</a></td></tr>
<tr class="separator:ac6a42c993f66fceb5022b330e5672b6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a0755f0abe443e4b57da234ec7b49fde0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1parameter_1_1FieldEntry_3_01mxnet_1_1TShape_01_4.html#a0755f0abe443e4b57da234ec7b49fde0">FieldEntry</a> ()</td></tr>
<tr class="separator:a0755f0abe443e4b57da234ec7b49fde0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6795bc6e9e883adf946f69e16c644788"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1parameter_1_1FieldEntry_3_01mxnet_1_1TShape_01_4.html#a6795bc6e9e883adf946f69e16c644788">Check</a> (void *head) const</td></tr>
<tr class="separator:a6795bc6e9e883adf946f69e16c644788"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afa1da539bf9bcb64d3b5a55aec23e8c2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdmlc_1_1parameter_1_1FieldEntry_3_01mxnet_1_1TShape_01_4.html#a0755f0abe443e4b57da234ec7b49fde0">FieldEntry</a>&lt; <a class="el" href="classmxnet_1_1TShape.html">mxnet::TShape</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1parameter_1_1FieldEntry_3_01mxnet_1_1TShape_01_4.html#afa1da539bf9bcb64d3b5a55aec23e8c2">enforce_nonzero</a> ()</td></tr>
<tr class="separator:afa1da539bf9bcb64d3b5a55aec23e8c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a66f7111b4492f16511239f527b014af6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdmlc_1_1parameter_1_1FieldEntry_3_01mxnet_1_1TShape_01_4.html#a0755f0abe443e4b57da234ec7b49fde0">FieldEntry</a>&lt; <a class="el" href="classmxnet_1_1TShape.html">mxnet::TShape</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1parameter_1_1FieldEntry_3_01mxnet_1_1TShape_01_4.html#a66f7111b4492f16511239f527b014af6">set_expect_ndim</a> (int ndim)</td></tr>
<tr class="separator:a66f7111b4492f16511239f527b014af6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Typedef Documentation</h2>
<a id="ac6a42c993f66fceb5022b330e5672b6c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac6a42c993f66fceb5022b330e5672b6c">&#9670;&nbsp;</a></span>Parent</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef FieldEntryBase&lt;<a class="el" href="classdmlc_1_1parameter_1_1FieldEntry_3_01mxnet_1_1TShape_01_4.html#a0755f0abe443e4b57da234ec7b49fde0">FieldEntry</a>&lt;<a class="el" href="classmxnet_1_1TShape.html">mxnet::TShape</a>&gt;, <a class="el" href="classmxnet_1_1TShape.html">mxnet::TShape</a>&gt; dmlc::parameter::FieldEntry&lt; <a class="el" href="classmxnet_1_1TShape.html">mxnet::TShape</a> &gt;::<a class="el" href="classdmlc_1_1parameter_1_1FieldEntry_3_01mxnet_1_1TShape_01_4.html#ac6a42c993f66fceb5022b330e5672b6c">Parent</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a0755f0abe443e4b57da234ec7b49fde0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0755f0abe443e4b57da234ec7b49fde0">&#9670;&nbsp;</a></span>FieldEntry()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">dmlc::parameter::FieldEntry&lt; <a class="el" href="classmxnet_1_1TShape.html">mxnet::TShape</a> &gt;::FieldEntry </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">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a6795bc6e9e883adf946f69e16c644788"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6795bc6e9e883adf946f69e16c644788">&#9670;&nbsp;</a></span>Check()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void dmlc::parameter::FieldEntry&lt; <a class="el" href="classmxnet_1_1TShape.html">mxnet::TShape</a> &gt;::Check </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>head</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="afa1da539bf9bcb64d3b5a55aec23e8c2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afa1da539bf9bcb64d3b5a55aec23e8c2">&#9670;&nbsp;</a></span>enforce_nonzero()</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="classdmlc_1_1parameter_1_1FieldEntry_3_01mxnet_1_1TShape_01_4.html#a0755f0abe443e4b57da234ec7b49fde0">FieldEntry</a>&lt;<a class="el" href="classmxnet_1_1TShape.html">mxnet::TShape</a>&gt;&amp; dmlc::parameter::FieldEntry&lt; <a class="el" href="classmxnet_1_1TShape.html">mxnet::TShape</a> &gt;::enforce_nonzero </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">
</div>
</div>
<a id="a66f7111b4492f16511239f527b014af6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a66f7111b4492f16511239f527b014af6">&#9670;&nbsp;</a></span>set_expect_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="classdmlc_1_1parameter_1_1FieldEntry_3_01mxnet_1_1TShape_01_4.html#a0755f0abe443e4b57da234ec7b49fde0">FieldEntry</a>&lt;<a class="el" href="classmxnet_1_1TShape.html">mxnet::TShape</a>&gt;&amp; dmlc::parameter::FieldEntry&lt; <a class="el" href="classmxnet_1_1TShape.html">mxnet::TShape</a> &gt;::set_expect_ndim </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>ndim</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">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/work/mxnet/include/mxnet/<a class="el" href="tensor__blob_8h_source.html">tensor_blob.h</a></li>
</ul>
</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>