math/index.html

<!DOCTYPE html> <html lang="en-US"> <head> <meta charset="UTF-8"> <meta http-equiv="X-UA-Compatible" content="IE=Edge"> <title>Math - sfall</title> <link rel="shortcut icon" href="/sfall/favicon.ico" type="image/x-icon"> <link rel="stylesheet" href="/sfall/assets/css/just-the-docs-default.css"> <script type="text/javascript" src="/sfall/assets/js/vendor/lunr.min.js"></script> <script type="text/javascript" src="/sfall/assets/js/just-the-docs.js"></script> <meta name="viewport" content="width=device-width, initial-scale=1"> <!-- Begin Jekyll SEO tag v2.8.0 --> <title>Math | sfall</title> <meta name="generator" content="Jekyll v3.9.0" /> <meta property="og:title" content="Math" /> <meta property="og:locale" content="en_US" /> <meta name="description" content="Sfall documentation" /> <meta property="og:description" content="Sfall documentation" /> <link rel="canonical" href="/sfall/math/" /> <meta property="og:url" content="/sfall/math/" /> <meta property="og:site_name" content="sfall" /> <meta property="og:type" content="website" /> <meta name="twitter:card" content="summary" /> <meta property="twitter:title" content="Math" /> <script type="application/ld+json"> {"@context":"https://schema.org","@type":"WebPage","description":"Sfall documentation","headline":"Math","url":"/sfall/math/"}</script> <!-- End Jekyll SEO tag --> <link rel="apple-touch-icon" sizes="180x180" href="/assets/favicon/apple-touch-icon.png"> <link rel="icon" type="image/png" sizes="32x32" href="/assets/favicon/favicon-32x32.png"> <link rel="icon" type="image/png" sizes="16x16" href="/assets/favicon/favicon-16x16.png"> <link rel="manifest" href="/assets/favicon/site.webmanifest"> <link rel="mask-icon" href="/assets/favicon/safari-pinned-tab.svg" color="#5bbad5"> <meta name="msapplication-TileColor" content="#da532c"> <meta name="msapplication-config" content="/assets/favicon/browserconfig.xml"> <meta name="theme-color" content="#ffffff"> </head> <body> <svg xmlns="http://www.w3.org/2000/svg" style="display: none;"> <symbol id="svg-link" viewBox="0 0 24 24"> <title>Link</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-link"> <path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path> </svg> </symbol> <symbol id="svg-search" viewBox="0 0 24 24"> <title>Search</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-search"> <circle cx="11" cy="11" r="8"></circle><line x1="21" y1="21" x2="16.65" y2="16.65"></line> </svg> </symbol> <symbol id="svg-menu" viewBox="0 0 24 24"> <title>Menu</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-menu"> <line x1="3" y1="12" x2="21" y2="12"></line><line x1="3" y1="6" x2="21" y2="6"></line><line x1="3" y1="18" x2="21" y2="18"></line> </svg> </symbol> <symbol id="svg-arrow-right" viewBox="0 0 24 24"> <title>Expand</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-chevron-right"> <polyline points="9 18 15 12 9 6"></polyline> </svg> </symbol> <symbol id="svg-doc" viewBox="0 0 24 24"> <title>Document</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-file"> <path d="M13 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V9z"></path><polyline points="13 2 13 9 20 9"></polyline> </svg> </symbol> </svg> <div class="side-bar"> <div class="site-hea
</code></pre></div></div> <p>Exponentiation. Use as any other arithmetic operator, like <code class="language-plaintext highlighter-rouge">5^(1/3)</code>. If exponent is an integer, you can use a negative base, otherwise you will get “NaN” with a negative base. If both arguments are integers, the result will be an integer.</p><hr /> <h3 id="abs"> <a href="#abs" class="anchor-heading" aria-labelledby="abs"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>abs</strong> </h3> <div class="language-c++ highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">int</span><span class="o">/</span><span class="kt">float</span> <span class="n">abs</span><span class="p">(</span><span class="kt">int</span><span class="o">/</span><span class="kt">float</span> <span class="n">x</span><span class="p">)</span>
</code></pre></div></div> <p>Absolute (positive) value of x.</p><hr /> <h3 id="arctan"> <a href="#arctan" class="anchor-heading" aria-labelledby="arctan"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>arctan</strong> </h3> <div class="language-c++ highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">float</span> <span class="n">arctan</span><span class="p">(</span><span class="kt">float</span> <span class="n">x</span><span class="p">,</span> <span class="kt">float</span> <span class="n">y</span><span class="p">)</span>
</code></pre></div></div> <p>Arctangent of x. Pass 1 as y (don’t ask…).</p><hr /> <h3 id="ceil"> <a href="#ceil" class="anchor-heading" aria-labelledby="ceil"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>ceil</strong> </h3> <div class="language-c++ highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">int</span> <span class="n">ceil</span><span class="p">(</span><span class="kt">float</span><span class="p">)</span>
</code></pre></div></div> <p>Round x to the nearest integer that is not less than x.</p><hr /> <h3 id="cos"> <a href="#cos" class="anchor-heading" aria-labelledby="cos"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>cos</strong> </h3> <div class="language-c++ highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">float</span> <span class="n">cos</span><span class="p">(</span><span class="kt">float</span> <span class="n">x</span><span class="p">)</span>
</code></pre></div></div> <p>Cosine of x</p><hr /> <h3 id="div"> <a href="#div" class="anchor-heading" aria-labelledby="div"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>div</strong> </h3> <div class="language-c++ highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">div</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">)</span>
</code></pre></div></div> <p>Unsigned integer division. Use as a division operator, like <code class="language-plaintext highlighter-rouge">3 + (20 div 5)</code>. If both dividend and divisor are integers, they will be treated as unsigned integers. If one of them is a float, div will perform the signed division just like vanilla division operator.</p><hr /> <h3 id="exponent"> <a href="#exponent" class="anchor-heading" aria-labelledby="exponent"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>exponent</strong> </h3> <div class="language-c++ highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">float</span> <span class="n">exponent</span><span class="p">(</span><span class="kt">float</span> <span class="n">x</span><span class="p">)</span>
</code></pre></div></div> <p>E^X</p><hr /> <h3 class="d-inline-block" id="floor2"> <a href="#floor2" class="anchor-heading" aria-labelledby="floor2"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>floor2</strong> </h3> <p class="label label-green">sfall.h</p> <div class="language-c++ highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">int</span> <span class="n">floor2</span><span class="p">(</span><span class="kt">int</span><span class="o">/</span><span class="kt">float</span> <span class="n">value</span><span class="p">)</span>
</code></pre></div></div> <p>Works just like vanilla floor function, but returns correct integers for negative values (vanilla floor function works exactly the same as <code class="language-plaintext highlighter-rouge">ceil</code> for negative values, much like <code class="language-plaintext highlighter-rouge">trunc</code> in C/C++).</p><hr /> <h3 id="log"> <a href="#log" class="anchor-heading" aria-labelledby="log"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>log</strong> </h3> <div class="language-c++ highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">float</span> <span class="n">log</span><span class="p">(</span><span class="kt">float</span> <span class="n">x</span><span class="p">)</span>
</code></pre></div></div> <p>Natural logarithm of x.</p><hr /> <h3 id="round"> <a href="#round" class="anchor-heading" aria-labelledby="round"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>round</strong> </h3> <div class="language-c++ highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">int</span> <span class="n">round</span><span class="p">(</span><span class="kt">float</span> <span class="n">x</span><span class="p">)</span>
</code></pre></div></div> <p>Round x to the nearest integer.</p><hr /> <h3 id="sin"> <a href="#sin" class="anchor-heading" aria-labelledby="sin"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>sin</strong> </h3> <div class="language-c++ highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">float</span> <span class="n">sin</span><span class="p">(</span><span class="kt">float</span> <span class="n">x</span><span class="p">)</span>
</code></pre></div></div> <p>Sine of x</p><hr /> <h3 id="sqrt"> <a href="#sqrt" class="anchor-heading" aria-labelledby="sqrt"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>sqrt</strong> </h3> <div class="language-c++ highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">float</span> <span class="n">sqrt</span><span class="p">(</span><span class="kt">float</span> <span class="n">x</span><span class="p">)</span>
</code></pre></div></div> <p>Square root of x.</p><hr /> <h3 id="tan"> <a href="#tan" class="anchor-heading" aria-labelledby="tan"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>tan</strong> </h3> <div class="language-c++ highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">float</span> <span class="n">tan</span><span class="p">(</span><span class="kt">float</span> <span class="n">x</span><span class="p">)</span>
</code></pre></div></div> <p>Tangent of x</p> </div> </div> <div class="search-overlay"></div> </div> </body> </html>