Skip to content

Commit

Permalink
build based on 5d267d5
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Nov 9, 2023
1 parent ea73603 commit 869a13b
Show file tree
Hide file tree
Showing 82 changed files with 7,120 additions and 7,120 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.9.3","generation_timestamp":"2023-11-08T19:06:14","documenter_version":"1.1.2"}}
{"documenter":{"julia_version":"1.9.3","generation_timestamp":"2023-11-09T18:54:50","documenter_version":"1.1.2"}}
14 changes: 7 additions & 7 deletions dev/features/atlases.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/features/differentiation.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/features/distributions.html

Large diffs are not rendered by default.

24 changes: 12 additions & 12 deletions dev/features/group_actions.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/features/integration.html

Large diffs are not rendered by default.

38 changes: 19 additions & 19 deletions dev/features/statistics.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions dev/features/testing.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions dev/features/utilities.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions dev/index.html

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions dev/manifolds/centeredmatrices.html

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions dev/manifolds/choleskyspace.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions dev/manifolds/circle.html

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions dev/manifolds/connection.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/manifolds/elliptope.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/manifolds/essentialmanifold.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions dev/manifolds/euclidean.html

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions dev/manifolds/fiber_bundle.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions dev/manifolds/fixedrankmatrices.html

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions dev/manifolds/flag.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions dev/manifolds/generalizedgrassmann.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions dev/manifolds/generalizedstiefel.html

Large diffs are not rendered by default.

38 changes: 19 additions & 19 deletions dev/manifolds/generalunitary.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/manifolds/graph.html

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions dev/manifolds/grassmann.html

Large diffs are not rendered by default.

52 changes: 26 additions & 26 deletions dev/manifolds/group.html

Large diffs are not rendered by default.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3,864 changes: 1,932 additions & 1,932 deletions dev/manifolds/hyperbolic-b5a1a1a1.svg → dev/manifolds/hyperbolic-3584625c.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3,888 changes: 1,944 additions & 1,944 deletions dev/manifolds/hyperbolic-970c5ab2.svg → dev/manifolds/hyperbolic-918c44b0.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3,910 changes: 1,955 additions & 1,955 deletions dev/manifolds/hyperbolic-410fdd80.svg → dev/manifolds/hyperbolic-c60a189a.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
72 changes: 36 additions & 36 deletions dev/manifolds/hyperbolic.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions dev/manifolds/lorentz.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions dev/manifolds/metric.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/manifolds/multinomial.html

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions dev/manifolds/multinomialdoublystochastic.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/manifolds/multinomialsymmetric.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/manifolds/oblique.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/manifolds/positivenumbers.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions dev/manifolds/power.html

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions dev/manifolds/probabilitysimplex.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions dev/manifolds/product.html

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions dev/manifolds/projectivespace.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions dev/manifolds/quotient.html

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions dev/manifolds/rotations.html

Large diffs are not rendered by default.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion dev/manifolds/shapespace.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions dev/manifolds/skewhermitian.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions dev/manifolds/spdfixeddeterminant.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@
\bigr\}.\]</p><p>This manifold is modelled as a submanifold of <a href="symmetricpositivedefinite.html#Manifolds.SymmetricPositiveDefinite"><code>SymmetricPositiveDefinite</code></a><code>(n)</code>.</p><p>These matrices are sometimes also called <a href="https://en.wiktionary.org/wiki/isochoric">isochoric</a>, which refers to the interpretation of the matrix representing an ellipsoid. All ellipsoids that represent points on this manifold have the same volume.</p><p>The tangent space is modelled the same as for <a href="symmetricpositivedefinite.html#Manifolds.SymmetricPositiveDefinite"><code>SymmetricPositiveDefinite</code></a><code>(n)</code> and consists of all symmetric matrices with zero trace</p><p class="math-container">\[ T_p\mathcal P_d(n) =
\bigl\{
X \in \mathbb R^{n×n} \big|\ X=X^\mathrm{T} \text{ and } \operatorname{tr}(p) = 0
\bigr\},\]</p><p>since for a constant determinant we require that <code>0 = D\det(p)[Z] = \det(p)\operatorname{tr}(p^{-1}Z)</code> for all tangent vectors <span>$Z$</span>. Additionally we store the tangent vectors as <code>X=p^{-1}Z</code>, i.e. symmetric matrices.</p><p><strong>Constructor</strong></p><pre><code class="nohighlight hljs">SPDFixedDeterminant(n::Int, d::Real=1.0; parameter::Symbol=:type)</code></pre><p>Generate the manifold <span>$\mathcal P_d(n) \subset \mathcal P(n)$</span> of determinant <span>$d$</span>, which defaults to 1.</p><p><code>parameter</code>: whether a type parameter should be used to store <code>n</code>. By default size is stored in type. Value can either be <code>:field</code> or <code>:type</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaManifolds/Manifolds.jl/blob/2104befae9261a20cabb0994dc4060935ac17b62/src/manifolds/SPDFixedDeterminant.jl#L1-L39">source</a></section></article><p>This manifold can is a submanifold of the <a href="symmetricpositivedefinite.html#SymmetricPositiveDefiniteSection">symmetric positive definite matrices</a> and hence inherits most properties therefrom.</p><p>The differences are the functions</p><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.check_point-Tuple{SPDFixedDeterminant, Any}" href="#ManifoldsBase.check_point-Tuple{SPDFixedDeterminant, Any}"><code>ManifoldsBase.check_point</code></a><span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">check_point(M::SPDFixedDeterminant, p; kwargs...)</code></pre><p>Check whether <code>p</code> is a valid manifold point on the <a href="spdfixeddeterminant.html#Manifolds.SPDFixedDeterminant"><code>SPDFixedDeterminant</code></a><code>(n,d)</code> <code>M</code>, i.e. whether <code>p</code> is a <a href="symmetricpositivedefinite.html#Manifolds.SymmetricPositiveDefinite"><code>SymmetricPositiveDefinite</code></a> matrix of size <code>(n, n)</code></p><p>with determinant <span>$\det(p) =$</span><code>M.d</code>.</p><p>The tolerance for the determinant of <code>p</code> can be set using <code>kwargs...</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaManifolds/Manifolds.jl/blob/2104befae9261a20cabb0994dc4060935ac17b62/src/manifolds/SPDFixedDeterminant.jl#L55-L64">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.check_vector-Tuple{SPDFixedDeterminant, Any, Any}" href="#ManifoldsBase.check_vector-Tuple{SPDFixedDeterminant, Any, Any}"><code>ManifoldsBase.check_vector</code></a><span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">check_vector(M::SPDFixedDeterminant, p, X; kwargs... )</code></pre><p>Check whether <code>X</code> is a tangent vector to manifold point <code>p</code> on the <a href="spdfixeddeterminant.html#Manifolds.SPDFixedDeterminant"><code>SPDFixedDeterminant</code></a> <code>M</code>, i.e. <code>X</code> has to be a tangent vector on <a href="symmetricpositivedefinite.html#Manifolds.SymmetricPositiveDefinite"><code>SymmetricPositiveDefinite</code></a>, so a symmetric matrix, and additionally fulfill <span>$\operatorname{tr}(X) = 0$</span>.</p><p>The tolerance for the trace check of <code>X</code> can be set using <code>kwargs...</code>, which influences the <code>isapprox</code>-check.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaManifolds/Manifolds.jl/blob/2104befae9261a20cabb0994dc4060935ac17b62/src/manifolds/SPDFixedDeterminant.jl#L75-L84">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.project-Tuple{SPDFixedDeterminant, Any, Any}" href="#ManifoldsBase.project-Tuple{SPDFixedDeterminant, Any, Any}"><code>ManifoldsBase.project</code></a><span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">Y = project(M::SPDFixedDeterminant, p, X)
project!(M::SPDFixedDeterminant, Y, p, X)</code></pre><p>Project the symmetric matrix <code>X</code> onto the tangent space at <code>p</code> of the (sub-)manifold of s.p.d. matrices of determinant <code>M.d</code> (in place of <code>Y</code>), by setting its diagonal (and hence its trace) to zero.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaManifolds/Manifolds.jl/blob/2104befae9261a20cabb0994dc4060935ac17b62/src/manifolds/SPDFixedDeterminant.jl#L144-L152">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.project-Tuple{SPDFixedDeterminant, Any}" href="#ManifoldsBase.project-Tuple{SPDFixedDeterminant, Any}"><code>ManifoldsBase.project</code></a><span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">q = project(M::SPDFixedDeterminant, p)
project!(M::SPDFixedDeterminant, q, p)</code></pre><p>Project the symmetric positive definite (s.p.d.) matrix <code>p</code> from the embedding onto the (sub-)manifold of s.p.d. matrices of determinant <code>M.d</code> (in place of <code>q</code>).</p><p>The formula reads</p><p class="math-container">\[q = \Bigl(\frac{d}{\det(p)}\Bigr)^{\frac{1}{n}}p\]</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaManifolds/Manifolds.jl/blob/2104befae9261a20cabb0994dc4060935ac17b62/src/manifolds/SPDFixedDeterminant.jl#L123-L135">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="symmetricpositivedefinite.html">« Symmetric positive definite</a><a class="docs-footer-nextpage" href="symmetricpsdfixedrank.html">Symmetric positive semidefinite fixed rank »</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 8 November 2023 19:06">Wednesday 8 November 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
\bigr\},\]</p><p>since for a constant determinant we require that <code>0 = D\det(p)[Z] = \det(p)\operatorname{tr}(p^{-1}Z)</code> for all tangent vectors <span>$Z$</span>. Additionally we store the tangent vectors as <code>X=p^{-1}Z</code>, i.e. symmetric matrices.</p><p><strong>Constructor</strong></p><pre><code class="nohighlight hljs">SPDFixedDeterminant(n::Int, d::Real=1.0; parameter::Symbol=:type)</code></pre><p>Generate the manifold <span>$\mathcal P_d(n) \subset \mathcal P(n)$</span> of determinant <span>$d$</span>, which defaults to 1.</p><p><code>parameter</code>: whether a type parameter should be used to store <code>n</code>. By default size is stored in type. Value can either be <code>:field</code> or <code>:type</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaManifolds/Manifolds.jl/blob/5d267d532036399ed9d0e31d19345dee10b64bdb/src/manifolds/SPDFixedDeterminant.jl#L1-L39">source</a></section></article><p>This manifold can is a submanifold of the <a href="symmetricpositivedefinite.html#SymmetricPositiveDefiniteSection">symmetric positive definite matrices</a> and hence inherits most properties therefrom.</p><p>The differences are the functions</p><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.check_point-Tuple{SPDFixedDeterminant, Any}" href="#ManifoldsBase.check_point-Tuple{SPDFixedDeterminant, Any}"><code>ManifoldsBase.check_point</code></a><span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">check_point(M::SPDFixedDeterminant, p; kwargs...)</code></pre><p>Check whether <code>p</code> is a valid manifold point on the <a href="spdfixeddeterminant.html#Manifolds.SPDFixedDeterminant"><code>SPDFixedDeterminant</code></a><code>(n,d)</code> <code>M</code>, i.e. whether <code>p</code> is a <a href="symmetricpositivedefinite.html#Manifolds.SymmetricPositiveDefinite"><code>SymmetricPositiveDefinite</code></a> matrix of size <code>(n, n)</code></p><p>with determinant <span>$\det(p) =$</span><code>M.d</code>.</p><p>The tolerance for the determinant of <code>p</code> can be set using <code>kwargs...</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaManifolds/Manifolds.jl/blob/5d267d532036399ed9d0e31d19345dee10b64bdb/src/manifolds/SPDFixedDeterminant.jl#L55-L64">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.check_vector-Tuple{SPDFixedDeterminant, Any, Any}" href="#ManifoldsBase.check_vector-Tuple{SPDFixedDeterminant, Any, Any}"><code>ManifoldsBase.check_vector</code></a><span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">check_vector(M::SPDFixedDeterminant, p, X; kwargs... )</code></pre><p>Check whether <code>X</code> is a tangent vector to manifold point <code>p</code> on the <a href="spdfixeddeterminant.html#Manifolds.SPDFixedDeterminant"><code>SPDFixedDeterminant</code></a> <code>M</code>, i.e. <code>X</code> has to be a tangent vector on <a href="symmetricpositivedefinite.html#Manifolds.SymmetricPositiveDefinite"><code>SymmetricPositiveDefinite</code></a>, so a symmetric matrix, and additionally fulfill <span>$\operatorname{tr}(X) = 0$</span>.</p><p>The tolerance for the trace check of <code>X</code> can be set using <code>kwargs...</code>, which influences the <code>isapprox</code>-check.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaManifolds/Manifolds.jl/blob/5d267d532036399ed9d0e31d19345dee10b64bdb/src/manifolds/SPDFixedDeterminant.jl#L75-L84">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.project-Tuple{SPDFixedDeterminant, Any, Any}" href="#ManifoldsBase.project-Tuple{SPDFixedDeterminant, Any, Any}"><code>ManifoldsBase.project</code></a><span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">Y = project(M::SPDFixedDeterminant, p, X)
project!(M::SPDFixedDeterminant, Y, p, X)</code></pre><p>Project the symmetric matrix <code>X</code> onto the tangent space at <code>p</code> of the (sub-)manifold of s.p.d. matrices of determinant <code>M.d</code> (in place of <code>Y</code>), by setting its diagonal (and hence its trace) to zero.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaManifolds/Manifolds.jl/blob/5d267d532036399ed9d0e31d19345dee10b64bdb/src/manifolds/SPDFixedDeterminant.jl#L144-L152">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.project-Tuple{SPDFixedDeterminant, Any}" href="#ManifoldsBase.project-Tuple{SPDFixedDeterminant, Any}"><code>ManifoldsBase.project</code></a><span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">q = project(M::SPDFixedDeterminant, p)
project!(M::SPDFixedDeterminant, q, p)</code></pre><p>Project the symmetric positive definite (s.p.d.) matrix <code>p</code> from the embedding onto the (sub-)manifold of s.p.d. matrices of determinant <code>M.d</code> (in place of <code>q</code>).</p><p>The formula reads</p><p class="math-container">\[q = \Bigl(\frac{d}{\det(p)}\Bigr)^{\frac{1}{n}}p\]</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaManifolds/Manifolds.jl/blob/5d267d532036399ed9d0e31d19345dee10b64bdb/src/manifolds/SPDFixedDeterminant.jl#L123-L135">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="symmetricpositivedefinite.html">« Symmetric positive definite</a><a class="docs-footer-nextpage" href="symmetricpsdfixedrank.html">Symmetric positive semidefinite fixed rank »</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="Thursday 9 November 2023 18:54">Thursday 9 November 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 869a13b

Please sign in to comment.