Skip to content

Commit

Permalink
build based on 1924622
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Nov 29, 2023
1 parent 1e60592 commit ec5b48a
Show file tree
Hide file tree
Showing 9 changed files with 16 additions and 16 deletions.
2 changes: 1 addition & 1 deletion dev/guide/base/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@
10.519999999999992°</code></pre><p>The functions with a <code>*d</code> version and <code>deg2rad</code> only accept angles in degrees and functions with a <code>*pi</code> version only accept angles in half turns. Similarly, <code>rad2deg</code> only accepts angles in radians. The functions <code>exp</code> and <code>expm1</code> only accept imaginary angles, that is <code>1im*θ</code> for some angle <code>θ</code>.</p><p>Additionally, several inverse functions in base are extended to return quantities with dimensionful angles when requested. This is requested by providing a unit as the first argument. For instance</p><pre><code class="language-jldocs hljs">julia&gt; using DimensionfulAngles

julia&gt; acos(ua&quot;°&quot;, 0.9831912354632536)
10.52000000000001°</code></pre><p>The functions in <code>Base</code> that are currently extended to accept units as their first argument and return values with those units are:</p><ul><li>inverse trigonometric: <code>asin</code>, <code>acos</code>, <code>atan</code>, <code>acot</code>, <code>asec</code>, <code>acsc</code>, <code>asind</code>, <code>acosd</code>, <code>acotd</code>, <code>asecd</code>, <code>acscd</code>, <code>atan(x, y)</code></li><li>inverse hyperbolic: <code>asinh</code>, <code>acosh</code>, <code>atanh</code>, <code>acoth</code>, <code>asech</code>, <code>acsch</code></li><li>logarithmic: <code>log</code>, <code>log1p</code></li><li>phase angle of a complex number: <code>angle</code></li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../derived/">« Derived dimensions</a><a class="docs-footer-nextpage" href="../../proposed/">Relationship to proposed SI extensions. »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Sunday 16 July 2023 18:28">Sunday 16 July 2023</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
10.52000000000001°</code></pre><p>The functions in <code>Base</code> that are currently extended to accept units as their first argument and return values with those units are:</p><ul><li>inverse trigonometric: <code>asin</code>, <code>acos</code>, <code>atan</code>, <code>acot</code>, <code>asec</code>, <code>acsc</code>, <code>asind</code>, <code>acosd</code>, <code>acotd</code>, <code>asecd</code>, <code>acscd</code>, <code>atan(x, y)</code></li><li>inverse hyperbolic: <code>asinh</code>, <code>acosh</code>, <code>atanh</code>, <code>acoth</code>, <code>asech</code>, <code>acsch</code></li><li>logarithmic: <code>log</code>, <code>log1p</code></li><li>phase angle of a complex number: <code>angle</code></li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../derived/">« Derived dimensions</a><a class="docs-footer-nextpage" href="../../proposed/">Relationship to proposed SI extensions. »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 29 November 2023 23:14">Wednesday 29 November 2023</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
4 changes: 2 additions & 2 deletions dev/guide/derived/index.html

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions dev/guide/intro/index.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions dev/guide/units/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/motivation/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,4 @@
&quot;I am an angle?&quot;

julia&gt; what_am_i(percent)
&quot;I am an angle?&quot;</code></pre><h2 id="Takeaways"><a class="docs-heading-anchor" href="#Takeaways">Takeaways</a><a id="Takeaways-1"></a><a class="docs-heading-anchor-permalink" href="#Takeaways" title="Permalink"></a></h2><p>The main takeaway is that</p><blockquote><p>While the choice to use the SI dimensions in Unitful is the right one, for use cases that deal extensively with a dimensionless quantity, it can be extremely useful to extend the base dimensions to include that quantity. This package extends it to use <em>angles</em> as a dimension.</p></blockquote><p>There will always be quantities which are dimensionless and have units of <code>1</code> as well as distinct quantities with the same dimensions. There is no &quot;complete&quot; system and this package is simply an extension to facilitate working with angles specifically. And while this resolves some confusion between, for example frequency and angular frequency (which have the same dimension in SI), there are still different quantities with the same dimension of angle, namely plane angles and phase angles.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../guide/intro/">Basic usage »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Sunday 16 July 2023 18:28">Sunday 16 July 2023</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
&quot;I am an angle?&quot;</code></pre><h2 id="Takeaways"><a class="docs-heading-anchor" href="#Takeaways">Takeaways</a><a id="Takeaways-1"></a><a class="docs-heading-anchor-permalink" href="#Takeaways" title="Permalink"></a></h2><p>The main takeaway is that</p><blockquote><p>While the choice to use the SI dimensions in Unitful is the right one, for use cases that deal extensively with a dimensionless quantity, it can be extremely useful to extend the base dimensions to include that quantity. This package extends it to use <em>angles</em> as a dimension.</p></blockquote><p>There will always be quantities which are dimensionless and have units of <code>1</code> as well as distinct quantities with the same dimensions. There is no &quot;complete&quot; system and this package is simply an extension to facilitate working with angles specifically. And while this resolves some confusion between, for example frequency and angular frequency (which have the same dimension in SI), there are still different quantities with the same dimension of angle, namely plane angles and phase angles.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../guide/intro/">Basic usage »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 29 November 2023 23:14">Wednesday 29 November 2023</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/proposed/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@
<div id="Leonard_2021">B P Leonard, <a href='https://doi.org/10.1088/1681-7575/abe0fc'>Proposal for the dimensionally consistent treatment of angle and
solid angle by the International System of Units (SI)</a>, Metrologia, 58(5), 052001, 2021.</div>
</dd>
</dl></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../guide/base/">« Extension of <code>Base</code> functions</a><a class="docs-footer-nextpage" href="../syntax/">Index »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Sunday 16 July 2023 18:28">Sunday 16 July 2023</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
</dl></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../guide/base/">« Extension of <code>Base</code> functions</a><a class="docs-footer-nextpage" href="../syntax/">Index »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 29 November 2023 23:14">Wednesday 29 November 2023</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit ec5b48a

Please sign in to comment.