build based on b54c74a

previews/PR217/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.7","generation_timestamp":"2024-12-09T12:10:25","documenter_version":"1.8.0"}}
+{"documenter":{"julia_version":"1.10.7","generation_timestamp":"2024-12-09T12:36:00","documenter_version":"1.8.0"}}

previews/PR217/design/index.html

@@ -18,4 +18,4 @@
 
 julia> y[1]
 1-element Array{Float64,1}:
- 6.90031725726027e-310</code></pre><p>The function <a href="../functions/#ManifoldsBase.allocate_result-Tuple{AbstractManifold, Any, Vararg{Any}}"><code>allocate_result</code></a> allocates a correct return value. It takes into account the possibility that different arguments may have different numeric <a href="../functions/#ManifoldsBase.number_eltype-Tuple{Any}"><code>number_eltype</code></a> types thorough the <a href="../functions/#ManifoldsBase.allocate_result_type-Union{Tuple{TF}, Tuple{N}, Tuple{AbstractManifold, TF, Tuple{Vararg{Any, N}}}} where {N, TF}"><code>allocate_result_type</code></a> function. The most prominent example of the usage of this function is the logarithmic function <a href="../functions/#Base.log-Tuple{AbstractManifold, Any, Any}"><code>log</code></a> when used with typed points. Lets assume on a manifold <code>M</code> the have points of type <code>P</code> and corresponding tangent vector types <code>V</code>. then the logarithmic map has the signature</p><pre><code class="language-julia hljs">log(::M, ::P, ::P)</code></pre><p>but the return type would be <span>$V$</span>, whose internal sizes (fields/arrays) will depend on the concrete type of one of the points. This is accomplished by implementing a method <code>allocate_result(::M, ::typeof(log), ::P, ::P)</code> that returns the concrete variable for the result. This way, even with specific types, one just has to implement <code>log!</code> and the one line for the allocation.</p><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>This dispatch from the allocating to the in-place variant happens in Layer I (which changed in ManifoldsBase.jl 0.15), that is, functions like <code>exp</code> or <a href="../metamanifolds/#ManifoldsBase.retract-Tuple{AbstractPowerManifold, Vararg{Any}}"><code>retract</code></a> allocate their result and call the in-place variant <a href="../functions/#ManifoldsBase.exp!-Tuple{AbstractManifold, Any, Any, Any}"><code>exp!</code></a> and <a href="../retractions/#ManifoldsBase.retract!"><code>retract!</code></a> afterwards, where the ladder passes down to layer III to reach <a href="../retractions/#ManifoldsBase.retract_polar!-Tuple{AbstractManifold, Vararg{Any, 4}}"><code>retract_polar!</code></a>.</p></div></div></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../tutorials/implement-a-manifold/">« How to define a manifold</a><a class="docs-footer-nextpage" href="../types/">An abstract manifold »</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.8.0 on <span class="colophon-date" title="Monday 9 December 2024 12:10">Monday 9 December 2024</span>. Using Julia version 1.10.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+ 6.90031725726027e-310</code></pre><p>The function <a href="../functions/#ManifoldsBase.allocate_result-Tuple{AbstractManifold, Any, Vararg{Any}}"><code>allocate_result</code></a> allocates a correct return value. It takes into account the possibility that different arguments may have different numeric <a href="../functions/#ManifoldsBase.number_eltype-Tuple{Any}"><code>number_eltype</code></a> types thorough the <a href="../functions/#ManifoldsBase.allocate_result_type-Union{Tuple{TF}, Tuple{N}, Tuple{AbstractManifold, TF, Tuple{Vararg{Any, N}}}} where {N, TF}"><code>allocate_result_type</code></a> function. The most prominent example of the usage of this function is the logarithmic function <a href="../functions/#Base.log-Tuple{AbstractManifold, Any, Any}"><code>log</code></a> when used with typed points. Lets assume on a manifold <code>M</code> the have points of type <code>P</code> and corresponding tangent vector types <code>V</code>. then the logarithmic map has the signature</p><pre><code class="language-julia hljs">log(::M, ::P, ::P)</code></pre><p>but the return type would be <span>$V$</span>, whose internal sizes (fields/arrays) will depend on the concrete type of one of the points. This is accomplished by implementing a method <code>allocate_result(::M, ::typeof(log), ::P, ::P)</code> that returns the concrete variable for the result. This way, even with specific types, one just has to implement <code>log!</code> and the one line for the allocation.</p><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>This dispatch from the allocating to the in-place variant happens in Layer I (which changed in ManifoldsBase.jl 0.15), that is, functions like <code>exp</code> or <a href="../metamanifolds/#ManifoldsBase.retract-Tuple{AbstractPowerManifold, Vararg{Any}}"><code>retract</code></a> allocate their result and call the in-place variant <a href="../functions/#ManifoldsBase.exp!-Tuple{AbstractManifold, Any, Any, Any}"><code>exp!</code></a> and <a href="../retractions/#ManifoldsBase.retract!"><code>retract!</code></a> afterwards, where the ladder passes down to layer III to reach <a href="../retractions/#ManifoldsBase.retract_polar!-Tuple{AbstractManifold, Vararg{Any, 4}}"><code>retract_polar!</code></a>.</p></div></div></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../tutorials/implement-a-manifold/">« How to define a manifold</a><a class="docs-footer-nextpage" href="../types/">An abstract manifold »</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.8.0 on <span class="colophon-date" title="Monday 9 December 2024 12:36">Monday 9 December 2024</span>. Using Julia version 1.10.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

previews/PR217/index.html

@@ -9,4 +9,4 @@
     TITLE     = {Manifolds.Jl: An Extensible Julia Framework for Data Analysis on Manifolds},
     VOLUME    = {49},
     YEAR      = {2023}
-}</code></pre><p>Note that the citation is in <a href="https://ctan.org/pkg/biblatex">BibLaTeX</a> format.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="tutorials/implement-a-manifold/">How to define a manifold »</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.8.0 on <span class="colophon-date" title="Monday 9 December 2024 12:10">Monday 9 December 2024</span>. Using Julia version 1.10.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+}</code></pre><p>Note that the citation is in <a href="https://ctan.org/pkg/biblatex">BibLaTeX</a> format.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="tutorials/implement-a-manifold/">How to define a manifold »</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.8.0 on <span class="colophon-date" title="Monday 9 December 2024 12:36">Monday 9 December 2024</span>. Using Julia version 1.10.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>