Skip to content

Commit

Permalink
build based on 469a7a7
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Jun 27, 2024
1 parent 7a81916 commit 30b6f62
Show file tree
Hide file tree
Showing 6 changed files with 24 additions and 24 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.12.0-DEV.775","generation_timestamp":"2024-06-24T14:12:20","documenter_version":"1.4.1"}}
{"documenter":{"julia_version":"1.12.0-DEV.791","generation_timestamp":"2024-06-27T18:10:54","documenter_version":"1.4.1"}}
2 changes: 1 addition & 1 deletion dev/base/index.html
View file

Large diffs are not rendered by default.

20 changes: 10 additions & 10 deletions dev/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>MemViews · MemViews.jl</title><meta name="title" content="MemViews · MemViews.jl"/><meta property="og:title" content="MemViews · MemViews.jl"/><meta property="twitter:title" content="MemViews · MemViews.jl"/><meta name="description" content="Documentation for MemViews.jl."/><meta property="og:description" content="Documentation for MemViews.jl."/><meta property="twitter:description" content="Documentation for MemViews.jl."/><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>MemViews.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 class="is-active"><a class="tocitem" href>MemViews</a><ul class="internal"><li><a class="tocitem" href="#Usage"><span>Usage</span></a></li></ul></li><li><a class="tocitem" href="interfaces/">MemViews in interfaces</a></li><li><a class="tocitem" href="base/">MemViews in Base</a></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 class="is-active"><a href>MemViews</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>MemViews</a></li></ul></nav><div class="docs-right"><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"><h1 id="MemViews.jl"><a class="docs-heading-anchor" href="#MemViews.jl">MemViews.jl</a><a id="MemViews.jl-1"></a><a class="docs-heading-anchor-permalink" href="#MemViews.jl" title="Permalink"></a></h1><p>This package provide the <code>MemView</code> type, which is a lightweight and simple view into <code>Memory</code>. The <code>MemView</code> type is a useful low-level building block for code that operates on chunks of memory.</p><h4 id="Features:"><a class="docs-heading-anchor" href="#Features:">Features:</a><a id="Features:-1"></a><a class="docs-heading-anchor-permalink" href="#Features:" title="Permalink"></a></h4><ul><li>Simple and easy to reason about</li><li>Low-overhead, efficient methods</li><li>A safer alternative to pointers</li></ul><p>The <code>MemView</code> type has the following layout:</p><pre><code class="language-julia hljs">struct MemView{T, M} &lt;: AbstractVector{T}
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>MemoryViews · MemoryViews.jl</title><meta name="title" content="MemoryViews · MemoryViews.jl"/><meta property="og:title" content="MemoryViews · MemoryViews.jl"/><meta property="twitter:title" content="MemoryViews · MemoryViews.jl"/><meta name="description" content="Documentation for MemoryViews.jl."/><meta property="og:description" content="Documentation for MemoryViews.jl."/><meta property="twitter:description" content="Documentation for MemoryViews.jl."/><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>MemoryViews.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 class="is-active"><a class="tocitem" href>MemoryViews</a><ul class="internal"><li><a class="tocitem" href="#Usage"><span>Usage</span></a></li></ul></li><li><a class="tocitem" href="interfaces/">MemoryViews in interfaces</a></li><li><a class="tocitem" href="base/">MemoryViews in Base</a></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 class="is-active"><a href>MemoryViews</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>MemoryViews</a></li></ul></nav><div class="docs-right"><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"><h1 id="MemoryViews.jl"><a class="docs-heading-anchor" href="#MemoryViews.jl">MemoryViews.jl</a><a id="MemoryViews.jl-1"></a><a class="docs-heading-anchor-permalink" href="#MemoryViews.jl" title="Permalink"></a></h1><p>This package provide the <code>MemoryView</code> type, which is a lightweight and simple view into <code>Memory</code>. The <code>MemoryView</code> type is a useful low-level building block for code that operates on chunks of memory.</p><h4 id="Features:"><a class="docs-heading-anchor" href="#Features:">Features:</a><a id="Features:-1"></a><a class="docs-heading-anchor-permalink" href="#Features:" title="Permalink"></a></h4><ul><li>Simple and easy to reason about</li><li>Low-overhead, efficient methods</li><li>A safer alternative to pointers</li></ul><p>The <code>MemoryView</code> type has the following layout:</p><pre><code class="language-julia hljs">struct MemoryView{T, M} &lt;: AbstractVector{T}
ref::MemoryRef{T},
len::Int
end</code></pre><p>The <code>M</code> parameter is either <code>Mutable</code> or <code>Immutable</code>, which are unexported types defined in this package. MemViews also provide the following aliases for convenience:</p><pre><code class="language-julia hljs">const MutableMemView{T} = MemView{T, Mutable}
const ImmutableMemView{T} = MemView{T, Immutable}</code></pre><p>Immutable memory views are immutable, in that they do not support <code>setindex!</code> or other mutating methods. The existence of an <code>ImmutableMemView</code> does not protect its underlying data from being mutated through another variable.</p><h2 id="Usage"><a class="docs-heading-anchor" href="#Usage">Usage</a><a id="Usage-1"></a><a class="docs-heading-anchor-permalink" href="#Usage" title="Permalink"></a></h2><h3 id="Constructing-memory-views"><a class="docs-heading-anchor" href="#Constructing-memory-views">Constructing memory views</a><a id="Constructing-memory-views-1"></a><a class="docs-heading-anchor-permalink" href="#Constructing-memory-views" title="Permalink"></a></h3><p>Construct memory views from <code>x</code> with <code>MemView(x)</code>. MemViews should be constructable from any type that is stored as an array densely in memory. It can also be conctructed from other non-array types that are represented by a chunk of memory (like a <code>String</code>). By default, constructors exists for the memory-backed types in Base:</p><pre><code class="language-julia hljs"># Vectors
@assert MemView([&quot;a&quot;, &quot;b&quot;, &quot;c&quot;]) isa MemView
end</code></pre><p>The <code>M</code> parameter is either <code>Mutable</code> or <code>Immutable</code>, which are unexported types defined in this package. MemoryViews also provide the following aliases for convenience:</p><pre><code class="language-julia hljs">const MutableMemoryView{T} = MemoryView{T, Mutable}
const ImmutableMemoryView{T} = MemoryView{T, Immutable}</code></pre><p>Immutable memory views are immutable, in that they do not support <code>setindex!</code> or other mutating methods. The existence of an <code>ImmutableMemoryView</code> does not protect its underlying data from being mutated through another variable.</p><h2 id="Usage"><a class="docs-heading-anchor" href="#Usage">Usage</a><a id="Usage-1"></a><a class="docs-heading-anchor-permalink" href="#Usage" title="Permalink"></a></h2><h3 id="Constructing-memory-views"><a class="docs-heading-anchor" href="#Constructing-memory-views">Constructing memory views</a><a id="Constructing-memory-views-1"></a><a class="docs-heading-anchor-permalink" href="#Constructing-memory-views" title="Permalink"></a></h3><p>Construct memory views from <code>x</code> with <code>MemoryView(x)</code>. MemoryViews should be constructable from any type that is stored as an array densely in memory. It can also be conctructed from other non-array types that are represented by a chunk of memory (like a <code>String</code>). By default, constructors exists for the memory-backed types in Base:</p><pre><code class="language-julia hljs"># Vectors
@assert MemoryView([&quot;a&quot;, &quot;b&quot;, &quot;c&quot;]) isa MemoryView

# Strings
@assert MemView(&quot;abc&quot;) isa MemView
@assert MemoryView(&quot;abc&quot;) isa MemoryView

# Even complex nested memory-backed types
@assert MemView(view(codeunits(view(&quot;abcd&quot;, Base.OneTo(2))), :)) isa MemView</code></pre><p>For values <code>x</code> that are mutable such as <code>Memory</code>s and <code>Array</code>s (and <code>SubArray</code>s of those), <code>MemView(x)</code> return <code>MutableMemView</code>:</p><pre><code class="language-julia hljs">@assert MemView(Int32[1,2,3]) isa MutableMemView{Int32}
@assert MemView(Memory{String}(undef, 3)) isa MutableMemView{String}</code></pre><p>For values that are immutable, <code>MemView</code> return <code>ImmutableMemView</code>s:</p><pre><code class="language-julia hljs">@assert MemView(&quot;abc&quot;) isa ImmutableMemView{UInt8}</code></pre><p>The constructor <code>ImmutableMemView(x)</code> will construct an immutable view no matter if the type returned by <code>MemView(x)</code> is mutable or not. This is because it&#39;s always possible to convert a mutable memory view to an immutable one:</p><pre><code class="language-julia hljs">@assert MemView(UInt[]) isa MutableMemView{UInt}
@assert ImmutableMemView(UInt[]) isa ImmutableMemView{UInt}</code></pre><p>Hence, when adding new constructors for new types, you should only add methods to <code>MemView</code>. This should return a mutable memview where possible.</p><h3 id="Indexing"><a class="docs-heading-anchor" href="#Indexing">Indexing</a><a id="Indexing-1"></a><a class="docs-heading-anchor-permalink" href="#Indexing" title="Permalink"></a></h3><p><code>MemView{T}</code> is a subtype of <code>AbstractVector{T}</code>, and mostly behave like you would expect an abstract vector to behave w.r.t. indexing:</p><pre><code class="language-julia hljs">mem = MemView([1,2,3,4,5,6,7,8])
@assert MemoryView(view(codeunits(view(&quot;abcd&quot;, Base.OneTo(2))), :)) isa MemoryView</code></pre><p>For values <code>x</code> that are mutable such as <code>Memory</code>s and <code>Array</code>s (and <code>SubArray</code>s of those), <code>MemoryView(x)</code> return <code>MutableMemoryView</code>:</p><pre><code class="language-julia hljs">@assert MemoryView(Int32[1,2,3]) isa MutableMemoryView{Int32}
@assert MemoryView(Memory{String}(undef, 3)) isa MutableMemoryView{String}</code></pre><p>For values that are immutable, <code>MemoryView</code> return <code>ImmutableMemoryView</code>s:</p><pre><code class="language-julia hljs">@assert MemoryView(&quot;abc&quot;) isa ImmutableMemoryView{UInt8}</code></pre><p>The constructor <code>ImmutableMemoryView(x)</code> will construct an immutable view no matter if the type returned by <code>MemoryView(x)</code> is mutable or not. This is because it&#39;s always possible to convert a mutable memory view to an immutable one:</p><pre><code class="language-julia hljs">@assert MemoryView(UInt[]) isa MutableMemoryView{UInt}
@assert ImmutableMemoryView(UInt[]) isa ImmutableMemoryView{UInt}</code></pre><p>Hence, when adding new constructors for new types, you should only add methods to <code>MemoryView</code>. This should return a mutable memview where possible.</p><h3 id="Indexing"><a class="docs-heading-anchor" href="#Indexing">Indexing</a><a id="Indexing-1"></a><a class="docs-heading-anchor-permalink" href="#Indexing" title="Permalink"></a></h3><p><code>MemoryView{T}</code> is a subtype of <code>AbstractVector{T}</code>, and mostly behave like you would expect an abstract vector to behave w.r.t. indexing:</p><pre><code class="language-julia hljs">mem = MemoryView([1,2,3,4,5,6,7,8])

println(mem[2])
println(mem[2:4])
Expand All @@ -23,7 +23,7 @@
2
[2, 3, 4]
8
[1, 2, 3, 4, 5, 6, 7, 8]</code></pre><p>One exception is slicing, which does not copy the underlying data, but simply returns a new view of the same data. To copy explicitly, use <code>copy</code>, which will create a new <code>MemView</code> that looks into a copy of the underlying data:</p><pre><code class="language-julia hljs">mem1 = MemView([1,2,3])
[1, 2, 3, 4, 5, 6, 7, 8]</code></pre><p>One exception is slicing, which does not copy the underlying data, but simply returns a new view of the same data. To copy explicitly, use <code>copy</code>, which will create a new <code>MemoryView</code> that looks into a copy of the underlying data:</p><pre><code class="language-julia hljs">mem1 = MemoryView([1,2,3])
mem2 = mem1[1:3]
mem3 = copy(mem1)
mem1[1] = 3
Expand All @@ -32,4 +32,4 @@

# output
3
1</code></pre></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="interfaces/">MemViews in interfaces »</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.1 on <span class="colophon-date" title="Monday 24 June 2024 14:12">Monday 24 June 2024</span>. Using Julia version 1.12.0-DEV.775.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
1</code></pre></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="interfaces/">MemoryViews in interfaces »</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.1 on <span class="colophon-date" title="Thursday 27 June 2024 18:10">Thursday 27 June 2024</span>. Using Julia version 1.12.0-DEV.791.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 30b6f62

Please sign in to comment.