Skip to content

Commit

Permalink
build based on 31148ed
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Nov 12, 2024
1 parent 86c74b9 commit 89ba8b5
Show file tree
Hide file tree
Showing 16 changed files with 84 additions and 58 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.11.1","generation_timestamp":"2024-11-11T20:52:29","documenter_version":"1.7.0"}}
{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-11-12T21:10:19","documenter_version":"1.7.0"}}
22 changes: 11 additions & 11 deletions dev/api/clifford.html

Large diffs are not rendered by default.

5 changes: 5 additions & 0 deletions dev/api/extensions.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Extensions · CliffordNumbers.jl</title><meta name="title" content="Extensions · CliffordNumbers.jl"/><meta property="og:title" content="Extensions · CliffordNumbers.jl"/><meta property="twitter:title" content="Extensions · CliffordNumbers.jl"/><meta name="description" content="Documentation for CliffordNumbers.jl."/><meta property="og:description" content="Documentation for CliffordNumbers.jl."/><meta property="twitter:description" content="Documentation for CliffordNumbers.jl."/><meta property="og:url" content="https://brainandforce.github.io/CliffordNumbers.jl/api/extensions.html"/><meta property="twitter:url" content="https://brainandforce.github.io/CliffordNumbers.jl/api/extensions.html"/><link rel="canonical" href="https://brainandforce.github.io/CliffordNumbers.jl/api/extensions.html"/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../index.html">CliffordNumbers.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../index.html">Home</a></li><li><a class="tocitem" href="../numeric.html">Clifford number types</a></li><li><a class="tocitem" href="../metrics.html">Metric signatures</a></li><li><a class="tocitem" href="../indexing.html">Indexing</a></li><li><a class="tocitem" href="../operations.html">Operations</a></li><li><a class="tocitem" href="../performance.html">Performance tips</a></li><li><a class="tocitem" href="../extensions.html">Extensions</a></li><li><span class="tocitem">API</span><ul><li><a class="tocitem" href="clifford.html">CliffordNumbers</a></li><li><a class="tocitem" href="indexing.html">Indexing</a></li><li><a class="tocitem" href="math.html">Math</a></li><li><a class="tocitem" href="metrics.html">Metric signatures</a></li><li><a class="tocitem" href="internal.html">Internals</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href="extensions.html">Extensions</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href="extensions.html">Extensions</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/brainandforce/CliffordNumbers.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/brainandforce/CliffordNumbers.jl/blob/main/docs/src/api/extensions.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Extensions"><a class="docs-heading-anchor" href="#Extensions">Extensions</a><a id="Extensions-1"></a><a class="docs-heading-anchor-permalink" href="#Extensions" title="Permalink"></a></h1><h2 id="[Quaternions.jl]"><a class="docs-heading-anchor" href="#[Quaternions.jl]">[Quaternions.jl]</a><a id="[Quaternions.jl]-1"></a><a class="docs-heading-anchor-permalink" href="#[Quaternions.jl]" title="Permalink"></a></h2><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="Quaternions.Quaternion-Tuple{AbstractCliffordNumber{VGA(3)}}" href="#Quaternions.Quaternion-Tuple{AbstractCliffordNumber{VGA(3)}}"><code>Quaternions.Quaternion</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">Quaternion(c::AbstractCliffordNumber{VGA(3)})
Quaternion{T}(c::AbstractCliffordNumber{VGA(3)})</code></pre><p>Constructs a quaternion from an element of the algebra of physical space, the 3D geometric algebra with a positive-definite signature whose even subalgebra is isomorphic to the quaternion algebra ℍ. Any odd-grade coefficients of <code>c</code> are lost. If the type parameter <code>T</code> is supplied, the scalars of the input are converted to type T.</p><p>If loss of odd-grade coefficients should throw an error, use <code>convert(Quaternion, c)</code> or <code>convert(Quaternion{T}, c)</code> instead of the constructor.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/brainandforce/CliffordNumbers.jl/blob/31148edbfffc80e0cf2c8cdf420622d2fe3c854e/ext/CliffordNumbersQuaternionsExt.jl#L36-L47">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="Quaternions.slerp-Tuple{AbstractCliffordNumber{VGA(3)}, AbstractCliffordNumber{VGA(3)}, Real}" href="#Quaternions.slerp-Tuple{AbstractCliffordNumber{VGA(3)}, AbstractCliffordNumber{VGA(3)}, Real}"><code>Quaternions.slerp</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">slerp(x::AbstractCliffordNumber{VGA(3)}, y::AbstractCliffordNumber{VGA(3)}, t::Real)
-&gt; EvenCliffordNumber{VGA(3)}</code></pre><p>Performs spherical linear interpolation for rotors in the 3D vanilla geometric algebra, treating them as if they were <code>Quaternion</code> instances.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/brainandforce/CliffordNumbers.jl/blob/31148edbfffc80e0cf2c8cdf420622d2fe3c854e/ext/CliffordNumbersQuaternionsExt.jl#L79-L85">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="Quaternions.slerp-Tuple{AbstractCliffordNumber{VGA(3)}, Quaternion, Real}" href="#Quaternions.slerp-Tuple{AbstractCliffordNumber{VGA(3)}, Quaternion, Real}"><code>Quaternions.slerp</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">slerp(x::Quaternion, y::AbstractCliffordNumber{VGA(3)}, t::Real) -&gt; EvenCliffordNumber{VGA(3)}
slerp(x::AbstractCliffordNumber{VGA(3)}, y::Quaternion, t::Real) -&gt; EvenCliffordNumber{VGA(3)}</code></pre><p>Performs spherical linear interpolation for rotors in the 3D vanilla geometric algebra, treating them as if they were <code>Quaternion</code> instances. The resulting output gains Clifford number semantics, so it is of type <code>EvenCliffordNumber{VGA(3)}</code> instead of <code>Quaternion</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/brainandforce/CliffordNumbers.jl/blob/31148edbfffc80e0cf2c8cdf420622d2fe3c854e/ext/CliffordNumbersQuaternionsExt.jl#L92-L99">source</a></section></article><p>[Quaternions.jl]: https://github.com/JuliaGeometry/Quaternions.jl</p></article><nav class="docs-footer"><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>
12 changes: 6 additions & 6 deletions dev/api/indexing.html

Large diffs are not rendered by default.

Loading

0 comments on commit 89ba8b5

Please sign in to comment.