build based on 3ffd13f

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-11-12T21:10:19","documenter_version":"1.7.0"}}
+{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-11-12T21:18:54","documenter_version":"1.7.0"}}

dev/extensions.html

@@ -26,4 +26,4 @@
 julia> KVector{1, VGA(3)}(1, 2, 3) * 1.5u"m"
 (1.5e₁ + 3.0e₂ + 4.5e₃) m</code></pre><div class="admonition is-category-warn"><header class="admonition-header">Constructing Clifford numbers from `Quantity` coefficients fails</header><div class="admonition-body"><p>Attempts to construct a Clifford number from <code>Quantity</code> objects will fail, because <code>Quantity</code> does not subtype <code>Real</code> or <code>Complex</code>:</p><pre><code class="language-julia-repl hljs">julia&gt; KVector{1,VGA(3)}(1u&quot;m&quot;, 2u&quot;m&quot;, 3u&quot;m&quot;)
 ERROR: ArgumentError:
-...</code></pre><p>For this reason, Clifford numbers with mixed units cannot be constructed, and this is  intentional: <code>AbstractCliffordNumber</code> assumes an orthonormal basis.</p></div></div><p>Supported operations include the geometric product and wedge product.</p><p>[Quaternions.jl]:   https://github.com/JuliaGeometry/Quaternions.jl [Unitful.jl]: https://github.com/PainterQubits/Unitful.jl</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="performance.html">« Performance tips</a><a class="docs-footer-nextpage" href="api/clifford.html">CliffordNumbers »</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="Tuesday 12 November 2024 21:10">Tuesday 12 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+...</code></pre><p>For this reason, Clifford numbers with mixed units cannot be constructed, and this is  intentional: <code>AbstractCliffordNumber</code> assumes an orthonormal basis.</p></div></div><p>Supported operations include the geometric product and wedge product.</p><p>[Quaternions.jl]:   https://github.com/JuliaGeometry/Quaternions.jl [Unitful.jl]: https://github.com/PainterQubits/Unitful.jl</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="performance.html">« Performance tips</a><a class="docs-footer-nextpage" href="api/clifford.html">CliffordNumbers »</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="Tuesday 12 November 2024 21:18">Tuesday 12 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/indexing.html

@@ -37,4 +37,4 @@
 true
 
 julia> BitIndices{STA,CliffordNumber{STA}}() == BitIndices{STA,CliffordNumber{STA,Float32,8}}()
-true </code></pre><p>For this reason, you should call <code>BitIndices(x)</code> or <code>BitIndices(C)</code> instead of directly constructing <code>BitIndices{Q,C}()</code>.</p></div></div><h3 id="TransformedBitIndices{Q,C,F}"><a class="docs-heading-anchor" href="#TransformedBitIndices{Q,C,F}"><code>TransformedBitIndices{Q,C,F}</code></a><a id="TransformedBitIndices{Q,C,F}-1"></a><a class="docs-heading-anchor-permalink" href="#TransformedBitIndices{Q,C,F}" title="Permalink"></a></h3><p>If we want to perform a transformation on all elements of a <code>BitIndices</code> instance, we may use dot  syntax and broadcast an operation: for instance, <code>reverse.(BitIndices(x))</code> to obtain the reverse of all indices. Without any explicit specification of behavior, this will return a <code>Vector</code>, and for  the sake of performance we&#39;d like to avoid returning types without statically known lengths.</p><p>We could solve this by converting <code>BitIndices</code> to a <code>Tuple</code> internally as part of the broadcasting implementation, but doing this will cause its own set of problems: indexing an <code>AbstractCliffordNumber</code> with a <code>Tuple</code> returns a <code>Tuple</code>. This may be fine internally, if we know to call the constructor, but this is potentially confusing for new users. For this reason, we  provide <code>TransformedBitIndices{Q,C,F}</code>, which is a lazy representation of a function applied to every element of <code>BitIndices(C)</code>.</p><p>For convenience, we provide a few aliases for operations which are commonly used with <code>BitIndices</code>:</p><ul><li><code>ReversedBitIndices{Q,C}</code> is the type of <code>reverse.(::BitIndices{Q,C})</code>.</li><li><code>GradeInvolutedBitIndices{Q,C}</code> is the type of <code>grade_involution.(::BitIndices{Q,C})</code>.</li><li><code>ConjugatedBitIndices{Q,C}</code> is the type of <code>conj.(::BitIndices{Q,C})</code>.</li></ul><p>In the future, we may override some <code>broadcast</code> implementations to ensure that all of these types are interconvertible with each other and with <code>BitIndices{Q,C}</code>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="metrics.html">« Metric signatures</a><a class="docs-footer-nextpage" href="operations.html">Operations »</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="Tuesday 12 November 2024 21:10">Tuesday 12 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+true </code></pre><p>For this reason, you should call <code>BitIndices(x)</code> or <code>BitIndices(C)</code> instead of directly constructing <code>BitIndices{Q,C}()</code>.</p></div></div><h3 id="TransformedBitIndices{Q,C,F}"><a class="docs-heading-anchor" href="#TransformedBitIndices{Q,C,F}"><code>TransformedBitIndices{Q,C,F}</code></a><a id="TransformedBitIndices{Q,C,F}-1"></a><a class="docs-heading-anchor-permalink" href="#TransformedBitIndices{Q,C,F}" title="Permalink"></a></h3><p>If we want to perform a transformation on all elements of a <code>BitIndices</code> instance, we may use dot  syntax and broadcast an operation: for instance, <code>reverse.(BitIndices(x))</code> to obtain the reverse of all indices. Without any explicit specification of behavior, this will return a <code>Vector</code>, and for  the sake of performance we&#39;d like to avoid returning types without statically known lengths.</p><p>We could solve this by converting <code>BitIndices</code> to a <code>Tuple</code> internally as part of the broadcasting implementation, but doing this will cause its own set of problems: indexing an <code>AbstractCliffordNumber</code> with a <code>Tuple</code> returns a <code>Tuple</code>. This may be fine internally, if we know to call the constructor, but this is potentially confusing for new users. For this reason, we  provide <code>TransformedBitIndices{Q,C,F}</code>, which is a lazy representation of a function applied to every element of <code>BitIndices(C)</code>.</p><p>For convenience, we provide a few aliases for operations which are commonly used with <code>BitIndices</code>:</p><ul><li><code>ReversedBitIndices{Q,C}</code> is the type of <code>reverse.(::BitIndices{Q,C})</code>.</li><li><code>GradeInvolutedBitIndices{Q,C}</code> is the type of <code>grade_involution.(::BitIndices{Q,C})</code>.</li><li><code>ConjugatedBitIndices{Q,C}</code> is the type of <code>conj.(::BitIndices{Q,C})</code>.</li></ul><p>In the future, we may override some <code>broadcast</code> implementations to ensure that all of these types are interconvertible with each other and with <code>BitIndices{Q,C}</code>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="metrics.html">« Metric signatures</a><a class="docs-footer-nextpage" href="operations.html">Operations »</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="Tuesday 12 November 2024 21:18">Tuesday 12 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>