build based on 83ff37e

Author: Documenter.jl

dev/assets/Manifest.toml

@@ -103,7 +103,7 @@ version = "0.27.25"
 deps = ["ArrayInterface", "LinearAlgebra", "Setfield"]
 path = "/home/runner/work/FiniteDiff.jl/FiniteDiff.jl"
 uuid = "6a86dc24-6348-571c-b903-95158fe2bd41"
-version = "2.27.0"
+version = "2.28.0"
 
     [deps.FiniteDiff.extensions]
     FiniteDiffBandedMatricesExt = "BandedMatrices"

dev/derivatives/index.html

@@ -3,31 +3,31 @@
     f, x::T,
     fdtype::Type{T1}=Val{:central},
     returntype::Type{T2}=eltype(x),
-    f_x::Union{Nothing,T}=nothing)</code></pre><p>Single-point derivative of scalar-&gt;scalar maps.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDiff/FiniteDiff.jl/blob/262b06f375b37f66b71595a7d2864e4431830783/src/derivatives.jl#L1-L9">source</a></section><section><div><pre><code class="nohighlight hljs">FiniteDiff.finite_difference_derivative(
+    f_x::Union{Nothing,T}=nothing)</code></pre><p>Single-point derivative of scalar-&gt;scalar maps.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDiff/FiniteDiff.jl/blob/83ff37e01afd56c61703a870581c095b5a2e5c4c/src/derivatives.jl#L1-L9">source</a></section><section><div><pre><code class="nohighlight hljs">FiniteDiff.finite_difference_derivative(
     f,
     x          :: AbstractArray{&lt;:Number},
     fdtype     :: Type{T1} = Val{:central},
     returntype :: Type{T2} = eltype(x),      # return type of f
     fx         :: Union{Nothing,AbstractArray{&lt;:Number}} = nothing,
     epsilon    :: Union{Nothing,AbstractArray{&lt;:Real}} = nothing;
-    [epsilon_factor])</code></pre><p>Compute the derivative <code>df</code> of a scalar-valued map <code>f</code> at a collection of points <code>x</code>.</p><p>Cache-less.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDiff/FiniteDiff.jl/blob/262b06f375b37f66b71595a7d2864e4431830783/src/derivatives.jl#L89-L102">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="FiniteDiff.finite_difference_derivative!" href="#FiniteDiff.finite_difference_derivative!"><code>FiniteDiff.finite_difference_derivative!</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">FiniteDiff.finite_difference_derivative!(
+    [epsilon_factor])</code></pre><p>Compute the derivative <code>df</code> of a scalar-valued map <code>f</code> at a collection of points <code>x</code>.</p><p>Cache-less.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDiff/FiniteDiff.jl/blob/83ff37e01afd56c61703a870581c095b5a2e5c4c/src/derivatives.jl#L89-L102">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="FiniteDiff.finite_difference_derivative!" href="#FiniteDiff.finite_difference_derivative!"><code>FiniteDiff.finite_difference_derivative!</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">FiniteDiff.finite_difference_derivative!(
     df         :: AbstractArray{&lt;:Number},
     f,
     x          :: AbstractArray{&lt;:Number},
     fdtype     :: Type{T1} = Val{:central},
     returntype :: Type{T2} = eltype(x),
     fx         :: Union{Nothing,AbstractArray{&lt;:Number}} = nothing,
     epsilon    :: Union{Nothing,AbstractArray{&lt;:Real}}   = nothing;
-    [epsilon_factor])</code></pre><p>Compute the derivative <code>df</code> of a scalar-valued map <code>f</code> at a collection of points <code>x</code>.</p><p>Cache-less but non-allocating if <code>fx</code> and <code>epsilon</code> are supplied (<code>fx</code> must be <code>f(x)</code>).</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDiff/FiniteDiff.jl/blob/262b06f375b37f66b71595a7d2864e4431830783/src/derivatives.jl#L117-L131">source</a></section><section><div><pre><code class="nohighlight hljs">FiniteDiff.finite_difference_derivative!(
+    [epsilon_factor])</code></pre><p>Compute the derivative <code>df</code> of a scalar-valued map <code>f</code> at a collection of points <code>x</code>.</p><p>Cache-less but non-allocating if <code>fx</code> and <code>epsilon</code> are supplied (<code>fx</code> must be <code>f(x)</code>).</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDiff/FiniteDiff.jl/blob/83ff37e01afd56c61703a870581c095b5a2e5c4c/src/derivatives.jl#L117-L131">source</a></section><section><div><pre><code class="nohighlight hljs">FiniteDiff.finite_difference_derivative!(
     df::AbstractArray{&lt;:Number},
     f,
     x::AbstractArray{&lt;:Number},
     cache::DerivativeCache{T1,T2,fdtype,returntype};
     relstep=default_relstep(fdtype, eltype(x)),
     absstep=relstep,
-    dir=true)</code></pre><p>Compute the derivative <code>df</code> of a scalar-valued map <code>f</code> at a collection of points <code>x</code>.</p><p>Cached.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDiff/FiniteDiff.jl/blob/262b06f375b37f66b71595a7d2864e4431830783/src/derivatives.jl#L147-L160">source</a></section></article><h2 id="Cache"><a class="docs-heading-anchor" href="#Cache">Cache</a><a id="Cache-1"></a><a class="docs-heading-anchor-permalink" href="#Cache" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-binding" id="FiniteDiff.DerivativeCache" href="#FiniteDiff.DerivativeCache"><code>FiniteDiff.DerivativeCache</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">FiniteDiff.DerivativeCache(
+    dir=true)</code></pre><p>Compute the derivative <code>df</code> of a scalar-valued map <code>f</code> at a collection of points <code>x</code>.</p><p>Cached.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDiff/FiniteDiff.jl/blob/83ff37e01afd56c61703a870581c095b5a2e5c4c/src/derivatives.jl#L147-L160">source</a></section></article><h2 id="Cache"><a class="docs-heading-anchor" href="#Cache">Cache</a><a id="Cache-1"></a><a class="docs-heading-anchor-permalink" href="#Cache" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-binding" id="FiniteDiff.DerivativeCache" href="#FiniteDiff.DerivativeCache"><code>FiniteDiff.DerivativeCache</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">FiniteDiff.DerivativeCache(
     x          :: AbstractArray{&lt;:Number},
     fx         :: Union{Nothing,AbstractArray{&lt;:Number}} = nothing,
     epsilon    :: Union{Nothing,AbstractArray{&lt;:Real}} = nothing,
     fdtype     :: Type{T1} = Val{:central},
-    returntype :: Type{T2} = eltype(x))</code></pre><p>This allocates either <code>fx</code> or <code>epsilon</code> if these are nothing and they are needed. <code>fx</code> is the current call of <code>f(x)</code> and is required for forward-differencing (otherwise is not necessary).</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDiff/FiniteDiff.jl/blob/262b06f375b37f66b71595a7d2864e4431830783/src/derivatives.jl#L42-L53">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../tutorials/">« Tutorials</a><a class="docs-footer-nextpage" href="../gradients/">Gradients »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 13 August 2025 13:01">Wednesday 13 August 2025</span>. Using Julia version 1.11.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+    returntype :: Type{T2} = eltype(x))</code></pre><p>This allocates either <code>fx</code> or <code>epsilon</code> if these are nothing and they are needed. <code>fx</code> is the current call of <code>f(x)</code> and is required for forward-differencing (otherwise is not necessary).</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDiff/FiniteDiff.jl/blob/83ff37e01afd56c61703a870581c095b5a2e5c4c/src/derivatives.jl#L42-L53">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../tutorials/">« Tutorials</a><a class="docs-footer-nextpage" href="../gradients/">Gradients »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 13 August 2025 13:06">Wednesday 13 August 2025</span>. Using Julia version 1.11.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>