Skip to content

Commit

Permalink
build based on abaf736
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Oct 17, 2024
1 parent 20cee27 commit ddff0af
Show file tree
Hide file tree
Showing 7 changed files with 34 additions and 34 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.11.0","generation_timestamp":"2024-10-13T09:09:41","documenter_version":"1.7.0"}}
{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-10-17T18:09:17","documenter_version":"1.7.0"}}
2 changes: 1 addition & 1 deletion dev/assets/Manifest.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# This file is machine-generated - editing it directly is not advised

julia_version = "1.11.0"
julia_version = "1.11.1"
manifest_format = "2.0"
project_hash = "121a52a9b5dd1accb4ddf0945b042c7e9a1daada"

Expand Down
6 changes: 3 additions & 3 deletions dev/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@
L4(v, u, p, t, α, β) # == mul!(v, L4, u, α, β)</code></pre><p>The calling signature <code>L(u, p, t)</code>, for out-of-place evaluations, is equivalent to <code>L * u</code>, and the in-place evaluation <code>L(v, u, p, t, args...)</code> is equivalent to <code>LinearAlgebra.mul!(v, L, u, args...)</code>, where the arguments <code>p, t</code> are passed to <code>L</code> to update its state. More details are provided in the operator update section below. While overloads to <code>Base.*</code> and <code>LinearAlgebra.mul!</code> are available, where a <code>SciMLOperator</code> behaves like an <code>AbstractMatrix</code>, we recommend sticking with the <code>L(u, p, t)</code>, <code>L(v, u, p, t)</code>, <code>L(v, u, p, t, α, β)</code> calling signatures as the latter internally update the operator state.</p><p>The <code>(u, p, t)</code> calling signature is standardized over the <code>SciML</code> ecosystem and is flexible enough to support use cases such as time-evolution in ODEs, as well as sensitivity computation with respect to the parameter object <code>p</code>.</p><h2 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></h2><ul><li>Matrix-free operators with <code>FunctionOperator</code></li><li>Fast tensor product evaluation with <code>TensorProductOperator</code></li><li>Lazy algebra: addition, subtraction, multiplication, inverse, adjoint, and transpose</li><li>Couple fast methods for operator evaluation with inversion via <code>InvertibleOperator</code></li><li>One-line API to update operator state depending on arbitrary parameters.</li><li>Mutating and nonmutating update behavior (Zygote compatible)</li><li>One-line API for pre-caching operators for in-place operator evaluations</li></ul><h2 id="Contributing"><a class="docs-heading-anchor" href="#Contributing">Contributing</a><a id="Contributing-1"></a><a class="docs-heading-anchor-permalink" href="#Contributing" title="Permalink"></a></h2><ul><li><p>Please refer to the <a href="https://github.com/SciML/ColPrac/blob/master/README.md">SciML ColPrac: Contributor&#39;s Guide on Collaborative Practices for Community Packages</a> for guidance on PRs, issues, and other matters relating to contributing to SciML.</p></li><li><p>See the <a href="https://github.com/SciML/SciMLStyle">SciML Style Guide</a> for common coding practices and other style decisions.</p></li><li><p>There are a few community forums:</p><ul><li>The #diffeq-bridged and #sciml-bridged channels in the <a href="https://julialang.org/slack/">Julia Slack</a></li><li>The #diffeq-bridged and #sciml-bridged channels in the <a href="https://julialang.zulipchat.com/#narrow/stream/279055-sciml-bridged">Julia Zulip</a></li><li>On the <a href="https://discourse.julialang.org">Julia Discourse forums</a></li><li>See also <a href="https://sciml.ai/community/">SciML Community page</a></li></ul></li></ul><h2 id="Reproducibility"><a class="docs-heading-anchor" href="#Reproducibility">Reproducibility</a><a id="Reproducibility-1"></a><a class="docs-heading-anchor-permalink" href="#Reproducibility" title="Permalink"></a></h2><details><summary>The documentation of this SciML package was built using these direct dependencies,</summary><pre class="documenter-example-output"><code class="nohighlight hljs ansi">Status `~/work/SciMLOperators.jl/SciMLOperators.jl/docs/Project.toml`
[e30172f5] Documenter v1.7.0
[7a1cc6ca] FFTW v1.8.0
[c0aeaf25] SciMLOperators v0.3.10 `~/work/SciMLOperators.jl/SciMLOperators.jl`</code></pre></details><details><summary>and using this machine and Julia version.</summary><pre class="documenter-example-output"><code class="nohighlight hljs ansi">Julia Version 1.11.0
Commit 501a4f25c2b (2024-10-07 11:40 UTC)
[c0aeaf25] SciMLOperators v0.3.10 `~/work/SciMLOperators.jl/SciMLOperators.jl`</code></pre></details><details><summary>and using this machine and Julia version.</summary><pre class="documenter-example-output"><code class="nohighlight hljs ansi">Julia Version 1.11.1
Commit 8f5b7ca12ad (2024-10-16 10:53 UTC)
Build Info:
Official https://julialang.org/ release
Platform Info:
Expand Down Expand Up @@ -113,4 +113,4 @@
[83775a58] Zlib_jll v1.2.13+1
[8e850b90] libblastrampoline_jll v5.11.0+0
[8e850ede] nghttp2_jll v1.59.0+0
[3f19e933] p7zip_jll v17.4.0+2</code></pre></details><p>You can also download the <a href="https://github.com/SciML/SciMLOperators.jl/tree/gh-pages/v0.3.10/assets/Manifest.toml">manifest</a> file and the <a href="https://github.com/SciML/SciMLOperators.jl/tree/gh-pages/v0.3.10/assets/Project.toml">project</a> file.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="sciml/">Usage with <code>SciML</code> and beyond »</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="Sunday 13 October 2024 09:09">Sunday 13 October 2024</span>. Using Julia version 1.11.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
[3f19e933] p7zip_jll v17.4.0+2</code></pre></details><p>You can also download the <a href="https://github.com/SciML/SciMLOperators.jl/tree/gh-pages/v0.3.10/assets/Manifest.toml">manifest</a> file and the <a href="https://github.com/SciML/SciMLOperators.jl/tree/gh-pages/v0.3.10/assets/Project.toml">project</a> file.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="sciml/">Usage with <code>SciML</code> and beyond »</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="Thursday 17 October 2024 18:09">Thursday 17 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit ddff0af

Please sign in to comment.