Skip to content

Commit

Permalink
build based on 22bb1fe
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Aug 2, 2024
1 parent c8467f4 commit 3066f1d
Show file tree
Hide file tree
Showing 18 changed files with 948 additions and 449 deletions.
1 change: 1 addition & 0 deletions dev/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2024-08-02T15:09:48","documenter_version":"1.5.0"}}
7 changes: 7 additions & 0 deletions dev/api/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>API · ComplexValues.jl</title><meta name="title" content="API · ComplexValues.jl"/><meta property="og:title" content="API · ComplexValues.jl"/><meta property="twitter:title" content="API · ComplexValues.jl"/><meta name="description" content="Documentation for ComplexValues.jl."/><meta property="og:description" content="Documentation for ComplexValues.jl."/><meta property="twitter:description" content="Documentation for ComplexValues.jl."/><meta property="og:url" content="https://complexvariables.github.io/ComplexRegions.jl/api/"/><meta property="twitter:url" content="https://complexvariables.github.io/ComplexRegions.jl/api/"/><link rel="canonical" href="https://complexvariables.github.io/ComplexRegions.jl/api/"/><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="../">ComplexValues.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="../">Overview</a></li><li><a class="tocitem" href="../polar/">Polar</a></li><li><a class="tocitem" href="../spherical/">Spherical</a></li><li class="is-active"><a class="tocitem" href>API</a></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>API</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>API</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/complexvariables/ComplexValues.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/complexvariables/ComplexValues.jl/blob/master/docs/src/api.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="API"><a class="docs-heading-anchor" href="#API">API</a><a id="API-1"></a><a class="docs-heading-anchor-permalink" href="#API" title="Permalink"></a></h1><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="ComplexValues.Polar-Tuple{Number}" href="#ComplexValues.Polar-Tuple{Number}"><code>ComplexValues.Polar</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">Polar(z)</code></pre><p>Construct a polar representation of <code>z</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/complexvariables/ComplexValues.jl/blob/22bb1fec537be37ec096973b5c75f18f897a2708/src/polar.jl#L27-L30">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="ComplexValues.Polar-Tuple{Real, Real}" href="#ComplexValues.Polar-Tuple{Real, Real}"><code>ComplexValues.Polar</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">Polar(radius::Real, azimuth::Real)</code></pre><p>Construct a polar value with the given radius and angle.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/complexvariables/ComplexValues.jl/blob/22bb1fec537be37ec096973b5c75f18f897a2708/src/polar.jl#L18-L21">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="ComplexValues.Spherical-Tuple{Number}" href="#ComplexValues.Spherical-Tuple{Number}"><code>ComplexValues.Spherical</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">Spherical(z)</code></pre><p>Construct a spherical representation of the value <code>z</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/complexvariables/ComplexValues.jl/blob/22bb1fec537be37ec096973b5c75f18f897a2708/src/spherical.jl#L37-L40">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="ComplexValues.Spherical-Tuple{Real, Real}" href="#ComplexValues.Spherical-Tuple{Real, Real}"><code>ComplexValues.Spherical</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">Spherical(latitude, azimuth)</code></pre><p>Construct a spherical representation with given <code>latitude</code> in [-π/2,π/2] and <code>azimuth</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/complexvariables/ComplexValues.jl/blob/22bb1fec537be37ec096973b5c75f18f897a2708/src/spherical.jl#L28-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="ComplexValues.S2coord-Tuple{Spherical}" href="#ComplexValues.S2coord-Tuple{Spherical}"><code>ComplexValues.S2coord</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">S2coord(u::Spherical)</code></pre><p>Convert the spherical value to a 3-vector of coordinates on the unit sphere.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/complexvariables/ComplexValues.jl/blob/22bb1fec537be37ec096973b5c75f18f897a2708/src/spherical.jl#L58-L61">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="ComplexValues.real_type-Union{Tuple{Complex{T}}, Tuple{T}} where T" href="#ComplexValues.real_type-Union{Tuple{Complex{T}}, Tuple{T}} where T"><code>ComplexValues.real_type</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">real_type(z)</code></pre><p>Return the base type of a real or complex float <code>z</code>, i.e., the type of its real part.</p><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia&gt; real_type(1.0)
Float64
julia&gt; real_type(1.0f0 + 2im)
Float32
julia&gt; real_type(Polar(BigFloat(1), 2))
BigFloat</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/complexvariables/ComplexValues.jl/blob/22bb1fec537be37ec096973b5c75f18f897a2708/src/ComplexValues.jl#L24-L37">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../spherical/">« Spherical</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.5.0 on <span class="colophon-date" title="Friday 2 August 2024 15:09">Friday 2 August 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 3066f1d

Please sign in to comment.