Files
phy/emath/trait.NumExt.html
Orion Kindel 0ce894e6b0 doc
2025-03-18 10:30:23 -05:00

8 lines
22 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="Extends `f32`, `Vec2` etc with `at_least` and `at_most` as aliases for `max` and `min`."><title>NumExt in emath - 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="emath" 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="sidebar-items.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 trait"><!--[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="../emath/index.html">emath</a><span class="version">0.30.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">NumExt</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.at_least" title="at_least">at_least</a></li><li><a href="#tymethod.at_most" title="at_most">at_most</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-NumExt-for-f32" title="f32">f32</a></li><li><a href="#impl-NumExt-for-f64" title="f64">f64</a></li><li><a href="#impl-NumExt-for-i128" title="i128">i128</a></li><li><a href="#impl-NumExt-for-i16" title="i16">i16</a></li><li><a href="#impl-NumExt-for-i32" title="i32">i32</a></li><li><a href="#impl-NumExt-for-i64" title="i64">i64</a></li><li><a href="#impl-NumExt-for-i8" title="i8">i8</a></li><li><a href="#impl-NumExt-for-isize" title="isize">isize</a></li><li><a href="#impl-NumExt-for-u128" title="u128">u128</a></li><li><a href="#impl-NumExt-for-u16" title="u16">u16</a></li><li><a href="#impl-NumExt-for-u32" title="u32">u32</a></li><li><a href="#impl-NumExt-for-u64" title="u64">u64</a></li><li><a href="#impl-NumExt-for-u8" title="u8">u8</a></li><li><a href="#impl-NumExt-for-usize" title="usize">usize</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate emath</a></h2></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"><span class="rustdoc-breadcrumbs"><a href="index.html">emath</a></span><h1>Trait <span class="trait">NumExt</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/emath/lib.rs.html#292-300">Source</a> </span></div><pre class="rust item-decl"><code>pub trait NumExt {
// Required methods
fn <a href="#tymethod.at_least" class="fn">at_least</a>(self, lower_limit: Self) -&gt; Self;
<span class="item-spacer"></span> fn <a href="#tymethod.at_most" class="fn">at_most</a>(self, upper_limit: Self) -&gt; Self;
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Extends <code>f32</code>, <a href="struct.Vec2.html" title="struct emath::Vec2"><code>Vec2</code></a> etc with <code>at_least</code> and <code>at_most</code> as aliases for <code>max</code> and <code>min</code>.</p>
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.at_least" class="method"><a class="src rightside" href="../src/emath/lib.rs.html#295">Source</a><h4 class="code-header">fn <a href="#tymethod.at_least" class="fn">at_least</a>(self, lower_limit: Self) -&gt; Self</h4></section></summary><div class="docblock"><p>More readable version of <code>self.max(lower_limit)</code></p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.at_most" class="method"><a class="src rightside" href="../src/emath/lib.rs.html#299">Source</a><h4 class="code-header">fn <a href="#tymethod.at_most" class="fn">at_most</a>(self, upper_limit: Self) -&gt; Self</h4></section></summary><div class="docblock"><p>More readable version of <code>self.min(upper_limit)</code></p>
</div></details></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.84.0/reference/items/traits.html#object-safety">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-NumExt-for-f32" class="impl"><a class="src rightside" href="../src/emath/lib.rs.html#330">Source</a><a href="#impl-NumExt-for-f32" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.NumExt.html" title="trait emath::NumExt">NumExt</a> for <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.f32.html">f32</a></h3></section></summary><div class="impl-items"><section id="method.at_least" class="method trait-impl"><a class="src rightside" href="../src/emath/lib.rs.html#330">Source</a><a href="#method.at_least" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.at_least" class="fn">at_least</a>(self, lower_limit: Self) -&gt; Self</h4></section><section id="method.at_most" class="method trait-impl"><a class="src rightside" href="../src/emath/lib.rs.html#330">Source</a><a href="#method.at_most" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.at_most" class="fn">at_most</a>(self, upper_limit: Self) -&gt; Self</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-NumExt-for-f64" class="impl"><a class="src rightside" href="../src/emath/lib.rs.html#331">Source</a><a href="#impl-NumExt-for-f64" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.NumExt.html" title="trait emath::NumExt">NumExt</a> for <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.f64.html">f64</a></h3></section></summary><div class="impl-items"><section id="method.at_least-1" class="method trait-impl"><a class="src rightside" href="../src/emath/lib.rs.html#331">Source</a><a href="#method.at_least-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.at_least" class="fn">at_least</a>(self, lower_limit: Self) -&gt; Self</h4></section><section id="method.at_most-1" class="method trait-impl"><a class="src rightside" href="../src/emath/lib.rs.html#331">Source</a><a href="#method.at_most-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.at_most" class="fn">at_most</a>(self, upper_limit: Self) -&gt; Self</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-NumExt-for-i8" class="impl"><a class="src rightside" href="../src/emath/lib.rs.html#324">Source</a><a href="#impl-NumExt-for-i8" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.NumExt.html" title="trait emath::NumExt">NumExt</a> for <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.i8.html">i8</a></h3></section></summary><div class="impl-items"><section id="method.at_least-2" class="method trait-impl"><a class="src rightside" href="../src/emath/lib.rs.html#324">Source</a><a href="#method.at_least-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.at_least" class="fn">at_least</a>(self, lower_limit: Self) -&gt; Self</h4></section><section id="method.at_most-2" class="method trait-impl"><a class="src rightside" href="../src/emath/lib.rs.html#324">Source</a><a href="#method.at_most-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.at_most" class="fn">at_most</a>(self, upper_limit: Self) -&gt; Self</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-NumExt-for-i16" class="impl"><a class="src rightside" href="../src/emath/lib.rs.html#325">Source</a><a href="#impl-NumExt-for-i16" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.NumExt.html" title="trait emath::NumExt">NumExt</a> for <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.i16.html">i16</a></h3></section></summary><div class="impl-items"><section id="method.at_least-3" class="method trait-impl"><a class="src rightside" href="../src/emath/lib.rs.html#325">Source</a><a href="#method.at_least-3" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.at_least" class="fn">at_least</a>(self, lower_limit: Self) -&gt; Self</h4></section><section id="method.at_most-3" class="method trait-impl"><a class="src rightside" href="../src/emath/lib.rs.html#325">Source</a><a href="#method.at_most-3" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.at_most" class="fn">at_most</a>(self, upper_limit: Self) -&gt; Self</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-NumExt-for-i32" class="impl"><a class="src rightside" href="../src/emath/lib.rs.html#326">Source</a><a href="#impl-NumExt-for-i32" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.NumExt.html" title="trait emath::NumExt">NumExt</a> for <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.i32.html">i32</a></h3></section></summary><div class="impl-items"><section id="method.at_least-4" class="method trait-impl"><a class="src rightside" href="../src/emath/lib.rs.html#326">Source</a><a href="#method.at_least-4" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.at_least" class="fn">at_least</a>(self, lower_limit: Self) -&gt; Self</h4></section><section id="method.at_most-4" class="method trait-impl"><a class="src rightside" href="../src/emath/lib.rs.html#326">Source</a><a href="#method.at_most-4" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.at_most" class="fn">at_most</a>(self, upper_limit: Self) -&gt; Self</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-NumExt-for-i64" class="impl"><a class="src rightside" href="../src/emath/lib.rs.html#327">Source</a><a href="#impl-NumExt-for-i64" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.NumExt.html" title="trait emath::NumExt">NumExt</a> for <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.i64.html">i64</a></h3></section></summary><div class="impl-items"><section id="method.at_least-5" class="method trait-impl"><a class="src rightside" href="../src/emath/lib.rs.html#327">Source</a><a href="#method.at_least-5" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.at_least" class="fn">at_least</a>(self, lower_limit: Self) -&gt; Self</h4></section><section id="method.at_most-5" class="method trait-impl"><a class="src rightside" href="../src/emath/lib.rs.html#327">Source</a><a href="#method.at_most-5" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.at_most" class="fn">at_most</a>(self, upper_limit: Self) -&gt; Self</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-NumExt-for-i128" class="impl"><a class="src rightside" href="../src/emath/lib.rs.html#328">Source</a><a href="#impl-NumExt-for-i128" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.NumExt.html" title="trait emath::NumExt">NumExt</a> for <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.i128.html">i128</a></h3></section></summary><div class="impl-items"><section id="method.at_least-6" class="method trait-impl"><a class="src rightside" href="../src/emath/lib.rs.html#328">Source</a><a href="#method.at_least-6" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.at_least" class="fn">at_least</a>(self, lower_limit: Self) -&gt; Self</h4></section><section id="method.at_most-6" class="method trait-impl"><a class="src rightside" href="../src/emath/lib.rs.html#328">Source</a><a href="#method.at_most-6" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.at_most" class="fn">at_most</a>(self, upper_limit: Self) -&gt; Self</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-NumExt-for-isize" class="impl"><a class="src rightside" href="../src/emath/lib.rs.html#329">Source</a><a href="#impl-NumExt-for-isize" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.NumExt.html" title="trait emath::NumExt">NumExt</a> for <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.isize.html">isize</a></h3></section></summary><div class="impl-items"><section id="method.at_least-7" class="method trait-impl"><a class="src rightside" href="../src/emath/lib.rs.html#329">Source</a><a href="#method.at_least-7" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.at_least" class="fn">at_least</a>(self, lower_limit: Self) -&gt; Self</h4></section><section id="method.at_most-7" class="method trait-impl"><a class="src rightside" href="../src/emath/lib.rs.html#329">Source</a><a href="#method.at_most-7" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.at_most" class="fn">at_most</a>(self, upper_limit: Self) -&gt; Self</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-NumExt-for-u8" class="impl"><a class="src rightside" href="../src/emath/lib.rs.html#318">Source</a><a href="#impl-NumExt-for-u8" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.NumExt.html" title="trait emath::NumExt">NumExt</a> for <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u8.html">u8</a></h3></section></summary><div class="impl-items"><section id="method.at_least-8" class="method trait-impl"><a class="src rightside" href="../src/emath/lib.rs.html#318">Source</a><a href="#method.at_least-8" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.at_least" class="fn">at_least</a>(self, lower_limit: Self) -&gt; Self</h4></section><section id="method.at_most-8" class="method trait-impl"><a class="src rightside" href="../src/emath/lib.rs.html#318">Source</a><a href="#method.at_most-8" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.at_most" class="fn">at_most</a>(self, upper_limit: Self) -&gt; Self</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-NumExt-for-u16" class="impl"><a class="src rightside" href="../src/emath/lib.rs.html#319">Source</a><a href="#impl-NumExt-for-u16" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.NumExt.html" title="trait emath::NumExt">NumExt</a> for <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u16.html">u16</a></h3></section></summary><div class="impl-items"><section id="method.at_least-9" class="method trait-impl"><a class="src rightside" href="../src/emath/lib.rs.html#319">Source</a><a href="#method.at_least-9" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.at_least" class="fn">at_least</a>(self, lower_limit: Self) -&gt; Self</h4></section><section id="method.at_most-9" class="method trait-impl"><a class="src rightside" href="../src/emath/lib.rs.html#319">Source</a><a href="#method.at_most-9" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.at_most" class="fn">at_most</a>(self, upper_limit: Self) -&gt; Self</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-NumExt-for-u32" class="impl"><a class="src rightside" href="../src/emath/lib.rs.html#320">Source</a><a href="#impl-NumExt-for-u32" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.NumExt.html" title="trait emath::NumExt">NumExt</a> for <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a></h3></section></summary><div class="impl-items"><section id="method.at_least-10" class="method trait-impl"><a class="src rightside" href="../src/emath/lib.rs.html#320">Source</a><a href="#method.at_least-10" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.at_least" class="fn">at_least</a>(self, lower_limit: Self) -&gt; Self</h4></section><section id="method.at_most-10" class="method trait-impl"><a class="src rightside" href="../src/emath/lib.rs.html#320">Source</a><a href="#method.at_most-10" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.at_most" class="fn">at_most</a>(self, upper_limit: Self) -&gt; Self</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-NumExt-for-u64" class="impl"><a class="src rightside" href="../src/emath/lib.rs.html#321">Source</a><a href="#impl-NumExt-for-u64" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.NumExt.html" title="trait emath::NumExt">NumExt</a> for <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u64.html">u64</a></h3></section></summary><div class="impl-items"><section id="method.at_least-11" class="method trait-impl"><a class="src rightside" href="../src/emath/lib.rs.html#321">Source</a><a href="#method.at_least-11" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.at_least" class="fn">at_least</a>(self, lower_limit: Self) -&gt; Self</h4></section><section id="method.at_most-11" class="method trait-impl"><a class="src rightside" href="../src/emath/lib.rs.html#321">Source</a><a href="#method.at_most-11" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.at_most" class="fn">at_most</a>(self, upper_limit: Self) -&gt; Self</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-NumExt-for-u128" class="impl"><a class="src rightside" href="../src/emath/lib.rs.html#322">Source</a><a href="#impl-NumExt-for-u128" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.NumExt.html" title="trait emath::NumExt">NumExt</a> for <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u128.html">u128</a></h3></section></summary><div class="impl-items"><section id="method.at_least-12" class="method trait-impl"><a class="src rightside" href="../src/emath/lib.rs.html#322">Source</a><a href="#method.at_least-12" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.at_least" class="fn">at_least</a>(self, lower_limit: Self) -&gt; Self</h4></section><section id="method.at_most-12" class="method trait-impl"><a class="src rightside" href="../src/emath/lib.rs.html#322">Source</a><a href="#method.at_most-12" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.at_most" class="fn">at_most</a>(self, upper_limit: Self) -&gt; Self</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-NumExt-for-usize" class="impl"><a class="src rightside" href="../src/emath/lib.rs.html#323">Source</a><a href="#impl-NumExt-for-usize" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.NumExt.html" title="trait emath::NumExt">NumExt</a> for <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a></h3></section></summary><div class="impl-items"><section id="method.at_least-13" class="method trait-impl"><a class="src rightside" href="../src/emath/lib.rs.html#323">Source</a><a href="#method.at_least-13" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.at_least" class="fn">at_least</a>(self, lower_limit: Self) -&gt; Self</h4></section><section id="method.at_most-13" class="method trait-impl"><a class="src rightside" href="../src/emath/lib.rs.html#323">Source</a><a href="#method.at_most-13" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.at_most" class="fn">at_most</a>(self, upper_limit: Self) -&gt; Self</h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-NumExt-for-Pos2" class="impl"><a class="src rightside" href="../src/emath/lib.rs.html#333">Source</a><a href="#impl-NumExt-for-Pos2" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.NumExt.html" title="trait emath::NumExt">NumExt</a> for <a class="struct" href="struct.Pos2.html" title="struct emath::Pos2">Pos2</a></h3></section><section id="impl-NumExt-for-Vec2" class="impl"><a class="src rightside" href="../src/emath/lib.rs.html#332">Source</a><a href="#impl-NumExt-for-Vec2" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.NumExt.html" title="trait emath::NumExt">NumExt</a> for <a class="struct" href="struct.Vec2.html" title="struct emath::Vec2">Vec2</a></h3></section></div><script src="../trait.impl/emath/trait.NumExt.js" data-ignore-extern-crates="std" async></script></section></div></main></body></html>