versions/1.9.1/api/cpp/docs/api/group__dnnl__api__reduction.html - mxnet-site - Git at Google

 <!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: Reduction</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>
 </div><!-- top -->
 <!-- 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 class="header">
   <div class="summary">
 <a href="#nested-classes">Classes</a> &#124;
 <a href="#func-members">Functions</a>  </div>
   <div class="headertitle">
 <div class="title">Reduction<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></div></div>  </div>
 </div><!--header-->
 <div class="contents">
 <div class="dynheader">
 Collaboration diagram for Reduction:</div>
 <div class="dyncontent">
 <center><table><tr><td><img src="group__dnnl__api__reduction.png" border="0" alt="" usemap="#group____dnnl____api____reduction"/>
 <map name="group____dnnl____api____reduction" id="group____dnnl____api____reduction">
 <area shape="rect" id="node2" href="group__dnnl__api__primitives.html" title="Dnnl_api_primitives" alt="" coords="5,5,157,32"/>
 </map>
 </td></tr></table></center>
 </div>
 <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">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structdnnl__reduction__desc__t.html">dnnl_reduction_desc_t</a></td></tr>
 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A descriptor of reduction operation.  <a href="structdnnl__reduction__desc__t.html#details">More...</a><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="func-members"></a>
 Functions</h2></td></tr>
 <tr class="memitem:ga507b07a09447e911f68d11aad0fecdde"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dnnl__api__reduction.html#ga507b07a09447e911f68d11aad0fecdde">dnnl_reduction_desc_init</a> (<a class="el" href="structdnnl__reduction__desc__t.html">dnnl_reduction_desc_t</a> *desc, <a class="el" href="group__dnnl__api__primitives__common.html#ga96946c805f6c4922c38c37049ab95d23">dnnl_alg_kind_t</a> alg_kind, const <a class="el" href="structdnnl__memory__desc__t.html">dnnl_memory_desc_t</a> *src_desc, const <a class="el" href="structdnnl__memory__desc__t.html">dnnl_memory_desc_t</a> *dst_desc, float p, float eps)</td></tr>
 <tr class="separator:ga507b07a09447e911f68d11aad0fecdde"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 <h2 class="groupheader">Function Documentation</h2>
 <a id="ga507b07a09447e911f68d11aad0fecdde"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#ga507b07a09447e911f68d11aad0fecdde">&#9670;&nbsp;</a></span>dnnl_reduction_desc_init()</h2>

 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API dnnl_reduction_desc_init </td>
           <td>(</td>
           <td class="paramtype"><a class="el" href="structdnnl__reduction__desc__t.html">dnnl_reduction_desc_t</a> *&#160;</td>
           <td class="paramname"><em>desc</em>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype"><a class="el" href="group__dnnl__api__primitives__common.html#ga96946c805f6c4922c38c37049ab95d23">dnnl_alg_kind_t</a>&#160;</td>
           <td class="paramname"><em>alg_kind</em>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype">const <a class="el" href="structdnnl__memory__desc__t.html">dnnl_memory_desc_t</a> *&#160;</td>
           <td class="paramname"><em>src_desc</em>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype">const <a class="el" href="structdnnl__memory__desc__t.html">dnnl_memory_desc_t</a> *&#160;</td>
           <td class="paramname"><em>dst_desc</em>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype">float&#160;</td>
           <td class="paramname"><em>p</em>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype">float&#160;</td>
           <td class="paramname"><em>eps</em>&#160;</td>
         </tr>
         <tr>
           <td></td>
           <td>)</td>
           <td></td><td></td>
         </tr>
       </table>
 </div><div class="memdoc">
 <p>Initializes a descriptor for a reduction primitive.</p>
 <dl class="section note"><dt>Note</dt><dd>Destination memory descriptor is allowed to be initialized with <a class="el" href="group__dnnl__api__memory.html#gga395e42b594683adb25ed2d842bb3091dafee39ac6fff0325cae43cd66495c18ac">dnnl_format_tag_any</a> or with format_kind set to <a class="el" href="group__dnnl__api__memory.html#ggaa75cad747fa467d9dc527d943ba3367da77ae35388e04dc3e98d90675a7110c83">dnnl_format_kind_any</a>.</dd></dl>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">desc</td><td>Output descriptor for a reduction primitive. </td></tr>
     <tr><td class="paramname">alg_kind</td><td>reduction algorithm kind. 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>. </td></tr>
     <tr><td class="paramname">p</td><td>Algorithm specific parameter. </td></tr>
     <tr><td class="paramname">eps</td><td>Algorithm specific parameter. </td></tr>
     <tr><td class="paramname">src_desc</td><td>Source memory descriptor. </td></tr>
     <tr><td class="paramname">dst_desc</td><td>Destination memory descriptor. </td></tr>
   </table>
   </dd>
 </dl>
 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__dnnl__api__utils.html#ggad24f9ded06e34d3ee71e7fc4b408d57aaa31395e9dccc103cf166cf7b38fc5b9c" title="The operation was successful. ">dnnl_success</a> on success and a status describing the error otherwise. </dd></dl>

 </div>
 </div>
 </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>
	<!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: Reduction</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>
	</div><!-- top -->
	<!-- 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 class="header">
	<div class="summary">
	<a href="#nested-classes">Classes</a> \|
	<a href="#func-members">Functions</a> </div>
	<div class="headertitle">
	<div class="title">Reduction<div class="ingroups"><a class="el" href="group__dnnl__api.html">Dnnl_api</a> » <a class="el" href="group__dnnl__api__primitives.html">Dnnl_api_primitives</a></div></div> </div>
	</div><!--header-->
	<div class="contents">
	<div class="dynheader">
	Collaboration diagram for Reduction:</div>
	<div class="dyncontent">
	<center><table><tr><td><img src="group__dnnl__api__reduction.png" border="0" alt="" usemap="#group____dnnl____api____reduction"/>
	<map name="group____dnnl____api____reduction" id="group____dnnl____api____reduction">
	<area shape="rect" id="node2" href="group__dnnl__api__primitives.html" title="Dnnl_api_primitives" alt="" coords="5,5,157,32"/>
	</map>
	</td></tr></table></center>
	</div>
	<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">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structdnnl__reduction__desc__t.html">dnnl_reduction_desc_t</a></td></tr>
	<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A descriptor of reduction operation. <a href="structdnnl__reduction__desc__t.html#details">More...</a><br /></td></tr>
	<tr class="separator:"><td class="memSeparator" colspan="2"> </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:ga507b07a09447e911f68d11aad0fecdde"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dnnl__api__reduction.html#ga507b07a09447e911f68d11aad0fecdde">dnnl_reduction_desc_init</a> (<a class="el" href="structdnnl__reduction__desc__t.html">dnnl_reduction_desc_t</a> desc, <a class="el" href="group__dnnl__api__primitives__common.html#ga96946c805f6c4922c38c37049ab95d23">dnnl_alg_kind_t</a> alg_kind, const <a class="el" href="structdnnl__memory__desc__t.html">dnnl_memory_desc_t</a> src_desc, const <a class="el" href="structdnnl__memory__desc__t.html">dnnl_memory_desc_t</a> *dst_desc, float p, float eps)</td></tr>
	<tr class="separator:ga507b07a09447e911f68d11aad0fecdde"><td class="memSeparator" colspan="2"> </td></tr>
	</table>
	<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
	<h2 class="groupheader">Function Documentation</h2>
	<a id="ga507b07a09447e911f68d11aad0fecdde"></a>
	<h2 class="memtitle"><span class="permalink"><a href="#ga507b07a09447e911f68d11aad0fecdde">◆ </a></span>dnnl_reduction_desc_init()</h2>

	<div class="memitem">
	<div class="memproto">
	<table class="memname">
	<tr>
	<td class="memname"><a class="el" href="group__dnnl__api__utils.html#gad24f9ded06e34d3ee71e7fc4b408d57a">dnnl_status_t</a> DNNL_API dnnl_reduction_desc_init </td>
	<td>(</td>
	<td class="paramtype"><a class="el" href="structdnnl__reduction__desc__t.html">dnnl_reduction_desc_t</a> * </td>
	<td class="paramname"><em>desc</em>, </td>
	</tr>
	<tr>
	<td class="paramkey"></td>
	<td></td>
	<td class="paramtype"><a class="el" href="group__dnnl__api__primitives__common.html#ga96946c805f6c4922c38c37049ab95d23">dnnl_alg_kind_t</a> </td>
	<td class="paramname"><em>alg_kind</em>, </td>
	</tr>
	<tr>
	<td class="paramkey"></td>
	<td></td>
	<td class="paramtype">const <a class="el" href="structdnnl__memory__desc__t.html">dnnl_memory_desc_t</a> * </td>
	<td class="paramname"><em>src_desc</em>, </td>
	</tr>
	<tr>
	<td class="paramkey"></td>
	<td></td>
	<td class="paramtype">const <a class="el" href="structdnnl__memory__desc__t.html">dnnl_memory_desc_t</a> * </td>
	<td class="paramname"><em>dst_desc</em>, </td>
	</tr>
	<tr>
	<td class="paramkey"></td>
	<td></td>
	<td class="paramtype">float </td>
	<td class="paramname"><em>p</em>, </td>
	</tr>
	<tr>
	<td class="paramkey"></td>
	<td></td>
	<td class="paramtype">float </td>
	<td class="paramname"><em>eps</em> </td>
	</tr>
	<tr>
	<td></td>
	<td>)</td>
	<td></td><td></td>
	</tr>
	</table>
	</div><div class="memdoc">
	<p>Initializes a descriptor for a reduction primitive.</p>
	<dl class="section note"><dt>Note</dt><dd>Destination memory descriptor is allowed to be initialized with <a class="el" href="group__dnnl__api__memory.html#gga395e42b594683adb25ed2d842bb3091dafee39ac6fff0325cae43cd66495c18ac">dnnl_format_tag_any</a> or with format_kind set to <a class="el" href="group__dnnl__api__memory.html#ggaa75cad747fa467d9dc527d943ba3367da77ae35388e04dc3e98d90675a7110c83">dnnl_format_kind_any</a>.</dd></dl>
	<dl class="params"><dt>Parameters</dt><dd>
	<table class="params">
	<tr><td class="paramname">desc</td><td>Output descriptor for a reduction primitive. </td></tr>
	<tr><td class="paramname">alg_kind</td><td>reduction algorithm kind. 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>. </td></tr>
	<tr><td class="paramname">p</td><td>Algorithm specific parameter. </td></tr>
	<tr><td class="paramname">eps</td><td>Algorithm specific parameter. </td></tr>
	<tr><td class="paramname">src_desc</td><td>Source memory descriptor. </td></tr>
	<tr><td class="paramname">dst_desc</td><td>Destination memory descriptor. </td></tr>
	</table>
	</dd>
	</dl>
	<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__dnnl__api__utils.html#ggad24f9ded06e34d3ee71e7fc4b408d57aaa31395e9dccc103cf166cf7b38fc5b9c" title="The operation was successful. ">dnnl_success</a> on success and a status describing the error otherwise. </dd></dl>

	</div>
	</div>
	</div><!-- contents -->
	<!-- start footer part -->
	<hr class="footer"/><address class="footer"><small>
	Generated on Thu Jan 5 2023 00:58:43 for mxnet by  <a href="http://www.doxygen.org/index.html">
	<img class="footer" src="doxygen.png" alt="doxygen"/>
	</a> 1.8.13
	</small></address>
	</body>
	</html>