Skip to content

Commit

Permalink
build based on 3f5a008
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Nov 23, 2023
1 parent 529f4bd commit e938336
Show file tree
Hide file tree
Showing 61 changed files with 259 additions and 259 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.9.4","generation_timestamp":"2023-11-22T22:27:24","documenter_version":"1.1.2"}}
{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2023-11-23T05:59:03","documenter_version":"1.1.2"}}
6 changes: 3 additions & 3 deletions dev/constructors/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@

julia> (x11, x12, y1, y2, z)
("x11", "x12", "y1", "y2", "z")
</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Nemocas/AbstractAlgebra.jl/blob/b73e66e5ea50bec1c54c6b34c3948cd0392549a3/src/misc/VarNames.jl#L323-L405">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="AbstractAlgebra.variable_names" href="#AbstractAlgebra.variable_names"><code>AbstractAlgebra.variable_names</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">variable_names(a...) -&gt; Vector{Symbol}
</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Nemocas/AbstractAlgebra.jl/blob/3f5a008e1d83a0d1879a9a56a1117118f3dc0cf3/src/misc/VarNames.jl#L323-L405">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="AbstractAlgebra.variable_names" href="#AbstractAlgebra.variable_names"><code>AbstractAlgebra.variable_names</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">variable_names(a...) -&gt; Vector{Symbol}
variable_names(a::Tuple) -&gt; Vector{Symbol}</code></pre><p>Create a vector of variable names from a variable name specification.</p><p>Each argument can be either an Array of <code>VarName</code>s, or of the form <code>s::VarName =&gt; iter</code>, or of the form <code>s::VarName =&gt; (iter...)</code>. Here <code>iter</code> is supposed to be any iterable, typically a range like <code>1:5</code>. The <code>:s =&gt; iter</code> specification is shorthand for <code>[&quot;s[$i]&quot; for i in iter]</code>. Similarly <code>:s =&gt; (iter1, iter2)</code> is shorthand for <code>[&quot;s[$i,$j]&quot; for i in iter1, j in iter2]</code>, and likewise for three and more iterables.</p><p>As an alternative <code>&quot;s#&quot; =&gt; iter</code> is shorthand for <code>[&quot;s$i&quot; for i in iter]</code>. This also works for multiple iterators in that<code>&quot;s#&quot; =&gt; (iter1, iter2)</code> is shorthand for <code>[&quot;s$i$j&quot; for i in iter1, j in iter2]</code>. If you need anything else, feel free to open an issue with AbstractAlgebra.</p><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia&gt; AbstractAlgebra.variable_names(:x, :y)
2-element Vector{Symbol}:
:x
Expand Down Expand Up @@ -70,7 +70,7 @@
:b
:c
:z
</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Nemocas/AbstractAlgebra.jl/blob/b73e66e5ea50bec1c54c6b34c3948cd0392549a3/src/misc/VarNames.jl#L12-L73">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="AbstractAlgebra.reshape_to_varnames" href="#AbstractAlgebra.reshape_to_varnames"><code>AbstractAlgebra.reshape_to_varnames</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">reshape_to_varnames(vec::Vector{T}, varnames...) :: Tuple{Array{&lt;:Any, T}}
</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Nemocas/AbstractAlgebra.jl/blob/3f5a008e1d83a0d1879a9a56a1117118f3dc0cf3/src/misc/VarNames.jl#L12-L73">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="AbstractAlgebra.reshape_to_varnames" href="#AbstractAlgebra.reshape_to_varnames"><code>AbstractAlgebra.reshape_to_varnames</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">reshape_to_varnames(vec::Vector{T}, varnames...) :: Tuple{Array{&lt;:Any, T}}
reshape_to_varnames(vec::Vector{T}, varnames::Tuple) :: Tuple{Array{&lt;:Any, T}}</code></pre><p>Turn <code>vec</code> into the shape of <code>varnames</code>. Reverse flattening from <a href="#AbstractAlgebra.variable_names"><code>variable_names</code></a>.</p><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia&gt; s = ([:a, :b], &quot;x#&quot; =&gt; (1:1, 1:2), &quot;y#&quot; =&gt; 1:2, :z);

julia&gt; AbstractAlgebra.reshape_to_varnames(AbstractAlgebra.variable_names(s...), s...)
Expand All @@ -84,4 +84,4 @@

julia&gt; R, (a, b), x, y, z = polynomial_ring(ZZ, s...)
(Multivariate polynomial ring in 7 variables over integers, AbstractAlgebra.Generic.MPoly{BigInt}[a, b], AbstractAlgebra.Generic.MPoly{BigInt}[x11 x12], AbstractAlgebra.Generic.MPoly{BigInt}[y1, y2], z)
</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Nemocas/AbstractAlgebra.jl/blob/b73e66e5ea50bec1c54c6b34c3948cd0392549a3/src/misc/VarNames.jl#L120-L144">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../extending_abstractalgebra/">« Extending the interface of AbstractAlgebra.jl</a><a class="docs-footer-nextpage" href="../ring_introduction/">Introduction »</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.1.2 on <span class="colophon-date" title="Wednesday 22 November 2023 22:27">Wednesday 22 November 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Nemocas/AbstractAlgebra.jl/blob/3f5a008e1d83a0d1879a9a56a1117118f3dc0cf3/src/misc/VarNames.jl#L120-L144">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../extending_abstractalgebra/">« Extending the interface of AbstractAlgebra.jl</a><a class="docs-footer-nextpage" href="../ring_introduction/">Introduction »</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.1.2 on <span class="colophon-date" title="Thursday 23 November 2023 05:59">Thursday 23 November 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit e938336

Please sign in to comment.