Skip to content

Commit 3cc7033

Browse files
author
Documenter.jl
committed
build based on 97f7293 
1 parent dfe1157 commit 3cc7033

6 files changed

Lines changed: 18 additions & 14 deletions

File tree

‎dev/.documenter-siteinfo.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"documenter":{"julia_version":"1.11.6","generation_timestamp":"2025-09-01T20:47:16","documenter_version":"1.14.1"}}
1+
{"documenter":{"julia_version":"1.11.7","generation_timestamp":"2025-09-17T15:01:13","documenter_version":"1.14.1"}}

‎dev/api/index.html‎

Lines changed: 6 additions & 6 deletions
Large diffs are not rendered by default.

‎dev/examples/index.html‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -144,8 +144,12 @@
144144

145145
# output
146146

147-
&quot;xᵀCᵀ(Aᵀ ⊙ Bᵀ)xI + x(xᵀCᵀ(Aᵀ ⊙ Bᵀ) + xᵀ(A ⊙ B)C)&quot;</code></pre><h3 id="Derivative"><a class="docs-heading-anchor" href="#Derivative">Derivative</a><a id="Derivative-1"></a><a class="docs-heading-anchor-permalink" href="#Derivative" title="Permalink"></a></h3><pre><code class="language-julia hljs">to_std(derivative(c * I, c))
147+
&quot;xᵀCᵀ(Aᵀ ⊙ Bᵀ)xI + x(xᵀCᵀ(Aᵀ ⊙ Bᵀ) + xᵀ(A ⊙ B)C)&quot;</code></pre><pre><code class="language-julia hljs">to_std(jacobian(diag(diagm(x&#39; * B&#39; * A * A)), x))
148148

149149
# output
150150

151-
&quot;I&quot;</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../usage/">« Differentiating Matrix Expressions</a><a class="docs-footer-nextpage" href="../api/">API Reference »</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.14.1 on <span class="colophon-date" title="Monday 1 September 2025 20:47">Monday 1 September 2025</span>. Using Julia version 1.11.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
151+
&quot;diagm(vec(1))AᵀAᵀB&quot;</code></pre><h3 id="Derivative"><a class="docs-heading-anchor" href="#Derivative">Derivative</a><a id="Derivative-1"></a><a class="docs-heading-anchor-permalink" href="#Derivative" title="Permalink"></a></h3><pre><code class="language-julia hljs">to_std(derivative(c * I, c))
152+
153+
# output
154+
155+
&quot;I&quot;</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../usage/">« Differentiating Matrix Expressions</a><a class="docs-footer-nextpage" href="../api/">API Reference »</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.14.1 on <span class="colophon-date" title="Wednesday 17 September 2025 15:01">Wednesday 17 September 2025</span>. Using Julia version 1.11.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

‎dev/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,4 @@
2929

3030
# output
3131

32-
ERROR: DomainError</code></pre></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="usage/">Differentiating Matrix Expressions »</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.14.1 on <span class="colophon-date" title="Monday 1 September 2025 20:47">Monday 1 September 2025</span>. Using Julia version 1.11.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
32+
ERROR: DomainError</code></pre></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="usage/">Differentiating Matrix Expressions »</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.14.1 on <span class="colophon-date" title="Wednesday 17 September 2025 15:01">Wednesday 17 September 2025</span>. Using Julia version 1.11.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

‎dev/search_index.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎dev/usage/index.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020
# output
2121

22-
cA¹₂</code></pre><p>Supported operators and functions when creating expressions:</p><ul><li>Basic operators <code>+</code>, <code>-</code>, <code>&#39;</code>, <code>*</code>, <code>^</code>, <code>abs</code>, <code>sin</code>, <code>cos</code> and <code>log</code></li><li>Element-wise operators <code>sin.</code>, <code>cos.</code>, <code>abs.</code>, <code>.*</code>, <code>.^</code> and <code>log.</code></li><li>Vector 1-norm and 2-norm can be computed with <code>LinearAlgebra.norm(..., 1)</code> and <code>LinearAlgebra.norm(..., 2)</code></li><li>Sums of vectors can be computed with <code>sum</code>.</li><li>Matrix traces can be computed with <code>LinearAlgebra.tr</code>.</li><li><code>LinearAlgebra.I</code> for the identity matrix.</li></ul><p>See <a href="../examples/#Creating-Expressions">Creating Expressions</a> for more examples.</p><h2 id="Computing-Derivatives"><a class="docs-heading-anchor" href="#Computing-Derivatives">Computing Derivatives</a><a id="Computing-Derivatives-1"></a><a class="docs-heading-anchor-permalink" href="#Computing-Derivatives" title="Permalink"></a></h2><p>Matrix derivatives are computed on expressions in Ricci-notation directly. <code>DiffMatic</code> provides specialized functions for computing gradients, Jacobians and Hessians respectively.</p><p><a href="../api/#DiffMatic.gradient"><code>gradient</code></a> and <a href="../api/#DiffMatic.hessian"><code>hessian</code></a> require a scalar as input:</p><pre><code class="language-julia hljs">expr = 2 * x&#39; * A * B * x
22+
cA¹₂</code></pre><p>Supported operators and functions when creating expressions:</p><ul><li>Basic operators <code>+</code>, <code>-</code>, <code>&#39;</code>, <code>*</code>, <code>^</code>, <code>abs</code>, <code>sin</code>, <code>cos</code> and <code>log</code></li><li>Element-wise operators <code>sin.</code>, <code>cos.</code>, <code>abs.</code>, <code>.*</code>, <code>.^</code> and <code>log.</code></li><li>Diagonal matrix using <code>LinearAlgebra.diagm</code></li><li>Vector of a matrix diagonal using <code>LinearAlgebra.diag</code></li><li>Vector 1-norm and 2-norm can be computed with <code>LinearAlgebra.norm(..., 1)</code> and <code>LinearAlgebra.norm(..., 2)</code></li><li>Sums of vectors can be computed with <code>sum</code>.</li><li>Matrix traces can be computed with <code>LinearAlgebra.tr</code>.</li><li><code>LinearAlgebra.I</code> for the identity matrix.</li></ul><p>See <a href="../examples/#Creating-Expressions">Creating Expressions</a> for more examples.</p><h2 id="Computing-Derivatives"><a class="docs-heading-anchor" href="#Computing-Derivatives">Computing Derivatives</a><a id="Computing-Derivatives-1"></a><a class="docs-heading-anchor-permalink" href="#Computing-Derivatives" title="Permalink"></a></h2><p>Matrix derivatives are computed on expressions in Ricci-notation directly. <code>DiffMatic</code> provides specialized functions for computing gradients, Jacobians and Hessians respectively.</p><p><a href="../api/#DiffMatic.gradient"><code>gradient</code></a> and <a href="../api/#DiffMatic.hessian"><code>hessian</code></a> require a scalar as input:</p><pre><code class="language-julia hljs">expr = 2 * x&#39; * A * B * x
2323

2424
g = gradient(expr, x) # The second argument denotes the differentiation variable.
2525

@@ -37,7 +37,7 @@
3737

3838
# output
3939

40-
&quot;xᵀxA + 2Axxᵀ&quot;</code></pre><p>Special notation used in the output:</p><ul><li>&quot;⊙&quot;: Element-wise multiplication.</li><li>&quot;⊘&quot;: Element-wise division.</li><li>&quot;diag(x)&quot;: Diagonal matrix with &quot;x&quot; on the diagonal.</li><li>&quot;vec(1)&quot;: Vector consisting of 1:s.</li><li>&quot;sgn(x)&quot;: The signum function applied element-wise.</li><li>&quot;tr(X)&quot;: Trace of the matrix &quot;X&quot;.</li><li>&quot;abs(x)&quot;: Element-wise absolute value of &quot;x&quot;.</li></ul><h3 id="Julia-Function"><a class="docs-heading-anchor" href="#Julia-Function">Julia Function</a><a id="Julia-Function-1"></a><a class="docs-heading-anchor-permalink" href="#Julia-Function" title="Permalink"></a></h3><p>A Julia function is generated by passing a <a href="../api/#DiffMatic.JuliaFunc"><code>JuliaFunc</code></a> instance as a keyword argument <code>format</code> to <a href="../api/#DiffMatic.to_std"><code>to_std</code></a>. The function is returned in the form of an <a href="https://docs.julialang.org/en/v1/manual/metaprogramming/#Expressions-and-evaluation">expression</a>:</p><pre><code class="language-julia hljs">to_std(g; format = JuliaFunc())
40+
&quot;xᵀxA + 2Axxᵀ&quot;</code></pre><p>Special notation used in the output:</p><ul><li>&quot;⊙&quot;: Element-wise multiplication.</li><li>&quot;⊘&quot;: Element-wise division.</li><li>&quot;diagm(x)&quot;: Diagonal matrix with &quot;x&quot; on the diagonal.</li><li>&quot;vec(1)&quot;: Vector consisting of 1:s.</li><li>&quot;sgn(x)&quot;: The signum function applied element-wise.</li><li>&quot;tr(X)&quot;: Trace of the matrix &quot;X&quot;.</li><li>&quot;abs(x)&quot;: Element-wise absolute value of &quot;x&quot;.</li></ul><h3 id="Julia-Function"><a class="docs-heading-anchor" href="#Julia-Function">Julia Function</a><a id="Julia-Function-1"></a><a class="docs-heading-anchor-permalink" href="#Julia-Function" title="Permalink"></a></h3><p>A Julia function is generated by passing a <a href="../api/#DiffMatic.JuliaFunc"><code>JuliaFunc</code></a> instance as a keyword argument <code>format</code> to <a href="../api/#DiffMatic.to_std"><code>to_std</code></a>. The function is returned in the form of an <a href="https://docs.julialang.org/en/v1/manual/metaprogramming/#Expressions-and-evaluation">expression</a>:</p><pre><code class="language-julia hljs">to_std(g; format = JuliaFunc())
4141

4242
# output
4343

@@ -92,4 +92,4 @@
9292
return 2 * ((transpose(B) * transpose(A)) * x) + 2 * (A * (B * x))
9393
end
9494
end
95-
</code></pre><div class="citation canonical"><dl><dt>[1]</dt><dd><div id="laue2018computinghigherorder">S. Laue, M. Mitterreiter and J. Giesen. <em>Computing Higher Order Derivatives of Matrix and Tensor Expressions</em>. In: <em>Advances in Neural Information Processing Systems</em>, Vol. 31 (Curran Associates, Inc., 2018).</div></dd></dl></div></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Quick Start</a><a class="docs-footer-nextpage" 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.14.1 on <span class="colophon-date" title="Monday 1 September 2025 20:47">Monday 1 September 2025</span>. Using Julia version 1.11.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
95+
</code></pre><div class="citation canonical"><dl><dt>[1]</dt><dd><div id="laue2018computinghigherorder">S. Laue, M. Mitterreiter and J. Giesen. <em>Computing Higher Order Derivatives of Matrix and Tensor Expressions</em>. In: <em>Advances in Neural Information Processing Systems</em>, Vol. 31 (Curran Associates, Inc., 2018).</div></dd></dl></div></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Quick Start</a><a class="docs-footer-nextpage" 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.14.1 on <span class="colophon-date" title="Wednesday 17 September 2025 15:01">Wednesday 17 September 2025</span>. Using Julia version 1.11.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

0 commit comments

Comments
 (0)