Skip to content

Commit

Permalink
build based on 4c61559
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Jan 28, 2024
1 parent a748588 commit c5ecc56
Show file tree
Hide file tree
Showing 18 changed files with 988 additions and 955 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.10.0","generation_timestamp":"2024-01-21T20:51:41","documenter_version":"1.2.1"}}
{"documenter":{"julia_version":"1.10.0","generation_timestamp":"2024-01-28T20:51:41","documenter_version":"1.2.1"}}
52 changes: 40 additions & 12 deletions dev/assets/Manifest.toml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,12 @@ uuid = "56f22d72-fd6d-98f1-02f0-08ddc0907c33"
[[deps.Base64]]
uuid = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"

[[deps.BenchmarkTools]]
deps = ["JSON", "Logging", "Printf", "Profile", "Statistics", "UUIDs"]
git-tree-sha1 = "f1f03a9fa24271160ed7e73051fba3c1a759b53f"
uuid = "6e4b80f9-dd63-53aa-95a3-0cdb28fa8baf"
version = "1.4.0"

[[deps.BitFlags]]
git-tree-sha1 = "2dc09997850d68179b69dafb58ae806167a32b1b"
uuid = "d1d4a3ce-64b1-5f1a-9ba4-7e7e69966f35"
Expand All @@ -81,6 +87,12 @@ git-tree-sha1 = "f641eb0a4f00c343bbc32346e1217b86f3ce9dad"
uuid = "49dc2e85-a5d0-5ad3-a950-438e2897f1b9"
version = "0.5.1"

[[deps.CodecBzip2]]
deps = ["Bzip2_jll", "Libdl", "TranscodingStreams"]
git-tree-sha1 = "c0ae2a86b162fb5d7acc65269b469ff5b8a73594"
uuid = "523fee87-0ab8-5b00-afb7-3ecf72e48cfd"
version = "0.8.1"

[[deps.CodecZlib]]
deps = ["TranscodingStreams", "Zlib_jll"]
git-tree-sha1 = "cd67fc487743b2f0fd4380d4cbd3a24660d0eec8"
Expand Down Expand Up @@ -167,9 +179,9 @@ uuid = "a8cc5b0e-0ffa-5ad4-8c14-923d3ee1735f"
version = "4.1.1"

[[deps.DataAPI]]
git-tree-sha1 = "8da84edb865b0b5b0100c0666a9bc9a0b71c553c"
git-tree-sha1 = "abe83f3a2f1b857aac70ef8b269080af17764bbe"
uuid = "9a962f9c-6df0-11e9-0e5d-c546b8b5ee8a"
version = "1.15.0"
version = "1.16.0"

[[deps.DataInterpolations]]
deps = ["LinearAlgebra", "PrettyTables", "RecipesBase", "Reexport"]
Expand Down Expand Up @@ -363,15 +375,15 @@ version = "3.3.9+0"

[[deps.GR]]
deps = ["Artifacts", "Base64", "DelimitedFiles", "Downloads", "GR_jll", "HTTP", "JSON", "Libdl", "LinearAlgebra", "Pkg", "Preferences", "Printf", "Random", "Serialization", "Sockets", "TOML", "Tar", "Test", "UUIDs", "p7zip_jll"]
git-tree-sha1 = "27442171f28c952804dede8ff72828a96f2bfc1f"
git-tree-sha1 = "a8c834cdae6a8347c72eea19930ebdaabb6015e6"
uuid = "28b8d3ca-fb5f-59d9-8090-bfdbd6d07a71"
version = "0.72.10"
version = "0.73.1"

[[deps.GR_jll]]
deps = ["Artifacts", "Bzip2_jll", "Cairo_jll", "FFMPEG_jll", "Fontconfig_jll", "FreeType2_jll", "GLFW_jll", "JLLWrappers", "JpegTurbo_jll", "Libdl", "Libtiff_jll", "Pixman_jll", "Qt6Base_jll", "Zlib_jll", "libpng_jll"]
git-tree-sha1 = "025d171a2847f616becc0f84c8dc62fe18f0f6dd"
git-tree-sha1 = "2abcce0c099dfb0863efc261be904fc2b85eccdd"
uuid = "d2c73de3-f751-5644-a686-071e5b155ba9"
version = "0.72.10+0"
version = "0.73.1+0"

[[deps.Gettext_jll]]
deps = ["Artifacts", "CompilerSupportLibraries_jll", "JLLWrappers", "Libdl", "Libiconv_jll", "Pkg", "XML2_jll"]
Expand Down Expand Up @@ -655,6 +667,12 @@ git-tree-sha1 = "465a70f0fc7d443a00dcdc3267a497397b8a3899"
uuid = "d0879d2d-cac2-40c8-9cee-1863dc0c7391"
version = "0.1.2"

[[deps.MathOptInterface]]
deps = ["BenchmarkTools", "CodecBzip2", "CodecZlib", "DataStructures", "ForwardDiff", "JSON", "LinearAlgebra", "MutableArithmetics", "NaNMath", "OrderedCollections", "PrecompileTools", "Printf", "SparseArrays", "SpecialFunctions", "Test", "Unicode"]
git-tree-sha1 = "e2ae8cf5ac6daf5a3959f7f6ded9c2028b61d09d"
uuid = "b8f27783-ece8-5eb3-8dc8-9495eed66fee"
version = "1.25.1"

[[deps.MbedTLS]]
deps = ["Dates", "MbedTLS_jll", "MozillaCACerts_jll", "NetworkOptions", "Random", "Sockets"]
git-tree-sha1 = "c067a280ddc25f196b5e7df3877c6b226d390aaf"
Expand Down Expand Up @@ -690,6 +708,12 @@ uuid = "a63ad114-7e13-5084-954f-fe012c677804"
uuid = "14a3606d-f60d-562e-9121-12d972cd8159"
version = "2023.1.10"

[[deps.MutableArithmetics]]
deps = ["LinearAlgebra", "SparseArrays", "Test"]
git-tree-sha1 = "806eea990fb41f9b36f1253e5697aa645bf6a9f8"
uuid = "d8a4904e-b15c-11e9-3269-09a3773c0cb0"
version = "1.4.0"

[[deps.NLSolversBase]]
deps = ["DiffResults", "Distributed", "FiniteDiff", "ForwardDiff"]
git-tree-sha1 = "a0b464d183da839699f4c79e7606d9d186ec172c"
Expand Down Expand Up @@ -741,10 +765,10 @@ uuid = "efe28fd5-8261-553b-a9e1-b2916fc3738e"
version = "0.5.5+0"

[[deps.Optim]]
deps = ["Compat", "FillArrays", "ForwardDiff", "LineSearches", "LinearAlgebra", "NLSolversBase", "NaNMath", "Parameters", "PositiveFactorizations", "Printf", "SparseArrays", "StatsBase"]
git-tree-sha1 = "01f85d9269b13fedc61e63cc72ee2213565f7a72"
deps = ["Compat", "FillArrays", "ForwardDiff", "LineSearches", "LinearAlgebra", "MathOptInterface", "NLSolversBase", "NaNMath", "Parameters", "PositiveFactorizations", "Printf", "SparseArrays", "StatsBase"]
git-tree-sha1 = "f55af9918e2a67dcadf5ec758a5ff25746c3819f"
uuid = "429524aa-4258-5aef-a3af-852621145aeb"
version = "1.7.8"
version = "1.8.0"

[[deps.Opus_jll]]
deps = ["Artifacts", "JLLWrappers", "Libdl", "Pkg"]
Expand Down Expand Up @@ -803,10 +827,10 @@ uuid = "995b91a9-d308-5afd-9ec6-746e21dbc043"
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", "Preferences", "Printf", "REPL", "Random", "RecipesBase", "RecipesPipeline", "Reexport", "RelocatableFolders", "Requires", "Scratch", "Showoff", "SparseArrays", "Statistics", "StatsBase", "UUIDs", "UnicodeFun", "UnitfulLatexify", "Unzip"]
git-tree-sha1 = "ccee59c6e48e6f2edf8a5b64dc817b6729f99eb5"
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"
uuid = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
version = "1.39.0"
version = "1.40.0"

[deps.Plots.extensions]
FileIOExt = "FileIO"
Expand Down Expand Up @@ -850,6 +874,10 @@ version = "2.3.1"
deps = ["Unicode"]
uuid = "de0858da-6303-5e67-8744-51eddeeeb8d7"

[[deps.Profile]]
deps = ["Printf"]
uuid = "9abbd945-dff8-562f-b5e8-e1ebf5ef1b79"

[[deps.Qt6Base_jll]]
deps = ["Artifacts", "CompilerSupportLibraries_jll", "Fontconfig_jll", "Glib_jll", "JLLWrappers", "Libdl", "Libglvnd_jll", "OpenSSL_jll", "Vulkan_Loader_jll", "Xorg_libSM_jll", "Xorg_libXext_jll", "Xorg_libXrender_jll", "Xorg_libxcb_jll", "Xorg_xcb_util_cursor_jll", "Xorg_xcb_util_image_jll", "Xorg_xcb_util_keysyms_jll", "Xorg_xcb_util_renderutil_jll", "Xorg_xcb_util_wm_jll", "Zlib_jll", "libinput_jll", "xkbcommon_jll"]
git-tree-sha1 = "37b7bb7aabf9a085e0044307e1717436117f2b3b"
Expand Down
21 changes: 13 additions & 8 deletions dev/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.7.8
[91a5bcdd] Plots v1.39.0
[429524aa] Optim v1.8.0
[91a5bcdd] Plots v1.40.0
[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)
Expand All @@ -21,8 +21,10 @@
[1520ce14] AbstractTrees v0.4.4
[79e6a3ab] Adapt v4.0.1
[4fba245c] ArrayInterface v7.7.0
[6e4b80f9] BenchmarkTools v1.4.0
[d1d4a3ce] BitFlags v0.1.8
[49dc2e85] Calculus v0.5.1
[523fee87] CodecBzip2 v0.8.1
[944b1d66] CodecZlib v0.7.3
[35d6a980] ColorSchemes v3.24.0
[3da002f7] ColorTypes v0.11.4
Expand All @@ -34,7 +36,7 @@
[187b0558] ConstructionBase v1.5.4
[d38c429a] Contour v0.6.2
[a8cc5b0e] Crayons v4.1.1
[9a962f9c] DataAPI v1.15.0
[9a962f9c] DataAPI v1.16.0
[82cc6244] DataInterpolations v4.6.0 `~/work/DataInterpolations.jl/DataInterpolations.jl`
[864edb3b] DataStructures v0.18.16
[e2d170a0] DataValueInterfaces v1.0.0
Expand All @@ -50,7 +52,7 @@
[53c48c17] FixedPointNumbers v0.8.4
[59287772] Formatting v0.4.2
[f6369f11] ForwardDiff v0.10.36
⌅ [28b8d3ca] GR v0.72.10
[28b8d3ca] GR v0.73.1
[d7ba0133] Git v1.3.0
[42e2da0e] Grisu v1.0.2
[cd3eb016] HTTP v1.10.1
Expand All @@ -71,21 +73,23 @@
[d8e11817] MLStyle v0.4.17
[1914dd2f] MacroTools v0.5.13
[d0879d2d] MarkdownAST v0.1.2
[b8f27783] MathOptInterface v1.25.1
[739be429] MbedTLS v1.1.9
[442fdcdd] Measures v0.3.2
[c03570c3] Memoize v0.4.4
[e1d29d7a] Missings v1.1.0
[d8a4904e] MutableArithmetics v1.4.0
[d41bc354] NLSolversBase v7.8.3
[77ba4419] NaNMath v1.0.2
[4d8831e6] OpenSSL v1.4.1
[429524aa] Optim v1.7.8
[429524aa] Optim v1.8.0
[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.39.0
[91a5bcdd] Plots v1.40.0
[85a6dd25] PositiveFactorizations v0.2.4
[aea7be01] PrecompileTools v1.2.0
[21216c6a] Preferences v1.4.1
Expand Down Expand Up @@ -128,7 +132,7 @@
[d7e528f0] FreeType2_jll v2.13.1+0
[559328eb] FriBidi_jll v1.0.10+0
[0656b61e] GLFW_jll v3.3.9+0
⌅ [d2c73de3] GR_jll v0.72.10+0
[d2c73de3] GR_jll v0.73.1+0
[78b55507] Gettext_jll v0.21.0+0
[f8c6e375] Git_jll v2.43.0+0
[7746bdde] Glib_jll v2.76.5+0
Expand Down Expand Up @@ -217,6 +221,7 @@
[ca575930] NetworkOptions v1.2.0
[44cfe95a] Pkg v1.10.0
[de0858da] Printf
[9abbd945] Profile
[3fa0cd96] REPL
[9a3f8284] Random
[ea8e919c] SHA v0.7.0
Expand Down Expand Up @@ -244,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 21 January 2024 20:51">Sunday 21 January 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="Sunday 28 January 2024 20:51">Sunday 28 January 2024</span>. Using Julia version 1.10.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit c5ecc56

Please sign in to comment.