orion/phy
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
doc
phy/num_traits/index.html
Orion Kindel 0ce894e6b0 doc
2025-03-18 10:30:23 -05:00

8 lines
18 KiB
HTML
Raw Permalink Blame History

<!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"><title>num_traits - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="num_traits" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../num_traits/index.html">num_<wbr>traits</a><span class="version">0.2.19</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#compatibility" title="Compatibility">Compatibility</a></li></ul><h3><a href="#reexports">Crate Items</a></h3><ul class="block"><li><a href="#reexports" title="Re-exports">Re-exports</a></li><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Crate <span>num_traits</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/num_traits/lib.rs.html#11-635">Source</a> </span></div><details class="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 class="doc-anchor" href="#compatibility">§</a>Compatibility</h3>
<p>The <code>num-traits</code> crate is tested for rustc 1.60 and greater.</p>
</div></details><h2 id="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name" id="reexport.Bounded"><code>pub use crate::bounds::<a class="trait" href="bounds/trait.Bounded.html" title="trait num_traits::bounds::Bounded">Bounded</a>;</code></div></li><li><div class="item-name" id="reexport.Float"><code>pub use crate::float::<a class="trait" href="float/trait.Float.html" title="trait num_traits::float::Float">Float</a>;</code></div></li><li><div class="item-name" id="reexport.FloatConst"><code>pub use crate::float::<a class="trait" href="float/trait.FloatConst.html" title="trait num_traits::float::FloatConst">FloatConst</a>;</code></div></li><li><div class="item-name" id="reexport.cast"><code>pub use crate::cast::<a class="fn" href="cast/fn.cast.html" title="fn num_traits::cast::cast">cast</a>;</code></div></li><li><div class="item-name" id="reexport.AsPrimitive"><code>pub use crate::cast::<a class="trait" href="cast/trait.AsPrimitive.html" title="trait num_traits::cast::AsPrimitive">AsPrimitive</a>;</code></div></li><li><div class="item-name" id="reexport.FromPrimitive"><code>pub use crate::cast::<a class="trait" href="cast/trait.FromPrimitive.html" title="trait num_traits::cast::FromPrimitive">FromPrimitive</a>;</code></div></li><li><div class="item-name" id="reexport.NumCast"><code>pub use crate::cast::<a class="trait" href="cast/trait.NumCast.html" title="trait num_traits::cast::NumCast">NumCast</a>;</code></div></li><li><div class="item-name" id="reexport.ToPrimitive"><code>pub use crate::cast::<a class="trait" href="cast/trait.ToPrimitive.html" title="trait num_traits::cast::ToPrimitive">ToPrimitive</a>;</code></div></li><li><div class="item-name" id="reexport.one"><code>pub use crate::identities::<a class="fn" href="identities/fn.one.html" title="fn num_traits::identities::one">one</a>;</code></div></li><li><div class="item-name" id="reexport.zero"><code>pub use crate::identities::<a class="fn" href="identities/fn.zero.html" title="fn num_traits::identities::zero">zero</a>;</code></div></li><li><div class="item-name" id="reexport.ConstOne"><code>pub use crate::identities::<a class="trait" href="identities/trait.ConstOne.html" title="trait num_traits::identities::ConstOne">ConstOne</a>;</code></div></li><li><div class="item-name" id="reexport.ConstZero"><code>pub use crate::identities::<a class="trait" href="identities/trait.ConstZero.html" title="trait num_traits::identities::ConstZero">ConstZero</a>;</code></div></li><li><div class="item-name" id="reexport.One"><code>pub use crate::identities::<a class="trait" href="identities/trait.One.html" title="trait num_traits::identities::One">One</a>;</code></div></li><li><div class="item-name" id="reexport.Zero"><code>pub use crate::identities::<a class="trait" href="identities/trait.Zero.html" title="trait num_traits::identities::Zero">Zero</a>;</code></div></li><li><div class="item-name" id="reexport.PrimInt"><code>pub use crate::int::<a class="trait" href="int/trait.PrimInt.html" title="trait num_traits::int::PrimInt">PrimInt</a>;</code></div></li><li><div class="item-name" id="reexport.FromBytes"><code>pub use crate::ops::bytes::<a class="trait" href="ops/bytes/trait.FromBytes.html" title="trait num_traits::ops::bytes::FromBytes">FromBytes</a>;</code></div></li><li><div class="item-name" id="reexport.ToBytes"><code>pub use crate::ops::bytes::<a class="trait" href="ops/bytes/trait.ToBytes.html" title="trait num_traits::ops::bytes::ToBytes">ToBytes</a>;</code></div></li><li><div class="item-name" id="reexport.CheckedAdd"><code>pub use crate::ops::checked::<a class="trait" href="ops/checked/trait.CheckedAdd.html" title="trait num_traits::ops::checked::CheckedAdd">CheckedAdd</a>;</code></div></li><li><div class="item-name" id="reexport.CheckedDiv"><code>pub use crate::ops::checked::<a class="trait" href="ops/checked/trait.CheckedDiv.html" title="trait num_traits::ops::checked::CheckedDiv">CheckedDiv</a>;</code></div></li><li><div class="item-name" id="reexport.CheckedMul"><code>pub use crate::ops::checked::<a class="trait" href="ops/checked/trait.CheckedMul.html" title="trait num_traits::ops::checked::CheckedMul">CheckedMul</a>;</code></div></li><li><div class="item-name" id="reexport.CheckedNeg"><code>pub use crate::ops::checked::<a class="trait" href="ops/checked/trait.CheckedNeg.html" title="trait num_traits::ops::checked::CheckedNeg">CheckedNeg</a>;</code></div></li><li><div class="item-name" id="reexport.CheckedRem"><code>pub use crate::ops::checked::<a class="trait" href="ops/checked/trait.CheckedRem.html" title="trait num_traits::ops::checked::CheckedRem">CheckedRem</a>;</code></div></li><li><div class="item-name" id="reexport.CheckedShl"><code>pub use crate::ops::checked::<a class="trait" href="ops/checked/trait.CheckedShl.html" title="trait num_traits::ops::checked::CheckedShl">CheckedShl</a>;</code></div></li><li><div class="item-name" id="reexport.CheckedShr"><code>pub use crate::ops::checked::<a class="trait" href="ops/checked/trait.CheckedShr.html" title="trait num_traits::ops::checked::CheckedShr">CheckedShr</a>;</code></div></li><li><div class="item-name" id="reexport.CheckedSub"><code>pub use crate::ops::checked::<a class="trait" href="ops/checked/trait.CheckedSub.html" title="trait num_traits::ops::checked::CheckedSub">CheckedSub</a>;</code></div></li><li><div class="item-name" id="reexport.CheckedEuclid"><code>pub use crate::ops::euclid::<a class="trait" href="ops/euclid/trait.CheckedEuclid.html" title="trait num_traits::ops::euclid::CheckedEuclid">CheckedEuclid</a>;</code></div></li><li><div class="item-name" id="reexport.Euclid"><code>pub use crate::ops::euclid::<a class="trait" href="ops/euclid/trait.Euclid.html" title="trait num_traits::ops::euclid::Euclid">Euclid</a>;</code></div></li><li><div class="item-name" id="reexport.Inv"><code>pub use crate::ops::inv::<a class="trait" href="ops/inv/trait.Inv.html" title="trait num_traits::ops::inv::Inv">Inv</a>;</code></div></li><li><div class="item-name" id="reexport.MulAdd"><code>pub use crate::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></li><li><div class="item-name" id="reexport.MulAddAssign"><code>pub use crate::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></li><li><div class="item-name" id="reexport.Saturating"><code>pub use crate::ops::saturating::<a class="trait" href="ops/saturating/trait.Saturating.html" title="trait num_traits::ops::saturating::Saturating">Saturating</a>;</code></div></li><li><div class="item-name" id="reexport.SaturatingAdd"><code>pub use crate::ops::saturating::<a class="trait" href="ops/saturating/trait.SaturatingAdd.html" title="trait num_traits::ops::saturating::SaturatingAdd">SaturatingAdd</a>;</code></div></li><li><div class="item-name" id="reexport.SaturatingMul"><code>pub use crate::ops::saturating::<a class="trait" href="ops/saturating/trait.SaturatingMul.html" title="trait num_traits::ops::saturating::SaturatingMul">SaturatingMul</a>;</code></div></li><li><div class="item-name" id="reexport.SaturatingSub"><code>pub use crate::ops::saturating::<a class="trait" href="ops/saturating/trait.SaturatingSub.html" title="trait num_traits::ops::saturating::SaturatingSub">SaturatingSub</a>;</code></div></li><li><div class="item-name" id="reexport.WrappingAdd"><code>pub use crate::ops::wrapping::<a class="trait" href="ops/wrapping/trait.WrappingAdd.html" title="trait num_traits::ops::wrapping::WrappingAdd">WrappingAdd</a>;</code></div></li><li><div class="item-name" id="reexport.WrappingMul"><code>pub use crate::ops::wrapping::<a class="trait" href="ops/wrapping/trait.WrappingMul.html" title="trait num_traits::ops::wrapping::WrappingMul">WrappingMul</a>;</code></div></li><li><div class="item-name" id="reexport.WrappingNeg"><code>pub use crate::ops::wrapping::<a class="trait" href="ops/wrapping/trait.WrappingNeg.html" title="trait num_traits::ops::wrapping::WrappingNeg">WrappingNeg</a>;</code></div></li><li><div class="item-name" id="reexport.WrappingShl"><code>pub use crate::ops::wrapping::<a class="trait" href="ops/wrapping/trait.WrappingShl.html" title="trait num_traits::ops::wrapping::WrappingShl">WrappingShl</a>;</code></div></li><li><div class="item-name" id="reexport.WrappingShr"><code>pub use crate::ops::wrapping::<a class="trait" href="ops/wrapping/trait.WrappingShr.html" title="trait num_traits::ops::wrapping::WrappingShr">WrappingShr</a>;</code></div></li><li><div class="item-name" id="reexport.WrappingSub"><code>pub use crate::ops::wrapping::<a class="trait" href="ops/wrapping/trait.WrappingSub.html" title="trait num_traits::ops::wrapping::WrappingSub">WrappingSub</a>;</code></div></li><li><div class="item-name" id="reexport.checked_pow"><code>pub use crate::pow::<a class="fn" href="pow/fn.checked_pow.html" title="fn num_traits::pow::checked_pow">checked_pow</a>;</code></div></li><li><div class="item-name" id="reexport.pow"><code>pub use crate::pow::<a class="fn" href="pow/fn.pow.html" title="fn num_traits::pow::pow">pow</a>;</code></div></li><li><div class="item-name" id="reexport.Pow"><code>pub use crate::pow::<a class="trait" href="pow/trait.Pow.html" title="trait num_traits::pow::Pow">Pow</a>;</code></div></li><li><div class="item-name" id="reexport.abs"><code>pub use crate::sign::<a class="fn" href="sign/fn.abs.html" title="fn num_traits::sign::abs">abs</a>;</code></div></li><li><div class="item-name" id="reexport.abs_sub"><code>pub use crate::sign::<a class="fn" href="sign/fn.abs_sub.html" title="fn num_traits::sign::abs_sub">abs_sub</a>;</code></div></li><li><div class="item-name" id="reexport.signum"><code>pub use crate::sign::<a class="fn" href="sign/fn.signum.html" title="fn num_traits::sign::signum">signum</a>;</code></div></li><li><div class="item-name" id="reexport.Signed"><code>pub use crate::sign::<a class="trait" href="sign/trait.Signed.html" title="trait num_traits::sign::Signed">Signed</a>;</code></div></li><li><div class="item-name" id="reexport.Unsigned"><code>pub use crate::sign::<a class="trait" href="sign/trait.Unsigned.html" title="trait num_traits::sign::Unsigned">Unsigned</a>;</code></div></li></ul><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="bounds/index.html" title="mod num_traits::bounds">bounds</a></div></li><li><div class="item-name"><a class="mod" href="cast/index.html" title="mod num_traits::cast">cast</a></div></li><li><div class="item-name"><a class="mod" href="float/index.html" title="mod num_traits::float">float</a></div></li><li><div class="item-name"><a class="mod" href="identities/index.html" title="mod num_traits::identities">identities</a></div></li><li><div class="item-name"><a class="mod" href="int/index.html" title="mod num_traits::int">int</a></div></li><li><div class="item-name"><a class="mod" href="ops/index.html" title="mod num_traits::ops">ops</a></div></li><li><div class="item-name"><a class="mod" href="pow/index.html" title="mod num_traits::pow">pow</a></div></li><li><div class="item-name"><a class="mod" href="real/index.html" title="mod num_traits::real">real</a></div></li><li><div class="item-name"><a class="mod" href="sign/index.html" title="mod num_traits::sign">sign</a></div></li></ul><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.ParseFloatError.html" title="struct num_traits::ParseFloatError">Parse<wbr>Float<wbr>Error</a></div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.FloatErrorKind.html" title="enum num_traits::FloatErrorKind">Float<wbr>Error<wbr>Kind</a></div></li></ul><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.Num.html" title="trait num_traits::Num">Num</a></div><div class="desc 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></li><li><div class="item-name"><a class="trait" href="trait.NumAssign.html" title="trait num_traits::NumAssign">NumAssign</a></div><div class="desc docblock-short">The trait for <code>Num</code> types which also implement assignment operators.</div></li><li><div class="item-name"><a class="trait" href="trait.NumAssignOps.html" title="trait num_traits::NumAssignOps">NumAssign<wbr>Ops</a></div><div class="desc docblock-short">Generic trait for types implementing numeric assignment operators (like <code>+=</code>).</div></li><li><div class="item-name"><a class="trait" href="trait.NumAssignRef.html" title="trait num_traits::NumAssignRef">NumAssign<wbr>Ref</a></div><div class="desc docblock-short">The trait for <code>NumAssign</code> types which also implement assignment operations
taking the second operand by reference.</div></li><li><div class="item-name"><a class="trait" href="trait.NumOps.html" title="trait num_traits::NumOps">NumOps</a></div><div class="desc docblock-short">Generic trait for types implementing basic numeric operations</div></li><li><div class="item-name"><a class="trait" href="trait.NumRef.html" title="trait num_traits::NumRef">NumRef</a></div><div class="desc docblock-short">The trait for <code>Num</code> types which also implement numeric operations taking
the second operand by reference.</div></li><li><div class="item-name"><a class="trait" href="trait.RefNum.html" title="trait num_traits::RefNum">RefNum</a></div><div class="desc docblock-short">The trait for <code>Num</code> references which implement numeric operations, taking the
second operand either by value or by reference.</div></li></ul><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.clamp.html" title="fn num_traits::clamp">clamp</a></div><div class="desc docblock-short">A value bounded by a minimum and a maximum</div></li><li><div class="item-name"><a class="fn" href="fn.clamp_max.html" title="fn num_traits::clamp_max">clamp_<wbr>max</a></div><div class="desc docblock-short">A value bounded by a maximum value</div></li><li><div class="item-name"><a class="fn" href="fn.clamp_min.html" title="fn num_traits::clamp_min">clamp_<wbr>min</a></div><div class="desc docblock-short">A value bounded by a minimum value</div></li></ul></section></div></main></body></html>
Reference in New Issue View Git Blame Copy Permalink