Rivoreo Source Code Repositories
src.rivoreo.one / net / facil.io / 0.7.0.beta6 / . / docs / 0.7.x / fiobj_numbers.html
blob: a406deb8a55bbbcab71d5e2f1edd41015757f4d7 [file] [log] [blame] [raw]
<!DOCTYPE html><html><head><meta charset="utf-8" /><meta content="IE=edge" http-equiv="X-UA-Compatible" /><meta content="width=device-width, initial-scale=1, maximum-scale=2.0, user-scalable=yes, minimal-ui=yes" name="viewport" /><title>facil.io - FIOBJ Numbers API</title><meta content="facil.io - FIOBJ Numbers API" name="description" /><link href="https://fonts.googleapis.com/css?family=Montserrat|Quicksand|Karla" rel="stylesheet" type="text/css" /><script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.4/jquery.min.js"></script><link href="/assets/styles/main.css" rel="stylesheet" type="text/css" /><script type="application/ld+json">{"@context":"http://schema.org","@type":"WebSite","url":"http://facil.io","name":"facil.io","description":"facil.io - a light web application framework in C, with support for HTTP, WebSockets and Pub/Sub out of the box.","keywords":"C, web, framework, websockets, websocket, realtime, real-time, easy","image":"http://facil.io/website/logo/facil-io.svg","author":[{"@type":"Person","name":"Bo (Myst)","url":"http://stackoverflow.com/users/4025095/myst","email":"bo(at)facil.io"}],"sourceOrganization":{"@context":"http://schema.org","@type":"Organization","name":"Plezi","url":"http://facil.io","description":"facil.io - a light web application framework in C, with support for HTTP, WebSockets and Pub/Sub out of the box.","logo":"http://facil.io/website/logo/facil-io.svg","image":"http://facil.io/website/logo/facil-io.svg","email":"bo(at)facil.io","member":[{"@type":"Person","name":"Bo (Myst)","url":"http://stackoverflow.com/users/4025095/myst","email":"bo(at)facil.io"}]}}</script><meta content="facil.io" name="apple-mobile-web-app-title" /><meta content="facil.io - the C Web Application Framework" name="application-name" /><meta content="#b91d47" name="msapplication-TileColor" /><meta content="/mstile-144x144.png" name="msapplication-TileImage" /><meta content="#ffffff" name="theme-color" /></head><body><a href="/" id="logo"></a><input id="show_nav" type="checkbox" /><nav id="top_nav"><ul><li><a href="/0.7.x/index">Latest Docs</a></li><li><a href="https://github.com/boazsegev/facil.io" target="_blank">Source Code</a></li><li><a href="javascript: change_themes();" id="theme">Night Theme</a></li></ul></nav><input id="show_sidebar" type="checkbox" /><nav id="side_bar"><h2 id="version-0-7-x"><a href="/0.7.x/index">Version 0.7.x</a></h2>
<h3 id="core-library"><a href="/0.7.x/fio">Core Library</a></h3>
<ul>
<li><a href="/0.7.x/fio#connection-protocol-management">Protocol Management</a></li>
<li><a href="/0.7.x/fio#running-facil-io">Running the IO reactor</a></li>
<li><a href="/0.7.x/fio#socket-connection-functions">Connection Functions</a></li>
<li><a href="/0.7.x/fio#event-task-scheduling">Event / Task Scheduling</a></li>
<li><a href="/0.7.x/fio#pub-sub-services">Pub/Sub Services</a></li>
<li><a href="/0.7.x/fio#the-custom-memory-allocator">Memory Allocation</a></li>
<li><a href="/0.7.x/fio#general-helpers">General Helpers</a></li>
<li><a href="/0.7.x/fio#linked-lists">Linked Lists</a></li>
<li><a href="/0.7.x/fio#string-helpers">String Helpers</a></li>
<li><a href="/0.7.x/fio#dynamic-arrays">Dynamic Arrays</a></li>
<li><a href="/0.7.x/fio#hash-maps-sets">Hash Maps / Sets</a></li>
<li><a href="/0.7.x/fio#version-and-compilation-related-macros">Compilation Macros</a></li>
<li><a href="/0.7.x/fio#weak-functions">Weak Functions</a></li>
</ul>
<h3 id="extensions"><a href="/0.7.x/extensions">Extensions</a></h3>
<!-- * [TLS (SSL)](/0.7.x/fio_tls) -->
<ul>
<li><a href="/0.7.x/http">HTTP / WebSockets</a></li>
<li><a href="/0.7.x/redis">Redis (client)</a></li>
<li><a href="/0.7.x/fio_cli">CLI (command line)</a></li>
</ul>
<h3 id="the-fiobj-types"><a href="/0.7.x/fiobj">The FIOBJ types</a></h3>
<ul>
<li><a href="/0.7.x/fiobj_core">Core Functions</a></li>
<li><a href="/0.7.x/fiobj_primitives">Primitives</a></li>
<li><a href="/0.7.x/fiobj_numbers">Numbers</a></li>
<li><a href="/0.7.x/fiobj_str">Strings</a></li>
<li><a href="/0.7.x/fiobj_ary">Array</a></li>
<li><a href="/0.7.x/fiobj_hash">HashMap</a></li>
<li><a href="/0.7.x/fiobj_data">Data Streams</a></li>
<li><a href="/0.7.x/fiobj_json">JSON</a></li>
<li><a href="/0.7.x/fiobj_mustache">Mustache</a></li>
</ul>
</nav><div id="md_container"><div class='toc'><ul>
<li>
<a href="#facil-io-fiobj-numbers-api">facil.io - FIOBJ Numbers API</a>
<ul>
<li>
<ul>
<li>
<a href="#numbers-api-integers">Numbers API (Integers)</a>
<ul>
<li>
<a href="#fiobj_num_new"><code>fiobj_num_new</code></a>
</li>
<li>
<a href="#fiobj_num_tmp"><code>fiobj_num_tmp</code></a>
</li>
</ul>
</li>
<li>
<a href="#float-api-double">Float API (Double)</a>
<ul>
<li>
<a href="#fiobj_float_new"><code>fiobj_float_new</code></a>
</li>
<li>
<a href="#fiobj_float_set"><code>fiobj_float_set</code></a>
</li>
<li>
<a href="#fiobj_float_tmp"><code>fiobj_float_tmp</code></a>
</li>
</ul>
</li>
<li>
<a href="#numerical-helpers-not-fiobj-specific-but-included-as-part-of-the-library">Numerical Helpers: not FIOBJ specific, but included as part of the library</a>
<ul>
<li>
<a href="#fio_atol"><code>fio_atol</code></a>
</li>
<li>
<a href="#fio_atof"><code>fio_atof</code></a>
</li>
<li>
<a href="#fio_ltoa"><code>fio_ltoa</code></a>
</li>
<li>
<a href="#fio_ftoa"><code>fio_ftoa</code></a>
</li>
<li>
<a href="#fio_ltocstr"><code>fio_ltocstr</code></a>
</li>
<li>
<a href="#fio_ftocstr"><code>fio_ftocstr</code></a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div><h1 id="facil-io-fiobj-numbers-api">facil.io - FIOBJ Numbers API</h1>
<h3 id="numbers-api-integers">Numbers API (Integers)</h3>
<h4 id="fiobj_num_new"><code>fiobj_num_new</code></h4>
<pre><code class='highlight'><span class="n">FIOBJ</span> <span class="n">fiobj_num_new</span><span class="p">(</span><span class="kt">intptr_t</span> <span class="n">num</span><span class="p">);</span>
</code></pre>
<p>Creates a Number object. Remember to use <code>fiobj_free</code>.</p>
<h4 id="fiobj_num_tmp"><code>fiobj_num_tmp</code></h4>
<pre><code class='highlight'><span class="n">FIOBJ</span> <span class="n">fiobj_num_tmp</span><span class="p">(</span><span class="kt">intptr_t</span> <span class="n">num</span><span class="p">);</span>
</code></pre>
<p>Creates a temporary Number object. Avoid using <code>fiobj_free</code>.</p>
<h3 id="float-api-double">Float API (Double)</h3>
<h4 id="fiobj_float_new"><code>fiobj_float_new</code></h4>
<pre><code class='highlight'><span class="n">FIOBJ</span> <span class="n">fiobj_float_new</span><span class="p">(</span><span class="kt">double</span> <span class="n">num</span><span class="p">);</span>
</code></pre>
<p>Creates a Float object. Remember to use <code>fiobj_free</code>. </p>
<h4 id="fiobj_float_set"><code>fiobj_float_set</code></h4>
<pre><code class='highlight'><span class="kt">void</span> <span class="n">fiobj_float_set</span><span class="p">(</span><span class="n">FIOBJ</span> <span class="n">obj</span><span class="p">,</span> <span class="kt">double</span> <span class="n">num</span><span class="p">);</span>
</code></pre>
<p>Mutates a Float object&#39;s value. Effects every object&#39;s reference! </p>
<h4 id="fiobj_float_tmp"><code>fiobj_float_tmp</code></h4>
<pre><code class='highlight'><span class="n">FIOBJ</span> <span class="n">fiobj_float_tmp</span><span class="p">(</span><span class="kt">double</span> <span class="n">num</span><span class="p">);</span>
</code></pre>
<p>Creates a temporary Float object. Avoid using <code>fiobj_free</code>.</p>
<h3 id="numerical-helpers-not-fiobj-specific-but-included-as-part-of-the-library">Numerical Helpers: not FIOBJ specific, but included as part of the library</h3>
<h4 id="fio_atol"><code>fio_atol</code></h4>
<pre><code class='highlight'><span class="kt">int64_t</span> <span class="n">fio_atol</span><span class="p">(</span><span class="kt">char</span> <span class="o">**</span><span class="n">pstr</span><span class="p">);</span>
</code></pre>
<p>A helper function that converts between String data to a signed int64_t.</p>
<p>Numbers are assumed to be in base 10.</p>
<p>The <code>0x##</code> (or <code>x##</code>) and <code>0b##</code> (or <code>b##</code>) are recognized as base 16 and
base 2 (binary MSB first) respectively.</p>
<p>The pointer will be updated to point to the first byte after the number.</p>
<h4 id="fio_atof"><code>fio_atof</code></h4>
<pre><code class='highlight'><span class="kt">double</span> <span class="n">fio_atof</span><span class="p">(</span><span class="kt">char</span> <span class="o">**</span><span class="n">pstr</span><span class="p">);</span>
</code></pre>
<p>A helper function that converts between String data to a signed double.</p>
<h4 id="fio_ltoa"><code>fio_ltoa</code></h4>
<pre><code class='highlight'><span class="kt">size_t</span> <span class="n">fio_ltoa</span><span class="p">(</span><span class="kt">char</span> <span class="o">*</span><span class="n">dest</span><span class="p">,</span> <span class="kt">int64_t</span> <span class="n">num</span><span class="p">,</span> <span class="kt">uint8_t</span> <span class="n">base</span><span class="p">);</span>
</code></pre>
<p>A helper function that converts between a signed int64_t to a string.</p>
<p>No overflow guard is provided, make sure there&#39;s at least 66 bytes available
(for base 2).</p>
<p>Supports base 2, base 10 and base 16. An unsupported base will silently
default to base 10. Prefixes aren&#39;t added (i.e., no &quot;0x&quot; or &quot;0b&quot; at the
beginning of the string).</p>
<p>Returns the number of bytes actually written (excluding the NUL terminator).</p>
<h4 id="fio_ftoa"><code>fio_ftoa</code></h4>
<pre><code class='highlight'><span class="kt">size_t</span> <span class="n">fio_ftoa</span><span class="p">(</span><span class="kt">char</span> <span class="o">*</span><span class="n">dest</span><span class="p">,</span> <span class="kt">double</span> <span class="n">num</span><span class="p">,</span> <span class="kt">uint8_t</span> <span class="n">base</span><span class="p">);</span>
</code></pre>
<p>A helper function that converts between a double to a string.</p>
<p>No overflow guard is provided, make sure there&#39;s at least 130 bytes available
(for base 2).</p>
<p>Supports base 2, base 10 and base 16. An unsupported base will silently
default to base 10. Prefixes aren&#39;t added (i.e., no &quot;0x&quot; or &quot;0b&quot; at the
beginning of the string).</p>
<p>Returns the number of bytes actually written (excluding the NUL terminator).</p>
<h4 id="fio_ltocstr"><code>fio_ltocstr</code></h4>
<pre><code class='highlight'><span class="n">fio_str_info_s</span> <span class="n">fio_ltocstr</span><span class="p">(</span><span class="kt">long</span><span class="p">);</span>
</code></pre>
<p>Converts a number to a temporary, thread local, C string object</p>
<p>The <code>fio_str_s</code> object is only valid until the function is called again within the same thread or the thread terminates.</p>
<h4 id="fio_ftocstr"><code>fio_ftocstr</code></h4>
<pre><code class='highlight'><span class="n">fio_str_info_s</span> <span class="n">fio_ftocstr</span><span class="p">(</span><span class="kt">double</span><span class="p">);</span>
</code></pre>
<p>Converts a float to a temporary, thread local, C string object</p>
<p>The <code>fio_str_s</code> object is only valid until the function is called again within the same thread or the thread terminates.</p>
</div><a href="/" id="sign"></a><div class="hidden" id="notice"><a class="notice_close" onclick="hide_notice()">X</a><div id="notice_text"></div></div><script>function change_themes() {
if(localStorage.getItem("theme") == 'dark') {
localStorage.setItem("theme", "light");
} else {
localStorage.setItem("theme", "dark");
}
$('body')[0].className = localStorage.getItem("theme");
set_theme_link();
$('#show_nav').attr('checked', false);
return false;
};
function sidebar_name() { return window.location.pathname.slice(0, window.location.pathname.lastIndexOf("/")); }
function on_sidebar_link(e) {
sessionStorage.setItem("sidebar.expect", sidebar_name());
sessionStorage.setItem("sidebar.pos", document.getElementById("side_bar").scrollTop);
}
function load_sidebar_pos() {
var e = document.getElementById("side_bar");
if(!e) {
console.warn("No sidebar detected");
return;
}
var expect = sidebar_name();
if(sessionStorage.getItem("sidebar.expect") == expect) {
e.scrollTo(0, parseInt(sessionStorage.getItem("sidebar.pos")));
} else {
sessionStorage.setItem("sidebar.expect", false);
sessionStorage.setItem("sidebar.pos", 0);
}
if(e) {
// add link callbacks
var links = document.links;
var count = links.length;
for (var i = 0; i < count; i++) {
var href = links[i].href;
if(href.startsWith(document.location.origin)) {
href = href.slice(document.location.origin.length);
}
if(href.startsWith(expect)) {
/* add link event */
links[i].addEventListener("click", on_sidebar_link);
}
}
}
};
load_sidebar_pos();
function set_theme_link() {
$("#theme").html( ( (localStorage.getItem("theme") == 'dark') ? "Day" : "Night") + " Theme" );
}
$('body')[0].className = (localStorage.getItem("theme") == 'dark') ? "dark" : "light";
set_theme_link();
function show_notice() { document.getElementById("notice").classList.remove('hidden'); };
function hide_notice() { document.getElementById("notice").classList.add('hidden'); };
$('#toc').on("touchstart", function (e) { return true; } );
$('#toc').on("hover", function (e) { return true; } );
// hljs.initHighlighting();
// Google Analytics
// if(location.hostname != "localhost") {
// (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
// (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
// m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
// })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
// ga('create', 'UA-69931401-1', 'auto');
// ga('send', 'pageview');
// }</script></body></html>