-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Documenter.jl
committed
Apr 19, 2024
1 parent
9d54bed
commit 9a52c51
Showing
19 changed files
with
2,079 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
{"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-04-19T01:37:30","documenter_version":"1.4.0"}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
<!DOCTYPE html> | ||
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>MoYeArray · MoYe.jl</title><meta name="title" content="MoYeArray · MoYe.jl"/><meta property="og:title" content="MoYeArray · MoYe.jl"/><meta property="twitter:title" content="MoYeArray · MoYe.jl"/><meta name="description" content="Documentation for MoYe.jl."/><meta property="og:description" content="Documentation for MoYe.jl."/><meta property="twitter:description" content="Documentation for MoYe.jl."/><meta property="og:url" content="https://YichengDWu.github.io/MoYe.jl/api/array/"/><meta property="twitter:url" content="https://YichengDWu.github.io/MoYe.jl/api/array/"/><link rel="canonical" href="https://YichengDWu.github.io/MoYe.jl/api/array/"/><script data-outdated-warner src="../../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="../.."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../../assets/documenter.js"></script><script src="../../search_index.js"></script><script src="../../siteinfo.js"></script><script src="../../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../../">MoYe.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../../">Home</a></li><li><span class="tocitem">Manual</span><ul><li><a class="tocitem" href="../../manual/layout/">Layout</a></li><li><a class="tocitem" href="../../manual/array/">Array</a></li><li><a class="tocitem" href="../../manual/broadcast/">Broadcasting</a></li><li><a class="tocitem" href="../../manual/tiling_matmul/">MatMul</a></li><li><input class="collapse-toggle" id="menuitem-2-5" type="checkbox"/><label class="tocitem" for="menuitem-2-5"><span class="docs-label">Data Movement</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../../manual/datamovement/gs/">Global Memory & Shared Memory</a></li></ul></li></ul></li><li><span class="tocitem">API Reference</span><ul><li><a class="tocitem" href="../layout/">Layout</a></li><li class="is-active"><a class="tocitem" href>MoYeArray</a><ul class="internal"><li><a class="tocitem" href="#MoYeArray"><span>MoYeArray</span></a></li><li><a class="tocitem" href="#Index"><span>Index</span></a></li></ul></li><li><a class="tocitem" href="../tiling/">Tiling</a></li><li><a class="tocitem" href="../copy/">Data Movement</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">API Reference</a></li><li class="is-active"><a href>MoYeArray</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>MoYeArray</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/YichengDWu/MoYe.jl/blob/main/docs/src/api/array.md#" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h2 id="MoYeArray"><a class="docs-heading-anchor" href="#MoYeArray">MoYeArray</a><a id="MoYeArray-1"></a><a class="docs-heading-anchor-permalink" href="#MoYeArray" title="Permalink"></a></h2><h2 id="Index"><a class="docs-heading-anchor" href="#Index">Index</a><a id="Index-1"></a><a class="docs-heading-anchor-permalink" href="#Index" title="Permalink"></a></h2><ul><li><a href="#MoYe.ArrayEngine"><code>MoYe.ArrayEngine</code></a></li><li><a href="#MoYe.MoYeArray"><code>MoYe.MoYeArray</code></a></li><li><a href="#MoYe.ViewEngine"><code>MoYe.ViewEngine</code></a></li><li><a href="#MoYe.recast"><code>MoYe.recast</code></a></li><li><a href="#MoYe.zeros!"><code>MoYe.zeros!</code></a></li></ul><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="MoYe.ViewEngine" href="#MoYe.ViewEngine"><code>MoYe.ViewEngine</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">ViewEngine{T, P}</code></pre><p>A wrapper of a pointer. <code>P</code> is the type of the pointer.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/YichengDWu/MoYe.jl/blob/cf6a3066e79bf0cbbb4715a695f157c41b80158d/src/engine.jl#L1-L5">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="MoYe.ArrayEngine" href="#MoYe.ArrayEngine"><code>MoYe.ArrayEngine</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">ArrayEngine{T, L} <: DenseVector{T}</code></pre><p>A owning and mutable vector of type <code>T</code> with static length <code>L</code>.</p><p><strong>Examples</strong></p><pre><code class="language-julia hljs">julia> x = ArrayEngine{Float32}(undef, static(3)) | ||
3-element ArrayEngine{Float32, 3}: | ||
-9.8271385f-36 | ||
7.57f-43 | ||
-9.8271385f-36 | ||
|
||
julia> x[1] = 10f0 | ||
10.0f0 | ||
|
||
julia> x | ||
3-element ArrayEngine{Float32, 3}: | ||
10.0 | ||
7.57f-43 | ||
-9.8271385f-36</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/YichengDWu/MoYe.jl/blob/cf6a3066e79bf0cbbb4715a695f157c41b80158d/src/engine.jl#L52-L75">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="MoYe.MoYeArray" href="#MoYe.MoYeArray"><code>MoYe.MoYeArray</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">MoYeArray(engine::Engine, layout::Layout) | ||
MoYeArray{T}(::UndefInitializer, layout::StaticLayout) | ||
MoYeArray(ptr, layout::Layout)</code></pre><p>Create a MoYeArray from an engine and a layout. See also <a href="#MoYe.ArrayEngine"><code>ArrayEngine</code></a> and <a href="#MoYe.ViewEngine"><code>ViewEngine</code></a>.</p><p><strong>Examples</strong></p><pre><code class="language-julia hljs">julia> slayout = @Layout (5, 2); | ||
|
||
julia> array_engine = ArrayEngine{Float32}(undef, cosize(slayout)); # owning array | ||
|
||
julia> MoYeArray(array_engine, slayout) | ||
5×2 MoYeArray{Float32, 2, ArrayEngine{Float32, 10}, Layout{2, Tuple{Static.StaticInt{5}, Static.StaticInt{2}}, Tuple{Static.StaticInt{1}, Static.StaticInt{5}}}}: | ||
-3.24118f12 0.0 | ||
7.57f-43 0.0 | ||
0.0 0.0 | ||
0.0 0.0 | ||
7.89217f-40 0.0 | ||
|
||
julia> MoYeArray{Float32}(undef, slayout) | ||
5×2 MoYeArray{Float32, 2, ArrayEngine{Float32, 10}, Layout{2, Tuple{Static.StaticInt{5}, Static.StaticInt{2}}, Tuple{Static.StaticInt{1}, Static.StaticInt{5}}}}: | ||
4.0f-45 7.57f-43 | ||
0.0 0.0 | ||
-1.81623f7 0.0 | ||
7.57f-43 0.0 | ||
-1.81623f7 0.0 | ||
|
||
julia> A = ones(10); | ||
|
||
julia> MoYeArray(pointer(A), slayout) # non-owning array | ||
5×2 MoYeArray{Float64, 2, ViewEngine{Float64, Ptr{Float64}}, Layout{2, Tuple{Static.StaticInt{5}, Static.StaticInt{2}}, Tuple{Static.StaticInt{1}, Static.StaticInt{5}}}}: | ||
1.0 1.0 | ||
1.0 1.0 | ||
1.0 1.0 | ||
1.0 1.0 | ||
1.0 1.0 | ||
|
||
julia> function test_alloc() # when powered by a ArrayEngine, MoYeArray is stack-allocated | ||
slayout = @Layout (2, 3) # and mutable | ||
x = MoYeArray{Float32}(undef, slayout) | ||
fill!(x, 1.0f0) | ||
return sum(x) | ||
end | ||
test_alloc (generic function with 2 methods) | ||
|
||
julia> @allocated(test_alloc()) | ||
0 | ||
</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/YichengDWu/MoYe.jl/blob/cf6a3066e79bf0cbbb4715a695f157c41b80158d/src/array.jl#L1-L53">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="MoYe.recast" href="#MoYe.recast"><code>MoYe.recast</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">recast(::Type{NewType}, x::MoYeArray{OldType}) -> MoYeArray{NewType}</code></pre><p>Recast the element type of a MoYeArray. This is similar to <code>Base.reinterpret</code>, but dose all the computation at compile time, if possible.</p><p><strong>Examples</strong></p><pre><code class="language-julia hljs">julia> x = MoYeArray{Int32}(undef, @Layout((2,3))) | ||
2×3 MoYeArray{Int32, 2, ArrayEngine{Int32, 6}, Layout{2, Tuple{Static.StaticInt{2}, Static.StaticInt{3}}, Tuple{Static.StaticInt{1}, Static.StaticInt{2}}}}: | ||
-1948408944 0 2 | ||
514 -268435456 0 | ||
|
||
julia> x2 = recast(Int16, x) | ||
4×3 MoYeArray{Int16, 2, ViewEngine{Int16, Ptr{Int16}}, Layout{2, Tuple{Static.StaticInt{4}, Static.StaticInt{3}}, Tuple{Static.StaticInt{1}, Static.StaticInt{4}}}}: | ||
-23664 0 2 | ||
-29731 0 0 | ||
514 0 0 | ||
0 -4096 0 | ||
|
||
julia> x3 = recast(Int64, x) | ||
1×3 MoYeArray{Int64, 2, ViewEngine{Int64, Ptr{Int64}}, Layout{2, Tuple{Static.StaticInt{1}, Static.StaticInt{3}}, Tuple{Static.StaticInt{1}, Static.StaticInt{1}}}}: | ||
2209959748496 -1152921504606846976 2</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/YichengDWu/MoYe.jl/blob/cf6a3066e79bf0cbbb4715a695f157c41b80158d/src/array.jl#L259-L283">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="MoYe.zeros!" href="#MoYe.zeros!"><code>MoYe.zeros!</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">zeros!(x::MoYeArray)</code></pre><p>Fill <code>x</code> with zeros.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/YichengDWu/MoYe.jl/blob/cf6a3066e79bf0cbbb4715a695f157c41b80158d/src/algorithm/array_algorithms.jl#L170-L174">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../layout/">« Layout</a><a class="docs-footer-nextpage" href="../tiling/">Tiling »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.0 on <span class="colophon-date" title="Friday 19 April 2024 01:37">Friday 19 April 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> |
Oops, something went wrong.