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

7 lines
17 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="Defines the nearest integer value to the original value."><title>Round in euclid::num - 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="euclid" 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="../../euclid/index.html">euclid</a><span class="version">0.22.11</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Round</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.round" title="round">round</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-Round-for-f32" title="f32">f32</a></li><li><a href="#impl-Round-for-f64" title="f64">f64</a></li><li><a href="#impl-Round-for-i16" title="i16">i16</a></li><li><a href="#impl-Round-for-i32" title="i32">i32</a></li><li><a href="#impl-Round-for-i64" title="i64">i64</a></li><li><a href="#impl-Round-for-isize" title="isize">isize</a></li><li><a href="#impl-Round-for-u16" title="u16">u16</a></li><li><a href="#impl-Round-for-u32" title="u32">u32</a></li><li><a href="#impl-Round-for-u64" title="u64">u64</a></li><li><a href="#impl-Round-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><a href="index.html">In euclid::<wbr>num</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">euclid</a>::<wbr><a href="index.html">num</a></span><h1>Trait <span class="trait">Round</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/euclid/num.rs.html#49-55">Source</a> </span></div><pre class="rust item-decl"><code>pub trait Round: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> {
// Required method
fn <a href="#tymethod.round" class="fn">round</a>(self) -&gt; Self;
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Defines the nearest integer value to the original value.</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.round" class="method"><a class="src rightside" href="../../src/euclid/num.rs.html#54">Source</a><h4 class="code-header">fn <a href="#tymethod.round" class="fn">round</a>(self) -&gt; Self</h4></section></summary><div class="docblock"><p>Rounds to the nearest integer value.</p>
<p>This behavior is preserved for negative values (unlike the basic cast).</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-Round-for-f32" class="impl"><a class="src rightside" href="../../src/euclid/num.rs.html#127">Source</a><a href="#impl-Round-for-f32" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Round.html" title="trait euclid::num::Round">Round</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.round" class="method trait-impl"><a class="src rightside" href="../../src/euclid/num.rs.html#127">Source</a><a href="#method.round" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.round" class="fn">round</a>(self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.f32.html">f32</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Round-for-f64" class="impl"><a class="src rightside" href="../../src/euclid/num.rs.html#128">Source</a><a href="#impl-Round-for-f64" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Round.html" title="trait euclid::num::Round">Round</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.round-1" class="method trait-impl"><a class="src rightside" href="../../src/euclid/num.rs.html#128">Source</a><a href="#method.round-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.round" class="fn">round</a>(self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.f64.html">f64</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Round-for-i16" class="impl"><a class="src rightside" href="../../src/euclid/num.rs.html#119">Source</a><a href="#impl-Round-for-i16" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Round.html" title="trait euclid::num::Round">Round</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.round-2" class="method trait-impl"><a class="src rightside" href="../../src/euclid/num.rs.html#119">Source</a><a href="#method.round-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.round" class="fn">round</a>(self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.i16.html">i16</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Round-for-i32" class="impl"><a class="src rightside" href="../../src/euclid/num.rs.html#121">Source</a><a href="#impl-Round-for-i32" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Round.html" title="trait euclid::num::Round">Round</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.round-3" class="method trait-impl"><a class="src rightside" href="../../src/euclid/num.rs.html#121">Source</a><a href="#method.round-3" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.round" class="fn">round</a>(self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.i32.html">i32</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Round-for-i64" class="impl"><a class="src rightside" href="../../src/euclid/num.rs.html#123">Source</a><a href="#impl-Round-for-i64" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Round.html" title="trait euclid::num::Round">Round</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.round-4" class="method trait-impl"><a class="src rightside" href="../../src/euclid/num.rs.html#123">Source</a><a href="#method.round-4" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.round" class="fn">round</a>(self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.i64.html">i64</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Round-for-isize" class="impl"><a class="src rightside" href="../../src/euclid/num.rs.html#125">Source</a><a href="#impl-Round-for-isize" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Round.html" title="trait euclid::num::Round">Round</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.round-5" class="method trait-impl"><a class="src rightside" href="../../src/euclid/num.rs.html#125">Source</a><a href="#method.round-5" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.round" class="fn">round</a>(self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.isize.html">isize</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Round-for-u16" class="impl"><a class="src rightside" href="../../src/euclid/num.rs.html#120">Source</a><a href="#impl-Round-for-u16" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Round.html" title="trait euclid::num::Round">Round</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.round-6" class="method trait-impl"><a class="src rightside" href="../../src/euclid/num.rs.html#120">Source</a><a href="#method.round-6" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.round" class="fn">round</a>(self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u16.html">u16</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Round-for-u32" class="impl"><a class="src rightside" href="../../src/euclid/num.rs.html#122">Source</a><a href="#impl-Round-for-u32" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Round.html" title="trait euclid::num::Round">Round</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.round-7" class="method trait-impl"><a class="src rightside" href="../../src/euclid/num.rs.html#122">Source</a><a href="#method.round-7" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.round" class="fn">round</a>(self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Round-for-u64" class="impl"><a class="src rightside" href="../../src/euclid/num.rs.html#124">Source</a><a href="#impl-Round-for-u64" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Round.html" title="trait euclid::num::Round">Round</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.round-8" class="method trait-impl"><a class="src rightside" href="../../src/euclid/num.rs.html#124">Source</a><a href="#method.round-8" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.round" class="fn">round</a>(self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u64.html">u64</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Round-for-usize" class="impl"><a class="src rightside" href="../../src/euclid/num.rs.html#126">Source</a><a href="#impl-Round-for-usize" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Round.html" title="trait euclid::num::Round">Round</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.round-9" class="method trait-impl"><a class="src rightside" href="../../src/euclid/num.rs.html#126">Source</a><a href="#method.round-9" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.round" class="fn">round</a>(self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a></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-Round-for-Point2D%3CT,+U%3E" class="impl"><a class="src rightside" href="../../src/euclid/point.rs.html#712-718">Source</a><a href="#impl-Round-for-Point2D%3CT,+U%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T: <a class="trait" href="trait.Round.html" title="trait euclid::num::Round">Round</a>, U&gt; <a class="trait" href="trait.Round.html" title="trait euclid::num::Round">Round</a> for <a class="struct" href="../struct.Point2D.html" title="struct euclid::Point2D">Point2D</a>&lt;T, U&gt;</h3></section><section id="impl-Round-for-Point3D%3CT,+U%3E" class="impl"><a class="src rightside" href="../../src/euclid/point.rs.html#1553-1559">Source</a><a href="#impl-Round-for-Point3D%3CT,+U%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T: <a class="trait" href="trait.Round.html" title="trait euclid::num::Round">Round</a>, U&gt; <a class="trait" href="trait.Round.html" title="trait euclid::num::Round">Round</a> for <a class="struct" href="../struct.Point3D.html" title="struct euclid::Point3D">Point3D</a>&lt;T, U&gt;</h3></section><section id="impl-Round-for-Size2D%3CT,+U%3E" class="impl"><a class="src rightside" href="../../src/euclid/size.rs.html#504-510">Source</a><a href="#impl-Round-for-Size2D%3CT,+U%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T: <a class="trait" href="trait.Round.html" title="trait euclid::num::Round">Round</a>, U&gt; <a class="trait" href="trait.Round.html" title="trait euclid::num::Round">Round</a> for <a class="struct" href="../struct.Size2D.html" title="struct euclid::Size2D">Size2D</a>&lt;T, U&gt;</h3></section><section id="impl-Round-for-Size3D%3CT,+U%3E" class="impl"><a class="src rightside" href="../../src/euclid/size.rs.html#1424-1430">Source</a><a href="#impl-Round-for-Size3D%3CT,+U%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T: <a class="trait" href="trait.Round.html" title="trait euclid::num::Round">Round</a>, U&gt; <a class="trait" href="trait.Round.html" title="trait euclid::num::Round">Round</a> for <a class="struct" href="../struct.Size3D.html" title="struct euclid::Size3D">Size3D</a>&lt;T, U&gt;</h3></section><section id="impl-Round-for-Vector2D%3CT,+U%3E" class="impl"><a class="src rightside" href="../../src/euclid/vector.rs.html#877-883">Source</a><a href="#impl-Round-for-Vector2D%3CT,+U%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T: <a class="trait" href="trait.Round.html" title="trait euclid::num::Round">Round</a>, U&gt; <a class="trait" href="trait.Round.html" title="trait euclid::num::Round">Round</a> for <a class="struct" href="../struct.Vector2D.html" title="struct euclid::Vector2D">Vector2D</a>&lt;T, U&gt;</h3></section><section id="impl-Round-for-Vector3D%3CT,+U%3E" class="impl"><a class="src rightside" href="../../src/euclid/vector.rs.html#1804-1810">Source</a><a href="#impl-Round-for-Vector3D%3CT,+U%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T: <a class="trait" href="trait.Round.html" title="trait euclid::num::Round">Round</a>, U&gt; <a class="trait" href="trait.Round.html" title="trait euclid::num::Round">Round</a> for <a class="struct" href="../struct.Vector3D.html" title="struct euclid::Vector3D">Vector3D</a>&lt;T, U&gt;</h3></section></div><script src="../../trait.impl/euclid/num/trait.Round.js" data-ignore-extern-crates="std" async></script></section></div></main></body></html>