| <!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="Numeric traits for generic mathematics"><meta name="keywords" content="rust, rustlang, rust-lang, num_traits"><title>num_traits - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../normalize.css"><link rel="stylesheet" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../ayu.css" disabled><link rel="stylesheet" href="../dark.css" disabled><link rel="stylesheet" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="../crates.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../num_traits/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../num_traits/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Crate num_traits</a></h2><div class="sidebar-elems"><ul class="block"><li class="version">Version 0.2.15</li><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><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></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Crate <a class="mod" href="#">num_traits</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../src/num_traits/lib.rs.html#11-640">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Numeric traits for generic mathematics</p> |
| <h3 id="compatibility"><a href="#compatibility">Compatibility</a></h3> |
| <p>The <code>num-traits</code> crate is tested for rustc 1.8 and greater.</p> |
| </div></details><h2 id="reexports" class="small-section-header"><a href="#reexports">Re-exports</a></h2><div class="item-table"><div class="item-row"><div class="item-left import-item" id="reexport.Bounded"><code>pub use bounds::<a class="trait" href="bounds/trait.Bounded.html" title="trait num_traits::bounds::Bounded">Bounded</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.FloatConst"><code>pub use float::<a class="trait" href="float/trait.FloatConst.html" title="trait num_traits::float::FloatConst">FloatConst</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.cast"><code>pub use cast::<a class="fn" href="cast/fn.cast.html" title="fn num_traits::cast::cast">cast</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.AsPrimitive"><code>pub use cast::<a class="trait" href="cast/trait.AsPrimitive.html" title="trait num_traits::cast::AsPrimitive">AsPrimitive</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.FromPrimitive"><code>pub use cast::<a class="trait" href="cast/trait.FromPrimitive.html" title="trait num_traits::cast::FromPrimitive">FromPrimitive</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.NumCast"><code>pub use cast::<a class="trait" href="cast/trait.NumCast.html" title="trait num_traits::cast::NumCast">NumCast</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.ToPrimitive"><code>pub use cast::<a class="trait" href="cast/trait.ToPrimitive.html" title="trait num_traits::cast::ToPrimitive">ToPrimitive</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.one"><code>pub use identities::<a class="fn" href="identities/fn.one.html" title="fn num_traits::identities::one">one</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.zero"><code>pub use identities::<a class="fn" href="identities/fn.zero.html" title="fn num_traits::identities::zero">zero</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.One"><code>pub use identities::<a class="trait" href="identities/trait.One.html" title="trait num_traits::identities::One">One</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.Zero"><code>pub use identities::<a class="trait" href="identities/trait.Zero.html" title="trait num_traits::identities::Zero">Zero</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.PrimInt"><code>pub use int::<a class="trait" href="int/trait.PrimInt.html" title="trait num_traits::int::PrimInt">PrimInt</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.CheckedAdd"><code>pub use ops::checked::<a class="trait" href="ops/checked/trait.CheckedAdd.html" title="trait num_traits::ops::checked::CheckedAdd">CheckedAdd</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.CheckedDiv"><code>pub use ops::checked::<a class="trait" href="ops/checked/trait.CheckedDiv.html" title="trait num_traits::ops::checked::CheckedDiv">CheckedDiv</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.CheckedMul"><code>pub use ops::checked::<a class="trait" href="ops/checked/trait.CheckedMul.html" title="trait num_traits::ops::checked::CheckedMul">CheckedMul</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.CheckedNeg"><code>pub use ops::checked::<a class="trait" href="ops/checked/trait.CheckedNeg.html" title="trait num_traits::ops::checked::CheckedNeg">CheckedNeg</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.CheckedRem"><code>pub use ops::checked::<a class="trait" href="ops/checked/trait.CheckedRem.html" title="trait num_traits::ops::checked::CheckedRem">CheckedRem</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.CheckedShl"><code>pub use ops::checked::<a class="trait" href="ops/checked/trait.CheckedShl.html" title="trait num_traits::ops::checked::CheckedShl">CheckedShl</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.CheckedShr"><code>pub use ops::checked::<a class="trait" href="ops/checked/trait.CheckedShr.html" title="trait num_traits::ops::checked::CheckedShr">CheckedShr</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.CheckedSub"><code>pub use ops::checked::<a class="trait" href="ops/checked/trait.CheckedSub.html" title="trait num_traits::ops::checked::CheckedSub">CheckedSub</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.CheckedEuclid"><code>pub use ops::euclid::<a class="trait" href="ops/euclid/trait.CheckedEuclid.html" title="trait num_traits::ops::euclid::CheckedEuclid">CheckedEuclid</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.Euclid"><code>pub use ops::euclid::<a class="trait" href="ops/euclid/trait.Euclid.html" title="trait num_traits::ops::euclid::Euclid">Euclid</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.Inv"><code>pub use ops::inv::<a class="trait" href="ops/inv/trait.Inv.html" title="trait num_traits::ops::inv::Inv">Inv</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.MulAdd"><code>pub use ops::mul_add::<a class="trait" href="ops/mul_add/trait.MulAdd.html" title="trait num_traits::ops::mul_add::MulAdd">MulAdd</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.MulAddAssign"><code>pub use ops::mul_add::<a class="trait" href="ops/mul_add/trait.MulAddAssign.html" title="trait num_traits::ops::mul_add::MulAddAssign">MulAddAssign</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.Saturating"><code>pub use ops::saturating::<a class="trait" href="ops/saturating/trait.Saturating.html" title="trait num_traits::ops::saturating::Saturating">Saturating</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.SaturatingAdd"><code>pub use ops::saturating::<a class="trait" href="ops/saturating/trait.SaturatingAdd.html" title="trait num_traits::ops::saturating::SaturatingAdd">SaturatingAdd</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.SaturatingMul"><code>pub use ops::saturating::<a class="trait" href="ops/saturating/trait.SaturatingMul.html" title="trait num_traits::ops::saturating::SaturatingMul">SaturatingMul</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.SaturatingSub"><code>pub use ops::saturating::<a class="trait" href="ops/saturating/trait.SaturatingSub.html" title="trait num_traits::ops::saturating::SaturatingSub">SaturatingSub</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.WrappingAdd"><code>pub use ops::wrapping::<a class="trait" href="ops/wrapping/trait.WrappingAdd.html" title="trait num_traits::ops::wrapping::WrappingAdd">WrappingAdd</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.WrappingMul"><code>pub use ops::wrapping::<a class="trait" href="ops/wrapping/trait.WrappingMul.html" title="trait num_traits::ops::wrapping::WrappingMul">WrappingMul</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.WrappingNeg"><code>pub use ops::wrapping::<a class="trait" href="ops/wrapping/trait.WrappingNeg.html" title="trait num_traits::ops::wrapping::WrappingNeg">WrappingNeg</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.WrappingShl"><code>pub use ops::wrapping::<a class="trait" href="ops/wrapping/trait.WrappingShl.html" title="trait num_traits::ops::wrapping::WrappingShl">WrappingShl</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.WrappingShr"><code>pub use ops::wrapping::<a class="trait" href="ops/wrapping/trait.WrappingShr.html" title="trait num_traits::ops::wrapping::WrappingShr">WrappingShr</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.WrappingSub"><code>pub use ops::wrapping::<a class="trait" href="ops/wrapping/trait.WrappingSub.html" title="trait num_traits::ops::wrapping::WrappingSub">WrappingSub</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.checked_pow"><code>pub use pow::<a class="fn" href="pow/fn.checked_pow.html" title="fn num_traits::pow::checked_pow">checked_pow</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.pow"><code>pub use pow::<a class="fn" href="pow/fn.pow.html" title="fn num_traits::pow::pow">pow</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.Pow"><code>pub use pow::<a class="trait" href="pow/trait.Pow.html" title="trait num_traits::pow::Pow">Pow</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.abs"><code>pub use sign::<a class="fn" href="sign/fn.abs.html" title="fn num_traits::sign::abs">abs</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.abs_sub"><code>pub use sign::<a class="fn" href="sign/fn.abs_sub.html" title="fn num_traits::sign::abs_sub">abs_sub</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.signum"><code>pub use sign::<a class="fn" href="sign/fn.signum.html" title="fn num_traits::sign::signum">signum</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.Signed"><code>pub use sign::<a class="trait" href="sign/trait.Signed.html" title="trait num_traits::sign::Signed">Signed</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.Unsigned"><code>pub use sign::<a class="trait" href="sign/trait.Unsigned.html" title="trait num_traits::sign::Unsigned">Unsigned</a>;</code></div></div></div><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="bounds/index.html" title="num_traits::bounds mod">bounds</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="cast/index.html" title="num_traits::cast mod">cast</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="float/index.html" title="num_traits::float mod">float</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="identities/index.html" title="num_traits::identities mod">identities</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="int/index.html" title="num_traits::int mod">int</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="ops/index.html" title="num_traits::ops mod">ops</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="pow/index.html" title="num_traits::pow mod">pow</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="sign/index.html" title="num_traits::sign mod">sign</a></div></div></div><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ParseFloatError.html" title="num_traits::ParseFloatError struct">ParseFloatError</a></div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.FloatErrorKind.html" title="num_traits::FloatErrorKind enum">FloatErrorKind</a></div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Num.html" title="num_traits::Num trait">Num</a></div><div class="item-right docblock-short">The base trait for numeric types, covering <code>0</code> and <code>1</code> values, |
| comparisons, basic numeric operations, and string conversion.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.NumAssign.html" title="num_traits::NumAssign trait">NumAssign</a></div><div class="item-right docblock-short">The trait for <code>Num</code> types which also implement assignment operators.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.NumAssignOps.html" title="num_traits::NumAssignOps trait">NumAssignOps</a></div><div class="item-right docblock-short">Generic trait for types implementing numeric assignment operators (like <code>+=</code>).</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.NumAssignRef.html" title="num_traits::NumAssignRef trait">NumAssignRef</a></div><div class="item-right docblock-short">The trait for <code>NumAssign</code> types which also implement assignment operations |
| taking the second operand by reference.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.NumOps.html" title="num_traits::NumOps trait">NumOps</a></div><div class="item-right docblock-short">Generic trait for types implementing basic numeric operations</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.NumRef.html" title="num_traits::NumRef trait">NumRef</a></div><div class="item-right docblock-short">The trait for <code>Num</code> types which also implement numeric operations taking |
| the second operand by reference.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.RefNum.html" title="num_traits::RefNum trait">RefNum</a></div><div class="item-right docblock-short">The trait for <code>Num</code> references which implement numeric operations, taking the |
| second operand either by value or by reference.</div></div></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.clamp.html" title="num_traits::clamp fn">clamp</a></div><div class="item-right docblock-short">A value bounded by a minimum and a maximum</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.clamp_max.html" title="num_traits::clamp_max fn">clamp_max</a></div><div class="item-right docblock-short">A value bounded by a maximum value</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.clamp_min.html" title="num_traits::clamp_min fn">clamp_min</a></div><div class="item-right docblock-short">A value bounded by a minimum value</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="num_traits" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
