build based on d76cdc8

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.0","generation_timestamp":"2024-02-04T20:51:51","documenter_version":"1.2.1"}}
+{"documenter":{"julia_version":"1.10.0","generation_timestamp":"2024-02-06T00:30:15","documenter_version":"1.2.1"}}

dev/assets/Manifest.toml

@@ -766,9 +766,9 @@ version = "0.5.5+0"
 
 [[deps.Optim]]
 deps = ["Compat", "FillArrays", "ForwardDiff", "LineSearches", "LinearAlgebra", "MathOptInterface", "NLSolversBase", "NaNMath", "Parameters", "PositiveFactorizations", "Printf", "SparseArrays", "StatsBase"]
-git-tree-sha1 = "47fea72de134f75b105a5d4a1abe5c6aec89d390"
+git-tree-sha1 = "d024bfb56144d947d4fafcd9cb5cafbe3410b133"
 uuid = "429524aa-4258-5aef-a3af-852621145aeb"
-version = "1.9.1"
+version = "1.9.2"
 
 [[deps.Opus_jll]]
 deps = ["Artifacts", "JLLWrappers", "Libdl", "Pkg"]
@@ -828,9 +828,9 @@ version = "1.4.0"
 
 [[deps.Plots]]
 deps = ["Base64", "Contour", "Dates", "Downloads", "FFMPEG", "FixedPointNumbers", "GR", "JLFzf", "JSON", "LaTeXStrings", "Latexify", "LinearAlgebra", "Measures", "NaNMath", "Pkg", "PlotThemes", "PlotUtils", "PrecompileTools", "Printf", "REPL", "Random", "RecipesBase", "RecipesPipeline", "Reexport", "RelocatableFolders", "Requires", "Scratch", "Showoff", "SparseArrays", "Statistics", "StatsBase", "UUIDs", "UnicodeFun", "UnitfulLatexify", "Unzip"]
-git-tree-sha1 = "38a748946dca52a622e79eea6ed35c6737499109"
+git-tree-sha1 = "c4fa93d7d66acad8f6f4ff439576da9d2e890ee0"
 uuid = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
-version = "1.40.0"
+version = "1.40.1"
 
     [deps.Plots.extensions]
     FileIOExt = "FileIO"

dev/index.html

@@ -3,8 +3,8 @@
 Pkg.add(&quot;DataInterpolations&quot;)</code></pre><h2 id="Available-Interpolations"><a class="docs-heading-anchor" href="#Available-Interpolations">Available Interpolations</a><a id="Available-Interpolations-1"></a><a class="docs-heading-anchor-permalink" href="#Available-Interpolations" title="Permalink"></a></h2><p>In all cases, <code>u</code> an <code>AbstractVector</code> of values and <code>t</code> is an <code>AbstractVector</code> of timepoints corresponding to <code>(u,t)</code> pairs.</p><ul><li><p><code>ConstantInterpolation(u,t)</code> - A piecewise constant interpolation.</p></li><li><p><code>LinearInterpolation(u,t)</code> - A linear interpolation.</p></li><li><p><code>QuadraticInterpolation(u,t)</code> - A quadratic interpolation.</p></li><li><p><code>LagrangeInterpolation(u,t,n)</code> - A Lagrange interpolation of order <code>n</code>.</p></li><li><p><code>QuadraticSpline(u,t)</code> - A quadratic spline interpolation.</p></li><li><p><code>CubicSpline(u,t)</code> - A cubic spline interpolation.</p></li><li><p><code>AkimaInterpolation(u, t)</code> - Akima spline interpolation provides a smoothing effect and is computationally efficient.</p></li><li><p><code>BSplineInterpolation(u,t,d,pVec,knotVec)</code> - An interpolation B-spline. This is a B-spline that hits each of the data points. The argument choices are:</p><ul><li><code>d</code> - degree of B-spline</li><li><code>pVec</code> - Symbol to Parameters Vector, <code>pVec = :Uniform</code> for uniformly spaced parameters, and <code>pVec = :ArcLen</code> for parameters generated by the chord length method.</li><li><code>knotVec</code> - Symbol to Knot Vector, <code>knotVec = :Uniform</code> for uniform knot vector, <code>knotVec = :Average</code> for average spaced knot vector.</li></ul></li><li><p><code>BSplineApprox(u,t,d,h,pVec,knotVec)</code> - A regression B-spline which smooths the fitting curve. The argument choices are the same as the <code>BSplineInterpolation</code>, with the additional parameter <code>h&lt;length(t)</code> which is the number of control points to use, with smaller <code>h</code> indicating more smoothing.</p></li></ul><h2 id="Extension-Methods"><a class="docs-heading-anchor" href="#Extension-Methods">Extension Methods</a><a id="Extension-Methods-1"></a><a class="docs-heading-anchor-permalink" href="#Extension-Methods" title="Permalink"></a></h2><p>The following methods require extra dependencies and will be loaded as package extensions.</p><ul><li><code>Curvefit(u,t,m,p,alg)</code> - An interpolation which is done by fitting a user-given functional form <code>m(t,p)</code> where <code>p</code> is the vector of parameters. The user&#39;s input <code>p</code> is an initial value for a least-squares fitting, <code>alg</code> is the algorithm choice to use to optimize the cost function (sum of squared deviations) via <code>Optim.jl</code> and optimal <code>p</code>s are used in the interpolation. Requires <code>using Optim</code>.</li><li><code>RegularizationSmooth(u,t,d;λ,alg)</code> - A regularization algorithm (ridge regression) which is done by minimizing an objective function (l2 loss + derivatives of order <code>d</code>) integrated in the time span. It is a global method which creates a smooth curve. Requires <code>using RegularizationTools</code>.</li></ul><h2 id="Plotting"><a class="docs-heading-anchor" href="#Plotting">Plotting</a><a id="Plotting-1"></a><a class="docs-heading-anchor-permalink" href="#Plotting" title="Permalink"></a></h2><p>DataInterpolations.jl is tied into the Plots.jl ecosystem, by way of RecipesBase. Any interpolation can be plotted using the <code>plot</code> command (or any other), since they have type recipes associated with them.</p><p>For convenience, and to allow keyword arguments to propagate properly, DataInterpolations.jl also defines several series types, corresponding to different interpolations.</p><p>The series types defined are:</p><ul><li><code>:linear_interp</code></li><li><code>:quadratic_interp</code></li><li><code>:lagrange_interp</code></li><li><code>:quadratic_spline</code></li><li><code>:cubic_spline</code></li></ul><p>By and large, these accept the same keywords as their function counterparts.</p><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/DataInterpolations.jl/DataInterpolations.jl/docs/Project.toml`
   [82cc6244] DataInterpolations v4.6.0 `~/work/DataInterpolations.jl/DataInterpolations.jl`
   [e30172f5] Documenter v1.2.1
-  [429524aa] Optim v1.9.1
-  [91a5bcdd] Plots v1.40.0
+  [429524aa] Optim v1.9.2
+  [91a5bcdd] Plots v1.40.1
   [29dad682] RegularizationTools v0.6.0
   [860ef19b] StableRNGs v1.0.1</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.10.0
 Commit 3120989f39b (2023-12-25 18:01 UTC)
@@ -82,14 +82,14 @@
   [d41bc354] NLSolversBase v7.8.3
   [77ba4419] NaNMath v1.0.2
   [4d8831e6] OpenSSL v1.4.1
-  [429524aa] Optim v1.9.1
+  [429524aa] Optim v1.9.2
   [bac558e1] OrderedCollections v1.6.3
   [d96e819e] Parameters v0.12.3
   [69de0a69] Parsers v2.8.1
   [b98c9c47] Pipe v1.3.0
   [ccf2f8ad] PlotThemes v3.1.0
   [995b91a9] PlotUtils v1.4.0
-  [91a5bcdd] Plots v1.40.0
+  [91a5bcdd] Plots v1.40.1
   [85a6dd25] PositiveFactorizations v0.2.4
   [aea7be01] PrecompileTools v1.2.0
   [21216c6a] Preferences v1.4.1
@@ -249,4 +249,4 @@
   [8e850b90] libblastrampoline_jll v5.8.0+1
   [8e850ede] nghttp2_jll v1.52.0+1
   [3f19e933] p7zip_jll v17.4.0+2
-Info Packages marked with ⌅ have new versions available but compatibility constraints restrict them from upgrading. To see why use `status --outdated -m`</code></pre></details><p>You can also download the <a href="https://github.com/SciML/DataInterpolations.jl/tree/gh-pages/v4.6.0/assets/Manifest.toml">manifest</a> file and the <a href="https://github.com/SciML/DataInterpolations.jl/tree/gh-pages/v4.6.0/assets/Project.toml">project</a> file.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="methods/">Methods »</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="Sunday 4 February 2024 20:51">Sunday 4 February 2024</span>. Using Julia version 1.10.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+Info Packages marked with ⌅ have new versions available but compatibility constraints restrict them from upgrading. To see why use `status --outdated -m`</code></pre></details><p>You can also download the <a href="https://github.com/SciML/DataInterpolations.jl/tree/gh-pages/v4.6.0/assets/Manifest.toml">manifest</a> file and the <a href="https://github.com/SciML/DataInterpolations.jl/tree/gh-pages/v4.6.0/assets/Project.toml">project</a> file.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="methods/">Methods »</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 6 February 2024 00:30">Tuesday 6 February 2024</span>. Using Julia version 1.10.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/interface/index.html

@@ -26,4 +26,4 @@
 DataInterpolations.derivative(A2, 300.0)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">-0.23144961208831108</code></pre><h2 id="Integrals"><a class="docs-heading-anchor" href="#Integrals">Integrals</a><a id="Integrals-1"></a><a class="docs-heading-anchor-permalink" href="#Integrals" title="Permalink"></a></h2><p>Integrals of the interpolated curves can also be computed easily.</p><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>Integrals for <code>LagrangeInterpolation</code>, <code>BSplineInterpolation</code>, <code>BSplineApprox</code>, <code>Curvefit</code> will error as there are no simple analytical solutions available. Please use numerical methods instead, such as <a href="https://docs.sciml.ai/Integrals/stable/">Integrals.jl</a>.</p></div></div><p>To compute the integrals from the start of time points provided during interpolation to any point, we can do:</p><pre><code class="language-julia hljs"># integral(A, t)
 DataInterpolations.integral(A1, 5.0)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">129.64386171415265</code></pre><p>If we want to compute integrals between two points, we can do:</p><pre><code class="language-julia hljs"># integral(A, t1, t2)
 DataInterpolations.integral(A1, 1.0, 5.0)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">114.9694509973317</code></pre><p>Again, if the interpolation is defined with <code>extrapolate=true</code>, the integral can be computed beyond the range of the timepoints.</p><pre><code class="language-julia hljs"># integral(A, t1, t2)
-DataInterpolations.integral(A2, 200.0, 300.0)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">1065.2015077631368</code></pre><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>If the times provided in the integral go beyond the range of the time points provided during interpolation, it uses extrapolation methods to compute the values, and hence the integral can be misrepsentative and might not reflect the true nature of the data.</p></div></div></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../methods/">« Methods</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="Sunday 4 February 2024 20:51">Sunday 4 February 2024</span>. Using Julia version 1.10.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+DataInterpolations.integral(A2, 200.0, 300.0)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">1065.2015077631368</code></pre><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>If the times provided in the integral go beyond the range of the time points provided during interpolation, it uses extrapolation methods to compute the values, and hence the integral can be misrepsentative and might not reflect the true nature of the data.</p></div></div></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../methods/">« Methods</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 6 February 2024 00:30">Tuesday 6 February 2024</span>. Using Julia version 1.10.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>