mirror/ascode
1
1
Fork 0
mirror of https://github.com/mcuadros/ascode synced 2025-11-16 05:17:13 +01:00
Code Issues
gh-pages
ascode/docs/reference/math/index.html

25 lines
11 KiB
HTML
Raw Permalink Blame History

<!doctype html><html lang=en><head><meta charset=utf-8><meta http-equiv=x-ua-compatible content="ie=edge"><title>math - AsCode - Terraform Alternative Syntax</title><meta name=viewport content="width=device-width,initial-scale=1"><link rel=icon href=https://ascode.run/images/favicon.png><link rel=stylesheet href=/css/style.min.df49831c6872564dff31a5f0978a9571f2c8110b513d4b3b1fc8ead41dcdc9f0.css></head><body class="page page-default-single"><div id=main-menu-mobile class=main-menu-mobile><ul><li class=menu-item-home><a href=/><span>Home</span></a></li><li class=menu-item-docs><a href=/docs/><span>Docs</span></a></li><li class=menu-item-github><a href=https://github.com/mcuadros/ascode><span>GitHub</span></a></li></ul></div><div class=wrapper><div class=header><div class=container><div class=logo><a href=https://ascode.run><img alt=Logo src=/images/logo-header.svg></a></div><div class=logo-mobile><a href=https://ascode.run><img alt=Logo src=/images/logo-header.svg></a></div><div id=main-menu class=main-menu><ul><li class=menu-item-home><a href=/><span>Home</span></a></li><li class=menu-item-docs><a href=/docs/><span>Docs</span></a></li><li class=menu-item-github><a href=https://github.com/mcuadros/ascode><span>GitHub</span></a></li></ul></div><button id=toggle-main-menu-mobile class="hamburger hamburger--slider" type=button>
<span class=hamburger-box><span class=hamburger-inner></span></span></button></div></div><div class="main container pt-2 pt-md-6 pb-3 pb-md-6"><div class=row><div class="col-12 col-md-3 mb-3"><div class=sidebar><div class=docs-menu><h4><a href=/docs/reference/>API Reference</a></h4><ul><li><a href=/docs/reference/types/>built-in</a></li><li><a href=/docs/reference/docker/>docker</a></li><li><a href=/docs/reference/base64/>encoding/base64</a></li><li><a href=/docs/reference/csv/>encoding/csv</a></li><li><a href=/docs/reference/json/>encoding/json</a></li><li><a href=/docs/reference/yaml/>encoding/yaml</a></li><li><a href=/docs/reference/http/>http</a></li><li><a class=active href=/docs/reference/math/>math</a></li><li><a href=/docs/reference/os/>os</a></li><li><a href=/docs/reference/filepath/>path/filepath</a></li><li><a href=/docs/reference/re/>re</a></li><li><a href=/docs/reference/time/>time</a></li><li><a href=/docs/reference/url/>url</a></li></ul></div><div style=font-size:90%;margin-top:40px><a href=/docs/>« Documentation</a></div></div></div><div class="col-12 col-md-9"><h1 class=title>math</h1><div class=content><h2 id=index>Index</h2><div class=toc><nav id=TableOfContents><ul><li><a href=#overview>Overview</a></li><li><a href=#functions>Functions</a><ul><li><a href=#def-bacosb>def <b>acos</b></a></li><li><a href=#def-bacoshb>def <b>acosh</b></a></li><li><a href=#def-basinb>def <b>asin</b></a></li><li><a href=#def-basinhb>def <b>asinh</b></a></li><li><a href=#def-batanb>def <b>atan</b></a></li><li><a href=#def-batan2b>def <b>atan2</b></a></li><li><a href=#def-batanhb>def <b>atanh</b></a></li><li><a href=#def-bceilb>def <b>ceil</b></a></li><li><a href=#def-bcosb>def <b>cos</b></a></li><li><a href=#def-bcoshb>def <b>cosh</b></a></li><li><a href=#def-bdegreesb>def <b>degrees</b></a></li><li><a href=#def-bexpb>def <b>exp</b></a></li><li><a href=#def-bfabsb>def <b>fabs</b></a></li><li><a href=#def-bfloorb>def <b>floor</b></a></li><li><a href=#def-bhypotb>def <b>hypot</b></a></li><li><a href=#def-bradiansb>def <b>radians</b></a></li><li><a href=#def-broundb>def <b>round</b></a></li><li><a href=#def-bsinb>def <b>sin</b></a></li><li><a href=#def-bsinhb>def <b>sinh</b></a></li><li><a href=#def-bsqrtb>def <b>sqrt</b></a></li><li><a href=#def-btanb>def <b>tan</b></a></li><li><a href=#def-btanhb>def <b>tanh</b></a></li></ul></li></ul></nav></div><h2 id=overview>Overview</h2><p>math defines mathematical functions, it&rsquo;s intended to be a drop-in
subset of python&rsquo;s math module for starlark: <a href=https://docs.python.org/3/library/math.html>https://docs.python.org/3/library/math.html</a></p><h2 id=functions>Functions</h2><h3 id=def-bacosb>def <b>acos</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nf>acos</span><span class=p>(</span><span class=nx>x</span><span class=p>)</span>
</code></pre></div><p>Return the arc cosine of x, in radians.</p><h3 id=def-bacoshb>def <b>acosh</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nf>acosh</span><span class=p>(</span><span class=nx>x</span><span class=p>)</span>
</code></pre></div><p>Return the inverse hyperbolic cosine of x.</p><h3 id=def-basinb>def <b>asin</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nf>asin</span><span class=p>(</span><span class=nx>x</span><span class=p>)</span>
</code></pre></div><p>Return the arc sine of x, in radians.</p><h3 id=def-basinhb>def <b>asinh</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nf>asinh</span><span class=p>(</span><span class=nx>x</span><span class=p>)</span>
</code></pre></div><p>Return the inverse hyperbolic sine of x.</p><h3 id=def-batanb>def <b>atan</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nf>atan</span><span class=p>(</span><span class=nx>x</span><span class=p>)</span>
</code></pre></div><p>Return the arc tangent of x, in radians.</p><h3 id=def-batan2b>def <b>atan2</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nf>atan2</span><span class=p>(</span><span class=nx>y</span><span class=p>,</span> <span class=nx>x</span><span class=p>)</span>
</code></pre></div><p>Return atan(y / x), in radians. The result is between -pi and pi. The vector in the plane from the origin to point (x, y) makes this angle with the positive X axis. The point of atan2() is that the signs of both inputs are known to it, so it can compute the correct quadrant for the angle. For example, atan(1) and atan2(1, 1) are both pi/4, but atan2(-1, -1) is -3*pi/4.</p><h3 id=def-batanhb>def <b>atanh</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nf>atanh</span><span class=p>(</span><span class=nx>x</span><span class=p>)</span>
</code></pre></div><p>Return the inverse hyperbolic tangent of x.</p><h3 id=def-bceilb>def <b>ceil</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nf>ceil</span><span class=p>(</span><span class=nx>x</span><span class=p>)</span>
</code></pre></div><p>Return the ceiling of x, the smallest integer greater than or equal to x.</p><h3 id=def-bcosb>def <b>cos</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nf>cos</span><span class=p>(</span><span class=nx>x</span><span class=p>)</span>
</code></pre></div><p>Return the cosine of x radians.</p><h3 id=def-bcoshb>def <b>cosh</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nf>cosh</span><span class=p>(</span><span class=nx>x</span><span class=p>)</span>
</code></pre></div><p>Return the hyperbolic cosine of x.</p><h3 id=def-bdegreesb>def <b>degrees</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nf>degrees</span><span class=p>(</span><span class=nx>x</span><span class=p>)</span>
</code></pre></div><p>Convert angle x from radians to degrees.</p><h3 id=def-bexpb>def <b>exp</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nf>exp</span><span class=p>(</span><span class=nx>x</span><span class=p>)</span>
</code></pre></div><p>Return e raised to the power x, where e = 2.718281… is the base of natural logarithms</p><h3 id=def-bfabsb>def <b>fabs</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nf>fabs</span><span class=p>(</span><span class=nx>x</span><span class=p>)</span>
</code></pre></div><p>Return the absolute value of x.</p><h3 id=def-bfloorb>def <b>floor</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nf>floor</span><span class=p>(</span><span class=nx>x</span><span class=p>)</span>
</code></pre></div><p>Return the floor of x, the largest integer less than or equal to x.</p><h3 id=def-bhypotb>def <b>hypot</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nf>hypot</span><span class=p>(</span><span class=nx>x</span><span class=p>,</span> <span class=nx>y</span><span class=p>)</span>
</code></pre></div><p>Return the Euclidean norm, sqrt(x<em>x + y</em>y). This is the length of the vector from the origin to point (x, y).</p><h3 id=def-bradiansb>def <b>radians</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nf>radians</span><span class=p>(</span><span class=nx>x</span><span class=p>)</span>
</code></pre></div><p>Convert angle x from degrees to radians.</p><h3 id=def-broundb>def <b>round</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nf>round</span><span class=p>(</span><span class=nx>x</span><span class=p>)</span>
</code></pre></div><p>Returns the nearest integer, rounding half away from zero.</p><h3 id=def-bsinb>def <b>sin</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nf>sin</span><span class=p>(</span><span class=nx>x</span><span class=p>)</span>
</code></pre></div><p>Return the sine of x radians.</p><h3 id=def-bsinhb>def <b>sinh</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nf>sinh</span><span class=p>(</span><span class=nx>x</span><span class=p>)</span>
</code></pre></div><p>Return the hyperbolic sine of x.</p><h3 id=def-bsqrtb>def <b>sqrt</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nf>sqrt</span><span class=p>(</span><span class=nx>x</span><span class=p>)</span>
</code></pre></div><p>Return the square root of x.</p><h3 id=def-btanb>def <b>tan</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nf>tan</span><span class=p>(</span><span class=nx>x</span><span class=p>)</span>
</code></pre></div><p>Return the tangent of x radians.</p><h3 id=def-btanhb>def <b>tanh</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nf>tanh</span><span class=p>(</span><span class=nx>x</span><span class=p>)</span>
</code></pre></div><p>Return the hyperbolic tangent of x.</p></div></div></div></div></div></div><div class=sub-footer><div class=container><div class=row><div class=col-12><div class=sub-footer-inner><ul><li><a href=https://github.com/mcuadros/ascod>Documentation version v1.3.0</a></li><li>Template by <a href=https://www.zerostatic.io>Robert Austin</a></li></ul></div></div></div></div><script type=text/javascript src=/js/scripts.min.be6fe1294698d6acd837c5182149cd1a24daae9fa1903ce810c264539d254d62.js></script></body></html>
View Git Blame Copy Permalink