build based on 0150982

BioJulia · Jul 27, 2024 · 439bedb · 439bedb
1 parent ca9c8ab
commit 439bedb
Show file tree

Hide file tree

Showing 12 changed files with 27 additions and 14 deletions.
diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json
@@ -1 +1 @@
-{"documenter":{"julia_version":"1.12.0-DEV.846","generation_timestamp":"2024-07-11T18:54:29","documenter_version":"1.4.1"}}
+{"documenter":{"julia_version":"1.12.0-DEV.933","generation_timestamp":"2024-07-27T09:39:35","documenter_version":"1.5.0"}}
diff --git a/dev/assets/documenter.js b/dev/assets/documenter.js
diff --git a/dev/assets/themes/catppuccin-frappe.css b/dev/assets/themes/catppuccin-frappe.css
diff --git a/dev/assets/themes/catppuccin-latte.css b/dev/assets/themes/catppuccin-latte.css
diff --git a/dev/assets/themes/catppuccin-macchiato.css b/dev/assets/themes/catppuccin-macchiato.css
diff --git a/dev/assets/themes/catppuccin-mocha.css b/dev/assets/themes/catppuccin-mocha.css
diff --git a/dev/assets/themes/documenter-dark.css b/dev/assets/themes/documenter-dark.css
diff --git a/dev/assets/themes/documenter-light.css b/dev/assets/themes/documenter-light.css
diff --git a/dev/base/index.html b/dev/base/index.html
diff --git a/dev/index.html b/dev/index.html
@@ -1,9 +1,9 @@
 <!DOCTYPE html>
-<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}
+<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/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><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. 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
+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 constructed 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
@@ -32,4 +32,4 @@
 
 # output
 3
-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 11 July 2024 18:54">Thursday 11 July 2024</span>. Using Julia version 1.12.0-DEV.846.</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><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.5.0 on <span class="colophon-date" title="Saturday 27 July 2024 09:39">Saturday 27 July 2024</span>. Using Julia version 1.12.0-DEV.933.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		{"documenter":{"julia_version":"1.12.0-DEV.846","generation_timestamp":"2024-07-11T18:54:29","documenter_version":"1.4.1"}}
		{"documenter":{"julia_version":"1.12.0-DEV.933","generation_timestamp":"2024-07-27T09:39:35","documenter_version":"1.5.0"}}