Skip to content

Commit

Permalink
build based on 956093d
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Sep 18, 2024
1 parent b2f5b59 commit 53742e6
Show file tree
Hide file tree
Showing 63 changed files with 282 additions and 282 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.5","generation_timestamp":"2024-09-18T07:17:37","documenter_version":"1.7.0"}}
{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-18T08:52:38","documenter_version":"1.7.0"}}
22 changes: 11 additions & 11 deletions dev/assertions/index.html
View file

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions dev/constructors/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
@g (macro with 1 method)

julia> @g("parameters", [:x, :y], a=1, b=2; c=3)
(&quot;parameters&quot;, :c =&gt; 3, :a =&gt; 1, :b =&gt; 2)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Nemocas/AbstractAlgebra.jl/blob/e892a0025c842625046763db35ab999b8c88c675/src/misc/VarNames.jl#L368-L462">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><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">variable_names(a...) -&gt; Vector{Symbol}
(&quot;parameters&quot;, :c =&gt; 3, :a =&gt; 1, :b =&gt; 2)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Nemocas/AbstractAlgebra.jl/blob/956093d85746ab34387a5be61857ba00ca33e971/src/misc/VarNames.jl#L368-L462">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><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></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>.</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 @@ -81,7 +81,7 @@
:a
:b
:c
:z</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Nemocas/AbstractAlgebra.jl/blob/e892a0025c842625046763db35ab999b8c88c675/src/misc/VarNames.jl#L11-L70">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><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">reshape_to_varnames(vec::Vector{T}, varnames...) :: Tuple{Array{&lt;:Any, T}}
:z</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Nemocas/AbstractAlgebra.jl/blob/956093d85746ab34387a5be61857ba00ca33e971/src/misc/VarNames.jl#L11-L70">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><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></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 @@ -94,4 +94,4 @@
(AbstractAlgebra.Generic.MPoly{BigInt}[a, b], AbstractAlgebra.Generic.MPoly{BigInt}[x11 x12], AbstractAlgebra.Generic.MPoly{BigInt}[y1, y2], AbstractAlgebra.Generic.MPoly{BigInt}[z])

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], AbstractAlgebra.Generic.MPoly{BigInt}[z])</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Nemocas/AbstractAlgebra.jl/blob/e892a0025c842625046763db35ab999b8c88c675/src/misc/VarNames.jl#L116-L139">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="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.7.0 on <span class="colophon-date" title="Wednesday 18 September 2024 07:17">Wednesday 18 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
(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], AbstractAlgebra.Generic.MPoly{BigInt}[z])</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Nemocas/AbstractAlgebra.jl/blob/956093d85746ab34387a5be61857ba00ca33e971/src/misc/VarNames.jl#L116-L139">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="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.7.0 on <span class="colophon-date" title="Wednesday 18 September 2024 08:52">Wednesday 18 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 53742e6

Please sign in to comment.