2024-06-07 11:28:06 +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" / >
< meta name = "generator" content = "Doxygen 1.10.0" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
< title > MLX: mlx/distributed/distributed.h Source File< / 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 >
< 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.10.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" 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');
$(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() { codefold.init(0); });
/* @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 = "dir_938ab0ecf10b8b860ff766c820f665fd.html" > mlx< / a > < / li > < li class = "navelem" > < a class = "el" href = "dir_23833761034051b43bb6c170b56e2cce.html" > distributed< / a > < / li > < / ul >
< / div >
< / div > <!-- top -->
< div class = "header" >
< div class = "headertitle" > < div class = "title" > distributed.h< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< a href = "distributed_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 >
< div class = "line" > < a id = "l00002" name = "l00002" > < / a > < span class = "lineno" > 2< / span > < / div >
< div class = "line" > < a id = "l00003" name = "l00003" > < / a > < span class = "lineno" > 3< / span > < span class = "preprocessor" > #pragma once< / span > < / div >
< div class = "line" > < a id = "l00004" name = "l00004" > < / a > < span class = "lineno" > 4< / span > < / div >
< div class = "line" > < a id = "l00005" name = "l00005" > < / a > < span class = "lineno" > 5< / span > < span class = "preprocessor" > #include < memory> < / span > < / 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" > 7< / span > < span class = "preprocessor" > #include " < a class = "code" href = "array_8h.html" > mlx/array.h< / a > " < / span > < / div >
< div class = "line" > < a id = "l00008" name = "l00008" > < / a > < span class = "lineno" > 8< / span > < / div >
< div class = "foldopen" id = "foldopen00009" data-start = "{" data-end = "}" >
< div class = "line" > < a id = "l00009" name = "l00009" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core_1_1distributed.html" > 9< / a > < / span > < span class = "keyword" > namespace < / span > < a class = "code hl_namespace" href = "namespacemlx_1_1core_1_1distributed.html" > mlx::core::distributed< / a > {< / div >
< div class = "line" > < a id = "l00010" name = "l00010" > < / a > < span class = "lineno" > 10< / span > < / div >
< div class = "line" > < a id = "l00011" name = "l00011" > < / a > < span class = "lineno" > 11< / span > < span class = "comment" > /* Check if a communication backend is available */< / span > < / div >
< div class = "line" > < a id = "l00012" name = "l00012" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core_1_1distributed.html#a95655473cd0032c06e5fe3fca85aeef3" > 12< / a > < / span > < span class = "keywordtype" > bool< / span > < a class = "code hl_function" href = "namespacemlx_1_1core_1_1distributed.html#a95655473cd0032c06e5fe3fca85aeef3" > is_available< / a > ();< / div >
< div class = "line" > < a id = "l00013" name = "l00013" > < / a > < span class = "lineno" > 13< / span > < / div >
< div class = "foldopen" id = "foldopen00019" data-start = "{" data-end = "};" >
< div class = "line" > < a id = "l00019" name = "l00019" > < / a > < span class = "lineno" > < a class = "line" href = "structmlx_1_1core_1_1distributed_1_1_group.html" > 19< / a > < / span > < span class = "keyword" > struct < / span > < a class = "code hl_struct" href = "structmlx_1_1core_1_1distributed_1_1_group.html" > Group< / a > {< / div >
< div class = "line" > < a id = "l00020" name = "l00020" > < / a > < span class = "lineno" > < a class = "line" href = "structmlx_1_1core_1_1distributed_1_1_group.html#a6f84accc8d6734989b2757bf6cdd0152" > 20< / a > < / span > < a class = "code hl_function" href = "structmlx_1_1core_1_1distributed_1_1_group.html#a6f84accc8d6734989b2757bf6cdd0152" > Group< / a > (std::shared_ptr< void> group) : group_(group) {}< / div >
< div class = "line" > < a id = "l00021" name = "l00021" > < / a > < span class = "lineno" > 21< / span > < / div >
< div class = "line" > < a id = "l00022" name = "l00022" > < / a > < span class = "lineno" > < a class = "line" href = "structmlx_1_1core_1_1distributed_1_1_group.html#ad4a5cdab8e2209ad4825f0c63a9cbec7" > 22< / a > < / span > < span class = "keywordtype" > int< / span > < a class = "code hl_function" href = "structmlx_1_1core_1_1distributed_1_1_group.html#ad4a5cdab8e2209ad4825f0c63a9cbec7" > rank< / a > ();< / div >
< div class = "line" > < a id = "l00023" name = "l00023" > < / a > < span class = "lineno" > < a class = "line" href = "structmlx_1_1core_1_1distributed_1_1_group.html#abd96a09217e3d1bcc522888257d22cef" > 23< / a > < / span > < span class = "keywordtype" > int< / span > < a class = "code hl_function" href = "structmlx_1_1core_1_1distributed_1_1_group.html#abd96a09217e3d1bcc522888257d22cef" > size< / a > ();< / div >
< div class = "line" > < a id = "l00024" name = "l00024" > < / a > < span class = "lineno" > 24< / span > < / div >
< div class = "line" > < a id = "l00033" name = "l00033" > < / a > < span class = "lineno" > < a class = "line" href = "structmlx_1_1core_1_1distributed_1_1_group.html#abbf40f8979488806bc5bca9ecc4130e9" > 33< / a > < / span > < a class = "code hl_struct" href = "structmlx_1_1core_1_1distributed_1_1_group.html" > Group< / a > < a class = "code hl_function" href = "structmlx_1_1core_1_1distributed_1_1_group.html#abbf40f8979488806bc5bca9ecc4130e9" > split< / a > (< span class = "keywordtype" > int< / span > color, < span class = "keywordtype" > int< / span > key = -1);< / div >
< div class = "line" > < a id = "l00034" name = "l00034" > < / a > < span class = "lineno" > 34< / span > < / div >
< div class = "foldopen" id = "foldopen00035" data-start = "{" data-end = "}" >
< div class = "line" > < a id = "l00035" name = "l00035" > < / a > < span class = "lineno" > < a class = "line" href = "structmlx_1_1core_1_1distributed_1_1_group.html#a3285b94851cf145a2a472f60b7f7ca36" > 35< / a > < / span > < span class = "keyword" > const< / span > std::shared_ptr< void> & < a class = "code hl_function" href = "structmlx_1_1core_1_1distributed_1_1_group.html#a3285b94851cf145a2a472f60b7f7ca36" > raw_group< / a > () {< / div >
< div class = "line" > < a id = "l00036" name = "l00036" > < / a > < span class = "lineno" > 36< / span > < span class = "keywordflow" > return< / span > group_;< / div >
< div class = "line" > < a id = "l00037" name = "l00037" > < / a > < span class = "lineno" > 37< / span > }< / div >
< / div >
< div class = "line" > < a id = "l00038" name = "l00038" > < / a > < span class = "lineno" > 38< / span > < / div >
< div class = "line" > < a id = "l00039" name = "l00039" > < / a > < span class = "lineno" > 39< / span > < span class = "keyword" > private< / span > :< / div >
< div class = "line" > < a id = "l00040" name = "l00040" > < / a > < span class = "lineno" > 40< / span > std::shared_ptr< void> group_{< span class = "keyword" > nullptr< / span > };< / div >
< div class = "line" > < a id = "l00041" name = "l00041" > < / a > < span class = "lineno" > 41< / span > };< / div >
< / div >
< div class = "line" > < a id = "l00042" name = "l00042" > < / a > < span class = "lineno" > 42< / span > < / div >
< div class = "line" > < a id = "l00051" name = "l00051" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core_1_1distributed.html#a33633c058c7ec82cca4f237243c6810d" > 51< / a > < / span > < a class = "code hl_struct" href = "structmlx_1_1core_1_1distributed_1_1_group.html" > Group< / a > < a class = "code hl_function" href = "namespacemlx_1_1core_1_1distributed.html#a33633c058c7ec82cca4f237243c6810d" > init< / a > (< span class = "keywordtype" > bool< / span > strict = < span class = "keyword" > false< / span > );< / div >
< div class = "line" > < a id = "l00052" name = "l00052" > < / a > < span class = "lineno" > 52< / span > < / div >
2024-09-18 03:06:14 +08:00
< div class = "line" > < a id = "l00053" name = "l00053" > < / a > < span class = "lineno" > 53< / span > } < span class = "comment" > // namespace mlx::core::distributed< / span > < / div >
2024-06-07 11:28:06 +08:00
< / div >
< div class = "ttc" id = "aarray_8h_html" > < div class = "ttname" > < a href = "array_8h.html" > array.h< / a > < / div > < / div >
< div class = "ttc" id = "anamespacemlx_1_1core_1_1distributed_html" > < div class = "ttname" > < a href = "namespacemlx_1_1core_1_1distributed.html" > mlx::core::distributed< / a > < / div > < div class = "ttdef" > < b > Definition< / b > distributed.h:9< / div > < / div >
< div class = "ttc" id = "anamespacemlx_1_1core_1_1distributed_html_a33633c058c7ec82cca4f237243c6810d" > < div class = "ttname" > < a href = "namespacemlx_1_1core_1_1distributed.html#a33633c058c7ec82cca4f237243c6810d" > mlx::core::distributed::init< / a > < / div > < div class = "ttdeci" > Group init(bool strict=false)< / div > < div class = "ttdoc" > Initialize the distributed backend and return the group containing all discoverable processes.< / div > < / div >
< div class = "ttc" id = "anamespacemlx_1_1core_1_1distributed_html_a95655473cd0032c06e5fe3fca85aeef3" > < div class = "ttname" > < a href = "namespacemlx_1_1core_1_1distributed.html#a95655473cd0032c06e5fe3fca85aeef3" > mlx::core::distributed::is_available< / a > < / div > < div class = "ttdeci" > bool is_available()< / div > < / div >
< div class = "ttc" id = "astructmlx_1_1core_1_1distributed_1_1_group_html" > < div class = "ttname" > < a href = "structmlx_1_1core_1_1distributed_1_1_group.html" > mlx::core::distributed::Group< / a > < / div > < div class = "ttdoc" > A distributed::Group represents a group of independent mlx processes that can communicate.< / div > < div class = "ttdef" > < b > Definition< / b > distributed.h:19< / div > < / div >
< div class = "ttc" id = "astructmlx_1_1core_1_1distributed_1_1_group_html_a3285b94851cf145a2a472f60b7f7ca36" > < div class = "ttname" > < a href = "structmlx_1_1core_1_1distributed_1_1_group.html#a3285b94851cf145a2a472f60b7f7ca36" > mlx::core::distributed::Group::raw_group< / a > < / div > < div class = "ttdeci" > const std::shared_ptr< void > & raw_group()< / div > < div class = "ttdef" > < b > Definition< / b > distributed.h:35< / div > < / div >
< div class = "ttc" id = "astructmlx_1_1core_1_1distributed_1_1_group_html_a6f84accc8d6734989b2757bf6cdd0152" > < div class = "ttname" > < a href = "structmlx_1_1core_1_1distributed_1_1_group.html#a6f84accc8d6734989b2757bf6cdd0152" > mlx::core::distributed::Group::Group< / a > < / div > < div class = "ttdeci" > Group(std::shared_ptr< void > group)< / div > < div class = "ttdef" > < b > Definition< / b > distributed.h:20< / div > < / div >
< div class = "ttc" id = "astructmlx_1_1core_1_1distributed_1_1_group_html_abbf40f8979488806bc5bca9ecc4130e9" > < div class = "ttname" > < a href = "structmlx_1_1core_1_1distributed_1_1_group.html#abbf40f8979488806bc5bca9ecc4130e9" > mlx::core::distributed::Group::split< / a > < / div > < div class = "ttdeci" > Group split(int color, int key=-1)< / div > < div class = "ttdoc" > Split the group according to the provided color.< / div > < / div >
< div class = "ttc" id = "astructmlx_1_1core_1_1distributed_1_1_group_html_abd96a09217e3d1bcc522888257d22cef" > < div class = "ttname" > < a href = "structmlx_1_1core_1_1distributed_1_1_group.html#abd96a09217e3d1bcc522888257d22cef" > mlx::core::distributed::Group::size< / a > < / div > < div class = "ttdeci" > int size()< / div > < / div >
< div class = "ttc" id = "astructmlx_1_1core_1_1distributed_1_1_group_html_ad4a5cdab8e2209ad4825f0c63a9cbec7" > < div class = "ttname" > < a href = "structmlx_1_1core_1_1distributed_1_1_group.html#ad4a5cdab8e2209ad4825f0c63a9cbec7" > mlx::core::distributed::Group::rank< / a > < / div > < div class = "ttdeci" > int rank()< / div > < / div >
< / div > <!-- fragment --> < / 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.10.0
< / small > < / address >
< / body >
< / html >
