Skip to content

Commit

Permalink
build based on 3b832d9
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed May 13, 2024
1 parent 59f07d2 commit d7ec427
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 3 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.2","generation_timestamp":"2024-05-13T03:05:53","documenter_version":"1.4.1"}}
{"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-05-13T03:13:10","documenter_version":"1.4.1"}}
25 changes: 24 additions & 1 deletion dev/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,25 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · VegCurveFit.jl</title><meta name="title" content="Home · VegCurveFit.jl"/><meta property="og:title" content="Home · VegCurveFit.jl"/><meta property="twitter:title" content="Home · VegCurveFit.jl"/><meta name="description" content="Documentation for VegCurveFit.jl."/><meta property="og:description" content="Documentation for VegCurveFit.jl."/><meta property="twitter:description" content="Documentation for VegCurveFit.jl."/><script data-outdated-warner src="assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="search_index.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href>VegCurveFit.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>Home</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Home</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/eco-hydro/VegCurveFit.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/eco-hydro/VegCurveFit.jl/blob/master/docs/src/index.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="VegCurveFit.jl"><a class="docs-heading-anchor" href="#VegCurveFit.jl">VegCurveFit.jl</a><a id="VegCurveFit.jl-1"></a><a class="docs-heading-anchor-permalink" href="#VegCurveFit.jl" title="Permalink"></a></h1><pre><code class="language-docs hljs">nlminb</code></pre></article><nav class="docs-footer"><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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.1 on <span class="colophon-date" title="Monday 13 May 2024 03:05">Monday 13 May 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · VegCurveFit.jl</title><meta name="title" content="Home · VegCurveFit.jl"/><meta property="og:title" content="Home · VegCurveFit.jl"/><meta property="twitter:title" content="Home · VegCurveFit.jl"/><meta name="description" content="Documentation for VegCurveFit.jl."/><meta property="og:description" content="Documentation for VegCurveFit.jl."/><meta property="twitter:description" content="Documentation for VegCurveFit.jl."/><script data-outdated-warner src="assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="search_index.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href>VegCurveFit.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>Home</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Home</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/eco-hydro/VegCurveFit.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/eco-hydro/VegCurveFit.jl/blob/master/docs/src/index.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="VegCurveFit.jl"><a class="docs-heading-anchor" href="#VegCurveFit.jl">VegCurveFit.jl</a><a id="VegCurveFit.jl-1"></a><a class="docs-heading-anchor-permalink" href="#VegCurveFit.jl" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="VegCurveFit.nlminb" href="#VegCurveFit.nlminb"><code>VegCurveFit.nlminb</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">nlminb(start, objective, ...; )</code></pre><p><strong>Arguments</strong></p><ul><li><p><code>args</code>: Other parameters to objective, e.g. t, y, w, FUN</p></li><li><p>feval<em>max, iter</em>max: The default value in fortran is 200 and 150. But they </p></li></ul><p>are set to 1000 at here.</p><p><strong>Return</strong></p><ul><li><code>par</code></li><li><code>objective</code></li><li><code>convergence</code>: <ul><li><code>0</code>: convergent</li><li><code>1</code>: not convergent</li></ul></li><li><code>iterations</code></li><li><code>evaluations</code></li></ul><p><strong>References</strong></p><ol><li><p>David M. Gay (1990), Usage summary for selected optimization routines. Computing Science Technical Report 153, AT&amp;T Bell Laboratories, Murray Hill.</p></li><li><p><a href="http://www.netlib.org/port/">http://www.netlib.org/port/</a></p></li></ol><p><strong>Example</strong></p><pre><code class="language-julia hljs">t = Array(1.0:8:366)
y = doubleLog_Beck(par, t)
ypred = doubleLog_Beck(par0, t)
par0 = [0.05, 0.6, 45, 0.1, 200, 0.2]
@time opt_par = nlminb(par0, goal!, doubleLog_Beck!, y, t, ypred,
feval_max = 1000, iter_max = 1000)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/eco-hydro/VegCurveFit.jl/blob/3b832d93f6630efe0a603121a79abaf5fedb2aac/src/Optim/nlminb.jl#L4-L39">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="VegCurveFit.findpeaks" href="#VegCurveFit.findpeaks"><code>VegCurveFit.findpeaks</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">findpeaks(x::AbstractVector{T};
nups::Int=1,
ndowns::Int=nups,
zerostr::Char=&#39;0&#39;,
peakpat=nothing,
verbose=false,
options...)</code></pre><p><strong>Examples</strong></p><p><strong>References</strong></p><ul><li>Gerhard Aigner, <a href="https://github.com/halleysfifthinc/Peaks.jl/issues/11#issuecomment-689998279">https://github.com/halleysfifthinc/Peaks.jl/issues/11#issuecomment-689998279</a></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/eco-hydro/VegCurveFit.jl/blob/3b832d93f6630efe0a603121a79abaf5fedb2aac/src/VegSeasons/findpeaks.jl#L4-L17">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="VegCurveFit.wBisquare_Kong2023" href="#VegCurveFit.wBisquare_Kong2023"><code>VegCurveFit.wBisquare_Kong2023</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">wBisquare(y, yfit, w; iter = 2, wmin, to_upper = true)</code></pre><p><strong>Arguments</strong></p><ul><li><code>iter</code> : not used</li><li><code>options</code> : currently ignored</li></ul><p><strong>Bad points</strong></p><ul><li><ol><li>under the yfit, in the growing season (yfit &gt; 0.3 * A + ymin)</li></ol></li></ul><p><strong>Examples</strong></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/eco-hydro/VegCurveFit.jl/blob/3b832d93f6630efe0a603121a79abaf5fedb2aac/src/weights/wBisquare_Kong2023.jl#L1-L12">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="VegCurveFit.cal_diag" href="#VegCurveFit.cal_diag"><code>VegCurveFit.cal_diag</code></a> — <span class="docstring-category">Function</span></header><section><div><p>retrieve the diagonal of the inverse of a banded matrix B</p><p>一种<code>带状矩阵对角阵</code>的快速算法，用于<code>Whittaker smoother</code>求解。</p><p class="math-container">\[B = (U&#39; * D * U) # Hutchinson 1985, Eq. 3.1
B^(-1) = B * U^(-1)&#39; + (1 - U) * B^(-1) # Hutchinson 1985, Eq. 3.3\]</p><p><strong>Arguments</strong></p><ul><li><code>U</code>: A = L D L&#39; = U&#39; * D * U. Note <code>U = L&#39;</code>!</li></ul><pre><code class="nohighlight hljs">U = [
1 c₁ e₁ f₁ 0
0 1 c₂ e₂ f₂
0 0 1 c₃ e₃
0 0 0 1 c₄
0 0 0 0 1]
U2 = [
c₁ e₁ f₁ 0
c₂ e₂ f₂ 0
c₃ e₃ 0 0
c₄ 0 0 0
0 0 0 0 ]</code></pre><p>Dongdong Kong, CUG, 2024-05-07</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/eco-hydro/VegCurveFit.jl/blob/3b832d93f6630efe0a603121a79abaf5fedb2aac/src/Smooth/Whittaker/whit3.jl#L89-L118">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="VegCurveFit.whit2_cv" href="#VegCurveFit.whit2_cv"><code>VegCurveFit.whit2_cv</code></a> — <span class="docstring-category">Function</span></header><section><div><p>R version Whittaker Cross validation</p><p>Whittaker smoothing with second order differences Computation of the hat diagonal (Hutchinson and de Hoog, 1986)</p><ul><li><code>In</code> : data vector (y), weigths (w), smoothing parameter (lambda)</li><li><code>Out</code>: list with smooth vector (z), hat diagonal (dhat)</li></ul><p>#author: Gianluca Frasso and Paul HC Eilers, 2015</p><p>#references</p><ol><li>Gianluca Frasso and Paul HC Eilers, L- and V-curves for optimal smoothing, 2015</li></ol></div><a class="docs-sourcelink" target="_blank" href="https://github.com/eco-hydro/VegCurveFit.jl/blob/3b832d93f6630efe0a603121a79abaf5fedb2aac/src/Smooth/Whittaker/whit2_Frasso2015.jl#L1-L16">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="VegCurveFit.whit2" href="#VegCurveFit.whit2"><code>VegCurveFit.whit2</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">whit2(y::AbstractVector{T}, w::AbstractVector{T2}, lambda::Float64; include_cve=true)</code></pre><p>z, cve = whit2(y, w;lambda=2.0) whit2(y, w; lambda) whit2(y, w; lambda)</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/eco-hydro/VegCurveFit.jl/blob/3b832d93f6630efe0a603121a79abaf5fedb2aac/src/Smooth/Whittaker/whit2.jl#L3-L9">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="VegCurveFit.whit2!" href="#VegCurveFit.whit2!"><code>VegCurveFit.whit2!</code></a> — <span class="docstring-category">Function</span></header><section><div><p>Second-order differences Whittaker-Henderson smoothing</p><p>LU decompose was used.</p><p>Ax = y A = LU, LUx = y let <code>b = Ux</code>, <code>Lb = y</code></p><p><strong>References</strong></p><p>&#39;Smoothing and interpolation with finite differences&#39; <a href="URL: http://dl.acm.org/citation.cfm?id=180916">Eilers P. H. C, 1994</a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/eco-hydro/VegCurveFit.jl/blob/3b832d93f6630efe0a603121a79abaf5fedb2aac/src/Smooth/Whittaker/whit2.jl#L18-L30">source</a></section></article></article><nav class="docs-footer"><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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.1 on <span class="colophon-date" title="Monday 13 May 2024 03:13">Monday 13 May 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Binary file modified dev/objects.inv
View file
Binary file not shown.
Loading

0 comments on commit d7ec427

Please sign in to comment.