-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Documenter.jl
committed
Aug 26, 2023
1 parent
2045963
commit 0005a49
Showing
3 changed files
with
4 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>API · TaylorDiff.jl</title><script data-outdated-warner src="../assets/warner.js"></script><link rel="canonical" href="https://juliadiff.org/TaylorDiff.jl/api/"/><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.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/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="../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="../">TaylorDiff.jl</a></span></div><form class="docs-search" action="../search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li class="is-active"><a class="tocitem" href>API</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"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>API</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>API</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/JuliaDiff/TaylorDiff.jl/blob/main/docs/src/api.md#" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="API"><a class="docs-heading-anchor" href="#API">API</a><a id="API-1"></a><a class="docs-heading-anchor-permalink" href="#API" title="Permalink"></a></h1><p>API for <a href="https://github.com/tansongchen/TaylorDiff.jl">TaylorDiff</a>.</p><article class="docstring"><header><a class="docstring-binding" id="TaylorDiff.TaylorScalar" href="#TaylorDiff.TaylorScalar"><code>TaylorDiff.TaylorScalar</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">TaylorScalar{T, N}</code></pre><p>Representation of Taylor polynomials.</p><p><strong>Fields</strong></p><ul><li><code>value::NTuple{N, T}</code>: i-th element of this stores the (i-1)-th derivative</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDiff/TaylorDiff.jl/blob/e19cfe41f4fc899b372ebbbd03eeaee2b514b33b/src/scalar.jl#L7-L15">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="TaylorDiff.TaylorScalar-Union{Tuple{N}, Tuple{T}, Tuple{T, T}} where {T, N}" href="#TaylorDiff.TaylorScalar-Union{Tuple{N}, Tuple{T}, Tuple{T, T}} where {T, N}"><code>TaylorDiff.TaylorScalar</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">TaylorScalar{T, N}(x::T, d::T) where {T, N}</code></pre><p>Construct a Taylor polynomial with zeroth and first order coefficient, acting as a seed.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDiff/TaylorDiff.jl/blob/e19cfe41f4fc899b372ebbbd03eeaee2b514b33b/src/scalar.jl#L36-L40">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="TaylorDiff.TaylorScalar-Union{Tuple{N}, Tuple{T}} where {T, N}" href="#TaylorDiff.TaylorScalar-Union{Tuple{N}, Tuple{T}} where {T, N}"><code>TaylorDiff.TaylorScalar</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">TaylorScalar{T, N}(x::T) where {T, N}</code></pre><p>Construct a Taylor polynomial with zeroth order coefficient.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDiff/TaylorDiff.jl/blob/e19cfe41f4fc899b372ebbbd03eeaee2b514b33b/src/scalar.jl#L24-L28">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="TaylorDiff.derivative" href="#TaylorDiff.derivative"><code>TaylorDiff.derivative</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">derivative(f, x::T, order::Int64) | ||
| <html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>API · TaylorDiff.jl</title><script data-outdated-warner src="../assets/warner.js"></script><link rel="canonical" href="https://juliadiff.org/TaylorDiff.jl/api/"/><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.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/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="../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="../">TaylorDiff.jl</a></span></div><form class="docs-search" action="../search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li class="is-active"><a class="tocitem" href>API</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"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>API</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>API</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/JuliaDiff/TaylorDiff.jl/blob/main/docs/src/api.md#" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="API"><a class="docs-heading-anchor" href="#API">API</a><a id="API-1"></a><a class="docs-heading-anchor-permalink" href="#API" title="Permalink"></a></h1><p>API for <a href="https://github.com/tansongchen/TaylorDiff.jl">TaylorDiff</a>.</p><article class="docstring"><header><a class="docstring-binding" id="TaylorDiff.TaylorScalar" href="#TaylorDiff.TaylorScalar"><code>TaylorDiff.TaylorScalar</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">TaylorScalar{T, N}</code></pre><p>Representation of Taylor polynomials.</p><p><strong>Fields</strong></p><ul><li><code>value::NTuple{N, T}</code>: i-th element of this stores the (i-1)-th derivative</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDiff/TaylorDiff.jl/blob/41c99f48f62c4d7ed8d1d7d74ecb71a52242b38e/src/scalar.jl#L7-L15">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="TaylorDiff.TaylorScalar-Union{Tuple{N}, Tuple{T}, Tuple{T, T}} where {T, N}" href="#TaylorDiff.TaylorScalar-Union{Tuple{N}, Tuple{T}, Tuple{T, T}} where {T, N}"><code>TaylorDiff.TaylorScalar</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">TaylorScalar{T, N}(x::T, d::T) where {T, N}</code></pre><p>Construct a Taylor polynomial with zeroth and first order coefficient, acting as a seed.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDiff/TaylorDiff.jl/blob/41c99f48f62c4d7ed8d1d7d74ecb71a52242b38e/src/scalar.jl#L36-L40">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="TaylorDiff.TaylorScalar-Union{Tuple{N}, Tuple{T}} where {T, N}" href="#TaylorDiff.TaylorScalar-Union{Tuple{N}, Tuple{T}} where {T, N}"><code>TaylorDiff.TaylorScalar</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">TaylorScalar{T, N}(x::T) where {T, N}</code></pre><p>Construct a Taylor polynomial with zeroth order coefficient.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDiff/TaylorDiff.jl/blob/41c99f48f62c4d7ed8d1d7d74ecb71a52242b38e/src/scalar.jl#L24-L28">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="TaylorDiff.derivative" href="#TaylorDiff.derivative"><code>TaylorDiff.derivative</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">derivative(f, x::T, order::Int64) | ||
| derivative(f, x::T, ::Val{N})</code></pre><p>Computes <code>order</code>-th derivative of <code>f</code> w.r.t. <code>x</code>.</p><pre><code class="nohighlight hljs">derivative(f, x::Vector{T}, l::Vector{T}, order::Int64) | ||
| derivative(f, x::Vector{T}, l::Vector{T}, ::Val{N})</code></pre><p>Computes <code>order</code>-th directional derivative of <code>f</code> w.r.t. <code>x</code> in direction <code>l</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDiff/TaylorDiff.jl/blob/e19cfe41f4fc899b372ebbbd03eeaee2b514b33b/src/derivative.jl#L4-L14">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</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 23 August 2023 08:19">Wednesday 23 August 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> | ||
| derivative(f, x::Vector{T}, l::Vector{T}, ::Val{N})</code></pre><p>Computes <code>order</code>-th directional derivative of <code>f</code> w.r.t. <code>x</code> in direction <code>l</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaDiff/TaylorDiff.jl/blob/41c99f48f62c4d7ed8d1d7d74ecb71a52242b38e/src/derivative.jl#L4-L14">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</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="Saturday 26 August 2023 04:12">Saturday 26 August 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.