blob: b2d8493108f4c2b50eb681a06f1c309f3bb0a876 [file] [log] [blame]
<!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/assert_matrix_eq.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>assert_matrix_eq.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>
<span id="426">426</span>
<span id="427">427</span>
<span id="428">428</span>
<span id="429">429</span>
<span id="430">430</span>
<span id="431">431</span>
<span id="432">432</span>
<span id="433">433</span>
<span id="434">434</span>
<span id="435">435</span>
<span id="436">436</span>
<span id="437">437</span>
<span id="438">438</span>
<span id="439">439</span>
<span id="440">440</span>
<span id="441">441</span>
<span id="442">442</span>
<span id="443">443</span>
<span id="444">444</span>
<span id="445">445</span>
<span id="446">446</span>
<span id="447">447</span>
<span id="448">448</span>
<span id="449">449</span>
<span id="450">450</span>
<span id="451">451</span>
<span id="452">452</span>
<span id="453">453</span>
<span id="454">454</span>
<span id="455">455</span>
<span id="456">456</span>
<span id="457">457</span>
<span id="458">458</span>
<span id="459">459</span>
<span id="460">460</span>
<span id="461">461</span>
<span id="462">462</span>
<span id="463">463</span>
<span id="464">464</span>
<span id="465">465</span>
<span id="466">466</span>
<span id="467">467</span>
<span id="468">468</span>
<span id="469">469</span>
<span id="470">470</span>
<span id="471">471</span>
<span id="472">472</span>
<span id="473">473</span>
<span id="474">474</span>
<span id="475">475</span>
<span id="476">476</span>
<span id="477">477</span>
<span id="478">478</span>
<span id="479">479</span>
<span id="480">480</span>
<span id="481">481</span>
<span id="482">482</span>
<span id="483">483</span>
<span id="484">484</span>
<span id="485">485</span>
<span id="486">486</span>
<span id="487">487</span>
<span id="488">488</span>
<span id="489">489</span>
<span id="490">490</span>
<span id="491">491</span>
<span id="492">492</span>
<span id="493">493</span>
<span id="494">494</span>
<span id="495">495</span>
<span id="496">496</span>
<span id="497">497</span>
<span id="498">498</span>
<span id="499">499</span>
<span id="500">500</span>
<span id="501">501</span>
<span id="502">502</span>
<span id="503">503</span>
<span id="504">504</span>
<span id="505">505</span>
<span id="506">506</span>
<span id="507">507</span>
<span id="508">508</span>
<span id="509">509</span>
<span id="510">510</span>
<span id="511">511</span>
<span id="512">512</span>
<span id="513">513</span>
<span id="514">514</span>
<span id="515">515</span>
<span id="516">516</span>
<span id="517">517</span>
<span id="518">518</span>
<span id="519">519</span>
<span id="520">520</span>
<span id="521">521</span>
<span id="522">522</span>
<span id="523">523</span>
<span id="524">524</span>
<span id="525">525</span>
<span id="526">526</span>
<span id="527">527</span>
<span id="528">528</span>
<span id="529">529</span>
<span id="530">530</span>
<span id="531">531</span>
<span id="532">532</span>
<span id="533">533</span>
<span id="534">534</span>
<span id="535">535</span>
<span id="536">536</span>
<span id="537">537</span>
<span id="538">538</span>
<span id="539">539</span>
<span id="540">540</span>
<span id="541">541</span>
<span id="542">542</span>
<span id="543">543</span>
<span id="544">544</span>
<span id="545">545</span>
<span id="546">546</span>
<span id="547">547</span>
<span id="548">548</span>
<span id="549">549</span>
<span id="550">550</span>
<span id="551">551</span>
<span id="552">552</span>
<span id="553">553</span>
<span id="554">554</span>
<span id="555">555</span>
<span id="556">556</span>
<span id="557">557</span>
<span id="558">558</span>
<span id="559">559</span>
<span id="560">560</span>
<span id="561">561</span>
<span id="562">562</span>
<span id="563">563</span>
<span id="564">564</span>
<span id="565">565</span>
<span id="566">566</span>
<span id="567">567</span>
<span id="568">568</span>
<span id="569">569</span>
<span id="570">570</span>
<span id="571">571</span>
<span id="572">572</span>
<span id="573">573</span>
<span id="574">574</span>
<span id="575">575</span>
<span id="576">576</span>
<span id="577">577</span>
<span id="578">578</span>
<span id="579">579</span>
<span id="580">580</span>
<span id="581">581</span>
<span id="582">582</span>
<span id="583">583</span>
<span id="584">584</span>
<span id="585">585</span>
<span id="586">586</span>
<span id="587">587</span>
<span id="588">588</span>
<span id="589">589</span>
<span id="590">590</span>
<span id="591">591</span>
<span id="592">592</span>
<span id="593">593</span>
<span id="594">594</span>
<span id="595">595</span>
<span id="596">596</span>
<span id="597">597</span>
<span id="598">598</span>
<span id="599">599</span>
<span id="600">600</span>
<span id="601">601</span>
<span id="602">602</span>
<span id="603">603</span>
<span id="604">604</span>
<span id="605">605</span>
<span id="606">606</span>
<span id="607">607</span>
<span id="608">608</span>
<span id="609">609</span>
<span id="610">610</span>
<span id="611">611</span>
<span id="612">612</span>
<span id="613">613</span>
<span id="614">614</span>
<span id="615">615</span>
<span id="616">616</span>
<span id="617">617</span>
<span id="618">618</span>
<span id="619">619</span>
<span id="620">620</span>
<span id="621">621</span>
<span id="622">622</span>
<span id="623">623</span>
<span id="624">624</span>
<span id="625">625</span>
<span id="626">626</span>
<span id="627">627</span>
<span id="628">628</span>
<span id="629">629</span>
<span id="630">630</span>
<span id="631">631</span>
<span id="632">632</span>
<span id="633">633</span>
<span id="634">634</span>
<span id="635">635</span>
<span id="636">636</span>
<span id="637">637</span>
<span id="638">638</span>
<span id="639">639</span>
<span id="640">640</span>
<span id="641">641</span>
<span id="642">642</span>
<span id="643">643</span>
<span id="644">644</span>
<span id="645">645</span>
<span id="646">646</span>
<span id="647">647</span>
<span id="648">648</span>
<span id="649">649</span>
<span id="650">650</span>
<span id="651">651</span>
<span id="652">652</span>
<span id="653">653</span>
<span id="654">654</span>
<span id="655">655</span>
<span id="656">656</span>
<span id="657">657</span>
<span id="658">658</span>
<span id="659">659</span>
<span id="660">660</span>
<span id="661">661</span>
<span id="662">662</span>
<span id="663">663</span>
<span id="664">664</span>
<span id="665">665</span>
<span id="666">666</span>
<span id="667">667</span>
<span id="668">668</span>
<span id="669">669</span>
<span id="670">670</span>
<span id="671">671</span>
<span id="672">672</span>
<span id="673">673</span>
<span id="674">674</span>
<span id="675">675</span>
<span id="676">676</span>
<span id="677">677</span>
<span id="678">678</span>
<span id="679">679</span>
<span id="680">680</span>
<span id="681">681</span>
<span id="682">682</span>
<span id="683">683</span>
<span id="684">684</span>
<span id="685">685</span>
<span id="686">686</span>
<span id="687">687</span>
<span id="688">688</span>
<span id="689">689</span>
<span id="690">690</span>
<span id="691">691</span>
<span id="692">692</span>
</pre><pre class="rust"><code><span class="kw">use </span>matrix::BaseMatrix;
<span class="kw">use </span>std::fmt;
<span class="kw">use </span>macros::ElementwiseComparator;
<span class="kw">use </span>macros::comparison::ComparisonFailure;
<span class="kw">const </span>MAX_MISMATCH_REPORTS: usize = <span class="number">12</span>;
<span class="attribute">#[doc(hidden)]
#[derive(Debug, Copy, Clone, PartialEq)]
</span><span class="kw">pub struct </span>MatrixElementComparisonFailure&lt;T, E&gt; <span class="kw">where </span>E: ComparisonFailure {
<span class="kw">pub </span>x: T,
<span class="kw">pub </span>y: T,
<span class="kw">pub </span>error: E,
<span class="kw">pub </span>row: usize,
<span class="kw">pub </span>col: usize
}
<span class="kw">impl</span>&lt;T, E&gt; fmt::Display <span class="kw">for </span>MatrixElementComparisonFailure&lt;T, E&gt;
<span class="kw">where </span>T: fmt::Display,
E: ComparisonFailure {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter) -&gt; fmt::Result {
<span class="macro">write!</span>(f,
<span class="string">&quot;({i}, {j}): x = {x}, y = {y}.{reason}&quot;</span>,
i = <span class="self">self</span>.row,
j = <span class="self">self</span>.col,
x = <span class="self">self</span>.x,
y = <span class="self">self</span>.y,
reason = <span class="self">self</span>.error.failure_reason()
<span class="comment">// Add a space before the reason
</span>.map(|s| <span class="macro">format!</span>(<span class="string">&quot; {}&quot;</span>, s))
.unwrap_or(String::new()))
}
}
<span class="attribute">#[doc(hidden)]
#[derive(Debug, PartialEq)]
</span><span class="kw">pub enum </span>MatrixComparisonResult&lt;T, C, E&gt;
<span class="kw">where </span>T: Copy,
C: ElementwiseComparator&lt;T, E&gt;,
E: ComparisonFailure {
Match,
MismatchedDimensions { dim_x: (usize, usize), dim_y: (usize, usize) },
MismatchedElements { comparator: C, mismatches: Vec&lt;MatrixElementComparisonFailure&lt;T, E&gt;&gt; }
}
<span class="kw">impl</span>&lt;T, C, E&gt; MatrixComparisonResult&lt;T, C, E&gt;
<span class="kw">where </span>T: Copy + fmt::Display,
C: ElementwiseComparator&lt;T, E&gt;,
E: ComparisonFailure {
<span class="kw">pub fn </span>panic_message(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;String&gt; {
<span class="kw">match </span><span class="self">self </span>{
<span class="kw-2">&amp;</span>MatrixComparisonResult::MismatchedElements { <span class="kw-2">ref </span>comparator, <span class="kw-2">ref </span>mismatches } =&gt; {
<span class="comment">// TODO: Aligned output
</span><span class="kw">let </span><span class="kw-2">mut </span>formatted_mismatches = String::new();
<span class="kw">let </span>mismatches_overflow = mismatches.len() &gt; MAX_MISMATCH_REPORTS;
<span class="kw">let </span>overflow_msg = <span class="kw">if </span>mismatches_overflow {
<span class="kw">let </span>num_hidden_entries = mismatches.len() - MAX_MISMATCH_REPORTS;
<span class="macro">format!</span>(<span class="string">&quot; ... ({} mismatching elements not shown)\n&quot;</span>, num_hidden_entries)
} <span class="kw">else </span>{
String::new()
};
<span class="kw">for </span>mismatch <span class="kw">in </span>mismatches.iter().take(MAX_MISMATCH_REPORTS) {
formatted_mismatches.push_str(<span class="string">&quot; &quot;</span>);
formatted_mismatches.push_str(<span class="kw-2">&amp;</span>mismatch.to_string());
formatted_mismatches.push_str(<span class="string">&quot;\n&quot;</span>);
}
<span class="comment">// Strip off the last newline from the above
</span>formatted_mismatches = formatted_mismatches.trim_right().to_string();
<span class="prelude-val">Some</span>(<span class="macro">format!</span>(<span class="string">&quot;\n
Matrices X and Y have {num} mismatched element pairs.
The mismatched elements are listed below, in the format
(row, col): x = X[[row, col]], y = Y[[row, col]].
{mismatches}
{overflow_msg}
Comparison criterion: {description}
\n&quot;</span>,
num = mismatches.len(),
description = comparator.description(),
mismatches = formatted_mismatches,
overflow_msg = overflow_msg))
},
<span class="kw-2">&amp;</span>MatrixComparisonResult::MismatchedDimensions { dim_x, dim_y } =&gt; {
<span class="prelude-val">Some</span>(<span class="macro">format!</span>(<span class="string">&quot;\n
Dimensions of matrices X and Y do not match.
dim(X) = {x_rows} x {x_cols}
dim(Y) = {y_rows} x {y_cols}
\n&quot;</span>,
x_rows = dim_x.<span class="number">0</span>, x_cols = dim_x.<span class="number">1</span>,
y_rows = dim_y.<span class="number">0</span>, y_cols = dim_y.<span class="number">1</span>))
},
<span class="kw">_ </span>=&gt; <span class="prelude-val">None
</span>}
}
}
<span class="attribute">#[doc(hidden)]
</span><span class="kw">pub fn </span>elementwise_matrix_comparison&lt;T, M, C, E&gt;(x: <span class="kw-2">&amp;</span>M, y: <span class="kw-2">&amp;</span>M, comparator: C)
-&gt; MatrixComparisonResult&lt;T, C, E&gt;
<span class="kw">where </span>M: BaseMatrix&lt;T&gt;, T: Copy, C: ElementwiseComparator&lt;T, E&gt;, E: ComparisonFailure {
<span class="kw">if </span>x.rows() == y.rows() &amp;&amp; x.cols() == y.cols() {
<span class="kw">let </span>mismatches = {
<span class="kw">let </span><span class="kw-2">mut </span>mismatches = Vec::new();
<span class="kw">let </span>x = x.as_slice();
<span class="kw">let </span>y = y.as_slice();
<span class="kw">for </span>i <span class="kw">in </span><span class="number">0 </span>.. x.rows() {
<span class="kw">for </span>j <span class="kw">in </span><span class="number">0 </span>.. x.cols() {
<span class="kw">let </span>a = x[[i, j]].to_owned();
<span class="kw">let </span>b = y[[i, j]].to_owned();
<span class="kw">if let </span><span class="prelude-val">Err</span>(error) = comparator.compare(a, b) {
mismatches.push(MatrixElementComparisonFailure {
x: a,
y: b,
error: error,
row: i,
col: j
});
}
}
}
mismatches
};
<span class="kw">if </span>mismatches.is_empty() {
MatrixComparisonResult::Match
} <span class="kw">else </span>{
MatrixComparisonResult::MismatchedElements {
comparator: comparator,
mismatches: mismatches
}
}
} <span class="kw">else </span>{
MatrixComparisonResult::MismatchedDimensions {
dim_x: (x.rows(), x.cols()),
dim_y: (y.rows(), y.cols())
}
}
}
<span class="doccomment">/// Compare matrices for exact or approximate equality.
///
/// The `assert_matrix_eq!` simplifies the comparison of two matrices by
/// providing the following features:
///
/// - Verifies that the dimensions of the matrices match.
/// - Offers both exact and approximate comparison of individual elements.
/// - Multiple types of comparators available, depending on the needs of the user.
/// - Built-in error reporting makes it easy to determine which elements of the two matrices
/// that do not compare equal.
///
/// # Usage
/// Given two matrices `x` and `y`, the default invocation performs an exact elementwise
/// comparison of the two matrices.
///
/// ```
/// # #[macro_use] extern crate rulinalg; fn main() { let x = matrix![1.0f64]; let y = matrix![1.0f64];
/// // Performs elementwise exact comparison
/// assert_matrix_eq!(x, y);
/// # }
/// ```
///
/// An exact comparison is often not desirable. In particular, with floating point types,
/// rounding errors or other sources of inaccuracies tend to complicate the matter.
/// For this purpose, `assert_matrix_eq!` provides several comparators.
///
/// ```
/// # #[macro_use] extern crate rulinalg; fn main() {
/// # let x = matrix![1.0f64]; let y = matrix![1.0f64];
/// // Available comparators:
/// assert_matrix_eq!(x, y, comp = exact);
/// assert_matrix_eq!(x, y, comp = float);
/// assert_matrix_eq!(x, y, comp = abs, tol = 1e-12);
/// assert_matrix_eq!(x, y, comp = ulp, tol = 8);
/// # }
/// ```
/// **Note**: The `comp` argument *must* be specified after `x` and `y`, and cannot come
/// after comparator-specific options. This is a deliberate design decision,
/// with the rationale that assertions should look as uniform as possible for
/// the sake of readability.
///
///
/// ### The `exact` comparator
/// This comparator simply uses the default `==` operator to compare each pair of elements.
/// The default comparator delegates the comparison to the `exact` comparator.
///
/// ### The `float` comparator
/// The `float` comparator is designed to be a conservative default for comparing floating-point numbers.
/// It is inspired by the `AlmostEqualUlpsAndAbs` comparison function proposed in the excellent blog post
/// [Comparing Floating Point Numbers, 2012 Edition]
/// (https://randomascii.wordpress.com/2012/02/25/comparing-floating-point-numbers-2012-edition/)
/// by Bruce Dawson.
///
/// If you expect the two matrices to be almost exactly the same, but you want to leave some
/// room for (very small) rounding errors, then this comparator should be your default choice.
///
/// The comparison criterion can be summarized as follows:
///
/// 1. If `assert_matrix_eq!(x, y, comp = abs, tol = max_eps)` holds for `max_eps` close to the
/// machine epsilon for the floating point type,
/// then the comparison is successful.
/// 2. Otherwise, returns the result of `assert_matrix_eq!(x, y, comp = ulp, tol = max_ulp)`,
/// where `max_ulp` is a small positive integer constant.
///
/// The `max_eps` and `max_ulp` parameters can be tweaked to your preference with the syntax:
///
/// ```
/// # #[macro_use] extern crate rulinalg; fn main() {
/// # let x = matrix![1.0f64]; let y = matrix![1.0f64];
/// # let max_eps = 1.0; let max_ulp = 0;
/// assert_matrix_eq!(x, y, comp = float, eps = max_eps, ulp = max_ulp);
/// # }
/// ```
///
/// These additional parameters can be specified in any order after the choice of comparator,
/// and do not both need to be present.
///
/// ### The `abs` comparator
/// Compares the absolute difference between individual elements against the specified tolerance.
/// Specifically, for every pair of elements x and y picked from the same row and column in X and Y
/// respectively, the criterion is defined by
///
/// ```text
/// | x - y | &lt;= tol.
/// ```
///
/// In addition to floating point numbers, the comparator can also be used for integral numbers,
/// both signed and unsigned. In order to avoid unsigned underflow, the difference is always
/// computed by subtracting the smaller number from the larger number.
/// Note that the type of `tol` is required to be the same as that of the scalar field.
///
///
/// ### The `ulp` comparator
/// Elementwise comparison of floating point numbers based on their
/// [ULP](https://en.wikipedia.org/wiki/Unit_in_the_last_place) difference.
/// Once again, this is inspired by the proposals
/// [in the aforementioned blog post by Bruce Dawon]
/// (https://randomascii.wordpress.com/2012/02/25/comparing-floating-point-numbers-2012-edition/),
/// but it handles some cases explicitly as to provide better error reporting.
///
/// Note that the ULP difference of two floating point numbers is not defined in the following cases:
///
/// - The two numbers have different signs. The only exception here is +0 and -0,
/// which are considered an exact match.
/// - One of the numbers is NaN.
///
/// ULP-based comparison is typically used when two numbers are expected to be very,
/// very close to each other. However, it is typically not very useful very close to zero,
/// which is discussed in the linked blog post above.
/// The error in many mathematical functions can often be bounded by a certain number of ULP, and so
/// this comparator is particularly useful if this number is known.
///
/// Note that the scalar type of the matrix must implement the [Ulp trait](ulp/trait.Ulp.html) in order
/// to be used with this comparator. By default, `f32` and `f64` implementations are provided.
///
/// # Error reporting
///
/// One of the main motivations for the `assert_matrix_eq!` macro is the ability to give
/// useful error messages which help pinpoint the problems. For example, consider the example
///
/// ```rust,should_panic
/// #[macro_use]
/// extern crate rulinalg;
///
/// fn main() {
/// let a = matrix![1.00, 2.00;
/// 3.00, 4.00];
/// let b = matrix![1.01, 2.00;
/// 3.40, 4.00];
/// assert_matrix_eq!(a, b, comp = abs, tol = 1e-8);
/// }
/// ```
///
/// which yields the output
///
/// ```text
/// Matrices X and Y have 2 mismatched element pairs.
/// The mismatched elements are listed below, in the format
/// (row, col): x = X[[row, col]], y = Y[[row, col]].
///
/// (0, 0): x = 1, y = 1.01. Absolute error: 0.010000000000000009.
/// (1, 0): x = 3, y = 3.4. Absolute error: 0.3999999999999999.
///
/// Comparison criterion: absolute difference, |x - y| &lt;= 0.00000001.
/// ```
///
/// # Trait bounds on elements
/// Each comparator has specific requirements on which traits the elements
/// need to implement. To discover which traits are required for each comparator,
/// we refer the reader to implementors of
/// [ElementwiseComparator](macros/trait.ElementwiseComparator.html),
/// which provides the underlying comparison for the various macro invocations.
///
/// # Examples
///
/// ```
/// #[macro_use]
/// extern crate rulinalg;
/// use rulinalg::matrix::Matrix;
///
/// # fn main() {
/// let ref a = matrix![1, 2;
/// 3, 4i64];
/// let ref b = matrix![1, 3;
/// 3, 4i64];
///
/// let ref x = matrix![1.000, 2.000,
/// 3.000, 4.000f64];
/// let ref y = matrix![0.999, 2.001,
/// 2.998, 4.000f64];
///
///
/// // comp = abs is also applicable to integers
/// assert_matrix_eq!(a, b, comp = abs, tol = 1);
/// assert_matrix_eq!(x, y, comp = abs, tol = 0.01);
///
/// assert_matrix_eq!(a * 2, a + a);
/// assert_matrix_eq!(x * 2.0, x + x, comp = float);
/// # }
/// ```
</span><span class="attribute">#[macro_export]
</span><span class="macro">macro_rules! </span>assert_matrix_eq {
(<span class="macro-nonterminal">$x</span>:expr, <span class="macro-nonterminal">$y</span>:expr) =&gt; {
{
<span class="comment">// Note: The reason we take slices of both x and y is that if x or y are passed as references,
// we don&#39;t attempt to call elementwise_matrix_comparison with a &amp;&amp;BaseMatrix type (double reference),
// which does not work due to generics.
</span><span class="kw">use </span><span class="macro-nonterminal">$crate::macros</span>::{elementwise_matrix_comparison, ExactElementwiseComparator};
<span class="kw">use </span><span class="macro-nonterminal">$crate::matrix::BaseMatrix</span>;
<span class="kw">let </span>comp = ExactElementwiseComparator;
<span class="kw">let </span>msg = elementwise_matrix_comparison(<span class="kw-2">&amp;</span><span class="macro-nonterminal">$x</span>.as_slice(), <span class="kw-2">&amp;</span><span class="macro-nonterminal">$y</span>.as_slice(), comp).panic_message();
<span class="kw">if let </span><span class="prelude-val">Some</span>(msg) = msg {
<span class="comment">// Note: We need the panic to incur here inside of the macro in order
// for the line number to be correct when using it for tests,
// hence we build the panic message in code, but panic here.
</span><span class="macro">panic!</span>(<span class="string">&quot;{msg}
Please see the documentation for ways to compare matrices approximately.\n\n&quot;</span>,
msg = msg.trim_right());
}
}
};
(<span class="macro-nonterminal">$x</span>:expr, <span class="macro-nonterminal">$y</span>:expr, comp = exact) =&gt; {
{
<span class="kw">use </span><span class="macro-nonterminal">$crate::macros</span>::{elementwise_matrix_comparison, ExactElementwiseComparator};
<span class="kw">use </span><span class="macro-nonterminal">$crate::matrix::BaseMatrix</span>;
<span class="kw">let </span>comp = ExactElementwiseComparator;
<span class="kw">let </span>msg = elementwise_matrix_comparison(<span class="kw-2">&amp;</span><span class="macro-nonterminal">$x</span>.as_slice(), <span class="kw-2">&amp;</span><span class="macro-nonterminal">$y</span>.as_slice(), comp).panic_message();
<span class="kw">if let </span><span class="prelude-val">Some</span>(msg) = msg {
<span class="macro">panic!</span>(msg);
}
}
};
(<span class="macro-nonterminal">$x</span>:expr, <span class="macro-nonterminal">$y</span>:expr, comp = abs, tol = <span class="macro-nonterminal">$tol</span>:expr) =&gt; {
{
<span class="kw">use </span><span class="macro-nonterminal">$crate::macros</span>::{elementwise_matrix_comparison, AbsoluteElementwiseComparator};
<span class="kw">use </span><span class="macro-nonterminal">$crate::matrix::BaseMatrix</span>;
<span class="kw">let </span>comp = AbsoluteElementwiseComparator { tol: <span class="macro-nonterminal">$tol </span>};
<span class="kw">let </span>msg = elementwise_matrix_comparison(<span class="kw-2">&amp;</span><span class="macro-nonterminal">$x</span>.as_slice(), <span class="kw-2">&amp;</span><span class="macro-nonterminal">$y</span>.as_slice(), comp).panic_message();
<span class="kw">if let </span><span class="prelude-val">Some</span>(msg) = msg {
<span class="macro">panic!</span>(msg);
}
}
};
(<span class="macro-nonterminal">$x</span>:expr, <span class="macro-nonterminal">$y</span>:expr, comp = ulp, tol = <span class="macro-nonterminal">$tol</span>:expr) =&gt; {
{
<span class="kw">use </span><span class="macro-nonterminal">$crate::macros</span>::{elementwise_matrix_comparison, UlpElementwiseComparator};
<span class="kw">use </span><span class="macro-nonterminal">$crate::matrix::BaseMatrix</span>;
<span class="kw">let </span>comp = UlpElementwiseComparator { tol: <span class="macro-nonterminal">$tol </span>};
<span class="kw">let </span>msg = elementwise_matrix_comparison(<span class="kw-2">&amp;</span><span class="macro-nonterminal">$x</span>.as_slice(), <span class="kw-2">&amp;</span><span class="macro-nonterminal">$y</span>.as_slice(), comp).panic_message();
<span class="kw">if let </span><span class="prelude-val">Some</span>(msg) = msg {
<span class="macro">panic!</span>(msg);
}
}
};
(<span class="macro-nonterminal">$x</span>:expr, <span class="macro-nonterminal">$y</span>:expr, comp = float) =&gt; {
{
<span class="kw">use </span><span class="macro-nonterminal">$crate::macros</span>::{elementwise_matrix_comparison, FloatElementwiseComparator};
<span class="kw">use </span><span class="macro-nonterminal">$crate::matrix::BaseMatrix</span>;
<span class="kw">let </span>comp = FloatElementwiseComparator::default();
<span class="kw">let </span>msg = elementwise_matrix_comparison(<span class="kw-2">&amp;</span><span class="macro-nonterminal">$x</span>.as_slice(), <span class="kw-2">&amp;</span><span class="macro-nonterminal">$y</span>.as_slice(), comp).panic_message();
<span class="kw">if let </span><span class="prelude-val">Some</span>(msg) = msg {
<span class="macro">panic!</span>(msg);
}
}
};
<span class="comment">// This following allows us to optionally tweak the epsilon and ulp tolerances
// used in the default float comparator.
</span>(<span class="macro-nonterminal">$x</span>:expr, <span class="macro-nonterminal">$y</span>:expr, comp = float, $(<span class="macro-nonterminal">$key</span>:ident = <span class="macro-nonterminal">$val</span>:expr),+) =&gt; {
{
<span class="kw">use </span><span class="macro-nonterminal">$crate::macros</span>::{elementwise_matrix_comparison, FloatElementwiseComparator};
<span class="kw">use </span><span class="macro-nonterminal">$crate::matrix::BaseMatrix</span>;
<span class="kw">let </span>comp = FloatElementwiseComparator::default()$(.<span class="macro-nonterminal">$key</span>(<span class="macro-nonterminal">$val</span>))+;
<span class="kw">let </span>msg = elementwise_matrix_comparison(<span class="kw-2">&amp;</span><span class="macro-nonterminal">$x</span>.as_slice(), <span class="kw-2">&amp;</span><span class="macro-nonterminal">$y</span>.as_slice(), comp).panic_message();
<span class="kw">if let </span><span class="prelude-val">Some</span>(msg) = msg {
<span class="macro">panic!</span>(msg);
}
}
};
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use super</span>::{
elementwise_matrix_comparison,
MatrixComparisonResult
};
<span class="kw">use </span>macros::comparison::{
ExactElementwiseComparator, ExactError
};
<span class="kw">use </span>matrix::Matrix;
<span class="kw">use </span>quickcheck::TestResult;
<span class="macro">quickcheck! </span>{
<span class="kw">fn </span>property_elementwise_comparison_incompatible_matrices_yield_dimension_mismatch(
m: usize,
n: usize,
p: usize,
q: usize) -&gt; TestResult {
<span class="kw">if </span>m == p &amp;&amp; n == q {
<span class="kw">return </span>TestResult::discard()
}
<span class="comment">// It does not actually matter which comparator we use here, but we need to pick one
</span><span class="kw">let </span>comp = ExactElementwiseComparator;
<span class="kw">let </span><span class="kw-2">ref </span>x = Matrix::new(m, n, <span class="macro">vec!</span>[<span class="number">0</span>; m * n]);
<span class="kw">let </span><span class="kw-2">ref </span>y = Matrix::new(p, q, <span class="macro">vec!</span>[<span class="number">0</span>; p * q]);
<span class="kw">let </span>expected = MatrixComparisonResult::MismatchedDimensions { dim_x: (m, n), dim_y: (p, q) };
TestResult::from_bool(elementwise_matrix_comparison(x, y, comp) == expected)
}
}
<span class="macro">quickcheck! </span>{
<span class="kw">fn </span>property_elementwise_comparison_matrix_matches_self(m: usize, n: usize) -&gt; bool {
<span class="kw">let </span>comp = ExactElementwiseComparator;
<span class="kw">let </span><span class="kw-2">ref </span>x = Matrix::new(m, n, <span class="macro">vec!</span>[<span class="number">0</span>; m * n]);
elementwise_matrix_comparison(x, x, comp) == MatrixComparisonResult::Match
}
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>elementwise_matrix_comparison_reports_correct_mismatches() {
<span class="kw">use </span><span class="kw">super</span>::MatrixComparisonResult::MismatchedElements;
<span class="kw">use </span><span class="kw">super</span>::MatrixElementComparisonFailure;
<span class="kw">let </span>comp = ExactElementwiseComparator;
{
<span class="comment">// Single element matrices
</span><span class="kw">let </span><span class="kw-2">ref </span>x = <span class="macro">matrix!</span>[<span class="number">1</span>];
<span class="kw">let </span><span class="kw-2">ref </span>y = <span class="macro">matrix!</span>[<span class="number">2</span>];
<span class="kw">let </span>expected = MismatchedElements {
comparator: comp,
mismatches: <span class="macro">vec!</span>[MatrixElementComparisonFailure {
x: <span class="number">1</span>, y: <span class="number">2</span>,
error: ExactError,
row: <span class="number">0</span>, col: <span class="number">0
</span>}]
};
<span class="macro">assert_eq!</span>(elementwise_matrix_comparison(x, y, comp), expected);
}
{
<span class="comment">// Mismatch in top-left and bottom-corner elements for a short matrix
</span><span class="kw">let </span><span class="kw-2">ref </span>x = <span class="macro">matrix!</span>[<span class="number">0</span>, <span class="number">1</span>, <span class="number">2</span>;
<span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>];
<span class="kw">let </span><span class="kw-2">ref </span>y = <span class="macro">matrix!</span>[<span class="number">1</span>, <span class="number">1</span>, <span class="number">2</span>;
<span class="number">3</span>, <span class="number">4</span>, <span class="number">6</span>];
<span class="kw">let </span>mismatches = <span class="macro">vec!</span>[
MatrixElementComparisonFailure {
x: <span class="number">0</span>, y: <span class="number">1</span>,
error: ExactError,
row: <span class="number">0</span>, col: <span class="number">0
</span>},
MatrixElementComparisonFailure {
x: <span class="number">5</span>, y: <span class="number">6</span>,
error: ExactError,
row: <span class="number">1</span>, col: <span class="number">2
</span>}
];
<span class="kw">let </span>expected = MismatchedElements {
comparator: comp,
mismatches: mismatches
};
<span class="macro">assert_eq!</span>(elementwise_matrix_comparison(x, y, comp), expected);
}
{
<span class="comment">// Mismatch in top-left and bottom-corner elements for a tall matrix
</span><span class="kw">let </span><span class="kw-2">ref </span>x = <span class="macro">matrix!</span>[<span class="number">0</span>, <span class="number">1</span>;
<span class="number">2</span>, <span class="number">3</span>;
<span class="number">4</span>, <span class="number">5</span>];
<span class="kw">let </span><span class="kw-2">ref </span>y = <span class="macro">matrix!</span>[<span class="number">1</span>, <span class="number">1</span>;
<span class="number">2</span>, <span class="number">3</span>;
<span class="number">4</span>, <span class="number">6</span>];
<span class="kw">let </span>mismatches = <span class="macro">vec!</span>[
MatrixElementComparisonFailure {
x: <span class="number">0</span>, y: <span class="number">1</span>,
error: ExactError,
row: <span class="number">0</span>, col: <span class="number">0
</span>},
MatrixElementComparisonFailure {
x: <span class="number">5</span>, y: <span class="number">6</span>,
error: ExactError,
row: <span class="number">2</span>, col: <span class="number">1
</span>}
];
<span class="kw">let </span>expected = MismatchedElements {
comparator: comp,
mismatches: mismatches
};
<span class="macro">assert_eq!</span>(elementwise_matrix_comparison(x, y, comp), expected);
}
{
<span class="comment">// Check some arbitrary elements
</span><span class="kw">let </span><span class="kw-2">ref </span>x = <span class="macro">matrix!</span>[<span class="number">0</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>;
<span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>, <span class="number">7</span>];
<span class="kw">let </span><span class="kw-2">ref </span>y = <span class="macro">matrix!</span>[<span class="number">0</span>, <span class="number">1</span>, <span class="number">3</span>, <span class="number">3</span>;
<span class="number">4</span>, <span class="number">6</span>, <span class="number">6</span>, <span class="number">7</span>];
<span class="kw">let </span>mismatches = <span class="macro">vec!</span>[
MatrixElementComparisonFailure {
x: <span class="number">2</span>, y: <span class="number">3</span>,
error: ExactError,
row: <span class="number">0</span>, col: <span class="number">2
</span>},
MatrixElementComparisonFailure {
x: <span class="number">5</span>, y: <span class="number">6</span>,
error: ExactError,
row: <span class="number">1</span>, col: <span class="number">1
</span>}
];
<span class="kw">let </span>expected = MismatchedElements {
comparator: comp,
mismatches: mismatches
};
<span class="macro">assert_eq!</span>(elementwise_matrix_comparison(x, y, comp), expected);
}
}
<span class="attribute">#[test]
</span><span class="kw">pub fn </span>matrix_eq_absolute_compare_self_for_integer() {
<span class="kw">let </span>x = <span class="macro">matrix!</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>;
<span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>];
<span class="macro">assert_matrix_eq!</span>(x, x, comp = abs, tol = <span class="number">0</span>);
}
<span class="attribute">#[test]
</span><span class="kw">pub fn </span>matrix_eq_absolute_compare_self_for_floating_point() {
<span class="kw">let </span>x = <span class="macro">matrix!</span>[<span class="number">1.0</span>, <span class="number">2.0</span>, <span class="number">3.0</span>;
<span class="number">4.0</span>, <span class="number">5.0</span>, <span class="number">6.0</span>];
<span class="macro">assert_matrix_eq!</span>(x, x, comp = abs, tol = <span class="number">1e-10</span>);
}
<span class="attribute">#[test]
#[should_panic]
</span><span class="kw">pub fn </span>matrix_eq_absolute_mismatched_dimensions() {
<span class="kw">let </span>x = <span class="macro">matrix!</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>;
<span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>];
<span class="kw">let </span>y = <span class="macro">matrix!</span>[<span class="number">1</span>, <span class="number">2</span>;
<span class="number">3</span>, <span class="number">4</span>];
<span class="macro">assert_matrix_eq!</span>(x, y, comp = abs, tol = <span class="number">0</span>);
}
<span class="attribute">#[test]
#[should_panic]
</span><span class="kw">pub fn </span>matrix_eq_absolute_mismatched_floating_point_elements() {
<span class="kw">let </span>x = <span class="macro">matrix!</span>[<span class="number">1.00</span>, <span class="number">2.00</span>, <span class="number">3.00</span>;
<span class="number">4.00</span>, <span class="number">5.00</span>, <span class="number">6.00</span>];
<span class="kw">let </span>y = <span class="macro">matrix!</span>[<span class="number">1.00</span>, <span class="number">2.01</span>, <span class="number">3.00</span>;
<span class="number">3.99</span>, <span class="number">5.00</span>, <span class="number">6.00</span>];
<span class="macro">assert_matrix_eq!</span>(x, y, comp = abs, tol = <span class="number">1e-10</span>);
}
<span class="attribute">#[test]
</span><span class="kw">pub fn </span>matrix_eq_exact_compare_self_for_integer() {
<span class="kw">let </span>x = <span class="macro">matrix!</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>;
<span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>];
<span class="macro">assert_matrix_eq!</span>(x, x, comp = exact);
}
<span class="attribute">#[test]
</span><span class="kw">pub fn </span>matrix_eq_exact_compare_self_for_floating_point() {
<span class="kw">let </span>x = <span class="macro">matrix!</span>[<span class="number">1.0</span>, <span class="number">2.0</span>, <span class="number">3.0</span>;
<span class="number">4.0</span>, <span class="number">5.0</span>, <span class="number">6.0</span>];
<span class="macro">assert_matrix_eq!</span>(x, x, comp = exact);
}
<span class="attribute">#[test]
</span><span class="kw">pub fn </span>matrix_eq_ulp_compare_self() {
<span class="kw">let </span>x = <span class="macro">matrix!</span>[<span class="number">1.0</span>, <span class="number">2.0</span>, <span class="number">3.0</span>;
<span class="number">4.0</span>, <span class="number">5.0</span>, <span class="number">6.0</span>];
<span class="macro">assert_matrix_eq!</span>(x, x, comp = ulp, tol = <span class="number">0</span>);
}
<span class="attribute">#[test]
</span><span class="kw">pub fn </span>matrix_eq_default_compare_self_for_floating_point() {
<span class="kw">let </span>x = <span class="macro">matrix!</span>[<span class="number">1.0</span>, <span class="number">2.0</span>, <span class="number">3.0</span>;
<span class="number">4.0</span>, <span class="number">5.0</span>, <span class="number">6.0</span>];
<span class="macro">assert_matrix_eq!</span>(x, x);
}
<span class="attribute">#[test]
</span><span class="kw">pub fn </span>matrix_eq_default_compare_self_for_integer() {
<span class="kw">let </span>x = <span class="macro">matrix!</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>;
<span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>];
<span class="macro">assert_matrix_eq!</span>(x, x);
}
<span class="attribute">#[test]
#[should_panic]
</span><span class="kw">pub fn </span>matrix_eq_ulp_different_signs() {
<span class="kw">let </span>x = <span class="macro">matrix!</span>[<span class="number">1.0</span>, <span class="number">2.0</span>, <span class="number">3.0</span>;
<span class="number">4.0</span>, <span class="number">5.0</span>, <span class="number">6.0</span>];
<span class="kw">let </span>y = <span class="macro">matrix!</span>[<span class="number">1.0</span>, <span class="number">2.0</span>, -<span class="number">3.0</span>;
<span class="number">4.0</span>, <span class="number">5.0</span>, <span class="number">6.0</span>];
<span class="macro">assert_matrix_eq!</span>(x, y, comp = ulp, tol = <span class="number">0</span>);
}
<span class="attribute">#[test]
#[should_panic]
</span><span class="kw">pub fn </span>matrix_eq_ulp_nan() {
<span class="kw">use </span>std::f64;
<span class="kw">let </span>x = <span class="macro">matrix!</span>[<span class="number">1.0</span>, <span class="number">2.0</span>, <span class="number">3.0</span>;
<span class="number">4.0</span>, <span class="number">5.0</span>, <span class="number">6.0</span>];
<span class="kw">let </span>y = <span class="macro">matrix!</span>[<span class="number">1.0</span>, <span class="number">2.0</span>, f64::NAN;
<span class="number">4.0</span>, <span class="number">5.0</span>, <span class="number">6.0</span>];
<span class="macro">assert_matrix_eq!</span>(x, y, comp = ulp, tol = <span class="number">0</span>);
}
<span class="attribute">#[test]
</span><span class="kw">pub fn </span>matrix_eq_float_compare_self() {
<span class="kw">let </span>x = <span class="macro">matrix!</span>[<span class="number">1.0</span>, <span class="number">2.0</span>, <span class="number">3.0</span>;
<span class="number">4.0</span>, <span class="number">5.0</span>, <span class="number">6.0</span>];
<span class="macro">assert_matrix_eq!</span>(x, x, comp = float);
}
<span class="attribute">#[test]
</span><span class="kw">pub fn </span>matrix_eq_float_compare_self_with_eps() {
<span class="kw">let </span>x = <span class="macro">matrix!</span>[<span class="number">1.0</span>, <span class="number">2.0</span>, <span class="number">3.0</span>;
<span class="number">4.0</span>, <span class="number">5.0</span>, <span class="number">6.0</span>];
<span class="macro">assert_matrix_eq!</span>(x, x, comp = float, eps = <span class="number">1e-6</span>);
}
<span class="attribute">#[test]
</span><span class="kw">pub fn </span>matrix_eq_float_compare_self_with_ulp() {
<span class="kw">let </span>x = <span class="macro">matrix!</span>[<span class="number">1.0</span>, <span class="number">2.0</span>, <span class="number">3.0</span>;
<span class="number">4.0</span>, <span class="number">5.0</span>, <span class="number">6.0</span>];
<span class="macro">assert_matrix_eq!</span>(x, x, comp = float, ulp = <span class="number">12</span>);
}
<span class="attribute">#[test]
</span><span class="kw">pub fn </span>matrix_eq_float_compare_self_with_eps_and_ulp() {
<span class="kw">let </span>x = <span class="macro">matrix!</span>[<span class="number">1.0</span>, <span class="number">2.0</span>, <span class="number">3.0</span>;
<span class="number">4.0</span>, <span class="number">5.0</span>, <span class="number">6.0</span>];
<span class="macro">assert_matrix_eq!</span>(x, x, comp = float, eps = <span class="number">1e-6</span>, ulp = <span class="number">12</span>);
<span class="macro">assert_matrix_eq!</span>(x, x, comp = float, ulp = <span class="number">12</span>, eps = <span class="number">1e-6</span>);
}
<span class="attribute">#[test]
</span><span class="kw">pub fn </span>matrix_eq_pass_by_ref()
{
<span class="kw">let </span>x = <span class="macro">matrix!</span>[<span class="number">0.0f64</span>];
<span class="comment">// Exercise all the macro definitions and make sure that we are able to call it
// when the arguments are references.
</span><span class="macro">assert_matrix_eq!</span>(<span class="kw-2">&amp;</span>x, <span class="kw-2">&amp;</span>x);
<span class="macro">assert_matrix_eq!</span>(<span class="kw-2">&amp;</span>x, <span class="kw-2">&amp;</span>x, comp = exact);
<span class="macro">assert_matrix_eq!</span>(<span class="kw-2">&amp;</span>x, <span class="kw-2">&amp;</span>x, comp = abs, tol = <span class="number">0.0</span>);
<span class="macro">assert_matrix_eq!</span>(<span class="kw-2">&amp;</span>x, <span class="kw-2">&amp;</span>x, comp = ulp, tol = <span class="number">0</span>);
<span class="macro">assert_matrix_eq!</span>(<span class="kw-2">&amp;</span>x, <span class="kw-2">&amp;</span>x, comp = float);
<span class="macro">assert_matrix_eq!</span>(<span class="kw-2">&amp;</span>x, <span class="kw-2">&amp;</span>x, comp = float, eps = <span class="number">0.0</span>, ulp = <span class="number">0</span>);
}
}
</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>