51 lines
9.7 KiB
HTML
51 lines
9.7 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="Trait for floating point numbers that provide an implementation of the `totalOrder` predicate as defined in the IEEE 754 (2008 revision) floating point standard."><title>TotalOrder in num_traits::float - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.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"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.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.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.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]--><rustdoc-topbar><h2><a href="#">TotalOrder</a></h2></rustdoc-topbar><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"><section id="rustdoc-toc"><h2 class="location"><a href="#">Total<wbr>Order</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.total_cmp" title="total_cmp">total_cmp</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-TotalOrder-for-f32" title="f32">f32</a></li><li><a href="#impl-TotalOrder-for-f64" title="f64">f64</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 num_<wbr>traits::<wbr>float</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">num_traits</a>::<wbr><a href="index.html">float</a></div><h1>Trait <span class="trait">Total<wbr>Order</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/float.rs.html#2248-2300">Source</a> </span></div><pre class="rust item-decl"><code>pub trait TotalOrder {
|
||
// Required method
|
||
fn <a href="#tymethod.total_cmp" class="fn">total_cmp</a>(&self, other: &Self) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a>;
|
||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Trait for floating point numbers that provide an implementation
|
||
of the <code>totalOrder</code> predicate as defined in the IEEE 754 (2008 revision)
|
||
floating point standard.</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.total_cmp" class="method"><a class="src rightside" href="../../src/num_traits/float.rs.html#2299">Source</a><h4 class="code-header">fn <a href="#tymethod.total_cmp" class="fn">total_cmp</a>(&self, other: &Self) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a></h4></section></summary><div class="docblock"><p>Return the ordering between <code>self</code> and <code>other</code>.</p>
|
||
<p>Unlike the standard partial comparison between floating point numbers,
|
||
this comparison always produces an ordering in accordance to
|
||
the <code>totalOrder</code> predicate as defined in the IEEE 754 (2008 revision)
|
||
floating point standard. The values are ordered in the following sequence:</p>
|
||
<ul>
|
||
<li>negative quiet NaN</li>
|
||
<li>negative signaling NaN</li>
|
||
<li>negative infinity</li>
|
||
<li>negative numbers</li>
|
||
<li>negative subnormal numbers</li>
|
||
<li>negative zero</li>
|
||
<li>positive zero</li>
|
||
<li>positive subnormal numbers</li>
|
||
<li>positive numbers</li>
|
||
<li>positive infinity</li>
|
||
<li>positive signaling NaN</li>
|
||
<li>positive quiet NaN.</li>
|
||
</ul>
|
||
<p>The ordering established by this function does not always agree with the
|
||
<a href="https://doc.rust-lang.org/1.93.1/core/cmp/trait.PartialOrd.html" title="trait core::cmp::PartialOrd"><code>PartialOrd</code></a> and <a href="https://doc.rust-lang.org/1.93.1/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq"><code>PartialEq</code></a> implementations. For example,
|
||
they consider negative and positive zero equal, while <code>total_cmp</code>
|
||
doesn’t.</p>
|
||
<p>The interpretation of the signaling NaN bit follows the definition in
|
||
the IEEE 754 standard, which may not match the interpretation by some of
|
||
the older, non-conformant (e.g. MIPS) hardware implementations.</p>
|
||
<h5 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>num_traits::float::TotalOrder;
|
||
<span class="kw">use </span>std::cmp::Ordering;
|
||
<span class="kw">use </span>std::{f32, f64};
|
||
|
||
<span class="kw">fn </span>check_eq<T: TotalOrder>(x: T, y: T) {
|
||
<span class="macro">assert_eq!</span>(x.total_cmp(<span class="kw-2">&</span>y), Ordering::Equal);
|
||
}
|
||
|
||
check_eq(f64::NAN, f64::NAN);
|
||
check_eq(f32::NAN, f32::NAN);
|
||
|
||
<span class="kw">fn </span>check_lt<T: TotalOrder>(x: T, y: T) {
|
||
<span class="macro">assert_eq!</span>(x.total_cmp(<span class="kw-2">&</span>y), Ordering::Less);
|
||
}
|
||
|
||
check_lt(-f64::NAN, f64::NAN);
|
||
check_lt(f64::INFINITY, f64::NAN);
|
||
check_lt(-<span class="number">0.0_f64</span>, <span class="number">0.0_f64</span>);</code></pre></div></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.93.1/reference/items/traits.html#dyn-compatibility">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-TotalOrder-for-f32" class="impl"><a class="src rightside" href="../../src/num_traits/float.rs.html#2326">Source</a><a href="#impl-TotalOrder-for-f32" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.TotalOrder.html" title="trait num_traits::float::TotalOrder">TotalOrder</a> for <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.f32.html">f32</a></h3></section></summary><div class="impl-items"><section id="method.total_cmp" class="method trait-impl"><a class="src rightside" href="../../src/num_traits/float.rs.html#2326">Source</a><a href="#method.total_cmp" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.total_cmp" class="fn">total_cmp</a>(&self, other: &Self) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TotalOrder-for-f64" class="impl"><a class="src rightside" href="../../src/num_traits/float.rs.html#2325">Source</a><a href="#impl-TotalOrder-for-f64" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.TotalOrder.html" title="trait num_traits::float::TotalOrder">TotalOrder</a> for <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.f64.html">f64</a></h3></section></summary><div class="impl-items"><section id="method.total_cmp-1" class="method trait-impl"><a class="src rightside" href="../../src/num_traits/float.rs.html#2325">Source</a><a href="#method.total_cmp-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.total_cmp" class="fn">total_cmp</a>(&self, other: &Self) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a></h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../trait.impl/num_traits/float/trait.TotalOrder.js" data-ignore-extern-crates="std" async></script></section></div></main></body></html> |