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" / >
< title > MLX: mlx/backend/metal/copy.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 >
< 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-01-10 05:56:20 +08:00
$(function(){initNavTree('metal_2copy_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" >
< div class = "headertitle" > < div class = "title" > copy.h< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< a href = "metal_2copy_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 © 2023-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 " < a class = "code" href = "common_2copy_8h.html" > mlx/backend/common/copy.h< / a > " < / span > < / div >
< div class = "line" > < a id = "l00006" name = "l00006" > < / a > < span class = "lineno" > 6< / span > < span class = "preprocessor" > #include " < a class = "code" href = "stream_8h.html" > mlx/stream.h< / a > " < / span > < / div >
< div class = "line" > < a id = "l00007" name = "l00007" > < / a > < span class = "lineno" > 7< / span > < / div >
< div class = "line" > < a id = "l00008" name = "l00008" > < / a > < span class = "lineno" > 8< / span > < span class = "keyword" > namespace < / span > < a class = "code hl_namespace" href = "namespacemlx_1_1core.html" > mlx::core< / a > {< / div >
< div class = "line" > < a id = "l00009" name = "l00009" > < / a > < span class = "lineno" > 9< / span > < / div >
< div class = "line" > < a id = "l00010" name = "l00010" > < / a > < span class = "lineno" > 10< / span > < span class = "comment" > // Generic copy inplace< / span > < / div >
2025-01-10 05:56:20 +08:00
< div class = "line" > < a id = "l00011" name = "l00011" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core.html#a473fb602368f6c73d9105c9a151c4c82" > 11< / a > < / span > < span class = "keywordtype" > void< / span > < a class = "code hl_function" href = "namespacemlx_1_1core.html#a473fb602368f6c73d9105c9a151c4c82" > copy_gpu_inplace< / a > (< / div >
< div class = "line" > < a id = "l00012" name = "l00012" > < / a > < span class = "lineno" > 12< / span > < span class = "keyword" > const< / span > < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > & in,< / div >
< div class = "line" > < a id = "l00013" name = "l00013" > < / a > < span class = "lineno" > 13< / span > < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > & out,< / div >
< div class = "line" > < a id = "l00014" name = "l00014" > < / a > < span class = "lineno" > 14< / span > < span class = "keyword" > const< / span > < a class = "code hl_typedef" href = "namespacemlx_1_1core.html#a694e23f2d59606643728ad443d621416" > Shape< / a > & data_shape,< / div >
< div class = "line" > < a id = "l00015" name = "l00015" > < / a > < span class = "lineno" > 15< / span > < span class = "keyword" > const< / span > < a class = "code hl_typedef" href = "namespacemlx_1_1core.html#a79939016d0972ded7db37130da2a8b5c" > Strides< / a > & i_strides,< / div >
< div class = "line" > < a id = "l00016" name = "l00016" > < / a > < span class = "lineno" > 16< / span > < span class = "keyword" > const< / span > < a class = "code hl_typedef" href = "namespacemlx_1_1core.html#a79939016d0972ded7db37130da2a8b5c" > Strides< / a > & o_strides,< / div >
< div class = "line" > < a id = "l00017" name = "l00017" > < / a > < span class = "lineno" > 17< / span > int64_t i_offset,< / div >
< div class = "line" > < a id = "l00018" name = "l00018" > < / a > < span class = "lineno" > 18< / span > int64_t o_offset,< / div >
< div class = "line" > < a id = "l00019" name = "l00019" > < / a > < span class = "lineno" > 19< / span > < a class = "code hl_enumeration" href = "namespacemlx_1_1core.html#abd84ff6c5245e4e170b2ef5247594337" > CopyType< / a > ctype,< / div >
< div class = "line" > < a id = "l00020" name = "l00020" > < / a > < span class = "lineno" > 20< / span > < span class = "keyword" > const< / span > < a class = "code hl_struct" href = "structmlx_1_1core_1_1_stream.html" > Stream< / a > & s,< / div >
< div class = "line" > < a id = "l00021" name = "l00021" > < / a > < span class = "lineno" > 21< / span > < span class = "keyword" > const< / span > std::optional< array> & dynamic_i_offset = std::nullopt,< / div >
< div class = "line" > < a id = "l00022" name = "l00022" > < / a > < span class = "lineno" > 22< / span > < span class = "keyword" > const< / span > std::optional< array> & dynamic_o_offset = std::nullopt);< / div >
< div class = "line" > < a id = "l00023" name = "l00023" > < / a > < span class = "lineno" > 23< / span > < / div >
< div class = "line" > < a id = "l00024" name = "l00024" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core.html#addaa46a13ac2deb1d9ce621338320e0e" > 24< / a > < / span > < span class = "keywordtype" > void< / span > < a class = "code hl_function" href = "namespacemlx_1_1core.html#addaa46a13ac2deb1d9ce621338320e0e" > copy_gpu< / a > (< span class = "keyword" > const< / span > < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > & src, < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > & out, < a class = "code hl_enumeration" href = "namespacemlx_1_1core.html#abd84ff6c5245e4e170b2ef5247594337" > CopyType< / a > ctype, < span class = "keyword" > const< / span > < a class = "code hl_struct" href = "structmlx_1_1core_1_1_stream.html" > Stream< / a > & s);< / div >
< div class = "line" > < a id = "l00025" name = "l00025" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core.html#a6a6f4e46c8fc44fdc74c50ace02bcf38" > 25< / a > < / span > < span class = "keywordtype" > void< / span > < a class = "code hl_function" href = "namespacemlx_1_1core.html#addaa46a13ac2deb1d9ce621338320e0e" > copy_gpu< / a > (< span class = "keyword" > const< / span > < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > & src, < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > & out, < a class = "code hl_enumeration" href = "namespacemlx_1_1core.html#abd84ff6c5245e4e170b2ef5247594337" > CopyType< / a > ctype);< / div >
< div class = "line" > < a id = "l00026" name = "l00026" > < / a > < span class = "lineno" > 26< / span > < / div >
< div class = "line" > < a id = "l00027" name = "l00027" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core.html#a58ef0842dd1b8f79159d5fb6777d30a1" > 27< / a > < / span > < span class = "keywordtype" > void< / span > < a class = "code hl_function" href = "namespacemlx_1_1core.html#a473fb602368f6c73d9105c9a151c4c82" > copy_gpu_inplace< / a > (< / div >
< div class = "line" > < a id = "l00028" name = "l00028" > < / a > < span class = "lineno" > 28< / span > < span class = "keyword" > const< / span > < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > & in,< / div >
< div class = "line" > < a id = "l00029" name = "l00029" > < / a > < span class = "lineno" > 29< / span > < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > & out,< / div >
< div class = "line" > < a id = "l00030" name = "l00030" > < / a > < span class = "lineno" > 30< / span > < a class = "code hl_enumeration" href = "namespacemlx_1_1core.html#abd84ff6c5245e4e170b2ef5247594337" > CopyType< / a > ctype,< / div >
< div class = "line" > < a id = "l00031" name = "l00031" > < / a > < span class = "lineno" > 31< / span > < span class = "keyword" > const< / span > < a class = "code hl_struct" href = "structmlx_1_1core_1_1_stream.html" > Stream< / a > & s);< / div >
< div class = "line" > < a id = "l00032" name = "l00032" > < / a > < span class = "lineno" > 32< / span > < / div >
< div class = "line" > < a id = "l00033" name = "l00033" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core.html#a49fc043a981925b9be79e37fc415d966" > 33< / a > < / span > < span class = "keywordtype" > void< / span > < a class = "code hl_function" href = "namespacemlx_1_1core.html#a473fb602368f6c73d9105c9a151c4c82" > copy_gpu_inplace< / a > (< / div >
< div class = "line" > < a id = "l00034" name = "l00034" > < / a > < span class = "lineno" > 34< / span > < span class = "keyword" > const< / span > < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > & in,< / div >
< div class = "line" > < a id = "l00035" name = "l00035" > < / a > < span class = "lineno" > 35< / span > < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > & out,< / div >
< div class = "line" > < a id = "l00036" name = "l00036" > < / a > < span class = "lineno" > 36< / span > < span class = "keyword" > const< / span > < a class = "code hl_typedef" href = "namespacemlx_1_1core.html#a79939016d0972ded7db37130da2a8b5c" > Strides< / a > & i_strides,< / div >
< div class = "line" > < a id = "l00037" name = "l00037" > < / a > < span class = "lineno" > 37< / span > int64_t i_offset,< / div >
< div class = "line" > < a id = "l00038" name = "l00038" > < / a > < span class = "lineno" > 38< / span > < a class = "code hl_enumeration" href = "namespacemlx_1_1core.html#abd84ff6c5245e4e170b2ef5247594337" > CopyType< / a > ctype,< / div >
< div class = "line" > < a id = "l00039" name = "l00039" > < / a > < span class = "lineno" > 39< / span > < span class = "keyword" > const< / span > < a class = "code hl_struct" href = "structmlx_1_1core_1_1_stream.html" > Stream< / a > & s);< / div >
< div class = "line" > < a id = "l00040" name = "l00040" > < / a > < span class = "lineno" > 40< / span > < / div >
< div class = "line" > < a id = "l00041" name = "l00041" > < / a > < span class = "lineno" > 41< / span > < span class = "comment" > // Fill the output with the scalar val< / span > < / div >
< div class = "line" > < a id = "l00042" name = "l00042" > < / a > < span class = "lineno" > < a class = "line" href = "namespacemlx_1_1core.html#ae789dbda2a0f4e21aa0984f6a5dc986c" > 42< / a > < / span > < span class = "keywordtype" > void< / span > < a class = "code hl_function" href = "namespacemlx_1_1core.html#ae789dbda2a0f4e21aa0984f6a5dc986c" > fill_gpu< / a > (< span class = "keyword" > const< / span > < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > & val, < a class = "code hl_class" href = "classmlx_1_1core_1_1array.html" > array< / a > & out, < span class = "keyword" > const< / span > < a class = "code hl_struct" href = "structmlx_1_1core_1_1_stream.html" > Stream< / a > & s);< / div >
< div class = "line" > < a id = "l00043" name = "l00043" > < / a > < span class = "lineno" > 43< / span > < / div >
< div class = "line" > < a id = "l00044" name = "l00044" > < / a > < span class = "lineno" > 44< / span > } < span class = "comment" > // namespace mlx::core< / span > < / div >
< div class = "ttc" id = "aclassmlx_1_1core_1_1array_html" > < div class = "ttname" > < a href = "classmlx_1_1core_1_1array.html" > mlx::core::array< / a > < / div > < div class = "ttdef" > < b > Definition< / b > array.h:24< / div > < / div >
2024-10-15 23:12:17 +08:00
< div class = "ttc" id = "acommon_2copy_8h_html" > < div class = "ttname" > < a href = "common_2copy_8h.html" > copy.h< / a > < / div > < / div >
< div class = "ttc" id = "anamespacemlx_1_1core_html" > < div class = "ttname" > < a href = "namespacemlx_1_1core.html" > mlx::core< / a > < / div > < div class = "ttdef" > < b > Definition< / b > allocator.h:7< / div > < / div >
2025-01-10 05:56:20 +08:00
< div class = "ttc" id = "anamespacemlx_1_1core_html_a473fb602368f6c73d9105c9a151c4c82" > < div class = "ttname" > < a href = "namespacemlx_1_1core.html#a473fb602368f6c73d9105c9a151c4c82" > mlx::core::copy_gpu_inplace< / a > < / div > < div class = "ttdeci" > void copy_gpu_inplace(const array & in, array & out, const Shape & data_shape, const Strides & i_strides, const Strides & o_strides, int64_t i_offset, int64_t o_offset, CopyType ctype, const Stream & s, const std::optional< array > & dynamic_i_offset=std::nullopt, const std::optional< array > & dynamic_o_offset=std::nullopt)< / div > < / div >
< div class = "ttc" id = "anamespacemlx_1_1core_html_a694e23f2d59606643728ad443d621416" > < div class = "ttname" > < a href = "namespacemlx_1_1core.html#a694e23f2d59606643728ad443d621416" > mlx::core::Shape< / a > < / div > < div class = "ttdeci" > std::vector< ShapeElem > Shape< / div > < div class = "ttdef" > < b > Definition< / b > array.h:21< / div > < / div >
< div class = "ttc" id = "anamespacemlx_1_1core_html_a79939016d0972ded7db37130da2a8b5c" > < div class = "ttname" > < a href = "namespacemlx_1_1core.html#a79939016d0972ded7db37130da2a8b5c" > mlx::core::Strides< / a > < / div > < div class = "ttdeci" > std::vector< int64_t > Strides< / div > < div class = "ttdef" > < b > Definition< / b > array.h:22< / div > < / div >
2025-02-07 04:16:29 +08:00
< div class = "ttc" id = "anamespacemlx_1_1core_html_abd84ff6c5245e4e170b2ef5247594337" > < div class = "ttname" > < a href = "namespacemlx_1_1core.html#abd84ff6c5245e4e170b2ef5247594337" > mlx::core::CopyType< / a > < / div > < div class = "ttdeci" > CopyType< / div > < div class = "ttdef" > < b > Definition< / b > copy.h:9< / div > < / div >
2024-10-15 23:12:17 +08:00
< div class = "ttc" id = "anamespacemlx_1_1core_html_addaa46a13ac2deb1d9ce621338320e0e" > < div class = "ttname" > < a href = "namespacemlx_1_1core.html#addaa46a13ac2deb1d9ce621338320e0e" > mlx::core::copy_gpu< / a > < / div > < div class = "ttdeci" > void copy_gpu(const array & src, array & out, CopyType ctype, const Stream & s)< / div > < / div >
< div class = "ttc" id = "anamespacemlx_1_1core_html_ae789dbda2a0f4e21aa0984f6a5dc986c" > < div class = "ttname" > < a href = "namespacemlx_1_1core.html#ae789dbda2a0f4e21aa0984f6a5dc986c" > mlx::core::fill_gpu< / a > < / div > < div class = "ttdeci" > void fill_gpu(const array & val, array & out, const Stream & s)< / div > < / div >
< div class = "ttc" id = "astream_8h_html" > < div class = "ttname" > < a href = "stream_8h.html" > stream.h< / a > < / div > < / div >
< div class = "ttc" id = "astructmlx_1_1core_1_1_stream_html" > < div class = "ttname" > < a href = "structmlx_1_1core_1_1_stream.html" > mlx::core::Stream< / a > < / div > < div class = "ttdef" > < b > Definition< / b > stream.h:9< / div > < / div >
< / 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 >
< li class = "navelem" > < a class = "el" href = "dir_938ab0ecf10b8b860ff766c820f665fd.html" > mlx< / a > < / li > < li class = "navelem" > < a class = "el" href = "dir_1d446c9bd3c99228254c9484e0bc5c06.html" > backend< / a > < / li > < li class = "navelem" > < a class = "el" href = "dir_d0c977ea65824390717cdb7efc36c157.html" > metal< / a > < / li > < li class = "navelem" > < a class = "el" href = "metal_2copy_8h.html" > copy.h< / a > < / li >
2025-02-07 04:16:29 +08: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-10 05:56:20 +08:00
< / ul >
< / div >
2024-10-15 23:12:17 +08:00
< / body >
< / html >
