mirror of
https://github.com/ml-explore/mlx.git
synced 2025-06-26 02:33:21 +08:00
260 lines
13 KiB
HTML
260 lines
13 KiB
HTML
|
<!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" lang="en-US">
|
||
|
|
<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="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"/>
|
||
|
|
<script type="text/javascript" src="jquery.js"></script>
|
||
|
|
<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="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>
|
||
|
|
<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 id="projectrow">
|
||
|
|
<td id="projectalign">
|
||
|
|
<div id="projectname">MLX
|
||
|
|
</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<!-- end header part -->
|
||
|
|
<!-- Generated by Doxygen 1.12.0 -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
||
|
|
/* @license-end */
|
||
|
|
</script>
|
||
|
|
<script type="text/javascript">
|
||
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||
|
|
$(function() { codefold.init(0); });
|
||
|
|
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&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&dn=expat.txt MIT */
|
||
|
|
$(function(){ initResizable(false); });
|
||
|
|
/* @license-end */
|
||
|
|
</script>
|
||
|
|
<!-- 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">
|
||
|
|
<div id="MSearchResults">
|
||
|
|
<div class="SRPage">
|
||
|
|
<div id="SRIndex">
|
||
|
|
<div id="SRResults"></div>
|
||
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
||
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
||
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</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> |
|
||
|
|
<a href="#func-members">Functions</a> |
|
||
|
|
<a href="#var-members">Variables</a> </div>
|
||
|
|
<div class="headertitle"><div class="title">pocketfft::detail::threading Namespace Reference</div></div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
<table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" 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="structpocketfft_1_1detail_1_1threading_1_1aligned__allocator.html">aligned_allocator</a></td></tr>
|
||
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classpocketfft_1_1detail_1_1threading_1_1concurrent__queue.html">concurrent_queue</a></td></tr>
|
||
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classpocketfft_1_1detail_1_1threading_1_1latch.html">latch</a></td></tr>
|
||
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classpocketfft_1_1detail_1_1threading_1_1thread__pool.html">thread_pool</a></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 id="func-members" name="func-members"></a>
|
||
|
|
Functions</h2></td></tr>
|
||
|
|
<tr class="memitem:aebe85d6273d92c7d3728e2c621ccc82b" id="r_aebe85d6273d92c7d3728e2c621ccc82b"><td class="memItemLeft" align="right" valign="top">size_t & </td><td class="memItemRight" valign="bottom"><a class="el" href="#aebe85d6273d92c7d3728e2c621ccc82b">thread_id</a> ()</td></tr>
|
||
|
|
<tr class="separator:aebe85d6273d92c7d3728e2c621ccc82b"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:af5432c2e25aed679a73fe7b29534c833" id="r_af5432c2e25aed679a73fe7b29534c833"><td class="memItemLeft" align="right" valign="top">size_t & </td><td class="memItemRight" valign="bottom"><a class="el" href="#af5432c2e25aed679a73fe7b29534c833">num_threads</a> ()</td></tr>
|
||
|
|
<tr class="separator:af5432c2e25aed679a73fe7b29534c833"><td class="memSeparator" colspan="2"> </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> & </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"> </td></tr>
|
||
|
|
<tr class="memitem:a4fcf674db39f0e2c1c59d48491daed6e" id="r_a4fcf674db39f0e2c1c59d48491daed6e"><td class="memTemplParams" colspan="2">template<typename Func > </td></tr>
|
||
|
|
<tr class="memitem:a4fcf674db39f0e2c1c59d48491daed6e"><td class="memTemplItemLeft" align="right" valign="top">void </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="memdesc:a4fcf674db39f0e2c1c59d48491daed6e"><td class="mdescLeft"> </td><td class="mdescRight">Map a function f over nthreads. <br /></td></tr>
|
||
|
|
<tr class="separator:a4fcf674db39f0e2c1c59d48491daed6e"><td class="memSeparator" colspan="2"> </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 </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="separator:a2d5c0729f0b66cf061918baea4337d70"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table>
|
||
|
|
<h2 class="groupheader">Function Documentation</h2>
|
||
|
|
<a id="a7ec2b3f99232bd0f15f7b022c59d139a" name="a7ec2b3f99232bd0f15f7b022c59d139a"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7ec2b3f99232bd0f15f7b022c59d139a">◆ </a></span>get_pool()</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="classpocketfft_1_1detail_1_1threading_1_1thread__pool.html">thread_pool</a> & pocketfft::detail::threading::get_pool </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"><span class="paramname"><em></em></span></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="af5432c2e25aed679a73fe7b29534c833" name="af5432c2e25aed679a73fe7b29534c833"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af5432c2e25aed679a73fe7b29534c833">◆ </a></span>num_threads()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">size_t & pocketfft::detail::threading::num_threads </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"><span class="paramname"><em></em></span></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="aebe85d6273d92c7d3728e2c621ccc82b" name="aebe85d6273d92c7d3728e2c621ccc82b"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aebe85d6273d92c7d3728e2c621ccc82b">◆ </a></span>thread_id()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">size_t & pocketfft::detail::threading::thread_id </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"><span class="paramname"><em></em></span></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="a4fcf674db39f0e2c1c59d48491daed6e" name="a4fcf674db39f0e2c1c59d48491daed6e"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4fcf674db39f0e2c1c59d48491daed6e">◆ </a></span>thread_map()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<div class="memtemplate">
|
||
|
|
template<typename Func > </div>
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void pocketfft::detail::threading::thread_map </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>nthreads</em></span>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">Func</td> <td class="paramname"><span class="paramname"><em>f</em></span> )</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Map a function f over nthreads. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Variable Documentation</h2>
|
||
|
|
<a id="a2d5c0729f0b66cf061918baea4337d70" name="a2d5c0729f0b66cf061918baea4337d70"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2d5c0729f0b66cf061918baea4337d70">◆ </a></span>max_threads</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<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>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div><!-- contents -->
|
||
|
|
<!-- start footer part -->
|
||
|
|
<hr class="footer"/><address class="footer"><small>
|
||
|
|
Generated by <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 -->
|
||
|
|
</body>
|
||
|
|
</html>
|