build based on ff5cd7e

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.9.3","generation_timestamp":"2023-10-25T08:37:33","documenter_version":"1.1.2"}}
+{"documenter":{"julia_version":"1.9.3","generation_timestamp":"2023-10-29T08:43:01","documenter_version":"1.1.2"}}

dev/extensions/index.html

@@ -72,5 +72,5 @@
     linesearch;
     retraction_method::AbstractRetractionMethod=ExponentialRetraction(),
     vector_transport_method::AbstractVectorTransportMethod=ParallelTransport(),
-)</code></pre><p>Wrap <code>linesearch</code> (for example <a href="https://julianlsolvers.github.io/LineSearches.jl/latest/reference/linesearch.html#LineSearches.HagerZhang"><code>HagerZhang</code></a> or <a href="https://julianlsolvers.github.io/LineSearches.jl/latest/reference/linesearch.html#LineSearches.MoreThuente"><code>MoreThuente</code></a>). The initial step selection from Linesearches.jl is not yet supported and the value 1.0 is used. The retraction used for determining the line along which the search is performed can be  provided as <code>retraction_method</code>. Gradient vectors are transported between points using <code>vector_transport_method</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaManifolds/Manopt.jl/blob/7563b32d8c44689a82d9b2ac38663859259c0de1/src/helpers/LineSearchesTypes.jl#L2-L27">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="ManifoldsBase.mid_point" href="#ManifoldsBase.mid_point"><code>ManifoldsBase.mid_point</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">mid_point(M, p, q, x)
-mid_point!(M, y, p, q, x)</code></pre><p>Compute the mid point between <code>p</code> and <code>q</code>. If there is more than one mid point of (not necessarily minimizing) geodesics (e.g. on the sphere), the one nearest to <code>x</code> is returned (in place of <code>y</code>).</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaManifolds/Manopt.jl/blob/7563b32d8c44689a82d9b2ac38663859259c0de1/ext/ManoptManifoldsExt/manifold_functions.jl#L24-L31">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="Manopt.max_stepsize-Tuple{FiberBundle{𝔽, ManifoldsBase.TangentSpaceType, M} where {𝔽, M&lt;:AbstractManifold{𝔽}}, Any}" href="#Manopt.max_stepsize-Tuple{FiberBundle{𝔽, ManifoldsBase.TangentSpaceType, M} where {𝔽, M&lt;:AbstractManifold{𝔽}}, Any}"><code>Manopt.max_stepsize</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">max_stepsize(M::TangentBundle, p)</code></pre><p>Tangent bundle has injectivity radius of either infinity (for flat manifolds) or 0 (for non-flat manifolds). This makes a guess of what a reasonable maximum stepsize on a tangent bundle might be.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaManifolds/Manopt.jl/blob/7563b32d8c44689a82d9b2ac38663859259c0de1/ext/ManoptManifoldsExt/manifold_functions.jl#L2-L8">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="Manopt.max_stepsize-Tuple{FixedRankMatrices, Any}" href="#Manopt.max_stepsize-Tuple{FixedRankMatrices, Any}"><code>Manopt.max_stepsize</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">max_stepsize(M::FixedRankMatrices, p)</code></pre><p>Return a reasonable guess of maximum step size on <code>FixedRankMatrices</code> following the choice of typical distance in Matlab Manopt, i.e. dimension of <code>M</code>. See <a href="https://github.com/NicolasBoumal/manopt/blob/97b6eb6b185334ab7b3991585ed2c044d69ee905/manopt/manifolds/fixedrank/fixedrankembeddedfactory.m#L76-L78">this note</a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaManifolds/Manopt.jl/blob/7563b32d8c44689a82d9b2ac38663859259c0de1/ext/ManoptManifoldsExt/manifold_functions.jl#L13-L19">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../contributing/">« Contributing to Manopt.jl</a><a class="docs-footer-nextpage" href="../notation/">Notation »</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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.2 on <span class="colophon-date" title="Wednesday 25 October 2023 08:37">Wednesday 25 October 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+)</code></pre><p>Wrap <code>linesearch</code> (for example <a href="https://julianlsolvers.github.io/LineSearches.jl/latest/reference/linesearch.html#LineSearches.HagerZhang"><code>HagerZhang</code></a> or <a href="https://julianlsolvers.github.io/LineSearches.jl/latest/reference/linesearch.html#LineSearches.MoreThuente"><code>MoreThuente</code></a>). The initial step selection from Linesearches.jl is not yet supported and the value 1.0 is used. The retraction used for determining the line along which the search is performed can be  provided as <code>retraction_method</code>. Gradient vectors are transported between points using <code>vector_transport_method</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaManifolds/Manopt.jl/blob/ff5cd7e94c4b4111307395d582411a94bdb8bc41/src/helpers/LineSearchesTypes.jl#L2-L27">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="ManifoldsBase.mid_point" href="#ManifoldsBase.mid_point"><code>ManifoldsBase.mid_point</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">mid_point(M, p, q, x)
+mid_point!(M, y, p, q, x)</code></pre><p>Compute the mid point between <code>p</code> and <code>q</code>. If there is more than one mid point of (not necessarily minimizing) geodesics (e.g. on the sphere), the one nearest to <code>x</code> is returned (in place of <code>y</code>).</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaManifolds/Manopt.jl/blob/ff5cd7e94c4b4111307395d582411a94bdb8bc41/ext/ManoptManifoldsExt/manifold_functions.jl#L24-L31">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="Manopt.max_stepsize-Tuple{FiberBundle{𝔽, ManifoldsBase.TangentSpaceType, M} where {𝔽, M&lt;:AbstractManifold{𝔽}}, Any}" href="#Manopt.max_stepsize-Tuple{FiberBundle{𝔽, ManifoldsBase.TangentSpaceType, M} where {𝔽, M&lt;:AbstractManifold{𝔽}}, Any}"><code>Manopt.max_stepsize</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">max_stepsize(M::TangentBundle, p)</code></pre><p>Tangent bundle has injectivity radius of either infinity (for flat manifolds) or 0 (for non-flat manifolds). This makes a guess of what a reasonable maximum stepsize on a tangent bundle might be.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaManifolds/Manopt.jl/blob/ff5cd7e94c4b4111307395d582411a94bdb8bc41/ext/ManoptManifoldsExt/manifold_functions.jl#L2-L8">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="Manopt.max_stepsize-Tuple{FixedRankMatrices, Any}" href="#Manopt.max_stepsize-Tuple{FixedRankMatrices, Any}"><code>Manopt.max_stepsize</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">max_stepsize(M::FixedRankMatrices, p)</code></pre><p>Return a reasonable guess of maximum step size on <code>FixedRankMatrices</code> following the choice of typical distance in Matlab Manopt, i.e. dimension of <code>M</code>. See <a href="https://github.com/NicolasBoumal/manopt/blob/97b6eb6b185334ab7b3991585ed2c044d69ee905/manopt/manifolds/fixedrank/fixedrankembeddedfactory.m#L76-L78">this note</a></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaManifolds/Manopt.jl/blob/ff5cd7e94c4b4111307395d582411a94bdb8bc41/ext/ManoptManifoldsExt/manifold_functions.jl#L13-L19">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../contributing/">« Contributing to Manopt.jl</a><a class="docs-footer-nextpage" href="../notation/">Notation »</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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.2 on <span class="colophon-date" title="Sunday 29 October 2023 08:43">Sunday 29 October 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>