build based on 83751ec

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-01T12:43:36","documenter_version":"1.6.0"}}
+{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-04T14:10:42","documenter_version":"1.7.0"}}

dev/Automatic differentiation/index.html

@@ -13,7 +13,7 @@
  0.0  0.0  1.0
 
 julia> ∇f, f = gradient(tr, x, :all)
-([1.0 0.0 0.0; 0.0 1.0 0.0; 0.0 0.0 1.0], 1.1733382401532275)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/KeitaNakamura/Tensorial.jl/blob/0840a34f36fb01b7a200bce5400470612ec8f89b/src/ad.jl#L101-L125">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="Tensorial.hessian-Tuple{Any, Union{Number, AbstractTensor}}" href="#Tensorial.hessian-Tuple{Any, Union{Number, AbstractTensor}}"><code>Tensorial.hessian</code></a> — <span class="docstring-category">Method</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(f, x)
+([1.0 0.0 0.0; 0.0 1.0 0.0; 0.0 0.0 1.0], 1.1733382401532275)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/KeitaNakamura/Tensorial.jl/blob/83751ec368b7245fed14af785e64d6fe6b12aad3/src/ad.jl#L101-L125">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="Tensorial.hessian-Tuple{Any, Union{Number, AbstractTensor}}" href="#Tensorial.hessian-Tuple{Any, Union{Number, AbstractTensor}}"><code>Tensorial.hessian</code></a> — <span class="docstring-category">Method</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(f, x)
 hessian(f, x, :all)</code></pre><p>Compute the hessian of <code>f</code> with respect to <code>x</code> by the automatic differentiation. If pseudo keyword <code>:all</code> is given, the value of <code>f(x)</code> is also returned.</p><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia&gt; x = rand(Vec{3})
 3-element Vec{3, Float64}:
  0.32597672886359486
@@ -27,4 +27,4 @@
  -0.231782  -0.390397   1.32626
 
 julia&gt; ∇∇f, ∇f, f = hessian(norm, x, :all)
-([1.1360324375454411 -0.5821964220304534 -0.23178236037013888; -0.5821964220304533 0.5010791569244991 -0.39039709608344814; -0.23178236037013886 -0.39039709608344814 1.3262640626479867], [0.4829957515506539, 0.8135223859352438, 0.3238771859304809], 0.6749059962060727)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/KeitaNakamura/Tensorial.jl/blob/0840a34f36fb01b7a200bce5400470612ec8f89b/src/ad.jl#L138-L162">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../Broadcast/">« Broadcast</a><a class="docs-footer-nextpage" href="../Einstein summation/">Einstein summation »</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.6.0 on <span class="colophon-date" title="Sunday 1 September 2024 12:43">Sunday 1 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+([1.1360324375454411 -0.5821964220304534 -0.23178236037013888; -0.5821964220304533 0.5010791569244991 -0.39039709608344814; -0.23178236037013886 -0.39039709608344814 1.3262640626479867], [0.4829957515506539, 0.8135223859352438, 0.3238771859304809], 0.6749059962060727)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/KeitaNakamura/Tensorial.jl/blob/83751ec368b7245fed14af785e64d6fe6b12aad3/src/ad.jl#L138-L162">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../Broadcast/">« Broadcast</a><a class="docs-footer-nextpage" href="../Einstein summation/">Einstein summation »</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.7.0 on <span class="colophon-date" title="Wednesday 4 September 2024 14:10">Wednesday 4 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/Benchmarks/index.html

@@ -4,7 +4,7 @@
 S = rand(SymmetricSecondOrderTensor{3})
 B = rand(Tensor{Tuple{3,3,3}})
 AA = rand(FourthOrderTensor{3})
-SS = rand(SymmetricFourthOrderTensor{3})</code></pre><table><tr><th style="text-align: left">Operation</th><th style="text-align: right"><code>Tensor</code></th><th style="text-align: right"><code>Array</code></th><th style="text-align: right">speed-up</th></tr><tr><td style="text-align: left"><strong>Single contraction</strong></td><td style="text-align: right"></td><td style="text-align: right"></td><td style="text-align: right"></td></tr><tr><td style="text-align: left"><code>a ⋅ a</code></td><td style="text-align: right">2.785 ns</td><td style="text-align: right">9.567 ns</td><td style="text-align: right">×3.4</td></tr><tr><td style="text-align: left"><code>A ⋅ a</code></td><td style="text-align: right">3.396 ns</td><td style="text-align: right">65.316 ns</td><td style="text-align: right">×19.2</td></tr><tr><td style="text-align: left"><code>S ⋅ a</code></td><td style="text-align: right">3.706 ns</td><td style="text-align: right">65.776 ns</td><td style="text-align: right">×17.7</td></tr><tr><td style="text-align: left"><strong>Double contraction</strong></td><td style="text-align: right"></td><td style="text-align: right"></td><td style="text-align: right"></td></tr><tr><td style="text-align: left"><code>A ⊡ A</code></td><td style="text-align: right">3.406 ns</td><td style="text-align: right">11.111 ns</td><td style="text-align: right">×3.3</td></tr><tr><td style="text-align: left"><code>S ⊡ S</code></td><td style="text-align: right">3.406 ns</td><td style="text-align: right">11.111 ns</td><td style="text-align: right">×3.3</td></tr><tr><td style="text-align: left"><code>B ⊡ A</code></td><td style="text-align: right">5.419 ns</td><td style="text-align: right">131.278 ns</td><td style="text-align: right">×24.2</td></tr><tr><td style="text-align: left"><code>AA ⊡ A</code></td><td style="text-align: right">7.732 ns</td><td style="text-align: right">145.319 ns</td><td style="text-align: right">×18.8</td></tr><tr><td style="text-align: left"><code>SS ⊡ S</code></td><td style="text-align: right">4.187 ns</td><td style="text-align: right">144.684 ns</td><td style="text-align: right">×34.6</td></tr><tr><td style="text-align: left"><strong>Tensor product</strong></td><td style="text-align: right"></td><td style="text-align: right"></td><td style="text-align: right"></td></tr><tr><td style="text-align: left"><code>a ⊗ a</code></td><td style="text-align: right">3.406 ns</td><td style="text-align: right">40.085 ns</td><td style="text-align: right">×11.8</td></tr><tr><td style="text-align: left"><strong>Cross product</strong></td><td style="text-align: right"></td><td style="text-align: right"></td><td style="text-align: right"></td></tr><tr><td style="text-align: left"><code>a × a</code></td><td style="text-align: right">3.406 ns</td><td style="text-align: right">40.085 ns</td><td style="text-align: right">×11.8</td></tr><tr><td style="text-align: left"><strong>Determinant</strong></td><td style="text-align: right"></td><td style="text-align: right"></td><td style="text-align: right"></td></tr><tr><td style="text-align: left"><code>det(A)</code></td><td style="text-align: right">3.396 ns</td><td style="text-align: right">182.239 ns</td><td style="text-align: right">×53.7</td></tr><tr><td style="text-align: left"><code>det(S)</code></td><td style="text-align: right">3.095 ns</td><td style="text-align: right">182.167 ns</td><td style="text-align: right">×58.9</td></tr><tr><td style="text-align: left"><strong>Inverse</strong></td><td style="text-align: right"></td><td style="text-align: right"></td><td style="text-align: right"></td></tr><tr><td style="text-align: left"><code>inv(A)</code></td><td style="text-align: right">5.830 ns</td><td style="text-align: right">481.052 ns</td><td style="text-align: right">×82.5</td></tr><tr><td style="text-align: left"><code>inv(S)</code></td><td style="text-align: right">4.879 ns</td><td style="text-align: right">487.201 ns</td><td style="text-align: right">×99.9</td></tr><tr><td style="text-align: left"><code>inv(AA)</code></td><td style="text-align: right">939.423 ns</td><td style="text-align: right">1.605 μs</td><td style="text-align: right">×1.7</td></tr><tr><td style="text-align: left"><code>inv(SS)</code></td><td style="text-align: right">360.433 ns</td><td style="text-align: right">1.598 μs</td><td style="text-align: right">×4.4</td></tr></table><p>The benchmarks are generated by <a href="https://github.com/KeitaNakamura/Tensorial.jl/blob/master/benchmark/runbenchmarks.jl"><code>runbenchmarks.jl</code></a> on the following system:</p><pre><code class="language-julia hljs">julia&gt; versioninfo()
+SS = rand(SymmetricFourthOrderTensor{3})</code></pre><table><tr><th style="text-align: left">Operation</th><th style="text-align: right"><code>Tensor</code></th><th style="text-align: right"><code>Array</code></th><th style="text-align: right">speed-up</th></tr><tr><td style="text-align: left"><strong>Single contraction</strong></td><td style="text-align: right"></td><td style="text-align: right"></td><td style="text-align: right"></td></tr><tr><td style="text-align: left"><code>a ⋅ a</code></td><td style="text-align: right">2.785 ns</td><td style="text-align: right">9.567 ns</td><td style="text-align: right">×3.4</td></tr><tr><td style="text-align: left"><code>A ⋅ a</code></td><td style="text-align: right">3.396 ns</td><td style="text-align: right">65.291 ns</td><td style="text-align: right">×19.2</td></tr><tr><td style="text-align: left"><code>S ⋅ a</code></td><td style="text-align: right">3.706 ns</td><td style="text-align: right">65.271 ns</td><td style="text-align: right">×17.6</td></tr><tr><td style="text-align: left"><strong>Double contraction</strong></td><td style="text-align: right"></td><td style="text-align: right"></td><td style="text-align: right"></td></tr><tr><td style="text-align: left"><code>A ⊡ A</code></td><td style="text-align: right">3.406 ns</td><td style="text-align: right">11.112 ns</td><td style="text-align: right">×3.3</td></tr><tr><td style="text-align: left"><code>S ⊡ S</code></td><td style="text-align: right">3.406 ns</td><td style="text-align: right">11.111 ns</td><td style="text-align: right">×3.3</td></tr><tr><td style="text-align: left"><code>B ⊡ A</code></td><td style="text-align: right">5.440 ns</td><td style="text-align: right">131.066 ns</td><td style="text-align: right">×24.1</td></tr><tr><td style="text-align: left"><code>AA ⊡ A</code></td><td style="text-align: right">7.723 ns</td><td style="text-align: right">154.454 ns</td><td style="text-align: right">×20.0</td></tr><tr><td style="text-align: left"><code>SS ⊡ S</code></td><td style="text-align: right">4.288 ns</td><td style="text-align: right">146.151 ns</td><td style="text-align: right">×34.1</td></tr><tr><td style="text-align: left"><strong>Tensor product</strong></td><td style="text-align: right"></td><td style="text-align: right"></td><td style="text-align: right"></td></tr><tr><td style="text-align: left"><code>a ⊗ a</code></td><td style="text-align: right">3.406 ns</td><td style="text-align: right">39.903 ns</td><td style="text-align: right">×11.7</td></tr><tr><td style="text-align: left"><strong>Cross product</strong></td><td style="text-align: right"></td><td style="text-align: right"></td><td style="text-align: right"></td></tr><tr><td style="text-align: left"><code>a × a</code></td><td style="text-align: right">3.406 ns</td><td style="text-align: right">39.903 ns</td><td style="text-align: right">×11.7</td></tr><tr><td style="text-align: left"><strong>Determinant</strong></td><td style="text-align: right"></td><td style="text-align: right"></td><td style="text-align: right"></td></tr><tr><td style="text-align: left"><code>det(A)</code></td><td style="text-align: right">3.396 ns</td><td style="text-align: right">190.341 ns</td><td style="text-align: right">×56.0</td></tr><tr><td style="text-align: left"><code>det(S)</code></td><td style="text-align: right">3.095 ns</td><td style="text-align: right">184.229 ns</td><td style="text-align: right">×59.5</td></tr><tr><td style="text-align: left"><strong>Inverse</strong></td><td style="text-align: right"></td><td style="text-align: right"></td><td style="text-align: right"></td></tr><tr><td style="text-align: left"><code>inv(A)</code></td><td style="text-align: right">5.871 ns</td><td style="text-align: right">489.423 ns</td><td style="text-align: right">×83.4</td></tr><tr><td style="text-align: left"><code>inv(S)</code></td><td style="text-align: right">6.933 ns</td><td style="text-align: right">485.495 ns</td><td style="text-align: right">×70.0</td></tr><tr><td style="text-align: left"><code>inv(AA)</code></td><td style="text-align: right">918.394 ns</td><td style="text-align: right">1.510 μs</td><td style="text-align: right">×1.6</td></tr><tr><td style="text-align: left"><code>inv(SS)</code></td><td style="text-align: right">353.662 ns</td><td style="text-align: right">1.503 μs</td><td style="text-align: right">×4.2</td></tr></table><p>The benchmarks are generated by <a href="https://github.com/KeitaNakamura/Tensorial.jl/blob/master/benchmark/runbenchmarks.jl"><code>runbenchmarks.jl</code></a> on the following system:</p><pre><code class="language-julia hljs">julia&gt; versioninfo()
 Julia Version 1.10.5
 Commit 6f3fdf7b362 (2024-08-27 14:19 UTC)
 Build Info:
@@ -16,4 +16,4 @@
   LIBM: libopenlibm
   LLVM: libLLVM-15.0.7 (ORCJIT, znver3)
 Threads: 1 default, 0 interactive, 1 GC (on 4 virtual cores)
-</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../Quaternion/">« Quaternion</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.6.0 on <span class="colophon-date" title="Sunday 1 September 2024 12:43">Sunday 1 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../Quaternion/">« Quaternion</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.7.0 on <span class="colophon-date" title="Wednesday 4 September 2024 14:10">Wednesday 4 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>