Skip to content

Commit 5648aa2

Browse files
author
Documenter.jl
committed
build based on a528414 
1 parent cb9df5b commit 5648aa2

22 files changed

Lines changed: 1662 additions & 3 deletions

‎index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
<!--This file is automatically generated by Documenter.jl-->
2-
<meta http-equiv="refresh" content="0; url=./dev/"/>
2+
<meta http-equiv="refresh" content="0; url=./stable/"/>

‎stable‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
v0.1.0

‎v0.1‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
v0.1.0

‎v0.1.0/.documenter-siteinfo.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"documenter":{"julia_version":"1.11.5","generation_timestamp":"2025-05-19T12:37:41","documenter_version":"1.11.4"}}

‎v0.1.0/api/index.html‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
<!DOCTYPE html>
2+
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>API Reference · DiffMatic</title><meta name="title" content="API Reference · DiffMatic"/><meta property="og:title" content="API Reference · DiffMatic"/><meta property="twitter:title" content="API Reference · DiffMatic"/><meta name="description" content="Documentation for DiffMatic."/><meta property="og:description" content="Documentation for DiffMatic."/><meta property="twitter:description" content="Documentation for DiffMatic."/><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/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><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="../">DiffMatic</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><a class="tocitem" href="../">Quick Start</a></li><li><span class="tocitem">Detailed Usage</span><ul><li><a class="tocitem" href="../usage/">Differentiating Matrix Expressions</a></li><li><a class="tocitem" href="../examples/">Examples</a></li></ul></li><li class="is-active"><a class="tocitem" href>API Reference</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>API Reference</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>API Reference</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/asterycs/DiffMatic.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/asterycs/DiffMatic.jl/blob/trunk/docs/src/api.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="API-Reference"><a class="docs-heading-anchor" href="#API-Reference">API Reference</a><a id="API-Reference-1"></a><a class="docs-heading-anchor-permalink" href="#API-Reference" 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="DiffMatic.@matrix" href="#DiffMatic.@matrix"><code>DiffMatic.@matrix</code></a> — <span class="docstring-category">Macro</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">@matrix(ids...)</code></pre><p>Create one or more matrices. Example:</p><pre><code class="language-julia hljs">@matrix A X</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/asterycs/DiffMatic.jl/blob/a528414ece15bf191ef31d96b2dfb408e1575383/src/std.jl#L37-L48">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="DiffMatic.@vector" href="#DiffMatic.@vector"><code>DiffMatic.@vector</code></a> — <span class="docstring-category">Macro</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">@vector(ids...)</code></pre><p>Create one or more vectors. Example:</p><pre><code class="language-julia hljs">@vector x y</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/asterycs/DiffMatic.jl/blob/a528414ece15bf191ef31d96b2dfb408e1575383/src/std.jl#L55-L66">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="DiffMatic.@scalar" href="#DiffMatic.@scalar"><code>DiffMatic.@scalar</code></a> — <span class="docstring-category">Macro</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">@scalar(ids...)</code></pre><p>Create one or more scalars. Example:</p><pre><code class="language-julia hljs">@scalar a β</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/asterycs/DiffMatic.jl/blob/a528414ece15bf191ef31d96b2dfb408e1575383/src/std.jl#L72-L83">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="DiffMatic.derivative" href="#DiffMatic.derivative"><code>DiffMatic.derivative</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">derivative(expr, wrt::Tensor)</code></pre><p>Compute the derivative of <code>expr</code> with respect to <code>wrt</code>. Example:</p><pre><code class="language-julia hljs">@matrix A
3+
@vector x
4+
5+
derivative(x&#39; * x, x)
6+
7+
# output
8+
9+
2x₄</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/asterycs/DiffMatic.jl/blob/a528414ece15bf191ef31d96b2dfb408e1575383/src/std.jl#L89-L103">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="DiffMatic.gradient" href="#DiffMatic.gradient"><code>DiffMatic.gradient</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">gradient(expr, wrt::Tensor)</code></pre><p>Compute the gradient of <code>expr</code> with respect to <code>wrt</code>. <code>expr</code> must be a scalar and <code>wrt</code> a vector. Example:</p><pre><code class="language-julia hljs">@matrix A
10+
@vector x
11+
12+
gradient(x&#39; * A * x, x)
13+
14+
# output
15+
16+
x⁴A₄⁶ + A⁶⁵x₅</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/asterycs/DiffMatic.jl/blob/a528414ece15bf191ef31d96b2dfb408e1575383/src/std.jl#L116-L130">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="DiffMatic.jacobian" href="#DiffMatic.jacobian"><code>DiffMatic.jacobian</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">jacobian(expr, wrt::Tensor)</code></pre><p>Compute the jacobian of <code>expr</code> with respect to <code>wrt</code>. <code>expr</code> must be a column vector and <code>wrt</code> a vector. Example:</p><pre><code class="language-julia hljs">@matrix A
17+
@vector x
18+
19+
jacobian(A * x, x)
20+
21+
# output
22+
23+
A¹₅</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/asterycs/DiffMatic.jl/blob/a528414ece15bf191ef31d96b2dfb408e1575383/src/std.jl#L148-L162">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="DiffMatic.hessian" href="#DiffMatic.hessian"><code>DiffMatic.hessian</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">hessian(expr, wrt::Tensor)</code></pre><p>Compute the hessian of <code>expr</code> with respect to <code>wrt</code>. <code>expr</code> must be a scalar and <code>wrt</code> a vector. Example:</p><pre><code class="language-julia hljs">@matrix A
24+
@vector x
25+
26+
hessian(x&#39; * A * x, x)
27+
28+
# output
29+
30+
A₇⁶ + A⁶₇</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/asterycs/DiffMatic.jl/blob/a528414ece15bf191ef31d96b2dfb408e1575383/src/std.jl#L179-L193">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="DiffMatic.JuliaFunc" href="#DiffMatic.JuliaFunc"><code>DiffMatic.JuliaFunc</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">JuliaFunc()</code></pre><p>Julia function that evaluates an expression in standard form.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/asterycs/DiffMatic.jl/blob/a528414ece15bf191ef31d96b2dfb408e1575383/src/std.jl#L475-L479">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="DiffMatic.StdStr" href="#DiffMatic.StdStr"><code>DiffMatic.StdStr</code></a> — <span class="docstring-category">Type</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">StdStr()</code></pre><p>String format of an expression in standard form.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/asterycs/DiffMatic.jl/blob/a528414ece15bf191ef31d96b2dfb408e1575383/src/std.jl#L468-L472">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="DiffMatic.to_std" href="#DiffMatic.to_std"><code>DiffMatic.to_std</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">to_std(expr; format = StdStr())</code></pre><p>Convert the expression <code>expr</code> to standard notation.</p><ul><li><code>format</code>: Output format. Can be one of:<ul><li><a href="#DiffMatic.StdStr"><code>StdStr</code></a>: String format.</li><li><a href="#DiffMatic.JuliaFunc"><code>JuliaFunc</code></a>: Julia function.</li></ul></li></ul><p>Examples:</p><pre><code class="language-julia hljs">@matrix A
31+
@vector x
32+
33+
to_std(gradient(x&#39; * A * x, x))
34+
35+
# output
36+
37+
&quot;Aᵀx + Ax&quot;</code></pre><pre><code class="language-julia hljs">to_std(gradient(x&#39; * A * x, x); format = JuliaFunc())
38+
39+
# output
40+
41+
quote
42+
#= ... =#
43+
function generated_function(A, x)
44+
#= ... =#
45+
#= ... =#
46+
return transpose(A) * x + A * x
47+
end
48+
end</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/asterycs/DiffMatic.jl/blob/a528414ece15bf191ef31d96b2dfb408e1575383/src/std.jl#L489-L523">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../examples/">« Examples</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.11.4 on <span class="colophon-date" title="Monday 19 May 2025 12:37">Monday 19 May 2025</span>. Using Julia version 1.11.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

0 commit comments

Comments
 (0)