|
|
|
|
|
<!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="API documentation for the Rust `RelativeEq` trait in crate `cgmath`."><meta name="keywords" content="rust, rustlang, rust-lang, RelativeEq"><title>cgmath::RelativeEq - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../cgmath/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Trait RelativeEq</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.default_max_relative">default_max_relative</a><a href="#tymethod.relative_eq">relative_eq</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.relative_ne">relative_ne</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-RelativeEq%3C%26%27a%20T%3E-for-%26%27a%20T">&'a T</a><a href="#impl-RelativeEq%3C%26%27a%20mut%20T%3E-for-%26%27a%20mut%20T">&'a mut T</a><a href="#impl-RelativeEq%3C%5BB%5D%3E-for-%5BA%5D">[A]</a><a href="#impl-RelativeEq%3CCell%3CT%3E%3E-for-Cell%3CT%3E">Cell<T></a><a href="#impl-RelativeEq%3CRefCell%3CT%3E%3E-for-RefCell%3CT%3E">RefCell<T></a><a href="#impl-RelativeEq%3Cf32%3E-for-f32">f32</a><a href="#impl-RelativeEq%3Cf64%3E-for-f64">f64</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>cgmath</a></p><script>window.sidebarCurrent = {name: 'RelativeEq', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../src/approx/relative_eq.rs.html#11-37' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='index.html'>cgmath</a>::<wbr><a class="trait" href=''>RelativeEq</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait RelativeEq<Rhs = Self>: <a class="trait" href="../cgmath/trait.AbsDiffEq.html" title="trait cgmath::AbsDiffEq">AbsDiffEq</a><Rhs> <span class="where fmt-newline">where<br> Rhs: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/t
|
|
|
|
|
|
fn <a href='#tymethod.default_max_relative' class='fnname'>default_max_relative</a>() -> Self::<a class="type" href="../cgmath/trait.AbsDiffEq.html#associatedtype.Epsilon" title="type cgmath::AbsDiffEq::Epsilon">Epsilon</a>;
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.relative_eq' class='fnname'>relative_eq</a>(<br> &self, <br> other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs, <br> epsilon: Self::<a class="type" href="../cgmath/trait.AbsDiffEq.html#associatedtype.Epsilon" title="type cgmath::AbsDiffEq::Epsilon">Epsilon</a>, <br> max_relative: Self::<a class="type" href="../cgmath/trait.AbsDiffEq.html#associatedtype.Epsilon" title="type cgmath::AbsDiffEq::Epsilon">Epsilon</a><br> ) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>;
|
|
|
|
|
|
|
|
|
|
|
|
fn <a href='#method.relative_ne' class='fnname'>relative_ne</a>(<br> &self, <br> other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs, <br> epsilon: Self::<a class="type" href="../cgmath/trait.AbsDiffEq.html#associatedtype.Epsilon" title="type cgmath::AbsDiffEq::Epsilon">Epsilon</a>, <br> max_relative: Self::<a class="type" href="../cgmath/trait.AbsDiffEq.html#associatedtype.Epsilon" title="type cgmath::AbsDiffEq::Epsilon">Epsilon</a><br> ) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> { ... }
|
|
|
|
|
|
}</pre></div><div class='docblock'><p>Equality comparisons between two numbers using both the absolute difference and
|
|
|
|
|
|
relative based comparisons.</p>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.default_max_relative' class='method'><code id='default_max_relative.v'>fn <a href='#tymethod.default_max_relative' class='fnname'>default_max_relative</a>() -> Self::<a class="type" href="../cgmath/trait.AbsDiffEq.html#associatedtype.Epsilon" title="type cgmath::AbsDiffEq::Epsilon">Epsilon</a></code></h3><div class='docblock'><p>The default relative tolerance for testing values that are far-apart.</p>
|
|
|
|
|
|
<p>This is used when no <code>max_relative</code> value is supplied to the <code>relative_eq</code> macro.</p>
|
|
|
|
|
|
</div><h3 id='tymethod.relative_eq' class='method'><code id='relative_eq.v'>fn <a href='#tymethod.relative_eq' class='fnname'>relative_eq</a>(<br> &self, <br> other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs, <br> epsilon: Self::<a class="type" href="../cgmath/trait.AbsDiffEq.html#associatedtype.Epsilon" title="type cgmath::AbsDiffEq::Epsilon">Epsilon</a>, <br> max_relative: Self::<a class="type" href="../cgmath/trait.AbsDiffEq.html#associatedtype.Epsilon" title="type cgmath::AbsDiffEq::Epsilon">Epsilon</a><br>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h3><div class='docblock'><p>A test for equality that uses a relative comparison if the values are far apart.</p>
|
|
|
|
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|
|
|
|
|
<h2 id='provided-methods' class='small-section-header'>Provided methods<a href='#provided-methods' class='anchor'></a></h2><div class='methods'><h3 id='method.relative_ne' class='method'><code id='relative_ne.v'>fn <a href='#method.relative_ne' class='fnname'>relative_ne</a>(<br> &self, <br> other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs, <br> epsilon: Self::<a class="type" href="../cgmath/trait.AbsDiffEq.html#associatedtype.Epsilon" title="type cgmath::AbsDiffEq::Epsilon">Epsilon</a>, <br> max_relative: Self::<a class="type" href="../cgmath/trait.AbsDiffEq.html#associatedtype.Epsilon" title="type cgmath::AbsDiffEq::Epsilon">Epsilon</a><br>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h3><div class='docblock'><p>The inverse of <code>ApproxEq::relative_eq</code>.</p>
|
|
|
|
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|
|
|
|
|
<h2 id='foreign-impls' class='small-section-header'>Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a></h2><h3 id='impl-RelativeEq%3C%5BB%5D%3E-for-%5BA%5D' class='impl'><code class='in-band'>impl<A, B> <a class="trait" href="../cgmath/trait.RelativeEq.html" title="trait cgmath::RelativeEq">RelativeEq</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[</a>B<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[</a>A<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a> <span class="where fmt-newline">where<br> A: <a class="trait" href="../cgmath/trait.RelativeEq.html" title="trait cgmath::RelativeEq">RelativeEq</a><B>,<br> <A as <a class="trait" href="../cgmath/trait.AbsDiffEq.html" title="trait cgmath::AbsDiffEq">AbsDiffEq</a><B>>::<a class="type" href="../cgmath/trait.AbsDiffEq.html#associatedtype.Epsilon" title="type cgmath::AbsDiffEq::Epsilon">Epsilon</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, </span></code><a href='#impl-RelativeEq%3C%5BB%5D%3E-for-%5BA%5D' class='anchor'></a><a class='srclink' href='../src/approx/relative_eq.rs.html#158-174' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.default_max_relative' class="method hidden"><code id='default_max_relative.v-1'>fn <a href='#method.default_max_relative' class='fnname'>default_max_relative</a>() -> <A as <a class="trait" href="../cgmath/trait.AbsDiffEq.html" title="trait cgmath::AbsDiffEq">AbsDiffEq</a><B>>::<a class="type" href="../cgmath/trait.AbsDiffEq.html#associatedtype.Epsilon" title="type cgmath::AbsDiffEq::Epsilon">Epsilon</a></code><a class='srclink' href='../src/approx/relative_eq.rs.html#164-166' title='goto source code'>[src]</a></h4><h4 id='method.relative_eq' class="method hidden"><code id='relative_eq.v-1'>fn <a href='#method.relative_eq' class='fnname'>relative_eq</a>(<br> &self, <br> other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[B]</a>, <br> epsilon: <A as <a class="trait" href="../cgmath/trait.AbsDiffEq.html" title="trait cgmath::AbsDiffEq">AbsDiffEq</a><B>>::<a class="type" href="../cgmath/trait.AbsDiffEq.html#associatedtype.Epsilon" title="type cgmath::AbsDiffEq::Epsilon">Epsilon</a>, <br> max_relative: <A as <a class="trait" href="../cgmath/trait.AbsDiffEq.html" title="trait cgmath::AbsDiffEq">AbsDiffEq</a><B>>::<a class="type" href="../cgmath/trait.AbsDiffEq.html#associatedtype.Epsilon" title="type cgmath::AbsDiffEq::Epsilon">Epsilon</a><br>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../src/approx/relative_eq.rs.html#169-173' title='goto source code'>[src]</a></h4></div><h3 id='impl-RelativeEq%3C%26%27a%20T%3E-for-%26%27a%20T' class='impl'><code class='in-band'>impl<'a, T> <a class="trait" href="../cgmath/trait.RelativeEq.html" title="trait cgmath::RelativeEq">RelativeEq</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a </a>T> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a </a>T <span class="where fmt-newline">where<br> T: <a class="trait" href="../cgmath/trait.RelativeEq.html" title="trait cgmath::RelativeEq">RelativeEq</a><T> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-RelativeEq%3C%26%27a%20T%3E-for-%26%27a%20T' class='anchor'></a><a class='srclink'
|
|
|
|
|
|
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'><h3 id='impl-RelativeEq%3CEuler%3CA%3E%3E' class='impl'><code class='in-band'>impl<A: <a class="trait" href="../cgmath/prelude/trait.Angle.html" title="trait cgmath::prelude::Angle">Angle</a>> RelativeEq<<a class="struct" href="../cgmath/struct.Euler.html" title="struct cgmath::Euler">Euler</a><A>> for <a class="struct" href="../cgmath/struct.Euler.html" title="struct cgmath::Euler">Euler</a><A></code><a href='#impl-RelativeEq%3CEuler%3CA%3E%3E' class='anchor'></a><a class='srclink' href='../src/cgmath/euler.rs.html#161-173' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.default_max_relative-7' class="method hidden"><code id='default_max_relative.v-8'>fn <a href='#method.default_max_relative-7' class='fnname'>default_max_relative</a>() -> A::<a class="type" href="../cgmath/trait.AbsDiffEq.html#associatedtype.Epsilon" title="type cgmath::AbsDiffEq::Epsilon">Epsilon</a></code><a class='srclink' href='../src/cgmath/euler.rs.html#163-165' title='goto source code'>[src]</a></h4><h4 id='method.relative_eq-7' class="method hidden"><code id='relative_eq.v-8'>fn <a href='#method.relative_eq-7' class='fnname'>relative_eq</a>(<br> &self, <br> other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self, <br> epsilon: A::<a class="type" href="../cgmath/trait.AbsDiffEq.html#associatedtype.Epsilon" title="type cgmath::AbsDiffEq::Epsilon">Epsilon</a>, <br> max_relative: A::<a class="type" href="../cgmath/trait.AbsDiffEq.html#associatedtype.Epsilon" title="type cgmath::AbsDiffEq::Epsilon">Epsilon</a><br>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../src/cgmath/euler.rs.html#168-172' title='goto source code'>[src]</a></h4></div><h3 id='impl-RelativeEq%3CDecomposed%3CS%2C%20R%3E%3E' class='impl'><code class='in-band'>impl<S: <a class="trait" href="../cgmath/prelude/trait.VectorSpace.html" title="trait cgmath::prelude::VectorSpace">VectorSpace</a>, R, E: <a class="trait" href="../cgmath/trait.BaseFloat.html" title="trait cgmath::BaseFloat">BaseFloat</a>> RelativeEq<<a class="struct" href="../cgmath/struct.Decomposed.html" title="struct cgmath::Decomposed">Decomposed</a><S, R>> for <a class="struct" href="../cgmath/struct.Decomposed.html" title="struct cgmath::Decomposed">Decomposed</a><S, R> <span class="where fmt-newline">where<br> S: <a class="trait" href="../cgmath/trait.RelativeEq.html" title="trait cgmath::RelativeEq">RelativeEq</a><Epsilon = E>,<br> S::<a class="type" href="../cgmath/prelude/trait.VectorSpace.html#associatedtype.Scalar" title="type cgmath::prelude::VectorSpace::Scalar">Scalar</a>: <a class="trait" href="../cgmath/trait.RelativeEq.html" title="trait cgmath::RelativeEq">RelativeEq</a><Epsilon = E>,<br> R: <a class="trait" href="../cgmath/trait.RelativeEq.html" title="trait cgmath::RelativeEq">RelativeEq</a><Epsilon = E>, </span></code><a href='#impl-RelativeEq%3CDecomposed%3CS%2C%20R%3E%3E' class='anchor'></a><a class='srclink' href='../src/cgmath/transform.rs.html#187-204' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.default_max_relative-8' class="method hidden"><code id='default_max_relative.v-9'>fn <a href='#method.default_max_relative-8' class='fnname'>default_max_relative</a>() -> E</code><a class='srclink' href='../src/cgmath/transform.rs.html#194-196' title='goto source code'>[src]</a></h4><h4 id='method.relative_eq-8' class="method hidden"><code id='relative_eq.v-9'>fn <a href='#method.relative_eq-8' class='fnname'>relative_eq</a>(&self, other: <a class="primitive" href="https://doc.rust
|
|
|
|
|
|
src="../implementors/approx/relative_eq/trait.RelativeEq.js">
|
|
|
|
|
|
</script></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "cgmath";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
|
