2024-10-15 23:12:17 +08: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-07 04:16:29 +08:00
< meta name = "generator" content = "Doxygen 1.13.2" / >
2024-10-15 23:12:17 +08:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
2025-02-07 04:16:29 +08:00
< title > MLX: mlx/distributed/ring/ring.h Source File< / title >
2024-10-15 23:12:17 +08:00
< 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-10 05:56:20 +08:00
< script type = "text/javascript" src = "navtreedata.js" > < / script >
< script type = "text/javascript" src = "navtree.js" > < / script >
2024-10-15 23:12:17 +08: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-10 05:56:20 +08:00
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
$(function() { init_search(); });
/* @license-end */
< / script >
2024-10-15 23:12:17 +08: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-10 05:56:20 +08: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 23:12:17 +08:00
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
2025-02-07 04:16:29 +08:00
<!-- Generated by Doxygen 1.13.2 -->
2024-10-15 23:12:17 +08: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-10 05:56:20 +08: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 23:12:17 +08:00
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699& dn=expat.txt MIT */
2025-02-07 04:16:29 +08:00
$(function(){initNavTree('ring_8h_source.html',''); initResizable(true); });
2024-10-15 23:12:17 +08:00
/* @license-end */
< / script >
2025-01-10 05:56:20 +08:00
< div id = "doc-content" >
2024-10-15 23:12:17 +08: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" >
2025-02-07 04:16:29 +08:00
< div class = "headertitle" > < div class = "title" > ring.h< / div > < / div >
2024-10-15 23:12:17 +08:00
< / div > <!-- header -->
< div class = "contents" >
2025-02-07 04:16:29 +08:00
< a href = "ring_8h.html" > Go to the documentation of this file.< / a > < div class = "fragment" > < div class = "line" > < a id = "l00001" name = "l00001" > < / a > < span class = "lineno" > 1< / span > < span class = "comment" > // Copyright © 2024 Apple Inc.< / span > < / div >
2024-10-15 23:12:17 +08:00
< div class = "line" > < a id = "l00002" name = "l00002" > < / a > < span class = "lineno" > 2< / span > < / div >
2025-02-07 04:16:29 +08:00
< div class = "line" > < a id = "l00003" name = "l00003" > < / a > < span class = "lineno" > 3< / span > < span class = "preprocessor" > #include " < a class = "code" href = "distributed_8h.html" > mlx/distributed/distributed.h< / a > " < / span > < / div >
< div class = "line" > < a id = "l00004" name = "l00004" > < / a > < span class = "lineno" > 4< / span > < / div >
< div class = "foldopen" id = "foldopen00005" data-start = "{" data-end = "}" >
< div class = "line" > < a id = "l00005" name = "l00005" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core_1_1distributed_1_1ring.html" > 5< / a > < / span > < span class = "keyword" > namespace < / span > < a class = "code hl_namespace" href = "namespacemlx_1_1core_1_1distributed_1_1ring.html" > mlx::core::distributed::ring< / a > {< / div >
< div class = "line" > < a id = "l00006" name = "l00006" > < / a > < span class = "lineno" > 6< / span > < / div >
< div class = "line" > < a id = "l00007" name = "l00007" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core_1_1distributed_1_1ring.html#a6e4d590e07f0cf3cc2d15f258f9438ed" > 7< / a > < / span > < span class = "keyword" > using < / span > < a class = "code hl_typedef" href = "namespacemlx_1_1core_1_1distributed_1_1ring.html#a6e4d590e07f0cf3cc2d15f258f9438ed" > GroupImpl< / a > = < a class = "code hl_class" href = "classmlx_1_1core_1_1distributed_1_1detail_1_1_group_impl.html" > mlx::core::distributed::detail::GroupImpl< / a > ;< / div >
< div class = "line" > < a id = "l00008" name = "l00008" > < / a > < span class = "lineno" > 8< / span > < / div >
< div class = "line" > < a id = "l00009" name = "l00009" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core_1_1distributed_1_1ring.html#a1238e89ee95ba016741f0abe91b540ac" > 9< / a > < / span > < span class = "keywordtype" > bool< / span > < a class = "code hl_function" href = "namespacemlx_1_1core_1_1distributed_1_1ring.html#a1238e89ee95ba016741f0abe91b540ac" > is_available< / a > ();< / div >
< div class = "line" > < a id = "l00010" name = "l00010" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core_1_1distributed_1_1ring.html#a81a13abe6f334d2f6b058b39a2221e67" > 10< / a > < / span > std::shared_ptr< GroupImpl> < a class = "code hl_function" href = "namespacemlx_1_1core_1_1distributed_1_1ring.html#a81a13abe6f334d2f6b058b39a2221e67" > init< / a > (< span class = "keywordtype" > bool< / span > strict = < span class = "keyword" > false< / span > );< / div >
< div class = "line" > < a id = "l00011" name = "l00011" > < / a > < span class = "lineno" > 11< / span > < / div >
< div class = "line" > < a id = "l00012" name = "l00012" > < / a > < span class = "lineno" > 12< / span > } < span class = "comment" > // namespace mlx::core::distributed::ring< / span > < / div >
< / div >
< div class = "ttc" id = "aclassmlx_1_1core_1_1distributed_1_1detail_1_1_group_impl_html" > < div class = "ttname" > < a href = "classmlx_1_1core_1_1distributed_1_1detail_1_1_group_impl.html" > mlx::core::distributed::detail::GroupImpl< / a > < / div > < div class = "ttdoc" > Abstract base class of a distributed group implementation.< / div > < div class = "ttdef" > < b > Definition< / b > distributed_impl.h:12< / div > < / div >
< div class = "ttc" id = "adistributed_8h_html" > < div class = "ttname" > < a href = "distributed_8h.html" > distributed.h< / a > < / div > < / div >
< div class = "ttc" id = "anamespacemlx_1_1core_1_1distributed_1_1ring_html" > < div class = "ttname" > < a href = "namespacemlx_1_1core_1_1distributed_1_1ring.html" > mlx::core::distributed::ring< / a > < / div > < div class = "ttdef" > < b > Definition< / b > ring.h:5< / div > < / div >
< div class = "ttc" id = "anamespacemlx_1_1core_1_1distributed_1_1ring_html_a1238e89ee95ba016741f0abe91b540ac" > < div class = "ttname" > < a href = "namespacemlx_1_1core_1_1distributed_1_1ring.html#a1238e89ee95ba016741f0abe91b540ac" > mlx::core::distributed::ring::is_available< / a > < / div > < div class = "ttdeci" > bool is_available()< / div > < / div >
< div class = "ttc" id = "anamespacemlx_1_1core_1_1distributed_1_1ring_html_a6e4d590e07f0cf3cc2d15f258f9438ed" > < div class = "ttname" > < a href = "namespacemlx_1_1core_1_1distributed_1_1ring.html#a6e4d590e07f0cf3cc2d15f258f9438ed" > mlx::core::distributed::ring::GroupImpl< / a > < / div > < div class = "ttdeci" > mlx::core::distributed::detail::GroupImpl GroupImpl< / div > < div class = "ttdef" > < b > Definition< / b > ring.h:7< / div > < / div >
< div class = "ttc" id = "anamespacemlx_1_1core_1_1distributed_1_1ring_html_a81a13abe6f334d2f6b058b39a2221e67" > < div class = "ttname" > < a href = "namespacemlx_1_1core_1_1distributed_1_1ring.html#a81a13abe6f334d2f6b058b39a2221e67" > mlx::core::distributed::ring::init< / a > < / div > < div class = "ttdeci" > std::shared_ptr< GroupImpl > init(bool strict=false)< / div > < / div >
2024-10-15 23:12:17 +08:00
< / div > <!-- fragment --> < / div > <!-- contents -->
< / div > <!-- doc - content -->
2025-01-10 05:56:20 +08:00
<!-- start footer part -->
< div id = "nav-path" class = "navpath" > <!-- id is needed for treeview function! -->
< ul >
2025-02-07 04:16:29 +08:00
< li class = "navelem" > < a class = "el" href = "dir_938ab0ecf10b8b860ff766c820f665fd.html" > mlx< / a > < / li > < li class = "navelem" > < a class = "el" href = "dir_23833761034051b43bb6c170b56e2cce.html" > distributed< / a > < / li > < li class = "navelem" > < a class = "el" href = "dir_3afd476a29b32961d09b8b179155b807.html" > ring< / a > < / li > < li class = "navelem" > < a class = "el" href = "ring_8h.html" > ring.h< / 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.2 < / li >
2025-01-10 05:56:20 +08:00
< / ul >
< / div >
2024-10-15 23:12:17 +08:00
< / body >
< / html >
