github-actions[bot]
27 lines
15 KiB
HTML
27 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" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><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='../num_traits/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Crate num_traits</p><div class="block version"><p>Version 0.2.14</p></div><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="#reexports">Re-exports</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></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||
<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/num_traits/lib.rs.html#11-583" 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>
|
||
<h2 id="compatibility" class="section-header"><a href="#compatibility">Compatibility</a></h2>
|
||
<p>The <code>num-traits</code> crate is tested for rustc 1.8 and greater.</p>
|
||
</div><h2 id="reexports" class="section-header"><a href="#reexports">Re-exports</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.FloatConst.html" title="trait num_traits::float::FloatConst">FloatConst</a>;</code></td></tr><tr><td><code>pub use cast::<a class="fn" href="../num_traits/cast/fn.cast.html" title="fn num_traits::cast::cast">cast</a>;</code></td></tr><tr><td><code>pub use cast::<a class="trait" href="../num_traits/cast/trait.AsPrimitive.html" title="trait num_traits::cast::AsPrimitive">AsPrimitive</a>;</code></td></tr><tr><td><code>pub use cast::<a class="trait" href="../num_traits/cast/trait.FromPrimitive.html" title="trait num_traits::cast::FromPrimitive">FromPrimitive</a>;</code></td></tr><tr><td><code>pub use cast::<a class="trait" href="../num_traits/cast/trait.NumCast.html" title="trait num_traits::cast::NumCast">NumCast</a>;</code></td></tr><tr><td><code>pub use cast::<a class="trait" href="../num_traits/cast/trait.ToPrimitive.html" title="trait num_traits::cast::ToPrimitive">ToPrimitive</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 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="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="trait" href="../num_traits/identities/trait.Zero.html" title="trait num_traits::identities::Zero">Zero</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 ops::checked::<a class="trait" href="../num_traits/ops/checked/trait.CheckedAdd.html" title="trait num_traits::ops::checked::CheckedAdd">CheckedAdd</a>;</code></td></tr><tr><td><code>pub use ops::checked::<a class="trait" href="../num_traits/ops/checked/trait.CheckedDiv.html" title="trait num_traits::ops::checked::CheckedDiv">CheckedDiv</a>;</code></td></tr><tr><td><code>pub use ops::checked::<a class="trait" href="../num_traits/ops/checked/trait.CheckedMul.html" title="trait num_traits::ops::checked::CheckedMul">CheckedMul</a>;</code></td></tr><tr><td><code>pub use ops::checked::<a class="trait" href="../num_traits/ops/checked/trait.CheckedNeg.html" title="trait num_traits::ops::checked::CheckedNeg">CheckedNeg</a>;</code></td></tr><tr><td><code>pub use ops::checked::<a class="trait" href="../num_traits/ops/checked/trait.CheckedRem.html" title="trait num_traits::ops::checked::CheckedRem">CheckedRem</a>;</code></td></tr><tr><td><code>pub use ops::checked::<a class="trait" href="../num_traits/ops/checked/trait.CheckedShl.html" title="trait num_traits::ops::checked::CheckedShl">CheckedShl</a>;</code></td></tr><tr><td><code>pub use ops::checked::<a class="trait" href="../num_traits/ops/checked/trait.CheckedShr.html" title="trait num_traits::ops::checked::CheckedShr">CheckedShr</a>;</code></td></tr><tr><td><code>pub use ops::checked::<a class="trait" href="../num_traits/ops/checked/trait.CheckedSub.html" title="trait num_traits::ops::checked::CheckedSub">CheckedSub</a>;</code></td></tr><tr><td><code>pub use ops::inv::<a class="trait" href="../num_traits/ops/inv/trait.Inv.html" title="trait num_traits::ops::inv::Inv">Inv</a>;</code></td></tr><tr><td><code>pub use ops::mul_add::<a class="trait" href="../num_traits/ops/mul_add/trait.MulAdd.html" title="trait num_traits::ops::mul_add::MulAdd">MulAdd</a>;</code></td></tr><tr><td><code>pub use ops::mul_add::<a class="trait" href="../num_traits/ops/mul_add/trait.MulAddAssign.html" title="trait num_traits::ops::mul_add::MulAddAssign">MulAddAssign</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 ops::saturating::<a class="trait" href="../num_traits/ops/saturating/trait.SaturatingAdd.html" title="trait num_traits::ops::saturating::SaturatingAdd">SaturatingAdd</a>;</code></td></tr><tr><td><code>pub use ops::saturating::<a class="trait" href="../num_traits/ops/saturating/trait.SaturatingMul.html" title="trait num_traits::ops::saturating::SaturatingMul">SaturatingMul</a>;</code></td></tr><tr><td><code>pub use ops::saturating::<a class="trait" href="../num_traits/ops/saturating/trait.SaturatingSub.html" title="trait num_traits::ops::saturating::SaturatingSub">SaturatingSub</a>;</code></td></tr><tr><td><code>pub use ops::wrapping::<a class="trait" href="../num_traits/ops/wrapping/trait.WrappingAdd.html" title="trait num_traits::ops::wrapping::WrappingAdd">WrappingAdd</a>;</code></td></tr><tr><td><code>pub use ops::wrapping::<a class="trait" href="../num_traits/ops/wrapping/trait.WrappingMul.html" title="trait num_traits::ops::wrapping::WrappingMul">WrappingMul</a>;</code></td></tr><tr><td><code>pub use ops::wrapping::<a class="trait" href="../num_traits/ops/wrapping/trait.WrappingNeg.html" title="trait num_traits::ops::wrapping::WrappingNeg">WrappingNeg</a>;</code></td></tr><tr><td><code>pub use ops::wrapping::<a class="trait" href="../num_traits/ops/wrapping/trait.WrappingShl.html" title="trait num_traits::ops::wrapping::WrappingShl">WrappingShl</a>;</code></td></tr><tr><td><code>pub use ops::wrapping::<a class="trait" href="../num_traits/ops/wrapping/trait.WrappingShr.html" title="trait num_traits::ops::wrapping::WrappingShr">WrappingShr</a>;</code></td></tr><tr><td><code>pub use ops::wrapping::<a class="trait" href="../num_traits/ops/wrapping/trait.WrappingSub.html" title="trait num_traits::ops::wrapping::WrappingSub">WrappingSub</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><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="trait" href="../num_traits/pow/trait.Pow.html" title="trait num_traits::pow::Pow">Pow</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 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></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="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="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.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.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.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></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="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.clamp_max.html" title="num_traits::clamp_max fn">clamp_max</a></td><td class="docblock-short"><p>A value bounded by a maximum value</p>
|
||
</td></tr><tr class="module-item"><td><a class="fn" href="fn.clamp_min.html" title="num_traits::clamp_min fn">clamp_min</a></td><td class="docblock-short"><p>A value bounded by a minimum value</p>
|
||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "num_traits";</script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |