Skip to content

Commit

Permalink
build based on 85b4120
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Feb 3, 2024
1 parent c38b6cd commit 531c0a7
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 21 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.10.0","generation_timestamp":"2024-02-03T21:03:38","documenter_version":"1.2.1"}}
{"documenter":{"julia_version":"1.10.0","generation_timestamp":"2024-02-03T21:03:43","documenter_version":"1.2.1"}}
16 changes: 8 additions & 8 deletions dev/LArrays/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,22 +16,22 @@
julia> z.a
2-element view(::Array{Int64,2}, 2, :) with eltype Int64:
3
4</code></pre><p>The labels of LArray and SLArray can be accessed by function <code>symbols</code>, which returns a tuple of symbols.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/LabelledArrays.jl/blob/07989c44a7af1e90df40747c7aa74df77753b214/src/larray.jl#L194-L241">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="LabelledArrays.@LVector" href="#LabelledArrays.@LVector"><code>LabelledArrays.@LVector</code></a> — <span class="docstring-category">Macro</span></header><section><div><pre><code class="language-julia hljs">@LVector Type Names</code></pre><p>The <code>@LVector</code> macro creates an <code>LArray</code> of dimension 1 with eltype and undefined values. The vector&#39;s length is equal to the number of names given.</p><p>As with an <code>LArray</code>, the user can initialize the vector and set its values later.</p><pre><code class="language-julia hljs">A = @LVector Float64 (:a, :b, :c, :d)
A .= rand(4)</code></pre><p>To initialize the vector and set its values at the same time, use <a href="#LabelledArrays.@LArray"><code>@LArray</code></a> instead:</p><pre><code class="language-julia hljs">b = @LArray [1, 2, 3] (:a, :b, :c)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/LabelledArrays.jl/blob/07989c44a7af1e90df40747c7aa74df77753b214/src/larray.jl#L259-L280">source</a></section></article><h2 id="LArray-and-LVector-constructors"><a class="docs-heading-anchor" href="#LArray-and-LVector-constructors"><code>LArray</code> and <code>LVector</code> constructors</a><a id="LArray-and-LVector-constructors-1"></a><a class="docs-heading-anchor-permalink" href="#LArray-and-LVector-constructors" title="Permalink"></a></h2><p>The original constructors for <code>LArray</code>s and <code>LVector</code>s are as follows:</p><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="LabelledArrays.LArray" href="#LabelledArrays.LArray"><code>LabelledArrays.LArray</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">LArray(::Tuple, ::NamedTuple)
4</code></pre><p>The labels of LArray and SLArray can be accessed by function <code>symbols</code>, which returns a tuple of symbols.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/LabelledArrays.jl/blob/85b41209ef61a7eaa7ee0f7e44602ac70dbd7744/src/larray.jl#L194-L241">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="LabelledArrays.@LVector" href="#LabelledArrays.@LVector"><code>LabelledArrays.@LVector</code></a> — <span class="docstring-category">Macro</span></header><section><div><pre><code class="language-julia hljs">@LVector Type Names</code></pre><p>The <code>@LVector</code> macro creates an <code>LArray</code> of dimension 1 with eltype and undefined values. The vector&#39;s length is equal to the number of names given.</p><p>As with an <code>LArray</code>, the user can initialize the vector and set its values later.</p><pre><code class="language-julia hljs">A = @LVector Float64 (:a, :b, :c, :d)
A .= rand(4)</code></pre><p>To initialize the vector and set its values at the same time, use <a href="#LabelledArrays.@LArray"><code>@LArray</code></a> instead:</p><pre><code class="language-julia hljs">b = @LArray [1, 2, 3] (:a, :b, :c)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/LabelledArrays.jl/blob/85b41209ef61a7eaa7ee0f7e44602ac70dbd7744/src/larray.jl#L259-L280">source</a></section></article><h2 id="LArray-and-LVector-constructors"><a class="docs-heading-anchor" href="#LArray-and-LVector-constructors"><code>LArray</code> and <code>LVector</code> constructors</a><a id="LArray-and-LVector-constructors-1"></a><a class="docs-heading-anchor-permalink" href="#LArray-and-LVector-constructors" title="Permalink"></a></h2><p>The original constructors for <code>LArray</code>s and <code>LVector</code>s are as follows:</p><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="LabelledArrays.LArray" href="#LabelledArrays.LArray"><code>LabelledArrays.LArray</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">LArray(::Tuple, ::NamedTuple)
LArray(::Tuple, kwargs)</code></pre><p>The standard constructors for <code>LArray</code>.</p><p>For example:</p><pre><code class="language-julia hljs">LArray((2, 2), (a = 1, b = 2, c = 3, d = 4)) # need to specify size
LArray((2, 2); a = 1, b = 2, c = 3, d = 4)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/LabelledArrays.jl/blob/07989c44a7af1e90df40747c7aa74df77753b214/src/larray.jl#L29-L43">source</a></section><section><div><pre><code class="language-julia hljs">LVector(v1::Union{SLArray,LArray}; kwargs...)</code></pre><p>Creates a copy of v1 with corresponding items in kwargs replaced.</p><p>For example:</p><pre><code class="nohighlight hljs">ABCD = @SLArray (2,2) (:a,:b,:c,:d);
LArray((2, 2); a = 1, b = 2, c = 3, d = 4)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/LabelledArrays.jl/blob/85b41209ef61a7eaa7ee0f7e44602ac70dbd7744/src/larray.jl#L29-L43">source</a></section><section><div><pre><code class="language-julia hljs">LVector(v1::Union{SLArray,LArray}; kwargs...)</code></pre><p>Creates a copy of v1 with corresponding items in kwargs replaced.</p><p>For example:</p><pre><code class="nohighlight hljs">ABCD = @SLArray (2,2) (:a,:b,:c,:d);
B = ABCD(1,2,3,4);
B2 = LArray(B; c=30 )</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/LabelledArrays.jl/blob/07989c44a7af1e90df40747c7aa74df77753b214/src/larray.jl#L327-L337">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="LabelledArrays.LVector" href="#LabelledArrays.LVector"><code>LabelledArrays.LVector</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">LVector(::NamedTuple)
B2 = LArray(B; c=30 )</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/LabelledArrays.jl/blob/85b41209ef61a7eaa7ee0f7e44602ac70dbd7744/src/larray.jl#L327-L337">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="LabelledArrays.LVector" href="#LabelledArrays.LVector"><code>LabelledArrays.LVector</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">LVector(::NamedTuple)
LVector(kwargs)</code></pre><p>The standard constructor for <code>LVector</code>.</p><p>For example:</p><pre><code class="language-julia hljs">LVector((a = 1, b = 2))
LVector(a = 1, b = 2)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/LabelledArrays.jl/blob/07989c44a7af1e90df40747c7aa74df77753b214/src/larray.jl#L50-L64">source</a></section><section><div><pre><code class="language-julia hljs">LVector(v1::Union{SLArray,LArray}; kwargs...)</code></pre><p>Creates a 1D copy of v1 with corresponding items in kwargs replaced.</p><p>For example:</p><pre><code class="nohighlight hljs">z = LVector(a=1, b=2, c=3);
z2 = LVector(z; c=30)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/LabelledArrays.jl/blob/07989c44a7af1e90df40747c7aa74df77753b214/src/larray.jl#L312-L321">source</a></section></article><h2 id="Manipulating-LArrays-and-LVectors"><a class="docs-heading-anchor" href="#Manipulating-LArrays-and-LVectors">Manipulating <code>LArrays</code> and <code>LVectors</code></a><a id="Manipulating-LArrays-and-LVectors-1"></a><a class="docs-heading-anchor-permalink" href="#Manipulating-LArrays-and-LVectors" title="Permalink"></a></h2><p>User may want a list of the labels or keys in an <code>LArray</code> or <code>LVector</code>. The <code>symbols(::LArray)</code> function returns a tuple of array labels.</p><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="LabelledArrays.symbols" href="#LabelledArrays.symbols"><code>LabelledArrays.symbols</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">symbols(::SLArray)</code></pre><p>Returns the labels of the <code>SLArray</code>.</p><p>For example:</p><pre><code class="language-julia hljs">julia&gt; z = SLVector(a = 1, b = 2, c = 3)
LVector(a = 1, b = 2)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/LabelledArrays.jl/blob/85b41209ef61a7eaa7ee0f7e44602ac70dbd7744/src/larray.jl#L50-L64">source</a></section><section><div><pre><code class="language-julia hljs">LVector(v1::Union{SLArray,LArray}; kwargs...)</code></pre><p>Creates a 1D copy of v1 with corresponding items in kwargs replaced.</p><p>For example:</p><pre><code class="nohighlight hljs">z = LVector(a=1, b=2, c=3);
z2 = LVector(z; c=30)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/LabelledArrays.jl/blob/85b41209ef61a7eaa7ee0f7e44602ac70dbd7744/src/larray.jl#L312-L321">source</a></section></article><h2 id="Manipulating-LArrays-and-LVectors"><a class="docs-heading-anchor" href="#Manipulating-LArrays-and-LVectors">Manipulating <code>LArrays</code> and <code>LVectors</code></a><a id="Manipulating-LArrays-and-LVectors-1"></a><a class="docs-heading-anchor-permalink" href="#Manipulating-LArrays-and-LVectors" title="Permalink"></a></h2><p>User may want a list of the labels or keys in an <code>LArray</code> or <code>LVector</code>. The <code>symbols(::LArray)</code> function returns a tuple of array labels.</p><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="LabelledArrays.symbols" href="#LabelledArrays.symbols"><code>LabelledArrays.symbols</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">symbols(::SLArray)</code></pre><p>Returns the labels of the <code>SLArray</code>.</p><p>For example:</p><pre><code class="language-julia hljs">julia&gt; z = SLVector(a = 1, b = 2, c = 3)
3-element SLArray{Tuple{3}, Int64, 1, 3, (:a, :b, :c)} with indices SOneTo(3):
:a =&gt; 1
:b =&gt; 2
:c =&gt; 3

julia&gt; symbols(z)
(:a, :b, :c)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/LabelledArrays.jl/blob/07989c44a7af1e90df40747c7aa74df77753b214/src/slarray.jl#L311-L328">source</a></section><section><div><pre><code class="language-julia hljs">symbols(::LArray)</code></pre><p>Returns the labels of the <code>LArray</code>.</p><p>For example:</p><pre><code class="language-julia hljs">julia&gt; z = @LVector Float64 (:a, :b, :c, :d);
(:a, :b, :c)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/LabelledArrays.jl/blob/85b41209ef61a7eaa7ee0f7e44602ac70dbd7744/src/slarray.jl#L311-L328">source</a></section><section><div><pre><code class="language-julia hljs">symbols(::LArray)</code></pre><p>Returns the labels of the <code>LArray</code>.</p><p>For example:</p><pre><code class="language-julia hljs">julia&gt; z = @LVector Float64 (:a, :b, :c, :d);

julia&gt; symbols(z)
(:a, :b, :c, :d)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/LabelledArrays.jl/blob/07989c44a7af1e90df40747c7aa74df77753b214/src/larray.jl#L292-L305">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../SLArrays/">« SLArrays</a><a class="docs-footer-nextpage" href="../NamedTuples_relation/">Relation to NamedTuples »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Saturday 3 February 2024 21:03">Saturday 3 February 2024</span>. Using Julia version 1.10.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
(:a, :b, :c, :d)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/SciML/LabelledArrays.jl/blob/85b41209ef61a7eaa7ee0f7e44602ac70dbd7744/src/larray.jl#L292-L305">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../SLArrays/">« SLArrays</a><a class="docs-footer-nextpage" href="../NamedTuples_relation/">Relation to NamedTuples »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Saturday 3 February 2024 21:03">Saturday 3 February 2024</span>. Using Julia version 1.10.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 531c0a7

Please sign in to comment.