Google Git
Sign in
apache / mxnet-site / d5c5a235eef72f64ccaf224b834a20ef3287469b / . / versions / 1.9.1 / api / cpp / docs / api / structdnnl__reduction__desc__t.html
blob: 44abd9472b63977f29ad9a922a8b43251c08b968 [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: dnnl_reduction_desc_t 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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structdnnl__reduction__desc__t-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">dnnl_reduction_desc_t Struct Reference<div class="ingroups"><a class="el" href="group__dnnl__api.html">Dnnl_api</a> &raquo; <a class="el" href="group__dnnl__api__primitives.html">Dnnl_api_primitives</a> &raquo; <a class="el" href="group__dnnl__api__reduction.html">Reduction</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>A descriptor of reduction operation.
<a href="structdnnl__reduction__desc__t.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="oneapi_2dnnl_2dnnl__types_8h_source.html">dnnl_types.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for dnnl_reduction_desc_t:</div>
<div class="dyncontent">
<div class="center"><img src="structdnnl__reduction__desc__t__coll__graph.png" border="0" usemap="#dnnl__reduction__desc__t_coll__map" alt="Collaboration graph"/></div>
<map name="dnnl__reduction__desc__t_coll__map" id="dnnl__reduction__desc__t_coll__map">
<area shape="rect" id="node2" href="structdnnl__memory__desc__t.html" title="{dnnl_memory_desc_t\n|+ ndims\l+ dims\l+ data_type\l+ padded_dims\l+ padded_offsets\l+ offset0\l+ format_kind\l+ format_desc\l|}" alt="" coords="264,292,425,472"/>
<area shape="rect" id="node3" href="structdnnl__wino__desc__t.html" title="Description of tensor of weights for winograd 2x3 convolution. " alt="" coords="5,5,143,229"/>
<area shape="rect" id="node4" href="structdnnl__blocking__desc__t.html" title="{dnnl_blocking_desc_t\n|+ strides\l+ inner_nblks\l+ inner_blks\l+ inner_idxs\l|}" alt="" coords="167,57,328,178"/>
<area shape="rect" id="node5" href="structdnnl__rnn__packed__desc__t.html" title="Description of tensor of packed weights for rnn. " alt="" coords="353,13,534,222"/>
<area shape="rect" id="node6" href="structdnnl__memory__extra__desc__t.html" title="Description of extra information stored in memory. " alt="" coords="559,49,787,185"/>
</map>
</div>
<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:abe4e6b2f3798b2144784974e87a9b884"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__dnnl__api__primitives__common.html#ga9878f4795e53ad8443e5c0a29e53286a">dnnl_primitive_kind_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdnnl__reduction__desc__t.html#abe4e6b2f3798b2144784974e87a9b884">primitive_kind</a></td></tr>
<tr class="separator:abe4e6b2f3798b2144784974e87a9b884"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a835996fde0c166f98cafacad81a721cd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__dnnl__api__primitives__common.html#ga96946c805f6c4922c38c37049ab95d23">dnnl_alg_kind_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdnnl__reduction__desc__t.html#a835996fde0c166f98cafacad81a721cd">alg_kind</a></td></tr>
<tr class="separator:a835996fde0c166f98cafacad81a721cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa0daa0060d84d01fc44cdc2b2c265dc6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structdnnl__memory__desc__t.html">dnnl_memory_desc_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdnnl__reduction__desc__t.html#aa0daa0060d84d01fc44cdc2b2c265dc6">src_desc</a></td></tr>
<tr class="memdesc:aa0daa0060d84d01fc44cdc2b2c265dc6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Source memory descriptor. <a href="#aa0daa0060d84d01fc44cdc2b2c265dc6">More...</a><br /></td></tr>
<tr class="separator:aa0daa0060d84d01fc44cdc2b2c265dc6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a051a063de9837b53c804bb84bcaff800"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structdnnl__memory__desc__t.html">dnnl_memory_desc_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdnnl__reduction__desc__t.html#a051a063de9837b53c804bb84bcaff800">dst_desc</a></td></tr>
<tr class="memdesc:a051a063de9837b53c804bb84bcaff800"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destination memory descriptor. <a href="#a051a063de9837b53c804bb84bcaff800">More...</a><br /></td></tr>
<tr class="separator:a051a063de9837b53c804bb84bcaff800"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6416796e8e4e6baa165f613464473445"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdnnl__reduction__desc__t.html#a6416796e8e4e6baa165f613464473445">p</a></td></tr>
<tr class="separator:a6416796e8e4e6baa165f613464473445"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa4ad9b484420e66d5158ffc86d92f7e8"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdnnl__reduction__desc__t.html#aa4ad9b484420e66d5158ffc86d92f7e8">eps</a></td></tr>
<tr class="separator:aa4ad9b484420e66d5158ffc86d92f7e8"><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>A descriptor of reduction operation. </p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="a835996fde0c166f98cafacad81a721cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a835996fde0c166f98cafacad81a721cd">&#9670;&nbsp;</a></span>alg_kind</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__dnnl__api__primitives__common.html#ga96946c805f6c4922c38c37049ab95d23">dnnl_alg_kind_t</a> dnnl_reduction_desc_t::alg_kind</td>
</tr>
</table>
</div><div class="memdoc">
<p>The kind of reduction algorithm. Possible values: <a class="el" href="group__dnnl__api__primitives__common.html#gga96946c805f6c4922c38c37049ab95d23aae4722e394206cf9774ae45db959854e" title="Reduction using max. ">dnnl_reduction_max</a>, <a class="el" href="group__dnnl__api__primitives__common.html#gga96946c805f6c4922c38c37049ab95d23a3edeac87290d164cfd3e79adcb6ed91a" title="Reduction using min. ">dnnl_reduction_min</a>, <a class="el" href="group__dnnl__api__primitives__common.html#gga96946c805f6c4922c38c37049ab95d23ae74491a0b7bfe0720be69e3732894818" title="Reduction using sum. ">dnnl_reduction_sum</a>, <a class="el" href="group__dnnl__api__primitives__common.html#gga96946c805f6c4922c38c37049ab95d23a9ff432e67749e211f5f0f64d5f707359" title="Reduction using mul. ">dnnl_reduction_mul</a>, <a class="el" href="group__dnnl__api__primitives__common.html#gga96946c805f6c4922c38c37049ab95d23ac88d2b9bc130483c177868888c705694" title="Reduction using mean. ">dnnl_reduction_mean</a>, <a class="el" href="group__dnnl__api__primitives__common.html#gga96946c805f6c4922c38c37049ab95d23ad6459b4162ab312f59fa48bf9dcf35c3" title="Reduction using lp norm. ">dnnl_reduction_norm_lp_max</a>, <a class="el" href="group__dnnl__api__primitives__common.html#gga96946c805f6c4922c38c37049ab95d23a21c93597a1be438219bbbd832830f096" title="Reduction using lp norm. ">dnnl_reduction_norm_lp_sum</a>, <a class="el" href="group__dnnl__api__primitives__common.html#gga96946c805f6c4922c38c37049ab95d23a3838df4d5d37de3237359043ccebfba1" title="Reduction using lp norm without final pth-root. ">dnnl_reduction_norm_lp_power_p_max</a>, <a class="el" href="group__dnnl__api__primitives__common.html#gga96946c805f6c4922c38c37049ab95d23adcb83e9f76b3beaeb831a59cd257d7dd" title="Reduction using lp norm without final pth-root. ">dnnl_reduction_norm_lp_power_p_sum</a>. </p>
</div>
</div>
<a id="a051a063de9837b53c804bb84bcaff800"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a051a063de9837b53c804bb84bcaff800">&#9670;&nbsp;</a></span>dst_desc</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structdnnl__memory__desc__t.html">dnnl_memory_desc_t</a> dnnl_reduction_desc_t::dst_desc</td>
</tr>
</table>
</div><div class="memdoc">
<p>Destination memory descriptor. </p>
</div>
</div>
<a id="aa4ad9b484420e66d5158ffc86d92f7e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa4ad9b484420e66d5158ffc86d92f7e8">&#9670;&nbsp;</a></span>eps</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float dnnl_reduction_desc_t::eps</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a6416796e8e4e6baa165f613464473445"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6416796e8e4e6baa165f613464473445">&#9670;&nbsp;</a></span>p</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float dnnl_reduction_desc_t::p</td>
</tr>
</table>
</div><div class="memdoc">
<p>Algorithm specific parameters. Accordance table: <a class="el" href="group__dnnl__api__primitives__common.html#gga96946c805f6c4922c38c37049ab95d23aae4722e394206cf9774ae45db959854e" title="Reduction using max. ">dnnl_reduction_max</a>: <code>p</code> and <code>eps</code> are ignored <a class="el" href="group__dnnl__api__primitives__common.html#gga96946c805f6c4922c38c37049ab95d23a3edeac87290d164cfd3e79adcb6ed91a" title="Reduction using min. ">dnnl_reduction_min</a>: <code>p</code> and <code>eps</code> are ignored <a class="el" href="group__dnnl__api__primitives__common.html#gga96946c805f6c4922c38c37049ab95d23ad6459b4162ab312f59fa48bf9dcf35c3" title="Reduction using lp norm. ">dnnl_reduction_norm_lp_max</a>: <code>p</code> &ndash; power, <code>eps</code> &ndash; epsilon <a class="el" href="group__dnnl__api__primitives__common.html#gga96946c805f6c4922c38c37049ab95d23a21c93597a1be438219bbbd832830f096" title="Reduction using lp norm. ">dnnl_reduction_norm_lp_sum</a>: <code>p</code> &ndash; power, <code>eps</code> &ndash; epsilon <a class="el" href="group__dnnl__api__primitives__common.html#gga96946c805f6c4922c38c37049ab95d23a3838df4d5d37de3237359043ccebfba1" title="Reduction using lp norm without final pth-root. ">dnnl_reduction_norm_lp_power_p_max</a>: <code>p</code> &ndash; power, <code>eps</code> &ndash; epsilon <a class="el" href="group__dnnl__api__primitives__common.html#gga96946c805f6c4922c38c37049ab95d23adcb83e9f76b3beaeb831a59cd257d7dd" title="Reduction using lp norm without final pth-root. ">dnnl_reduction_norm_lp_power_p_sum</a>: <code>p</code> &ndash; power, <code>eps</code> &ndash; epsilon <a class="el" href="group__dnnl__api__primitives__common.html#gga96946c805f6c4922c38c37049ab95d23ae74491a0b7bfe0720be69e3732894818" title="Reduction using sum. ">dnnl_reduction_sum</a>: <code>p</code> and <code>eps</code> are ignored <a class="el" href="group__dnnl__api__primitives__common.html#gga96946c805f6c4922c38c37049ab95d23a9ff432e67749e211f5f0f64d5f707359" title="Reduction using mul. ">dnnl_reduction_mul</a>: <code>p</code> and <code>eps</code> are ignored <a class="el" href="group__dnnl__api__primitives__common.html#gga96946c805f6c4922c38c37049ab95d23ac88d2b9bc130483c177868888c705694" title="Reduction using mean. ">dnnl_reduction_mean</a>: <code>p</code> and <code>eps</code> are ignored </p>
</div>
</div>
<a id="abe4e6b2f3798b2144784974e87a9b884"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe4e6b2f3798b2144784974e87a9b884">&#9670;&nbsp;</a></span>primitive_kind</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__dnnl__api__primitives__common.html#ga9878f4795e53ad8443e5c0a29e53286a">dnnl_primitive_kind_t</a> dnnl_reduction_desc_t::primitive_kind</td>
</tr>
</table>
</div><div class="memdoc">
<p>The kind of primitive. Used for self-identifying the primitive descriptor. Must be <a class="el" href="group__dnnl__api__primitives__common.html#gga9878f4795e53ad8443e5c0a29e53286aaf3bb69107badd983d16909afe507ed04" title="A reduction primitive. ">dnnl_reduction</a>. </p>
</div>
</div>
<a id="aa0daa0060d84d01fc44cdc2b2c265dc6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa0daa0060d84d01fc44cdc2b2c265dc6">&#9670;&nbsp;</a></span>src_desc</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structdnnl__memory__desc__t.html">dnnl_memory_desc_t</a> dnnl_reduction_desc_t::src_desc</td>
</tr>
</table>
</div><div class="memdoc">
<p>Source memory descriptor. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>/work/mxnet/include/mkldnn/oneapi/dnnl/<a class="el" href="oneapi_2dnnl_2dnnl__types_8h_source.html">dnnl_types.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>