| <!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="Source of the Rust file `/root/.cargo/git/checkouts/rulinalg-309246e5a94bf5cf/1ed8b93/src/macros/comparison.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>comparison.rs - source</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="../../../source-script.js"></script><script defer src="../../../source-files.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 source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><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></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../rulinalg/index.html"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></a><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="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| <span id="98">98</span> |
| <span id="99">99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| <span id="117">117</span> |
| <span id="118">118</span> |
| <span id="119">119</span> |
| <span id="120">120</span> |
| <span id="121">121</span> |
| <span id="122">122</span> |
| <span id="123">123</span> |
| <span id="124">124</span> |
| <span id="125">125</span> |
| <span id="126">126</span> |
| <span id="127">127</span> |
| <span id="128">128</span> |
| <span id="129">129</span> |
| <span id="130">130</span> |
| <span id="131">131</span> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| <span id="136">136</span> |
| <span id="137">137</span> |
| <span id="138">138</span> |
| <span id="139">139</span> |
| <span id="140">140</span> |
| <span id="141">141</span> |
| <span id="142">142</span> |
| <span id="143">143</span> |
| <span id="144">144</span> |
| <span id="145">145</span> |
| <span id="146">146</span> |
| <span id="147">147</span> |
| <span id="148">148</span> |
| <span id="149">149</span> |
| <span id="150">150</span> |
| <span id="151">151</span> |
| <span id="152">152</span> |
| <span id="153">153</span> |
| <span id="154">154</span> |
| <span id="155">155</span> |
| <span id="156">156</span> |
| <span id="157">157</span> |
| <span id="158">158</span> |
| <span id="159">159</span> |
| <span id="160">160</span> |
| <span id="161">161</span> |
| <span id="162">162</span> |
| <span id="163">163</span> |
| <span id="164">164</span> |
| <span id="165">165</span> |
| <span id="166">166</span> |
| <span id="167">167</span> |
| <span id="168">168</span> |
| <span id="169">169</span> |
| <span id="170">170</span> |
| <span id="171">171</span> |
| <span id="172">172</span> |
| <span id="173">173</span> |
| <span id="174">174</span> |
| <span id="175">175</span> |
| <span id="176">176</span> |
| <span id="177">177</span> |
| <span id="178">178</span> |
| <span id="179">179</span> |
| <span id="180">180</span> |
| <span id="181">181</span> |
| <span id="182">182</span> |
| <span id="183">183</span> |
| <span id="184">184</span> |
| <span id="185">185</span> |
| <span id="186">186</span> |
| <span id="187">187</span> |
| <span id="188">188</span> |
| <span id="189">189</span> |
| <span id="190">190</span> |
| <span id="191">191</span> |
| <span id="192">192</span> |
| <span id="193">193</span> |
| <span id="194">194</span> |
| <span id="195">195</span> |
| <span id="196">196</span> |
| <span id="197">197</span> |
| <span id="198">198</span> |
| <span id="199">199</span> |
| <span id="200">200</span> |
| <span id="201">201</span> |
| <span id="202">202</span> |
| <span id="203">203</span> |
| <span id="204">204</span> |
| <span id="205">205</span> |
| <span id="206">206</span> |
| <span id="207">207</span> |
| <span id="208">208</span> |
| <span id="209">209</span> |
| <span id="210">210</span> |
| <span id="211">211</span> |
| <span id="212">212</span> |
| <span id="213">213</span> |
| <span id="214">214</span> |
| <span id="215">215</span> |
| <span id="216">216</span> |
| <span id="217">217</span> |
| <span id="218">218</span> |
| <span id="219">219</span> |
| <span id="220">220</span> |
| <span id="221">221</span> |
| <span id="222">222</span> |
| <span id="223">223</span> |
| <span id="224">224</span> |
| <span id="225">225</span> |
| <span id="226">226</span> |
| <span id="227">227</span> |
| <span id="228">228</span> |
| <span id="229">229</span> |
| <span id="230">230</span> |
| <span id="231">231</span> |
| <span id="232">232</span> |
| <span id="233">233</span> |
| <span id="234">234</span> |
| <span id="235">235</span> |
| <span id="236">236</span> |
| <span id="237">237</span> |
| <span id="238">238</span> |
| <span id="239">239</span> |
| <span id="240">240</span> |
| <span id="241">241</span> |
| <span id="242">242</span> |
| <span id="243">243</span> |
| <span id="244">244</span> |
| <span id="245">245</span> |
| <span id="246">246</span> |
| <span id="247">247</span> |
| <span id="248">248</span> |
| <span id="249">249</span> |
| <span id="250">250</span> |
| <span id="251">251</span> |
| <span id="252">252</span> |
| <span id="253">253</span> |
| <span id="254">254</span> |
| <span id="255">255</span> |
| <span id="256">256</span> |
| <span id="257">257</span> |
| <span id="258">258</span> |
| <span id="259">259</span> |
| <span id="260">260</span> |
| <span id="261">261</span> |
| <span id="262">262</span> |
| <span id="263">263</span> |
| <span id="264">264</span> |
| <span id="265">265</span> |
| <span id="266">266</span> |
| <span id="267">267</span> |
| <span id="268">268</span> |
| <span id="269">269</span> |
| <span id="270">270</span> |
| <span id="271">271</span> |
| <span id="272">272</span> |
| <span id="273">273</span> |
| <span id="274">274</span> |
| <span id="275">275</span> |
| <span id="276">276</span> |
| <span id="277">277</span> |
| <span id="278">278</span> |
| <span id="279">279</span> |
| <span id="280">280</span> |
| <span id="281">281</span> |
| <span id="282">282</span> |
| <span id="283">283</span> |
| <span id="284">284</span> |
| <span id="285">285</span> |
| <span id="286">286</span> |
| <span id="287">287</span> |
| <span id="288">288</span> |
| <span id="289">289</span> |
| <span id="290">290</span> |
| <span id="291">291</span> |
| <span id="292">292</span> |
| <span id="293">293</span> |
| <span id="294">294</span> |
| <span id="295">295</span> |
| <span id="296">296</span> |
| <span id="297">297</span> |
| <span id="298">298</span> |
| <span id="299">299</span> |
| <span id="300">300</span> |
| <span id="301">301</span> |
| <span id="302">302</span> |
| <span id="303">303</span> |
| <span id="304">304</span> |
| <span id="305">305</span> |
| <span id="306">306</span> |
| <span id="307">307</span> |
| <span id="308">308</span> |
| <span id="309">309</span> |
| <span id="310">310</span> |
| <span id="311">311</span> |
| <span id="312">312</span> |
| <span id="313">313</span> |
| <span id="314">314</span> |
| <span id="315">315</span> |
| <span id="316">316</span> |
| <span id="317">317</span> |
| <span id="318">318</span> |
| <span id="319">319</span> |
| <span id="320">320</span> |
| <span id="321">321</span> |
| <span id="322">322</span> |
| <span id="323">323</span> |
| <span id="324">324</span> |
| <span id="325">325</span> |
| <span id="326">326</span> |
| <span id="327">327</span> |
| <span id="328">328</span> |
| <span id="329">329</span> |
| <span id="330">330</span> |
| <span id="331">331</span> |
| <span id="332">332</span> |
| <span id="333">333</span> |
| <span id="334">334</span> |
| <span id="335">335</span> |
| <span id="336">336</span> |
| <span id="337">337</span> |
| <span id="338">338</span> |
| <span id="339">339</span> |
| <span id="340">340</span> |
| <span id="341">341</span> |
| <span id="342">342</span> |
| <span id="343">343</span> |
| <span id="344">344</span> |
| <span id="345">345</span> |
| <span id="346">346</span> |
| <span id="347">347</span> |
| <span id="348">348</span> |
| <span id="349">349</span> |
| <span id="350">350</span> |
| <span id="351">351</span> |
| <span id="352">352</span> |
| <span id="353">353</span> |
| <span id="354">354</span> |
| <span id="355">355</span> |
| <span id="356">356</span> |
| <span id="357">357</span> |
| <span id="358">358</span> |
| <span id="359">359</span> |
| <span id="360">360</span> |
| <span id="361">361</span> |
| <span id="362">362</span> |
| <span id="363">363</span> |
| <span id="364">364</span> |
| <span id="365">365</span> |
| <span id="366">366</span> |
| <span id="367">367</span> |
| <span id="368">368</span> |
| <span id="369">369</span> |
| <span id="370">370</span> |
| <span id="371">371</span> |
| <span id="372">372</span> |
| <span id="373">373</span> |
| <span id="374">374</span> |
| <span id="375">375</span> |
| <span id="376">376</span> |
| <span id="377">377</span> |
| <span id="378">378</span> |
| <span id="379">379</span> |
| <span id="380">380</span> |
| <span id="381">381</span> |
| <span id="382">382</span> |
| <span id="383">383</span> |
| <span id="384">384</span> |
| <span id="385">385</span> |
| <span id="386">386</span> |
| <span id="387">387</span> |
| <span id="388">388</span> |
| <span id="389">389</span> |
| <span id="390">390</span> |
| <span id="391">391</span> |
| <span id="392">392</span> |
| <span id="393">393</span> |
| <span id="394">394</span> |
| <span id="395">395</span> |
| <span id="396">396</span> |
| <span id="397">397</span> |
| <span id="398">398</span> |
| <span id="399">399</span> |
| <span id="400">400</span> |
| <span id="401">401</span> |
| <span id="402">402</span> |
| <span id="403">403</span> |
| <span id="404">404</span> |
| <span id="405">405</span> |
| <span id="406">406</span> |
| <span id="407">407</span> |
| <span id="408">408</span> |
| <span id="409">409</span> |
| <span id="410">410</span> |
| <span id="411">411</span> |
| <span id="412">412</span> |
| <span id="413">413</span> |
| <span id="414">414</span> |
| <span id="415">415</span> |
| <span id="416">416</span> |
| <span id="417">417</span> |
| <span id="418">418</span> |
| <span id="419">419</span> |
| <span id="420">420</span> |
| <span id="421">421</span> |
| <span id="422">422</span> |
| <span id="423">423</span> |
| <span id="424">424</span> |
| <span id="425">425</span> |
| </pre><pre class="rust"><code><span class="kw">use </span>ulp; |
| <span class="kw">use </span>ulp::Ulp; |
| |
| <span class="kw">use </span>libnum::{Num, Float}; |
| |
| <span class="kw">use </span>std::fmt; |
| |
| <span class="doccomment">/// Trait that describes elementwise comparators for [assert_matrix_eq!](../macro.assert_matrix_eq!.html). |
| /// |
| /// Usually you should not need to interface with this trait directly. It is a part of the documentation |
| /// only so that the trait bounds for the comparators are made public. |
| </span><span class="kw">pub trait </span>ElementwiseComparator<T, E> <span class="kw">where </span>T: Copy, E: ComparisonFailure { |
| <span class="doccomment">/// Compares two elements. |
| /// |
| /// Returns the error associated with the comparison if it failed. |
| </span><span class="kw">fn </span>compare(<span class="kw-2">&</span><span class="self">self</span>, x: T, y: T) -> <span class="prelude-ty">Result</span><(), E>; |
| |
| <span class="doccomment">/// A description of the comparator. |
| </span><span class="kw">fn </span>description(<span class="kw-2">&</span><span class="self">self</span>) -> String; |
| } |
| |
| <span class="attribute">#[doc(hidden)] |
| </span><span class="kw">pub trait </span>ComparisonFailure { |
| <span class="kw">fn </span>failure_reason(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><String>; |
| } |
| |
| <span class="attribute">#[doc(hidden)] |
| #[derive(Copy, Clone, Debug, PartialEq)] |
| </span><span class="kw">pub struct </span>AbsoluteError<T>(<span class="kw">pub </span>T); |
| |
| <span class="doccomment">/// The `abs` comparator used with [assert_matrix_eq!](../macro.assert_matrix_eq!.html). |
| </span><span class="attribute">#[derive(Copy, Clone, Debug, PartialEq)] |
| </span><span class="kw">pub struct </span>AbsoluteElementwiseComparator<T> { |
| <span class="doccomment">/// The maximum absolute difference tolerated (inclusive). |
| </span><span class="kw">pub </span>tol: T |
| } |
| |
| <span class="kw">impl</span><T> ComparisonFailure <span class="kw">for </span>AbsoluteError<T> <span class="kw">where </span>T: fmt::Display { |
| <span class="kw">fn </span>failure_reason(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><String> { |
| <span class="prelude-val">Some</span>( |
| <span class="macro">format!</span>(<span class="string">"Absolute error: {error}."</span>, error = <span class="self">self</span>.<span class="number">0</span>) |
| ) |
| } |
| } |
| |
| <span class="kw">impl</span><T> ElementwiseComparator<T, AbsoluteError<T>> <span class="kw">for </span>AbsoluteElementwiseComparator<T> |
| <span class="kw">where </span>T: Copy + fmt::Display + Num + PartialOrd<T> { |
| |
| <span class="kw">fn </span>compare(<span class="kw-2">&</span><span class="self">self</span>, a: T, b: T) -> <span class="prelude-ty">Result</span><(), AbsoluteError<T>> { |
| <span class="macro">assert!</span>(<span class="self">self</span>.tol >= T::zero()); |
| |
| <span class="comment">// Note: Cannot use num::abs because we do not want to restrict |
| // ourselves to Signed types (i.e. we still want to be able to |
| // handle unsigned types). |
| |
| </span><span class="kw">if </span>a == b { |
| <span class="prelude-val">Ok</span>(()) |
| } <span class="kw">else </span>{ |
| <span class="kw">let </span>distance = <span class="kw">if </span>a > b { a - b } <span class="kw">else </span>{ b - a }; |
| <span class="kw">if </span>distance <= <span class="self">self</span>.tol { |
| <span class="prelude-val">Ok</span>(()) |
| } <span class="kw">else </span>{ |
| <span class="prelude-val">Err</span>(AbsoluteError(distance)) |
| } |
| } |
| } |
| |
| <span class="kw">fn </span>description(<span class="kw-2">&</span><span class="self">self</span>) -> String { |
| <span class="macro">format!</span>(<span class="string">"absolute difference, |x - y| <= {tol}."</span>, tol = <span class="self">self</span>.tol) |
| } |
| } |
| |
| <span class="doccomment">/// The `exact` comparator used with [assert_matrix_eq!](../macro.assert_matrix_eq!.html). |
| </span><span class="attribute">#[derive(Copy, Clone, Debug, PartialEq)] |
| </span><span class="kw">pub struct </span>ExactElementwiseComparator; |
| |
| <span class="attribute">#[doc(hidden)] |
| #[derive(Copy, Clone, Debug, PartialEq)] |
| </span><span class="kw">pub struct </span>ExactError; |
| |
| <span class="kw">impl </span>ComparisonFailure <span class="kw">for </span>ExactError { |
| <span class="kw">fn </span>failure_reason(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><String> { <span class="prelude-val">None </span>} |
| } |
| |
| <span class="kw">impl</span><T> ElementwiseComparator<T, ExactError> <span class="kw">for </span>ExactElementwiseComparator |
| <span class="kw">where </span>T: Copy + fmt::Display + PartialEq<T> { |
| |
| <span class="kw">fn </span>compare(<span class="kw-2">&</span><span class="self">self</span>, a: T, b: T) -> <span class="prelude-ty">Result</span><(), ExactError> { |
| <span class="kw">if </span>a == b { |
| <span class="prelude-val">Ok</span>(()) |
| } <span class="kw">else </span>{ |
| <span class="prelude-val">Err</span>(ExactError) |
| } |
| } |
| |
| <span class="kw">fn </span>description(<span class="kw-2">&</span><span class="self">self</span>) -> String { |
| <span class="macro">format!</span>(<span class="string">"exact equality x == y."</span>) |
| } |
| } |
| |
| <span class="doccomment">/// The `ulp` comparator used with [assert_matrix_eq!](../macro.assert_matrix_eq!.html). |
| </span><span class="attribute">#[derive(Copy, Clone, Debug, PartialEq)] |
| </span><span class="kw">pub struct </span>UlpElementwiseComparator { |
| <span class="doccomment">/// The maximum difference in ULP units tolerated (inclusive). |
| </span><span class="kw">pub </span>tol: u64 |
| } |
| |
| <span class="attribute">#[doc(hidden)] |
| #[derive(Copy, Clone, Debug, PartialEq)] |
| </span><span class="kw">pub struct </span>UlpError(<span class="kw">pub </span>ulp::UlpComparisonResult); |
| |
| <span class="kw">impl </span>ComparisonFailure <span class="kw">for </span>UlpError { |
| <span class="kw">fn </span>failure_reason(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><String> { |
| <span class="kw">use </span>ulp::UlpComparisonResult; |
| <span class="kw">match </span><span class="self">self</span>.<span class="number">0 </span>{ |
| UlpComparisonResult::Difference(diff) => |
| <span class="prelude-val">Some</span>(<span class="macro">format!</span>(<span class="string">"Difference: {diff} ULP."</span>, diff=diff)), |
| UlpComparisonResult::IncompatibleSigns => |
| <span class="prelude-val">Some</span>(<span class="macro">format!</span>(<span class="string">"Numbers have incompatible signs."</span>)), |
| <span class="kw">_ </span>=> <span class="prelude-val">None |
| </span>} |
| } |
| } |
| |
| <span class="kw">impl</span><T> ElementwiseComparator<T, UlpError> <span class="kw">for </span>UlpElementwiseComparator |
| <span class="kw">where </span>T: Copy + Ulp { |
| |
| <span class="kw">fn </span>compare(<span class="kw-2">&</span><span class="self">self</span>, a: T, b: T) -> <span class="prelude-ty">Result</span><(), UlpError> { |
| <span class="kw">let </span>diff = Ulp::ulp_diff(<span class="kw-2">&</span>a, <span class="kw-2">&</span>b); |
| <span class="kw">match </span>diff { |
| ulp::UlpComparisonResult::ExactMatch => <span class="prelude-val">Ok</span>(()), |
| ulp::UlpComparisonResult::Difference(diff) <span class="kw">if </span>diff <= <span class="self">self</span>.tol => <span class="prelude-val">Ok</span>(()), |
| <span class="kw">_ </span>=> <span class="prelude-val">Err</span>(UlpError(diff)) |
| } |
| } |
| |
| <span class="kw">fn </span>description(<span class="kw-2">&</span><span class="self">self</span>) -> String { |
| <span class="macro">format!</span>(<span class="string">"ULP difference less than or equal to {tol}. See documentation for details."</span>, |
| tol = <span class="self">self</span>.tol) |
| } |
| } |
| |
| <span class="doccomment">/// The `float` comparator used with [assert_matrix_eq!](../macro.assert_matrix_eq!.html). |
| </span><span class="attribute">#[derive(Copy, Clone, Debug, PartialEq)] |
| </span><span class="kw">pub struct </span>FloatElementwiseComparator<T> { |
| abs: AbsoluteElementwiseComparator<T>, |
| ulp: UlpElementwiseComparator |
| } |
| |
| <span class="attribute">#[doc(hidden)] |
| #[allow(dead_code)] |
| </span><span class="kw">impl</span><T> FloatElementwiseComparator<T> <span class="kw">where </span>T: Float + Ulp { |
| <span class="kw">pub fn </span>default() -> <span class="self">Self </span>{ |
| FloatElementwiseComparator { |
| abs: AbsoluteElementwiseComparator { tol: T::epsilon() }, |
| ulp: UlpElementwiseComparator { tol: <span class="number">4 </span>} |
| } |
| } |
| |
| <span class="kw">pub fn </span>eps(<span class="self">self</span>, eps: T) -> <span class="self">Self </span>{ |
| FloatElementwiseComparator { |
| abs: AbsoluteElementwiseComparator { tol: eps }, |
| ulp: <span class="self">self</span>.ulp |
| } |
| } |
| |
| <span class="kw">pub fn </span>ulp(<span class="self">self</span>, max_ulp: u64) -> <span class="self">Self </span>{ |
| FloatElementwiseComparator { |
| abs: <span class="self">self</span>.abs, |
| ulp: UlpElementwiseComparator { tol: max_ulp } |
| } |
| } |
| } |
| |
| <span class="kw">impl</span><T> ElementwiseComparator<T, UlpError> <span class="kw">for </span>FloatElementwiseComparator<T> |
| <span class="kw">where </span>T: Copy + Ulp + Float + fmt::Display { |
| <span class="kw">fn </span>compare(<span class="kw-2">&</span><span class="self">self</span>, a: T, b: T) -> <span class="prelude-ty">Result</span><(), UlpError> { |
| <span class="comment">// First perform an absolute comparison with a presumably very small epsilon tolerance |
| </span><span class="kw">if let </span><span class="prelude-val">Err</span>(<span class="kw">_</span>) = <span class="self">self</span>.abs.compare(a, b) { |
| <span class="comment">// Then fall back to an ULP-based comparison |
| </span><span class="self">self</span>.ulp.compare(a, b) |
| } <span class="kw">else </span>{ |
| <span class="comment">// If the epsilon comparison succeeds, we have a match |
| </span><span class="prelude-val">Ok</span>(()) |
| } |
| } |
| |
| <span class="kw">fn </span>description(<span class="kw-2">&</span><span class="self">self</span>) -> String { |
| <span class="macro">format!</span>(<span class="string">" |
| Epsilon-sized absolute comparison, followed by an ULP-based comparison. |
| Please see the documentation for details. |
| Epsilon: {eps} |
| ULP tolerance: {ulp}"</span>, |
| eps = <span class="self">self</span>.abs.tol, |
| ulp = <span class="self">self</span>.ulp.tol) |
| } |
| } |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>tests { |
| <span class="kw">use </span>macros::comparison::{ |
| AbsoluteElementwiseComparator, AbsoluteError, ElementwiseComparator, |
| ExactElementwiseComparator, ExactError, |
| UlpElementwiseComparator, UlpError, |
| FloatElementwiseComparator, |
| }; |
| <span class="kw">use </span>ulp::{Ulp, UlpComparisonResult}; |
| <span class="kw">use </span>quickcheck::TestResult; |
| <span class="kw">use </span>std::f64; |
| |
| <span class="doccomment">/// Returns the next adjacent floating point number (in the direction of positive infinity) |
| </span><span class="kw">fn </span>next_f64(x: f64) -> f64 { |
| <span class="kw">use </span>std::mem; |
| <span class="kw">let </span>as_int = <span class="kw">unsafe </span>{ mem::transmute::<f64, i64>(x) }; |
| <span class="kw">unsafe </span>{ mem::transmute::<i64, f64>(as_int + <span class="number">1</span>) } |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">pub fn </span>absolute_comparator_integer() { |
| <span class="kw">let </span>comp = AbsoluteElementwiseComparator { tol: <span class="number">1 </span>}; |
| |
| <span class="macro">assert_eq!</span>(comp.compare(<span class="number">0</span>, <span class="number">0</span>), <span class="prelude-val">Ok</span>(())); |
| <span class="macro">assert_eq!</span>(comp.compare(<span class="number">1</span>, <span class="number">0</span>), <span class="prelude-val">Ok</span>(())); |
| <span class="macro">assert_eq!</span>(comp.compare(-<span class="number">1</span>, <span class="number">0</span>), <span class="prelude-val">Ok</span>(())); |
| <span class="macro">assert_eq!</span>(comp.compare(<span class="number">2</span>, <span class="number">0</span>), <span class="prelude-val">Err</span>(AbsoluteError(<span class="number">2</span>))); |
| <span class="macro">assert_eq!</span>(comp.compare(-<span class="number">2</span>, <span class="number">0</span>), <span class="prelude-val">Err</span>(AbsoluteError(<span class="number">2</span>))); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">pub fn </span>absolute_comparator_floating_point() { |
| <span class="kw">let </span>comp = AbsoluteElementwiseComparator { tol: <span class="number">1.0 </span>}; |
| |
| <span class="comment">// Note: floating point math is not generally exact, but |
| // here we only compare with 0.0, so we can expect exact results. |
| </span><span class="macro">assert_eq!</span>(comp.compare(<span class="number">0.0</span>, <span class="number">0.0</span>), <span class="prelude-val">Ok</span>(())); |
| <span class="macro">assert_eq!</span>(comp.compare(<span class="number">1.0</span>, <span class="number">0.0</span>), <span class="prelude-val">Ok</span>(())); |
| <span class="macro">assert_eq!</span>(comp.compare(-<span class="number">1.0</span>, <span class="number">0.0</span>), <span class="prelude-val">Ok</span>(())); |
| <span class="macro">assert_eq!</span>(comp.compare(<span class="number">2.0</span>, <span class="number">0.0</span>), <span class="prelude-val">Err</span>(AbsoluteError(<span class="number">2.0</span>))); |
| <span class="macro">assert_eq!</span>(comp.compare(-<span class="number">2.0</span>, <span class="number">0.0</span>), <span class="prelude-val">Err</span>(AbsoluteError(<span class="number">2.0</span>))); |
| } |
| |
| <span class="macro">quickcheck! </span>{ |
| <span class="kw">fn </span>property_absolute_comparator_is_symmetric_i64(a: i64, b: i64, tol: i64) -> TestResult { |
| <span class="kw">if </span>tol <= <span class="number">0 </span>{ |
| <span class="kw">return </span>TestResult::discard() |
| } |
| |
| <span class="kw">let </span>comp = AbsoluteElementwiseComparator { tol: tol }; |
| TestResult::from_bool(comp.compare(a, b) == comp.compare(b, a)) |
| } |
| } |
| |
| <span class="macro">quickcheck! </span>{ |
| <span class="kw">fn </span>property_absolute_comparator_is_symmetric_f64(a: f64, b: f64, tol: f64) -> TestResult { |
| <span class="kw">if </span>tol <= <span class="number">0.0 </span>{ |
| <span class="kw">return </span>TestResult::discard() |
| } |
| |
| <span class="comment">// Floating point math is not exact, but the AbsoluteElementwiseComparator is designed |
| // so that it gives exactly the same result when the argument positions are reversed |
| </span><span class="kw">let </span>comp = AbsoluteElementwiseComparator { tol: tol }; |
| TestResult::from_bool(comp.compare(a, b) == comp.compare(b, a)) |
| } |
| } |
| |
| <span class="macro">quickcheck! </span>{ |
| <span class="kw">fn </span>property_absolute_comparator_tolerance_is_not_strict_f64(tol: f64) -> TestResult { |
| <span class="kw">if </span>tol <= <span class="number">0.0 </span>|| !tol.is_finite() { |
| <span class="kw">return </span>TestResult::discard() |
| } |
| |
| <span class="comment">// The comparator is defined by <=, not < |
| </span><span class="kw">let </span>comp = AbsoluteElementwiseComparator { tol: tol }; |
| <span class="kw">let </span>includes_tol = comp.compare(tol, <span class="number">0.0</span>).is_ok(); |
| <span class="kw">let </span>excludes_next_after_tol = comp.compare(next_f64(tol), <span class="number">0.0</span>).is_err(); |
| TestResult::from_bool(includes_tol && excludes_next_after_tol) |
| } |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">pub fn </span>exact_comparator_integer() { |
| <span class="kw">let </span>comp = ExactElementwiseComparator; |
| |
| <span class="macro">assert_eq!</span>(comp.compare(<span class="number">0</span>, <span class="number">0</span>), <span class="prelude-val">Ok</span>(())); |
| <span class="macro">assert_eq!</span>(comp.compare(<span class="number">1</span>, <span class="number">0</span>), <span class="prelude-val">Err</span>(ExactError)); |
| <span class="macro">assert_eq!</span>(comp.compare(-<span class="number">1</span>, <span class="number">0</span>), <span class="prelude-val">Err</span>(ExactError)); |
| <span class="macro">assert_eq!</span>(comp.compare(<span class="number">1</span>, -<span class="number">1</span>), <span class="prelude-val">Err</span>(ExactError)); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">pub fn </span>exact_comparator_floating_point() { |
| <span class="kw">let </span>comp = ExactElementwiseComparator; |
| |
| <span class="macro">assert_eq!</span>(comp.compare(<span class="number">0.0</span>, <span class="number">0.0</span>), <span class="prelude-val">Ok</span>(())); |
| <span class="macro">assert_eq!</span>(comp.compare(-<span class="number">0.0</span>, -<span class="number">0.0</span>), <span class="prelude-val">Ok</span>(())); |
| <span class="macro">assert_eq!</span>(comp.compare(-<span class="number">0.0</span>, <span class="number">0.0</span>), <span class="prelude-val">Ok</span>(())); |
| <span class="macro">assert_eq!</span>(comp.compare(<span class="number">1.0</span>, <span class="number">0.0</span>), <span class="prelude-val">Err</span>(ExactError)); |
| <span class="macro">assert_eq!</span>(comp.compare(-<span class="number">1.0</span>, <span class="number">0.0</span>), <span class="prelude-val">Err</span>(ExactError)); |
| <span class="macro">assert_eq!</span>(comp.compare(f64::NAN, <span class="number">5.0</span>), <span class="prelude-val">Err</span>(ExactError)); |
| } |
| |
| <span class="macro">quickcheck! </span>{ |
| <span class="kw">fn </span>property_exact_comparator_is_symmetric_i64(a: i64, b: i64) -> bool { |
| <span class="kw">let </span>comp = ExactElementwiseComparator; |
| comp.compare(a, b) == comp.compare(b, a) |
| } |
| } |
| |
| <span class="macro">quickcheck! </span>{ |
| <span class="kw">fn </span>property_exact_comparator_is_symmetric_f64(a: f64, b: f64) -> bool { |
| <span class="kw">let </span>comp = ExactElementwiseComparator; |
| comp.compare(a, b) == comp.compare(b, a) |
| } |
| } |
| |
| <span class="macro">quickcheck! </span>{ |
| <span class="kw">fn </span>property_exact_comparator_matches_equality_operator_i64(a: i64, b: i64) -> bool { |
| <span class="kw">let </span>comp = ExactElementwiseComparator; |
| <span class="kw">let </span>result = comp.compare(a, b); |
| |
| <span class="kw">match </span>a == b { |
| <span class="bool-val">true </span>=> result == <span class="prelude-val">Ok</span>(()), |
| <span class="bool-val">false </span>=> result == <span class="prelude-val">Err</span>(ExactError) |
| } |
| } |
| } |
| |
| <span class="macro">quickcheck! </span>{ |
| <span class="kw">fn </span>property_exact_comparator_matches_equality_operator_f64(a: f64, b: f64) -> bool { |
| <span class="kw">let </span>comp = ExactElementwiseComparator; |
| <span class="kw">let </span>result = comp.compare(a, b); |
| |
| <span class="kw">match </span>a == b { |
| <span class="bool-val">true </span>=> result == <span class="prelude-val">Ok</span>(()), |
| <span class="bool-val">false </span>=> result == <span class="prelude-val">Err</span>(ExactError) |
| } |
| } |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">pub fn </span>ulp_comparator_f64() { |
| <span class="comment">// The Ulp implementation has its own set of tests, so we just want |
| // to make a sample here |
| </span><span class="kw">let </span>comp = UlpElementwiseComparator { tol: <span class="number">1 </span>}; |
| |
| <span class="macro">assert_eq!</span>(comp.compare(<span class="number">0.0</span>, <span class="number">0.0</span>), <span class="prelude-val">Ok</span>(())); |
| <span class="macro">assert_eq!</span>(comp.compare(<span class="number">0.0</span>, -<span class="number">0.0</span>), <span class="prelude-val">Ok</span>(())); |
| <span class="macro">assert_eq!</span>(comp.compare(-<span class="number">1.0</span>, <span class="number">1.0</span>), <span class="prelude-val">Err</span>(UlpError(UlpComparisonResult::IncompatibleSigns))); |
| <span class="macro">assert_eq!</span>(comp.compare(<span class="number">1.0</span>, <span class="number">0.0</span>), <span class="prelude-val">Err</span>(UlpError(f64::ulp_diff(<span class="kw-2">&</span><span class="number">1.0</span>, <span class="kw-2">&</span><span class="number">0.0</span>)))); |
| <span class="macro">assert_eq!</span>(comp.compare(f64::NAN, <span class="number">0.0</span>), <span class="prelude-val">Err</span>(UlpError(UlpComparisonResult::Nan)));; |
| } |
| |
| <span class="macro">quickcheck! </span>{ |
| <span class="kw">fn </span>property_ulp_comparator_is_symmetric(a: f64, b: f64, tol: u64) -> TestResult { |
| <span class="kw">if </span>tol == <span class="number">0 </span>{ |
| <span class="kw">return </span>TestResult::discard() |
| } |
| |
| <span class="kw">let </span>comp = UlpElementwiseComparator { tol: tol }; |
| TestResult::from_bool(comp.compare(a, b) == comp.compare(b, a)) |
| } |
| } |
| |
| <span class="macro">quickcheck! </span>{ |
| <span class="kw">fn </span>property_ulp_comparator_matches_ulp_trait(a: f64, b: f64, tol: u64) -> bool { |
| <span class="kw">let </span>comp = UlpElementwiseComparator { tol: tol }; |
| <span class="kw">let </span>result = comp.compare(a, b); |
| |
| <span class="kw">use </span>ulp::UlpComparisonResult::{ExactMatch, Difference}; |
| |
| <span class="kw">match </span>f64::ulp_diff(<span class="kw-2">&</span>a, <span class="kw-2">&</span>b) { |
| ExactMatch => result.is_ok(), |
| Difference(diff) <span class="kw">if </span>diff <= tol => result.is_ok(), |
| otherwise => result == <span class="prelude-val">Err</span>(UlpError(otherwise)) |
| } |
| } |
| } |
| |
| <span class="macro">quickcheck! </span>{ |
| <span class="kw">fn </span>property_ulp_comparator_next_f64_is_ok_when_inside_tolerance(x: f64) -> TestResult { |
| <span class="kw">let </span>y = next_f64(x); |
| |
| <span class="kw">if </span>!(x.is_finite() && y.is_finite() && x.signum() == y.signum()) { |
| <span class="kw">return </span>TestResult::discard() |
| } |
| |
| <span class="kw">let </span>comp0 = UlpElementwiseComparator { tol: <span class="number">0 </span>}; |
| <span class="kw">let </span>comp1 = UlpElementwiseComparator { tol: <span class="number">1 </span>}; |
| |
| <span class="kw">let </span>tol_0_fails = comp0.compare(x, y) == <span class="prelude-val">Err</span>(UlpError(UlpComparisonResult::Difference(<span class="number">1</span>))); |
| <span class="kw">let </span>tol_1_succeeds = comp1.compare(x, y) == <span class="prelude-val">Ok</span>(()); |
| |
| TestResult::from_bool(tol_0_fails && tol_1_succeeds) |
| } |
| } |
| |
| <span class="macro">quickcheck! </span>{ |
| <span class="kw">fn </span>property_float_comparator_matches_abs_with_zero_ulp_tol(a: f64, b: f64, abstol: f64) -> TestResult { |
| <span class="kw">if </span>abstol <= <span class="number">0.0 </span>{ |
| <span class="kw">return </span>TestResult::discard() |
| } |
| |
| <span class="kw">let </span>abstol = abstol.abs(); |
| <span class="kw">let </span>comp = FloatElementwiseComparator::default().eps(abstol).ulp(<span class="number">0</span>); |
| <span class="kw">let </span>abscomp = AbsoluteElementwiseComparator { tol: abstol }; |
| <span class="kw">let </span>result = comp.compare(a, b); |
| |
| <span class="comment">// Recall that the float comparator returns UlpError, so we cannot compare the results |
| // of abscomp directly |
| </span>TestResult::from_bool(<span class="kw">match </span>abscomp.compare(a, b) { |
| <span class="prelude-val">Err</span>(AbsoluteError(<span class="kw">_</span>)) => result.is_err(), |
| <span class="prelude-val">Ok</span>(<span class="kw">_</span>) => result.is_ok() |
| }) |
| } |
| } |
| |
| <span class="macro">quickcheck! </span>{ |
| <span class="kw">fn </span>property_float_comparator_matches_ulp_with_zero_eps_tol(a: f64, b: f64, max_ulp: u64) -> bool { |
| <span class="kw">let </span>comp = FloatElementwiseComparator::default().eps(<span class="number">0.0</span>).ulp(max_ulp); |
| <span class="kw">let </span>ulpcomp = UlpElementwiseComparator { tol: max_ulp }; |
| |
| comp.compare(a, b) == ulpcomp.compare(a, b) |
| } |
| } |
| } |
| </code></pre></div> |
| </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> |