249 lines
15 KiB
HTML
249 lines
15 KiB
HTML
|
<!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">
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../main.css">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="shortcut icon" href="https://rust-num.github.io/num/favicon.ico">
|
|||
|
|
|
|||
|
|
</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">
|
|||
|
|
<a href='../num_traits/index.html'><img src='https://rust-num.github.io/num/rust-logo-128x128-blk-v2.png' alt='logo' width='100'></a>
|
|||
|
|
<p class='location'>Crate num_traits</p><div class="block items"><ul><li><a href="#reexports">Reexports</a></li><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>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<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=''>num_traits</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'>−</span>]
|
|||
|
|
</a>
|
|||
|
|
</span><a class='srclink' href='../src/num_traits/lib.rs.html#11-432' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<div class='docblock'><p>Numeric traits for generic mathematics</p>
|
|||
|
|
</div><h2 id='reexports' class='section-header'><a href="#reexports">Reexports</a></h2>
|
|||
|
|
<table><tr><td><code>pub use bounds::<a class="trait" href="../num_traits/bounds/trait.Bounded.html" title="trait num_traits::bounds::Bounded">Bounded</a>;</code></td></tr><tr><td><code>pub use float::<a class="trait" href="../num_traits/float/trait.Float.html" title="trait num_traits::float::Float">Float</a>;</code></td></tr><tr><td><code>pub use float::<a class="trait" href="../num_traits/float/trait.FloatConst.html" title="trait num_traits::float::FloatConst">FloatConst</a>;</code></td></tr><tr><td><code>pub use identities::<a class="trait" href="../num_traits/identities/trait.Zero.html" title="trait num_traits::identities::Zero">Zero</a>;</code></td></tr><tr><td><code>pub use identities::<a class="trait" href="../num_traits/identities/trait.One.html" title="trait num_traits::identities::One">One</a>;</code></td></tr><tr><td><code>pub use identities::<a class="fn" href="../num_traits/identities/fn.zero.html" title="fn num_traits::identities::zero">zero</a>;</code></td></tr><tr><td><code>pub use identities::<a class="fn" href="../num_traits/identities/fn.one.html" title="fn num_traits::identities::one">one</a>;</code></td></tr><tr><td><code>pub use ops::<a class="mod" href="../num_traits/ops/checked/index.html" title="mod num_traits::ops::checked">checked</a>::*;</code></td></tr><tr><td><code>pub use ops::<a class="mod" href="../num_traits/ops/wrapping/index.html" title="mod num_traits::ops::wrapping">wrapping</a>::*;</code></td></tr><tr><td><code>pub use ops::saturating::<a class="trait" href="../num_traits/ops/saturating/trait.Saturating.html" title="trait num_traits::ops::saturating::Saturating">Saturating</a>;</code></td></tr><tr><td><code>pub use sign::<a class="trait" href="../num_traits/sign/trait.Signed.html" title="trait num_traits::sign::Signed">Signed</a>;</code></td></tr><tr><td><code>pub use sign::<a class="trait" href="../num_traits/sign/trait.Unsigned.html" title="trait num_traits::sign::Unsigned">Unsigned</a>;</code></td></tr><tr><td><code>pub use sign::<a class="fn" href="../num_traits/sign/fn.abs.html" title="fn num_traits::sign::abs">abs</a>;</code></td></tr><tr><td><code>pub use sign::<a class="fn" href="../num_traits/sign/fn.abs_sub.html" title="fn num_traits::sign::abs_sub">abs_sub</a>;</code></td></tr><tr><td><code>pub use sign::<a class="fn" href="../num_traits/sign/fn.signum.html" title="fn num_traits::sign::signum">signum</a>;</code></td></tr><tr><td><code>pub use <a class="mod" href="../num_traits/cast/index.html" title="mod num_traits::cast">cast</a>::*;</code></td></tr><tr><td><code>pub use int::<a class="trait" href="../num_traits/int/trait.PrimInt.html" title="trait num_traits::int::PrimInt">PrimInt</a>;</code></td></tr><tr><td><code>pub use pow::<a class="fn" href="../num_traits/pow/fn.pow.html" title="fn num_traits::pow::pow">pow</a>;</code></td></tr><tr><td><code>pub use pow::<a class="fn" href="../num_traits/pow/fn.checked_pow.html" title="fn num_traits::pow::checked_pow">checked_pow</a>;</code></td></tr></table><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='mod num_traits::bounds'>bounds</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="mod" href="cast/index.html"
|
|||
|
|
title='mod num_traits::cast'>cast</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="mod" href="float/index.html"
|
|||
|
|
title='mod num_traits::float'>float</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="mod" href="identities/index.html"
|
|||
|
|
title='mod num_traits::identities'>identities</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="mod" href="int/index.html"
|
|||
|
|
title='mod num_traits::int'>int</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="mod" href="ops/index.html"
|
|||
|
|
title='mod num_traits::ops'>ops</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="mod" href="pow/index.html"
|
|||
|
|
title='mod num_traits::pow'>pow</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="mod" href="sign/index.html"
|
|||
|
|
title='mod num_traits::sign'>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='struct num_traits::ParseFloatError'>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='enum num_traits::FloatErrorKind'>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.Num.html"
|
|||
|
|
title='trait num_traits::Num'>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='trait num_traits::NumAssign'>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='trait num_traits::NumAssignOps'>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='trait num_traits::NumAssignRef'>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.NumOps.html"
|
|||
|
|
title='trait num_traits::NumOps'>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='trait num_traits::NumRef'>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.RefNum.html"
|
|||
|
|
title='trait num_traits::RefNum'>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></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
|
|||
|
|
<table>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="fn" href="fn.clamp.html"
|
|||
|
|
title='fn num_traits::clamp'>clamp</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>A value bounded by a minimum and a maximum</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>?</dt>
|
|||
|
|
<dd>Show this help dialog</dd>
|
|||
|
|
<dt>S</dt>
|
|||
|
|
<dd>Focus the search field</dd>
|
|||
|
|
<dt>⇤</dt>
|
|||
|
|
<dd>Move up in search results</dd>
|
|||
|
|
<dt>⇥</dt>
|
|||
|
|
<dd>Move down in search results</dd>
|
|||
|
|
<dt>⏎</dt>
|
|||
|
|
<dd>Go to active search result</dd>
|
|||
|
|
<dt>+</dt>
|
|||
|
|
<dd>Collapse/expand 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 = "num_traits";
|
|||
|
|
</script>
|
|||
|
|
<script src="../main.js"></script>
|
|||
|
|
<script defer src="../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|