This commit is contained in:
CircleCI Docs
2025-01-09 21:56:20 +00:00
parent 04b749a588
commit d8d647015b
2642 changed files with 137687 additions and 70861 deletions

View File

@@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="generator" content="Doxygen 1.13.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MLX: pocketfft::detail::threading Namespace Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -11,11 +11,18 @@
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.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">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
@@ -28,12 +35,24 @@
<div id="projectname">MLX
</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
<input type="text" id="MSearchField" value="" placeholder="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.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<!-- Generated by Doxygen 1.13.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
@@ -44,22 +63,23 @@ var searchBox = new SearchBox("searchBox", "search/",'.html');
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',false);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
$(function(){initNavTree('namespacepocketfft_1_1detail_1_1threading.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
@@ -81,12 +101,6 @@ $(function(){ initResizable(false); });
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacepocketfft.html">pocketfft</a></li><li class="navelem"><a class="el" href="namespacepocketfft_1_1detail.html">detail</a></li><li class="navelem"><a class="el" href="namespacepocketfft_1_1detail_1_1threading.html">threading</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
@@ -115,14 +129,14 @@ Functions</h2></td></tr>
<tr class="separator:af5432c2e25aed679a73fe7b29534c833"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ec2b3f99232bd0f15f7b022c59d139a" id="r_a7ec2b3f99232bd0f15f7b022c59d139a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpocketfft_1_1detail_1_1threading_1_1thread__pool.html">thread_pool</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7ec2b3f99232bd0f15f7b022c59d139a">get_pool</a> ()</td></tr>
<tr class="separator:a7ec2b3f99232bd0f15f7b022c59d139a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4fcf674db39f0e2c1c59d48491daed6e" id="r_a4fcf674db39f0e2c1c59d48491daed6e"><td class="memTemplParams" colspan="2">template&lt;typename Func &gt; </td></tr>
<tr class="memitem:a4fcf674db39f0e2c1c59d48491daed6e"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a4fcf674db39f0e2c1c59d48491daed6e">thread_map</a> (size_t nthreads, Func <a class="el" href="types_2bf16_8h.html#af900396d7b72ff2a7002e8befe8cf8f1">f</a>)</td></tr>
<tr class="memitem:a4fcf674db39f0e2c1c59d48491daed6e" id="r_a4fcf674db39f0e2c1c59d48491daed6e"><td class="memTemplParams" colspan="2">template&lt;typename Func&gt; </td></tr>
<tr class="memitem:a4fcf674db39f0e2c1c59d48491daed6e"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a4fcf674db39f0e2c1c59d48491daed6e">thread_map</a> (size_t nthreads, Func f)</td></tr>
<tr class="memdesc:a4fcf674db39f0e2c1c59d48491daed6e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Map a function f over nthreads. <br /></td></tr>
<tr class="separator:a4fcf674db39f0e2c1c59d48491daed6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a2d5c0729f0b66cf061918baea4337d70" id="r_a2d5c0729f0b66cf061918baea4337d70"><td class="memItemLeft" align="right" valign="top">static const size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2d5c0729f0b66cf061918baea4337d70">max_threads</a> = std::max(1<a class="el" href="types_2bf16_8h.html#aa21e554721eddcf127b7fcfa7fdc56bd">u</a>, std::thread::hardware_concurrency())</td></tr>
<tr class="memitem:a2d5c0729f0b66cf061918baea4337d70" id="r_a2d5c0729f0b66cf061918baea4337d70"><td class="memItemLeft" align="right" valign="top">static const size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2d5c0729f0b66cf061918baea4337d70">max_threads</a> = std::max(1u, std::thread::hardware_concurrency())</td></tr>
<tr class="separator:a2d5c0729f0b66cf061918baea4337d70"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
@@ -144,7 +158,7 @@ Variables</h2></td></tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -169,7 +183,7 @@ Variables</h2></td></tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -194,7 +208,7 @@ Variables</h2></td></tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -207,7 +221,7 @@ Variables</h2></td></tr>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Func &gt; </div>
template&lt;typename Func&gt; </div>
<table class="memname">
<tr>
<td class="memname">void pocketfft::detail::threading::thread_map </td>
@@ -237,12 +251,12 @@ template&lt;typename Func &gt; </div>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const size_t pocketfft::detail::threading::max_threads = std::max(1<a class="el" href="types_2bf16_8h.html#aa21e554721eddcf127b7fcfa7fdc56bd">u</a>, std::thread::hardware_concurrency())</td>
<td class="memname">const size_t pocketfft::detail::threading::max_threads = std::max(1u, std::thread::hardware_concurrency())</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
<span class="mlabels"><span class="mlabel static">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
@@ -250,10 +264,13 @@ template&lt;typename Func &gt; </div>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0
</small></address>
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespacepocketfft.html">pocketfft</a></li><li class="navelem"><a class="el" href="namespacepocketfft_1_1detail.html">detail</a></li><li class="navelem"><a class="el" href="namespacepocketfft_1_1detail_1_1threading.html">threading</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.1 </li>
</ul>
</div>
</body>
</html>