Skip to content

Commit 1f3480c

Browse files
author
Documenter.jl
committed
build based on 788e098 
1 parent 9b806a2 commit 1f3480c

10 files changed

Lines changed: 36 additions & 36 deletions

File tree

‎dev/.documenter-siteinfo.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"documenter":{"documenter_version":"1.17.0","generation_timestamp":"2026-04-30T18:25:11","julia_version":"1.12.6"}}
1+
{"documenter":{"documenter_version":"1.17.0","generation_timestamp":"2026-04-30T18:25:35","julia_version":"1.12.6"}}

‎dev/assets/Manifest.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ version = "1.11.0"
137137
deps = ["ArrayInterface", "LinearAlgebra", "Setfield"]
138138
path = "/home/runner/work/FiniteDiff.jl/FiniteDiff.jl"
139139
uuid = "6a86dc24-6348-571c-b903-95158fe2bd41"
140-
version = "2.30.0"
140+
version = "2.31.0"
141141

142142
[deps.FiniteDiff.extensions]
143143
FiniteDiffBandedMatricesExt = "BandedMatrices"

‎dev/derivatives/index.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,31 +4,31 @@
44
x :: T,
55
fdtype :: Type{T1} = Val{:central},
66
returntype :: Type{T2} = eltype(x),
7-
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/88355ead740f10f28e3186e9fd3301bbb89f0729/src/derivatives.jl#L1-L10">source</a></section><section><div><pre><code class="language-julia hljs">FiniteDiff.finite_difference_derivative(
7+
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/788e0982d808f7e96bc9d0833fd664b3b237f1a4/src/derivatives.jl#L1-L10">source</a></section><section><div><pre><code class="language-julia hljs">FiniteDiff.finite_difference_derivative(
88
f,
99
x :: AbstractArray{&lt;:Number},
1010
fdtype :: Type{T1} = Val{:central},
1111
returntype :: Type{T2} = eltype(x), # return type of f
1212
fx :: Union{Nothing,AbstractArray{&lt;:Number}} = nothing,
1313
epsilon :: Union{Nothing,AbstractArray{&lt;:Real}} = nothing;
14-
[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/88355ead740f10f28e3186e9fd3301bbb89f0729/src/derivatives.jl#L90-L103">source</a></section></details></article><article><details class="docstring" open="true"><summary id="FiniteDiff.finite_difference_derivative!"><a class="docstring-binding" href="#FiniteDiff.finite_difference_derivative!"><code>FiniteDiff.finite_difference_derivative!</code></a> — <span class="docstring-category">Function</span></summary><section><div><pre><code class="language-julia hljs">FiniteDiff.finite_difference_derivative!(
14+
[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/788e0982d808f7e96bc9d0833fd664b3b237f1a4/src/derivatives.jl#L90-L103">source</a></section></details></article><article><details class="docstring" open="true"><summary id="FiniteDiff.finite_difference_derivative!"><a class="docstring-binding" href="#FiniteDiff.finite_difference_derivative!"><code>FiniteDiff.finite_difference_derivative!</code></a> — <span class="docstring-category">Function</span></summary><section><div><pre><code class="language-julia hljs">FiniteDiff.finite_difference_derivative!(
1515
df :: AbstractArray{&lt;:Number},
1616
f,
1717
x :: AbstractArray{&lt;:Number},
1818
fdtype :: Type{T1} = Val{:central},
1919
returntype :: Type{T2} = eltype(x),
2020
fx :: Union{Nothing,AbstractArray{&lt;:Number}} = nothing,
2121
epsilon :: Union{Nothing,AbstractArray{&lt;:Real}} = nothing;
22-
[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/88355ead740f10f28e3186e9fd3301bbb89f0729/src/derivatives.jl#L118-L132">source</a></section><section><div><pre><code class="language-julia hljs">FiniteDiff.finite_difference_derivative!(
22+
[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/788e0982d808f7e96bc9d0833fd664b3b237f1a4/src/derivatives.jl#L118-L132">source</a></section><section><div><pre><code class="language-julia hljs">FiniteDiff.finite_difference_derivative!(
2323
df :: AbstractArray{&lt;:Number},
2424
f,
2525
x :: AbstractArray{&lt;:Number},
2626
cache :: DerivativeCache{T1,T2,fdtype,returntype};
2727
relstep = default_relstep(fdtype, eltype(x)),
2828
absstep = relstep,
29-
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/88355ead740f10f28e3186e9fd3301bbb89f0729/src/derivatives.jl#L148-L161">source</a></section></details></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><details class="docstring" open="true"><summary id="FiniteDiff.DerivativeCache"><a class="docstring-binding" href="#FiniteDiff.DerivativeCache"><code>FiniteDiff.DerivativeCache</code></a> — <span class="docstring-category">Type</span></summary><section><div><pre><code class="language-julia hljs">FiniteDiff.DerivativeCache(
29+
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/788e0982d808f7e96bc9d0833fd664b3b237f1a4/src/derivatives.jl#L148-L161">source</a></section></details></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><details class="docstring" open="true"><summary id="FiniteDiff.DerivativeCache"><a class="docstring-binding" href="#FiniteDiff.DerivativeCache"><code>FiniteDiff.DerivativeCache</code></a> — <span class="docstring-category">Type</span></summary><section><div><pre><code class="language-julia hljs">FiniteDiff.DerivativeCache(
3030
x :: AbstractArray{&lt;:Number},
3131
fx :: Union{Nothing,AbstractArray{&lt;:Number}} = nothing,
3232
epsilon :: Union{Nothing,AbstractArray{&lt;:Real}} = nothing,
3333
fdtype :: Type{T1} = Val{:central},
34-
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/88355ead740f10f28e3186e9fd3301bbb89f0729/src/derivatives.jl#L43-L54">source</a></section></details></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="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.17.0 on <span class="colophon-date" title="Thursday 30 April 2026 18:25">Thursday 30 April 2026</span>. Using Julia version 1.12.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
34+
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/788e0982d808f7e96bc9d0833fd664b3b237f1a4/src/derivatives.jl#L43-L54">source</a></section></details></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="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.17.0 on <span class="colophon-date" title="Thursday 30 April 2026 18:25">Thursday 30 April 2026</span>. Using Julia version 1.12.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

0 commit comments

Comments
 (0)