| <!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="Floating point types for which two instances can be compared for Unit in the Last Place (ULP) difference."><meta name="keywords" content="rust, rustlang, rust-lang, Ulp"><title>Ulp in rulinalg::ulp - 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="sidebar-items.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 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">☰</button><a class="sidebar-logo" href="../../rulinalg/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="../../rulinalg/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Ulp</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.ulp_diff">ulp_diff</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-Ulp-for-f32">f32</a></li><li><a href="#impl-Ulp-for-f64">f64</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In rulinalg::ulp</a></h2></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">Trait <a href="../index.html">rulinalg</a>::<wbr><a href="index.html">ulp</a>::<wbr><a class="trait" href="#">Ulp</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/rulinalg/ulp.rs.html#36-39">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust trait"><code>pub trait Ulp { |
| fn <a href="#tymethod.ulp_diff" class="fnname">ulp_diff</a>(a: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self, b: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self) -> <a class="enum" href="enum.UlpComparisonResult.html" title="enum rulinalg::ulp::UlpComparisonResult">UlpComparisonResult</a>; |
| }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Floating point types for which two instances can be compared for Unit in the Last Place (ULP) difference.</p> |
| <p>Implementing this trait enables the usage of the <code>ulp</code> comparator in |
| <a href="../macro.assert_matrix_eq!.html">assert_matrix_eq!</a> for the given type.</p> |
| <p>The definition here leverages the fact that for two adjacent floating point numbers, |
| their integer representations are also adjacent.</p> |
| <p>A somewhat accessible (but not exhaustive) guide on the topic is available in the popular article |
| [Comparing Floating Point Numbers, 2012 Edition] |
| (https://randomascii.wordpress.com/2012/02/25/comparing-floating-point-numbers-2012-edition/).</p> |
| <p>Implementations for <code>f32</code> and <code>f64</code> are already available, and so users should not normally |
| need to implement this. In the case when a custom implementation is necessary, |
| please see the possible return values for <a href="ulp/enum.UlpComparisonResult.html">UlpComparisonResult</a>. |
| Otherwise, we can recommend to read the source code of the included <code>f32</code> and <code>f64</code> implementations.</p> |
| </div></details><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.ulp_diff" class="method has-srclink"><a class="srclink rightside" href="../../src/rulinalg/ulp.rs.html#38">source</a><h4 class="code-header">fn <a href="#tymethod.ulp_diff" class="fnname">ulp_diff</a>(a: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self, b: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self) -> <a class="enum" href="enum.UlpComparisonResult.html" title="enum rulinalg::ulp::UlpComparisonResult">UlpComparisonResult</a></h4></section></summary><div class="docblock"><p>Returns the difference between two floating point numbers, measured in ULP.</p> |
| </div></details></div><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Ulp-for-f32" class="impl has-srclink"><a class="srclink rightside" href="../../src/rulinalg/ulp.rs.html#64">source</a><a href="#impl-Ulp-for-f32" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.Ulp.html" title="trait rulinalg::ulp::Ulp">Ulp</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a></h3></section></summary><div class="impl-items"><section id="method.ulp_diff" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/rulinalg/ulp.rs.html#64">source</a><a href="#method.ulp_diff" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.ulp_diff" class="fnname">ulp_diff</a>(a: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self, b: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self) -> <a class="enum" href="enum.UlpComparisonResult.html" title="enum rulinalg::ulp::UlpComparisonResult">UlpComparisonResult</a></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Ulp-for-f64" class="impl has-srclink"><a class="srclink rightside" href="../../src/rulinalg/ulp.rs.html#65">source</a><a href="#impl-Ulp-for-f64" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.Ulp.html" title="trait rulinalg::ulp::Ulp">Ulp</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a></h3></section></summary><div class="impl-items"><section id="method.ulp_diff-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/rulinalg/ulp.rs.html#65">source</a><a href="#method.ulp_diff-1" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.ulp_diff" class="fnname">ulp_diff</a>(a: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self, b: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self) -> <a class="enum" href="enum.UlpComparisonResult.html" title="enum rulinalg::ulp::UlpComparisonResult">UlpComparisonResult</a></h4></section></div></details><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"></div><script src="../../implementors/rulinalg/ulp/trait.Ulp.js" data-ignore-extern-crates="std" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rulinalg" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
