2024-10-15 15:12:17 +00:00
<!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" / >
2025-02-06 20:16:29 +00:00
< meta name = "generator" content = "Doxygen 1.13.2" / >
2024-10-15 15:12:17 +00:00
< 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" / >
2025-01-09 21:56:20 +00:00
< script type = "text/javascript" src = "navtreedata.js" > < / script >
< script type = "text/javascript" src = "navtree.js" > < / script >
2024-10-15 15:12:17 +00:00
< 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 >
2025-01-09 21:56:20 +00:00
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
$(function() { init_search(); });
/* @license-end */
< / script >
2024-10-15 15:12:17 +00:00
< 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 >
2025-01-09 21:56:20 +00:00
< td > < div id = "MSearchBox" class = "MSearchBoxInactive" >
< span class = "left" >
< span id = "MSearchSelect" onmouseover = "return searchBox.OnSearchSelectShow()" onmouseout = "return searchBox.OnSearchSelectHide()" >   < / 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 >
2024-10-15 15:12:17 +00:00
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
2025-02-06 20:16:29 +00:00
<!-- Generated by Doxygen 1.13.2 -->
2024-10-15 15:12:17 +00:00
< 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 >
2025-01-09 21:56:20 +00:00
< / 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 >
2024-10-15 15:12:17 +00:00
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
2025-01-09 21:56:20 +00:00
$(function(){initNavTree('namespacepocketfft_1_1detail_1_1threading.html',''); initResizable(true); });
2024-10-15 15:12:17 +00:00
/* @license-end */
< / script >
2025-01-09 21:56:20 +00:00
< div id = "doc-content" >
2024-10-15 15:12:17 +00:00
<!-- 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 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 >
2025-01-09 21:56:20 +00:00
< 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 f)< / td > < / tr >
2024-10-15 15:12:17 +00:00
< 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 >
2025-01-09 21:56:20 +00:00
< 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(1u, std::thread::hardware_concurrency())< / td > < / tr >
2024-10-15 15:12:17 +00:00
< 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" >
2025-01-09 21:56:20 +00:00
< span class = "mlabels" > < span class = "mlabel inline" > inline< / span > < / span > < / td >
2024-10-15 15:12:17 +00:00
< / 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" >
2025-01-09 21:56:20 +00:00
< span class = "mlabels" > < span class = "mlabel inline" > inline< / span > < / span > < / td >
2024-10-15 15:12:17 +00:00
< / 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" >
2025-01-09 21:56:20 +00:00
< span class = "mlabels" > < span class = "mlabel inline" > inline< / span > < / span > < / td >
2024-10-15 15:12:17 +00:00
< / 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" >
2025-01-09 21:56:20 +00:00
template< typename Func> < / div >
2024-10-15 15:12:17 +00:00
< 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 >
2025-01-09 21:56:20 +00:00
< td class = "memname" > const size_t pocketfft::detail::threading::max_threads = std::max(1u, std::thread::hardware_concurrency())< / td >
2024-10-15 15:12:17 +00:00
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
2025-01-09 21:56:20 +00:00
< span class = "mlabels" > < span class = "mlabel static" > static< / span > < / span > < / td >
2024-10-15 15:12:17 +00:00
< / tr >
< / table >
< / div > < div class = "memdoc" >
< / div >
< / div >
< / div > <!-- contents -->
< / div > <!-- doc - content -->
2025-01-09 21:56:20 +00:00
<!-- 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 >
2025-02-06 20:16:29 +00:00
< 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.2 < / li >
2025-01-09 21:56:20 +00:00
< / ul >
< / div >
2024-10-15 15:12:17 +00:00
< / body >
< / html >
