|
|
<!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 `half` crate."><meta name="keywords" content="rust, rustlang, rust-lang, half"><title>half - 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="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></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">☰</div><a href='../half/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate half</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all half's items</p></a><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'half', 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"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><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'>−</span>]</a></span><a class='srclink' href='../src/half/lib.rs.html#1-1264' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>half</a></span></h1><div class='docblock'><p>A crate that provides support for the half-precision floating point type.</p>
|
|
|
<p>This crate provides the <code>f16</code> type, which is an implementation of the IEEE 754-2008 <code>binary16</code>
|
|
|
floating point type. This 'half' precision floating point type is intended for efficient storage
|
|
|
where the full range and precision of a larger floating point value is not required. This is
|
|
|
especially useful for image storage formats.</p>
|
|
|
<p>Because <code>f16</code> is primarily for efficient storage, floating point operations are not implemented.
|
|
|
Operations should be performed with <code>f32</code> or higher-precision types and converted to/from <code>f16</code>
|
|
|
as necessary.</p>
|
|
|
<p>Some hardware architectures provide support for 16-bit floating point conversions. Enable the
|
|
|
<code>use-intrinsics</code> feature to use LLVM intrinsics for hardware conversions. This crate does no
|
|
|
checks on whether the hardware supports the feature. This feature currently only works on
|
|
|
nightly Rust due to a compiler feature gate.</p>
|
|
|
<p>Support for <code>serde</code> crate <code>Serialize</code> and <code>Deserialize</code> traits is provided when the <code>serde</code>
|
|
|
feature is enabled. This adds a dependency on <code>serde</code> crate so is an optional feature that works
|
|
|
on Rust 1.15 or newer.</p>
|
|
|
<p>The crate uses <code>#[no_std]</code> by default, so can be used in embedded environments without using the
|
|
|
Rust <code>std</code> library. A <code>std</code> feature is available, which enables additional utilities using the
|
|
|
<code>std</code> library, such as the <code>vec</code> module that provides zero-copy <code>Vec</code> conversions.</p>
|
|
|
</div><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="mod" href="consts/index.html" title='half::consts mod'>consts</a></td><td class='docblock-short'><p>Useful <code>f16</code> constants.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="mod" href="slice/index.html" title='half::slice mod'>slice</a></td><td class='docblock-short'><p>Contains utility functions to convert between slices of <code>u16</code> bits and <code>f16</code> numbers.</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.f16.html" title='half::f16 struct'>f16</a></td><td class='docblock-short'><p>The 16-bit floating point type.</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>⏎</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><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "half";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |
