Skip to content

Commit

Permalink
build based on c44b804
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Feb 23, 2024
1 parent ff4a518 commit 392416b
Show file tree
Hide file tree
Showing 34 changed files with 174 additions and 174 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.10.1","generation_timestamp":"2024-02-20T10:33:50","documenter_version":"1.2.1"}}
{"documenter":{"julia_version":"1.10.1","generation_timestamp":"2024-02-23T12:32:57","documenter_version":"1.2.1"}}
2 changes: 1 addition & 1 deletion dev/about/index.html

Large diffs are not rendered by default.

18 changes: 9 additions & 9 deletions dev/acb/index.html

Large diffs are not rendered by default.

26 changes: 13 additions & 13 deletions dev/algebraic/index.html

Large diffs are not rendered by default.

22 changes: 11 additions & 11 deletions dev/arb/index.html

Large diffs are not rendered by default.

18 changes: 9 additions & 9 deletions dev/complex/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/constructors/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/developer/conventions/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/developer/interfaces/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/developer/introduction/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@
git push --all</code></pre><p>However, if you are working on a much larger project it is <em>highly</em> recommended that you frequently pull from the official master branch and rebase your new branch on top of any changes that have been made there:</p><pre><code class="nohighlight hljs">git checkout master
git pull
git checkout mynewbranch
git rebase master</code></pre><p>Note that rebasing will try to rewrite each of your commits over the top of the branch you are rebasing on (master in this case). This process will have many steps if there are many commits and lots of conflicts. Simply follow the instructions until the process is finished.</p><p>The longer you leave it before rebasing on master the longer the rebase process will take. It can eventually become overwhelming as it is not replaying the latest state of your repository over master, but each commit that you made in order. You may have completely forgotten what those older commits were about, so this can become very difficult if not done regularly.</p><p>Once you have pushed your changes to your GitHub account, go to the official project GitHub page and you should see your branch mentioned near the top of the page. Open a pull request.</p><p>Someone will review your code and suggest changes they&#39;d like made. Simply add more commits to your branch and push again. They will automatically get added to your pull request.</p><p>Note that we don&#39;t accept code without tests and documentation. We use Documenter.jl for our documentation, in Markdown format. See our existing code for examples of docstrings above functions in the source code and look in the <code>docs/src</code> directory to see how these docstrings are merged into our online documentation.</p><h2 id="Development-list"><a class="docs-heading-anchor" href="#Development-list">Development list</a><a id="Development-list-1"></a><a class="docs-heading-anchor-permalink" href="#Development-list" title="Permalink"></a></h2><p>All developers of AbstractAlgebra and Nemo are welcome to write to our development list to ask questions and discuss development:</p><p><a href="https://groups.google.com/g/nemo-devel">https://groups.google.com/g/nemo-devel</a></p><h2 id="Reporting-bugs"><a class="docs-heading-anchor" href="#Reporting-bugs">Reporting bugs</a><a id="Reporting-bugs-1"></a><a class="docs-heading-anchor-permalink" href="#Reporting-bugs" title="Permalink"></a></h2><p>Bugs should be reported by opening an issue (ticket) on the official GitHub page for the relevant project. Please state the Julia version being used, the machine you are using and the version of AbstractAlgebra/Nemo you are using. The version can be found in the Project.toml file at the top level of the source tree.</p><h2 id="Development-roadmap"><a class="docs-heading-anchor" href="#Development-roadmap">Development roadmap</a><a id="Development-roadmap-1"></a><a class="docs-heading-anchor-permalink" href="#Development-roadmap" title="Permalink"></a></h2><p>AbstractAlgebra has a special roadmap ticket which lists the most important tickets that have been opened. If you want to contribute something high value this is the place to start:</p><p><a href="https://github.com/Nemocas/AbstractAlgebra.jl/issues/492">https://github.com/Nemocas/AbstractAlgebra.jl/issues/492</a></p><p>This ticket is updated every so often.</p><h2 id="Binaries"><a class="docs-heading-anchor" href="#Binaries">Binaries</a><a id="Binaries-1"></a><a class="docs-heading-anchor-permalink" href="#Binaries" title="Permalink"></a></h2><p>Binaries of C libraries for Nemo are currently made in a separate repository:</p><p><a href="https://github.com/JuliaPackaging/Yggdrasil">https://github.com/JuliaPackaging/Yggdrasil</a></p><p>If code is added to any of the C libraries used by Nemo, this jll package must be updated first and the version updated in Nemo.jl before the new functionality can be used. Ask the core developers for help with this as various other tasks must be completed at the same time.</p><h2 id="Relationship-to-Oscar"><a class="docs-heading-anchor" href="#Relationship-to-Oscar">Relationship to Oscar</a><a id="Relationship-to-Oscar-1"></a><a class="docs-heading-anchor-permalink" href="#Relationship-to-Oscar" title="Permalink"></a></h2><p>Nemo and AbstractAlgebra are heavily used by the Oscar computer algebra system being developed in Germany by a number of universities involved in a large project known as TRR 195, funded by the DFG.</p><p>Oscar is the number one customer for Nemo. Many bugs in Nemo are found and fixed by Oscar developers and most of the key Nemo developers are part of the Oscar project.</p><p>See the Oscar website for further details:</p><p><a href="https://www.oscar-system.org/">https://www.oscar-system.org/</a></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../misc/">« Miscellaneous</a><a class="docs-footer-nextpage" href="../conventions/">Conventions »</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="Tuesday 20 February 2024 10:33">Tuesday 20 February 2024</span>. Using Julia version 1.10.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
git rebase master</code></pre><p>Note that rebasing will try to rewrite each of your commits over the top of the branch you are rebasing on (master in this case). This process will have many steps if there are many commits and lots of conflicts. Simply follow the instructions until the process is finished.</p><p>The longer you leave it before rebasing on master the longer the rebase process will take. It can eventually become overwhelming as it is not replaying the latest state of your repository over master, but each commit that you made in order. You may have completely forgotten what those older commits were about, so this can become very difficult if not done regularly.</p><p>Once you have pushed your changes to your GitHub account, go to the official project GitHub page and you should see your branch mentioned near the top of the page. Open a pull request.</p><p>Someone will review your code and suggest changes they&#39;d like made. Simply add more commits to your branch and push again. They will automatically get added to your pull request.</p><p>Note that we don&#39;t accept code without tests and documentation. We use Documenter.jl for our documentation, in Markdown format. See our existing code for examples of docstrings above functions in the source code and look in the <code>docs/src</code> directory to see how these docstrings are merged into our online documentation.</p><h2 id="Development-list"><a class="docs-heading-anchor" href="#Development-list">Development list</a><a id="Development-list-1"></a><a class="docs-heading-anchor-permalink" href="#Development-list" title="Permalink"></a></h2><p>All developers of AbstractAlgebra and Nemo are welcome to write to our development list to ask questions and discuss development:</p><p><a href="https://groups.google.com/g/nemo-devel">https://groups.google.com/g/nemo-devel</a></p><h2 id="Reporting-bugs"><a class="docs-heading-anchor" href="#Reporting-bugs">Reporting bugs</a><a id="Reporting-bugs-1"></a><a class="docs-heading-anchor-permalink" href="#Reporting-bugs" title="Permalink"></a></h2><p>Bugs should be reported by opening an issue (ticket) on the official GitHub page for the relevant project. Please state the Julia version being used, the machine you are using and the version of AbstractAlgebra/Nemo you are using. The version can be found in the Project.toml file at the top level of the source tree.</p><h2 id="Development-roadmap"><a class="docs-heading-anchor" href="#Development-roadmap">Development roadmap</a><a id="Development-roadmap-1"></a><a class="docs-heading-anchor-permalink" href="#Development-roadmap" title="Permalink"></a></h2><p>AbstractAlgebra has a special roadmap ticket which lists the most important tickets that have been opened. If you want to contribute something high value this is the place to start:</p><p><a href="https://github.com/Nemocas/AbstractAlgebra.jl/issues/492">https://github.com/Nemocas/AbstractAlgebra.jl/issues/492</a></p><p>This ticket is updated every so often.</p><h2 id="Binaries"><a class="docs-heading-anchor" href="#Binaries">Binaries</a><a id="Binaries-1"></a><a class="docs-heading-anchor-permalink" href="#Binaries" title="Permalink"></a></h2><p>Binaries of C libraries for Nemo are currently made in a separate repository:</p><p><a href="https://github.com/JuliaPackaging/Yggdrasil">https://github.com/JuliaPackaging/Yggdrasil</a></p><p>If code is added to any of the C libraries used by Nemo, this jll package must be updated first and the version updated in Nemo.jl before the new functionality can be used. Ask the core developers for help with this as various other tasks must be completed at the same time.</p><h2 id="Relationship-to-Oscar"><a class="docs-heading-anchor" href="#Relationship-to-Oscar">Relationship to Oscar</a><a id="Relationship-to-Oscar-1"></a><a class="docs-heading-anchor-permalink" href="#Relationship-to-Oscar" title="Permalink"></a></h2><p>Nemo and AbstractAlgebra are heavily used by the Oscar computer algebra system being developed in Germany by a number of universities involved in a large project known as TRR 195, funded by the DFG.</p><p>Oscar is the number one customer for Nemo. Many bugs in Nemo are found and fixed by Oscar developers and most of the key Nemo developers are part of the Oscar project.</p><p>See the Oscar website for further details:</p><p><a href="https://www.oscar-system.org/">https://www.oscar-system.org/</a></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../misc/">« Miscellaneous</a><a class="docs-footer-nextpage" href="../conventions/">Conventions »</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="Friday 23 February 2024 12:32">Friday 23 February 2024</span>. Using Julia version 1.10.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/developer/parents/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@
4*x^2 + 3*x + 2

julia&gt; s = p + q
7*x^2 + 5*x + 3</code></pre><p>Naturally functions like <code>polynomial</code> and <code>matrix</code> and the light-weight parent constructors are missing for other modules in Nemo at present and it is hoped that developers will fill in such infrastructure rather than simply push the can down the road for someone else to fix. Forcing the creating of full parent objects into as few bottlenecks as possible will make it much easier for developers to remove problems associated with such calls when they arise in future.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../typesystem/">« The type system</a><a class="docs-footer-nextpage" href="../interfaces/">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="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="Tuesday 20 February 2024 10:33">Tuesday 20 February 2024</span>. Using Julia version 1.10.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
7*x^2 + 5*x + 3</code></pre><p>Naturally functions like <code>polynomial</code> and <code>matrix</code> and the light-weight parent constructors are missing for other modules in Nemo at present and it is hoped that developers will fill in such infrastructure rather than simply push the can down the road for someone else to fix. Forcing the creating of full parent objects into as few bottlenecks as possible will make it much easier for developers to remove problems associated with such calls when they arise in future.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../typesystem/">« The type system</a><a class="docs-footer-nextpage" href="../interfaces/">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="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="Friday 23 February 2024 12:32">Friday 23 February 2024</span>. Using Julia version 1.10.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/developer/topics/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
for k = 1:ncols(X)
A[i, j] = addmul_delayed_reduction!(A[i, j], x[i, k], y[k, j], C)
end
A[i, j] = reduce!(A[i, j])</code></pre><p>Here <code>C</code> is a temporary element of the same type as the other inputs which is used internally in <code>addmul_delayed_reduction!</code> if needed.</p><p>Notice the final call to <code>reduce!</code> to reduce the accumulated value after the accumulation loop has finished.</p><p>Note that <code>mul_red!</code> is never called directly but is called inside the generic implementation of <code>addmul_delayed_reduction!</code> for rings that support delayed reduction. That generic code falls back to a call to <code>addmul!</code> which in turn falls back to <code>mul!</code> and <code>addeq!</code> where delayed reduction or <code>addmul!</code> are not available.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../interfaces/">« 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="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="Tuesday 20 February 2024 10:33">Tuesday 20 February 2024</span>. Using Julia version 1.10.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
A[i, j] = reduce!(A[i, j])</code></pre><p>Here <code>C</code> is a temporary element of the same type as the other inputs which is used internally in <code>addmul_delayed_reduction!</code> if needed.</p><p>Notice the final call to <code>reduce!</code> to reduce the accumulated value after the accumulation loop has finished.</p><p>Note that <code>mul_red!</code> is never called directly but is called inside the generic implementation of <code>addmul_delayed_reduction!</code> for rings that support delayed reduction. That generic code falls back to a call to <code>addmul!</code> which in turn falls back to <code>mul!</code> and <code>addeq!</code> where delayed reduction or <code>addmul!</code> are not available.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../interfaces/">« 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="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="Friday 23 February 2024 12:32">Friday 23 February 2024</span>. Using Julia version 1.10.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/developer/typesystem/index.html

Large diffs are not rendered by default.

Loading

0 comments on commit 392416b

Please sign in to comment.