fluencelabs/wasmer
1
0
Fork 0
mirror of https://github.com/fluencelabs/wasmer synced 2025-04-25 18:32:15 +00:00
Code Issues Projects Releases Wiki Activity
wasmer/rustdoc/num_traits/index.html
Nick Lewycky 621a665633 Publishing GitHub Pages ***NO_CI***
2019-09-06 15:57:44 -07:00

59 lines
15 KiB
HTML
Raw Permalink 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 `num_traits` crate."><meta name="keywords" content="rust, rustlang, rust-lang, num_traits"><title>num_traits - 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">&#9776;</div><a href='../num_traits/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate num_traits</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all num_traits's items</p></a><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'num_traits', 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'>&#x2212;</span>]</a></span><a class='srclink' href='../src/num_traits/lib.rs.html#11-88' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>num_traits</a></span></h1><div class='docblock'><p>Numeric traits for generic mathematics</p>
<p>This version of the crate only exists to re-export compatible
items from num-traits 0.2. Please consider updating!</p>
</div><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
<table><tr class='module-item'><td><a class="mod" href="bounds/index.html" title='num_traits::bounds mod'>bounds</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="cast/index.html" title='num_traits::cast mod'>cast</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="float/index.html" title='num_traits::float mod'>float</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="identities/index.html" title='num_traits::identities mod'>identities</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="int/index.html" title='num_traits::int mod'>int</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="ops/index.html" title='num_traits::ops mod'>ops</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="pow/index.html" title='num_traits::pow mod'>pow</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="real/index.html" title='num_traits::real mod'>real</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="sign/index.html" title='num_traits::sign mod'>sign</a></td><td class='docblock-short'></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.ParseFloatError.html" title='num_traits::ParseFloatError struct'>ParseFloatError</a></td><td class='docblock-short'></td></tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
<table><tr class='module-item'><td><a class="enum" href="enum.FloatErrorKind.html" title='num_traits::FloatErrorKind enum'>FloatErrorKind</a></td><td class='docblock-short'></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.AsPrimitive.html" title='num_traits::AsPrimitive trait'>AsPrimitive</a></td><td class='docblock-short'><p>A generic interface for casting between machine scalars with the
<code>as</code> operator, which admits narrowing and precision loss.
Implementers of this trait AsPrimitive should behave like a primitive
numeric type (e.g. a newtype around another primitive), and the
intended conversion must never fail.</p>
</td></tr><tr class='module-item'><td><a class="trait" href="trait.Bounded.html" title='num_traits::Bounded trait'>Bounded</a></td><td class='docblock-short'><p>Numbers which have upper and lower bounds</p>
</td></tr><tr class='module-item'><td><a class="trait" href="trait.CheckedAdd.html" title='num_traits::CheckedAdd trait'>CheckedAdd</a></td><td class='docblock-short'><p>Performs addition that returns <code>None</code> instead of wrapping around on
overflow.</p>
</td></tr><tr class='module-item'><td><a class="trait" href="trait.CheckedDiv.html" title='num_traits::CheckedDiv trait'>CheckedDiv</a></td><td class='docblock-short'><p>Performs division that returns <code>None</code> instead of panicking on division by zero and instead of
wrapping around on underflow and overflow.</p>
</td></tr><tr class='module-item'><td><a class="trait" href="trait.CheckedMul.html" title='num_traits::CheckedMul trait'>CheckedMul</a></td><td class='docblock-short'><p>Performs multiplication that returns <code>None</code> instead of wrapping around on underflow or
overflow.</p>
</td></tr><tr class='module-item'><td><a class="trait" href="trait.CheckedShl.html" title='num_traits::CheckedShl trait'>CheckedShl</a></td><td class='docblock-short'><p>Performs a left shift that returns <code>None</code> on shifts larger than
the type width.</p>
</td></tr><tr class='module-item'><td><a class="trait" href="trait.CheckedShr.html" title='num_traits::CheckedShr trait'>CheckedShr</a></td><td class='docblock-short'><p>Performs a right shift that returns <code>None</code> on shifts larger than
the type width.</p>
</td></tr><tr class='module-item'><td><a class="trait" href="trait.CheckedSub.html" title='num_traits::CheckedSub trait'>CheckedSub</a></td><td class='docblock-short'><p>Performs subtraction that returns <code>None</code> instead of wrapping around on underflow.</p>
</td></tr><tr class='module-item'><td><a class="trait" href="trait.Float.html" title='num_traits::Float trait'>Float</a></td><td class='docblock-short'><p>Generic trait for floating point numbers</p>
</td></tr><tr class='module-item'><td><a class="trait" href="trait.FloatConst.html" title='num_traits::FloatConst trait'>FloatConst</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="trait" href="trait.FromPrimitive.html" title='num_traits::FromPrimitive trait'>FromPrimitive</a></td><td class='docblock-short'><p>A generic trait for converting a number to a value.</p>
</td></tr><tr class='module-item'><td><a class="trait" href="trait.Num.html" title='num_traits::Num trait'>Num</a></td><td class='docblock-short'><p>The base trait for numeric types, covering <code>0</code> and <code>1</code> values,
comparisons, basic numeric operations, and string conversion.</p>
</td></tr><tr class='module-item'><td><a class="trait" href="trait.NumAssign.html" title='num_traits::NumAssign trait'>NumAssign</a></td><td class='docblock-short'><p>The trait for <code>Num</code> types which also implement assignment operators.</p>
</td></tr><tr class='module-item'><td><a class="trait" href="trait.NumAssignOps.html" title='num_traits::NumAssignOps trait'>NumAssignOps</a></td><td class='docblock-short'><p>The trait for types implementing numeric assignment operators (like <code>+=</code>).</p>
</td></tr><tr class='module-item'><td><a class="trait" href="trait.NumAssignRef.html" title='num_traits::NumAssignRef trait'>NumAssignRef</a></td><td class='docblock-short'><p>The trait for <code>NumAssign</code> types which also implement assignment operations
taking the second operand by reference.</p>
</td></tr><tr class='module-item'><td><a class="trait" href="trait.NumCast.html" title='num_traits::NumCast trait'>NumCast</a></td><td class='docblock-short'><p>An interface for casting between machine scalars.</p>
</td></tr><tr class='module-item'><td><a class="trait" href="trait.NumOps.html" title='num_traits::NumOps trait'>NumOps</a></td><td class='docblock-short'><p>The trait for types implementing basic numeric operations</p>
</td></tr><tr class='module-item'><td><a class="trait" href="trait.NumRef.html" title='num_traits::NumRef trait'>NumRef</a></td><td class='docblock-short'><p>The trait for <code>Num</code> types which also implement numeric operations taking
the second operand by reference.</p>
</td></tr><tr class='module-item'><td><a class="trait" href="trait.One.html" title='num_traits::One trait'>One</a></td><td class='docblock-short'><p>Defines a multiplicative identity element for <code>Self</code>.</p>
</td></tr><tr class='module-item'><td><a class="trait" href="trait.PrimInt.html" title='num_traits::PrimInt trait'>PrimInt</a></td><td class='docblock-short'><p>Generic trait for primitive integers.</p>
</td></tr><tr class='module-item'><td><a class="trait" href="trait.RefNum.html" title='num_traits::RefNum trait'>RefNum</a></td><td class='docblock-short'><p>The trait for references which implement numeric operations, taking the
second operand either by value or by reference.</p>
</td></tr><tr class='module-item'><td><a class="trait" href="trait.Saturating.html" title='num_traits::Saturating trait'>Saturating</a></td><td class='docblock-short'><p>Saturating math operations</p>
</td></tr><tr class='module-item'><td><a class="trait" href="trait.Signed.html" title='num_traits::Signed trait'>Signed</a></td><td class='docblock-short'><p>Useful functions for signed numbers (i.e. numbers that can be negative).</p>
</td></tr><tr class='module-item'><td><a class="trait" href="trait.ToPrimitive.html" title='num_traits::ToPrimitive trait'>ToPrimitive</a></td><td class='docblock-short'><p>A generic trait for converting a value to a number.</p>
</td></tr><tr class='module-item'><td><a class="trait" href="trait.Unsigned.html" title='num_traits::Unsigned trait'>Unsigned</a></td><td class='docblock-short'><p>A trait for values which cannot be negative</p>
</td></tr><tr class='module-item'><td><a class="trait" href="trait.WrappingAdd.html" title='num_traits::WrappingAdd trait'>WrappingAdd</a></td><td class='docblock-short'><p>Performs addition that wraps around on overflow.</p>
</td></tr><tr class='module-item'><td><a class="trait" href="trait.WrappingMul.html" title='num_traits::WrappingMul trait'>WrappingMul</a></td><td class='docblock-short'><p>Performs multiplication that wraps around on overflow.</p>
</td></tr><tr class='module-item'><td><a class="trait" href="trait.WrappingSub.html" title='num_traits::WrappingSub trait'>WrappingSub</a></td><td class='docblock-short'><p>Performs subtraction that wraps around on overflow.</p>
</td></tr><tr class='module-item'><td><a class="trait" href="trait.Zero.html" title='num_traits::Zero trait'>Zero</a></td><td class='docblock-short'><p>Defines an additive identity element for <code>Self</code>.</p>
</td></tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
<table><tr class='module-item'><td><a class="fn" href="fn.abs.html" title='num_traits::abs fn'>abs</a></td><td class='docblock-short'><p>Computes the absolute value.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.abs_sub.html" title='num_traits::abs_sub fn'>abs_sub</a></td><td class='docblock-short'><p>The positive difference of two numbers.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.cast.html" title='num_traits::cast fn'>cast</a></td><td class='docblock-short'><p>Cast from one machine scalar to another.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.checked_pow.html" title='num_traits::checked_pow fn'>checked_pow</a></td><td class='docblock-short'><p>Raises a value to the power of exp, returning <code>None</code> if an overflow occurred.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.clamp.html" title='num_traits::clamp fn'>clamp</a></td><td class='docblock-short'><p>A value bounded by a minimum and a maximum</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.one.html" title='num_traits::one fn'>one</a></td><td class='docblock-short'><p>Returns the multiplicative identity, <code>1</code>.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.pow.html" title='num_traits::pow fn'>pow</a></td><td class='docblock-short'><p>Raises a value to the power of exp, using exponentiation by squaring.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.signum.html" title='num_traits::signum fn'>signum</a></td><td class='docblock-short'><p>Returns the sign of the number.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.zero.html" title='num_traits::zero fn'>zero</a></td><td class='docblock-short'><p>Returns the additive identity, <code>0</code>.</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><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 = "num_traits";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
Reference in New Issue View Git Blame Copy Permalink