versions/1.7.0/api/cpp/docs/api/group__dnnl__api__primitive__cache.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.11"/>
 <title>mxnet: Dnnl_api_primitive_cache</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>
 <script type="text/javascript">
   $(document).ready(function() { init_search(); });
 </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.11 -->
 <script type="text/javascript">
 var searchBox = new SearchBox("searchBox", "search",false,'Search');
 </script>
   <div id="navrow1" class="tabs">
     <ul class="tablist">
       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
       <li class="current"><a href="modules.html"><span>Modules</span></a></li>
       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
       <li><a href="annotated.html"><span>Classes</span></a></li>
       <li><a href="files.html"><span>Files</span></a></li>
       <li>
         <div id="MSearchBox" class="MSearchBoxInactive">
         <span class="left">
           <img id="MSearchSelect" src="search/mag_sel.png"
                onmouseover="return searchBox.OnSearchSelectShow()"
                onmouseout="return searchBox.OnSearchSelectHide()"
                alt=""/>
           <input type="text" id="MSearchField" value="Search" accesskey="S"
                onfocus="searchBox.OnSearchFieldFocus(true)"
                onblur="searchBox.OnSearchFieldFocus(false)"
                onkeyup="searchBox.OnSearchFieldChange(event)"/>
           </span><span class="right">
             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
           </span>
         </div>
       </li>
     </ul>
   </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="#func-members">Functions</a>  </div>
   <div class="headertitle">
 <div class="title">Dnnl_api_primitive_cache<div class="ingroups"><a class="el" href="group__dnnl__api.html">Dnnl_api</a></div></div>  </div>
 </div><!--header-->
 <div class="contents">
 <div class="dynheader">
 Collaboration diagram for Dnnl_api_primitive_cache:</div>
 <div class="dyncontent">
 <center><table><tr><td><img src="group__dnnl__api__primitive__cache.png" border="0" alt="" usemap="#group____dnnl____api____primitive____cache"/>
 <map name="group____dnnl____api____primitive____cache" id="group____dnnl____api____primitive____cache">
 <area shape="rect" id="node2" href="group__dnnl__api.html" title="Dnnl_api" alt="" coords="5,13,83,39"/>
 </map>
 </td></tr></table></center>
 </div>
 <table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
 Functions</h2></td></tr>
 <tr class="memitem:gaaffb070446181187b04ee1a321cc24f0"><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__primitive__cache.html#gaaffb070446181187b04ee1a321cc24f0">dnnl_get_primitive_cache_capacity</a> (int *capacity)</td></tr>
 <tr class="separator:gaaffb070446181187b04ee1a321cc24f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ga53456304297195ae9f053cc60ffe70a2"><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__primitive__cache.html#ga53456304297195ae9f053cc60ffe70a2">dnnl_set_primitive_cache_capacity</a> (int capacity)</td></tr>
 <tr class="separator:ga53456304297195ae9f053cc60ffe70a2"><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 class="anchor" id="gaaffb070446181187b04ee1a321cc24f0"></a>
 <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_get_primitive_cache_capacity </td>
           <td>(</td>
           <td class="paramtype">int *&#160;</td>
           <td class="paramname"><em>capacity</em></td><td>)</td>
           <td></td>
         </tr>
       </table>
 </div><div class="memdoc">
 <p>Returns the number of primitives that can be held in the primitive cache at the same time.</p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">capacity</td><td>Primitive cache capacity to query. Concurrently accessing <code>capacity</code> is safe. </td></tr>
   </table>
   </dd>
 </dl>
 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__dnnl__api__utils.html#ggad24f9ded06e34d3ee71e7fc4b408d57aaecec97c787d74a33924abcf16ae4f51c" title="The operation failed because of incorrect function arguments. ">dnnl_invalid_arguments</a>/#dnnl::status::invalid_arguments if the <code>capacity</code> value is invalid, and <a class="el" href="group__dnnl__api__utils.html#ggad24f9ded06e34d3ee71e7fc4b408d57aaa31395e9dccc103cf166cf7b38fc5b9c" title="The operation was successful. ">dnnl_success</a>/#dnnl::status::success on success. </dd></dl>

 </div>
 </div>
 <a class="anchor" id="ga53456304297195ae9f053cc60ffe70a2"></a>
 <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_set_primitive_cache_capacity </td>
           <td>(</td>
           <td class="paramtype">int&#160;</td>
           <td class="paramname"><em>capacity</em></td><td>)</td>
           <td></td>
         </tr>
       </table>
 </div><div class="memdoc">
 <p>Sets a number of primitives that can be held in the primitive cache at a time.</p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">capacity</td><td>Primitive cache capacity to set. If a new <code>capacity</code> is less than a number of primitives that the primitive cache already has then the excess entries will be evicted. Setting the <code>capacity</code> to 0 clears the primitive cache and disables it. Concurrently modifying <code>capacity</code> is safe. </td></tr>
   </table>
   </dd>
 </dl>
 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__dnnl__api__utils.html#ggad24f9ded06e34d3ee71e7fc4b408d57aaecec97c787d74a33924abcf16ae4f51c" title="The operation failed because of incorrect function arguments. ">dnnl_invalid_arguments</a>/#dnnl::status::invalid_arguments if the <code>capacity</code> value is invalid, and <a class="el" href="group__dnnl__api__utils.html#ggad24f9ded06e34d3ee71e7fc4b408d57aaa31395e9dccc103cf166cf7b38fc5b9c" title="The operation was successful. ">dnnl_success</a>/#dnnl::status::success on success. </dd></dl>

 </div>
 </div>
 </div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
 Generated on Fri Sep 11 2020 03:38:05 for mxnet by &#160;<a href="http://www.doxygen.org/index.html">
 <img class="footer" src="doxygen.png" alt="doxygen"/>
 </a> 1.8.11
 </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.11"/>
	<title>mxnet: Dnnl_api_primitive_cache</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>
	<script type="text/javascript">
	$(document).ready(function() { init_search(); });
	</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.11 -->
	<script type="text/javascript">
	var searchBox = new SearchBox("searchBox", "search",false,'Search');
	</script>
	<div id="navrow1" class="tabs">
	<ul class="tablist">
	<li><a href="index.html"><span>Main Page</span></a></li>
	<li class="current"><a href="modules.html"><span>Modules</span></a></li>
	<li><a href="namespaces.html"><span>Namespaces</span></a></li>
	<li><a href="annotated.html"><span>Classes</span></a></li>
	<li><a href="files.html"><span>Files</span></a></li>
	<li>
	<div id="MSearchBox" class="MSearchBoxInactive">
	<span class="left">
	<img id="MSearchSelect" src="search/mag_sel.png"
	onmouseover="return searchBox.OnSearchSelectShow()"
	onmouseout="return searchBox.OnSearchSelectHide()"
	alt=""/>
	<input type="text" id="MSearchField" value="Search" accesskey="S"
	onfocus="searchBox.OnSearchFieldFocus(true)"
	onblur="searchBox.OnSearchFieldFocus(false)"
	onkeyup="searchBox.OnSearchFieldChange(event)"/>
	</span><span class="right">
	<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
	</span>
	</div>
	</li>
	</ul>
	</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="#func-members">Functions</a> </div>
	<div class="headertitle">
	<div class="title">Dnnl_api_primitive_cache<div class="ingroups"><a class="el" href="group__dnnl__api.html">Dnnl_api</a></div></div> </div>
	</div><!--header-->
	<div class="contents">
	<div class="dynheader">
	Collaboration diagram for Dnnl_api_primitive_cache:</div>
	<div class="dyncontent">
	<center><table><tr><td><img src="group__dnnl__api__primitive__cache.png" border="0" alt="" usemap="#group____dnnl____api____primitive____cache"/>
	<map name="group____dnnl____api____primitive____cache" id="group____dnnl____api____primitive____cache">
	<area shape="rect" id="node2" href="group__dnnl__api.html" title="Dnnl_api" alt="" coords="5,13,83,39"/>
	</map>
	</td></tr></table></center>
	</div>
	<table class="memberdecls">
	<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
	Functions</h2></td></tr>
	<tr class="memitem:gaaffb070446181187b04ee1a321cc24f0"><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__primitive__cache.html#gaaffb070446181187b04ee1a321cc24f0">dnnl_get_primitive_cache_capacity</a> (int *capacity)</td></tr>
	<tr class="separator:gaaffb070446181187b04ee1a321cc24f0"><td class="memSeparator" colspan="2"> </td></tr>
	<tr class="memitem:ga53456304297195ae9f053cc60ffe70a2"><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__primitive__cache.html#ga53456304297195ae9f053cc60ffe70a2">dnnl_set_primitive_cache_capacity</a> (int capacity)</td></tr>
	<tr class="separator:ga53456304297195ae9f053cc60ffe70a2"><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 class="anchor" id="gaaffb070446181187b04ee1a321cc24f0"></a>
	<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_get_primitive_cache_capacity </td>
	<td>(</td>
	<td class="paramtype">int * </td>
	<td class="paramname"><em>capacity</em></td><td>)</td>
	<td></td>
	</tr>
	</table>
	</div><div class="memdoc">
	<p>Returns the number of primitives that can be held in the primitive cache at the same time.</p>
	<dl class="params"><dt>Parameters</dt><dd>
	<table class="params">
	<tr><td class="paramname">capacity</td><td>Primitive cache capacity to query. Concurrently accessing <code>capacity</code> is safe. </td></tr>
	</table>
	</dd>
	</dl>
	<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__dnnl__api__utils.html#ggad24f9ded06e34d3ee71e7fc4b408d57aaecec97c787d74a33924abcf16ae4f51c" title="The operation failed because of incorrect function arguments. ">dnnl_invalid_arguments</a>/#dnnl::status::invalid_arguments if the <code>capacity</code> value is invalid, and <a class="el" href="group__dnnl__api__utils.html#ggad24f9ded06e34d3ee71e7fc4b408d57aaa31395e9dccc103cf166cf7b38fc5b9c" title="The operation was successful. ">dnnl_success</a>/#dnnl::status::success on success. </dd></dl>

	</div>
	</div>
	<a class="anchor" id="ga53456304297195ae9f053cc60ffe70a2"></a>
	<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_set_primitive_cache_capacity </td>
	<td>(</td>
	<td class="paramtype">int </td>
	<td class="paramname"><em>capacity</em></td><td>)</td>
	<td></td>
	</tr>
	</table>
	</div><div class="memdoc">
	<p>Sets a number of primitives that can be held in the primitive cache at a time.</p>
	<dl class="params"><dt>Parameters</dt><dd>
	<table class="params">
	<tr><td class="paramname">capacity</td><td>Primitive cache capacity to set. If a new <code>capacity</code> is less than a number of primitives that the primitive cache already has then the excess entries will be evicted. Setting the <code>capacity</code> to 0 clears the primitive cache and disables it. Concurrently modifying <code>capacity</code> is safe. </td></tr>
	</table>
	</dd>
	</dl>
	<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__dnnl__api__utils.html#ggad24f9ded06e34d3ee71e7fc4b408d57aaecec97c787d74a33924abcf16ae4f51c" title="The operation failed because of incorrect function arguments. ">dnnl_invalid_arguments</a>/#dnnl::status::invalid_arguments if the <code>capacity</code> value is invalid, and <a class="el" href="group__dnnl__api__utils.html#ggad24f9ded06e34d3ee71e7fc4b408d57aaa31395e9dccc103cf166cf7b38fc5b9c" title="The operation was successful. ">dnnl_success</a>/#dnnl::status::success on success. </dd></dl>

	</div>
	</div>
	</div><!-- contents -->
	<!-- start footer part -->
	<hr class="footer"/><address class="footer"><small>
	Generated on Fri Sep 11 2020 03:38:05 for mxnet by  <a href="http://www.doxygen.org/index.html">
	<img class="footer" src="doxygen.png" alt="doxygen"/>
	</a> 1.8.11
	</small></address>
	</body>
	</html>