mentat/ryu/index.html
2018-08-22 17:04:13 +00:00

176 lines
No EOL
7.9 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="rustdoc">
<meta name="description" content="API documentation for the Rust `ryu` crate.">
<meta name="keywords" content="rust, rustlang, rust-lang, ryu">
<title>ryu - Rust</title>
<link rel="stylesheet" type="text/css" href="../normalize.css">
<link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle">
<link rel="stylesheet" type="text/css" href="../dark.css">
<link rel="stylesheet" type="text/css" href="../main.css" id="themeStyle">
<script src="../storage.js"></script>
</head>
<body class="rustdoc mod">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<div class="sidebar-menu">&#9776;</div>
<p class='location'>Crate ryu</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'ryu', ty: 'mod', relpath: '../'};</script></div>
</nav>
<div class="theme-picker">
<button id="theme-picker" aria-label="Pick another theme!">
<img src="../brush.svg" width="18" alt="Pick another theme!">
</button>
<div id="theme-choices"></div>
</div>
<script src="../theme.js"></script>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press S to search, ? for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Crate <a class="mod" href=''>ryu</a></span><span class='out-of-band'><span id='render-detail'>
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
[<span class='inner'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../src/ryu/lib.rs.html#1-68' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>Pure Rust implementation of Ryū, an algorithm to quickly convert floating
point numbers to decimal strings.</p>
<p>The PLDI'18 paper <a href="https://dl.acm.org/citation.cfm?id=3192369"><em>Ryū: fast float-to-string conversion</em></a> by Ulf
Adams includes a complete correctness proof of the algorithm. The paper is
available under the creative commons CC-BY-SA license.</p>
<p>This Rust implementation is a line-by-line port of Ulf Adams' implementation
in C, <a href="https://github.com/ulfjack/ryu">https://github.com/ulfjack/ryu</a>. The <a href="raw/index.html"><code>ryu::raw</code></a>
module exposes exactly the API and formatting of the C implementation as
unsafe pure Rust functions. There is additionally a safe API as demonstrated
in the example code below. The safe API uses the same underlying Ryū
algorithm but diverges from the formatting of the C implementation to
produce more human-readable output, for example <code>0.3</code> rather than <code>3E-1</code>.</p>
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">ryu</span>;
<span class="kw">fn</span> <span class="ident">main</span>() {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buffer</span> <span class="op">=</span> <span class="ident">ryu</span>::<span class="ident">Buffer</span>::<span class="ident">new</span>();
<span class="kw">let</span> <span class="ident">printed</span> <span class="op">=</span> <span class="ident">buffer</span>.<span class="ident">format</span>(<span class="number">1.234</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">printed</span>, <span class="string">&quot;1.234&quot;</span>);
}</pre>
</div><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
<table>
<tr class=' module-item'>
<td><a class="mod" href="raw/index.html"
title='mod ryu::raw'>raw</a></td>
<td class='docblock-short'>
<p>Unsafe functions that exactly mirror the API of the C implementation of Ryū.</p>
</td>
</tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
<tr class=' module-item'>
<td><a class="struct" href="struct.Buffer.html"
title='struct ryu::Buffer'>Buffer</a></td>
<td class='docblock-short'>
<p>Safe API for formatting floating point numbers to text.</p>
</td>
</tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
<table>
<tr class=' module-item'>
<td><a class="trait" href="trait.Float.html"
title='trait ryu::Float'>Float</a></td>
<td class='docblock-short'>
<p>A floating point number, f32 or f64, that can be written into a
[<code>ryu::Buffer</code>][Buffer].</p>
</td>
</tr></table></section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt><kbd>?</kbd></dt>
<dd>Show this help dialog</dd>
<dt><kbd>S</kbd></dt>
<dd>Focus the search field</dd>
<dt><kbd></kbd></dt>
<dd>Move up in search results</dd>
<dt><kbd></kbd></dt>
<dd>Move down in search results</dd>
<dt><kbd></kbd></dt>
<dd>Switch tab</dd>
<dt><kbd>&#9166;</kbd></dt>
<dd>Go to active search result</dd>
<dt><kbd>+</kbd></dt>
<dd>Expand all sections</dd>
<dt><kbd>-</kbd></dt>
<dd>Collapse all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../";
window.currentCrate = "ryu";
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>