blob: 08d84322bc1b04be7b3cd0f8c94fe0a4722e503f [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/matrix/permutation_matrix.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>permutation_matrix.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>
<span id="693">693</span>
<span id="694">694</span>
<span id="695">695</span>
<span id="696">696</span>
<span id="697">697</span>
<span id="698">698</span>
<span id="699">699</span>
<span id="700">700</span>
<span id="701">701</span>
<span id="702">702</span>
<span id="703">703</span>
<span id="704">704</span>
<span id="705">705</span>
<span id="706">706</span>
<span id="707">707</span>
<span id="708">708</span>
<span id="709">709</span>
<span id="710">710</span>
<span id="711">711</span>
<span id="712">712</span>
<span id="713">713</span>
<span id="714">714</span>
<span id="715">715</span>
<span id="716">716</span>
<span id="717">717</span>
<span id="718">718</span>
<span id="719">719</span>
<span id="720">720</span>
<span id="721">721</span>
<span id="722">722</span>
<span id="723">723</span>
<span id="724">724</span>
<span id="725">725</span>
<span id="726">726</span>
<span id="727">727</span>
<span id="728">728</span>
<span id="729">729</span>
<span id="730">730</span>
<span id="731">731</span>
<span id="732">732</span>
<span id="733">733</span>
<span id="734">734</span>
<span id="735">735</span>
<span id="736">736</span>
<span id="737">737</span>
<span id="738">738</span>
<span id="739">739</span>
<span id="740">740</span>
<span id="741">741</span>
<span id="742">742</span>
<span id="743">743</span>
<span id="744">744</span>
<span id="745">745</span>
<span id="746">746</span>
<span id="747">747</span>
<span id="748">748</span>
<span id="749">749</span>
<span id="750">750</span>
<span id="751">751</span>
<span id="752">752</span>
<span id="753">753</span>
<span id="754">754</span>
<span id="755">755</span>
<span id="756">756</span>
<span id="757">757</span>
<span id="758">758</span>
<span id="759">759</span>
<span id="760">760</span>
<span id="761">761</span>
<span id="762">762</span>
<span id="763">763</span>
<span id="764">764</span>
<span id="765">765</span>
<span id="766">766</span>
<span id="767">767</span>
<span id="768">768</span>
<span id="769">769</span>
<span id="770">770</span>
<span id="771">771</span>
<span id="772">772</span>
<span id="773">773</span>
<span id="774">774</span>
<span id="775">775</span>
<span id="776">776</span>
<span id="777">777</span>
<span id="778">778</span>
<span id="779">779</span>
<span id="780">780</span>
<span id="781">781</span>
<span id="782">782</span>
<span id="783">783</span>
<span id="784">784</span>
<span id="785">785</span>
<span id="786">786</span>
<span id="787">787</span>
<span id="788">788</span>
<span id="789">789</span>
<span id="790">790</span>
<span id="791">791</span>
<span id="792">792</span>
<span id="793">793</span>
<span id="794">794</span>
<span id="795">795</span>
<span id="796">796</span>
<span id="797">797</span>
<span id="798">798</span>
<span id="799">799</span>
<span id="800">800</span>
<span id="801">801</span>
<span id="802">802</span>
<span id="803">803</span>
<span id="804">804</span>
<span id="805">805</span>
<span id="806">806</span>
<span id="807">807</span>
<span id="808">808</span>
<span id="809">809</span>
<span id="810">810</span>
<span id="811">811</span>
<span id="812">812</span>
<span id="813">813</span>
<span id="814">814</span>
<span id="815">815</span>
<span id="816">816</span>
<span id="817">817</span>
<span id="818">818</span>
<span id="819">819</span>
<span id="820">820</span>
<span id="821">821</span>
<span id="822">822</span>
<span id="823">823</span>
<span id="824">824</span>
<span id="825">825</span>
<span id="826">826</span>
<span id="827">827</span>
<span id="828">828</span>
<span id="829">829</span>
<span id="830">830</span>
<span id="831">831</span>
<span id="832">832</span>
<span id="833">833</span>
<span id="834">834</span>
<span id="835">835</span>
<span id="836">836</span>
<span id="837">837</span>
<span id="838">838</span>
<span id="839">839</span>
<span id="840">840</span>
<span id="841">841</span>
<span id="842">842</span>
<span id="843">843</span>
<span id="844">844</span>
<span id="845">845</span>
<span id="846">846</span>
<span id="847">847</span>
<span id="848">848</span>
<span id="849">849</span>
<span id="850">850</span>
<span id="851">851</span>
<span id="852">852</span>
<span id="853">853</span>
<span id="854">854</span>
<span id="855">855</span>
<span id="856">856</span>
<span id="857">857</span>
<span id="858">858</span>
<span id="859">859</span>
<span id="860">860</span>
<span id="861">861</span>
<span id="862">862</span>
<span id="863">863</span>
<span id="864">864</span>
<span id="865">865</span>
<span id="866">866</span>
<span id="867">867</span>
<span id="868">868</span>
<span id="869">869</span>
<span id="870">870</span>
<span id="871">871</span>
<span id="872">872</span>
<span id="873">873</span>
<span id="874">874</span>
<span id="875">875</span>
<span id="876">876</span>
<span id="877">877</span>
<span id="878">878</span>
<span id="879">879</span>
<span id="880">880</span>
<span id="881">881</span>
<span id="882">882</span>
<span id="883">883</span>
<span id="884">884</span>
<span id="885">885</span>
</pre><pre class="rust"><code><span class="kw">use </span>std;
<span class="kw">use </span>matrix::{Matrix, BaseMatrix, BaseMatrixMut};
<span class="kw">use </span>vector::Vector;
<span class="kw">use </span>error::{Error, ErrorKind};
<span class="kw">use </span>libnum::Num;
<span class="doccomment">/// An efficient implementation of a permutation matrix.
///
/// # Examples
/// ```
/// # #[macro_use] extern crate rulinalg; fn main() {
/// use rulinalg::matrix::PermutationMatrix;
///
/// let ref x = matrix![1, 2, 3;
/// 4, 5, 6;
/// 7, 8, 9];
///
/// // Swap the two first rows of x by left-multiplying a permutation matrix
/// let expected = matrix![4, 5, 6;
/// 1, 2, 3;
/// 7, 8, 9];
/// let mut p = PermutationMatrix::identity(3);
/// p.swap_rows(0, 1);
/// assert_eq!(expected, p * x);
///
/// // Swap the two last columns of x by right-multiplying a permutation matrix
/// let expected = matrix![1, 3, 2;
/// 4, 6, 5;
/// 7, 9, 8];
/// let mut p = PermutationMatrix::identity(3);
/// p.swap_rows(1, 2);
/// assert_eq!(expected, x * p);
///
/// // One can also construct the same permutation matrix directly
/// // from an array representation.
/// let ref p = PermutationMatrix::from_array(vec![0, 2, 1]).unwrap();
/// assert_eq!(expected, x * p);
///
/// // One may also obtain a full matrix representation of the permutation
/// assert_eq!(p.as_matrix(), matrix![1, 0, 0;
/// 0, 0, 1;
/// 0, 1, 0]);
///
/// // The inverse of a permutation matrix can efficiently be obtained
/// let p_inv = p.inverse();
///
/// // And permutations can be composed through multiplication
/// assert_eq!(p * p_inv, PermutationMatrix::identity(3));
/// # }
/// ```
///
/// # Rationale and complexity
///
/// A [permutation matrix](https://en.wikipedia.org/wiki/Permutation_matrix)
/// is a very special kind of matrix. It is essentially a matrix representation
/// of the more general concept of a permutation. That is, an `n` x `n` permutation
/// matrix corresponds to a permutation of ordered sets whose cardinality is `n`.
/// In particular, given an `m` x `n` matrix `A` and an `m` x `m` permutation
/// matrix `P`, the action of left-multiplying `A` by `P`, `PA`, corresponds
/// to permuting the rows of `A` by the given permutation represented by `P`.
/// Conversely, right-multiplication corresponds to column permutation.
/// More precisely, given another permutation matrix `Q` of size `n` x `n`,
/// then `AQ` is the corresponding permutation of the columns of `A`.
///
/// Due to their unique structure, permutation matrices can be much more
/// efficiently represented and applied than general matrices. Recall that
/// for general matrices `X` and `Y` of size `m` x `m` and `n` x `n` respectively,
/// the storage of `X` requires O(`m`&lt;sup&gt;2&lt;/sup&gt;) memory and the storage of
/// `Y` requires O(`n`&lt;sup&gt;2&lt;/sup&gt;) memory. Ignoring for the moment the existence
/// of Strassen&#39;s matrix multiplication algorithm and more theoretical alternatives,
/// the multiplication `XA` requires O(`m`&lt;sup&gt;2&lt;/sup&gt;`n`) operations, and
/// the multiplication `AY` requires O(`m``n`&lt;sup&gt;2&lt;/sup&gt;) operations.
///
/// By contrast, the storage of `P` requires only O(`m`) memory, and
/// the storage of `K` requires O(`n`) memory. Moreover, the products
/// `PA` and `AK` both require merely O(`mn`) operations.
///
/// # Representation
/// A permutation of an ordered set of cardinality *n* is a map of the form
///
/// ```text
/// p: { 1, ..., n } -&gt; { 1, ..., n }.
/// ```
///
/// That is, for any index `i`, the permutation `p` sends `i` to some
/// index `j = p(i)`, and hence the map may be represented as an array of integers
/// of length *n*.
///
/// By convention, an instance of `PermutationMatrix` represents row permutations.
/// That is, the indices referred to above correspond to *row indices*,
/// and the internal representation of a `PermutationMatrix` is an array
/// describing how the permutation sends a row index `i` to a new row index
/// `j` in the permuted matrix. Because of this internal representation, one can only
/// efficiently swap *rows* of a `PermutationMatrix`.
/// However, keep in mind that while this API only lets one swap individual rows
/// of the permutation matrix itself, the right-multiplication of a general
/// matrix with a permutation matrix will permute the columns of the general matrix,
/// and so in practice this restriction is insignificant.
///
</span><span class="attribute">#[derive(Debug, PartialEq, Eq, Clone)]
</span><span class="kw">pub struct </span>PermutationMatrix&lt;T&gt; {
<span class="comment">// A permutation matrix of dimensions NxN is represented as a permutation of the rows
// of an NxM matrix for any M.
</span>perm: Vec&lt;usize&gt;,
<span class="comment">// Currently, we need to let PermutationMatrix be generic over T,
// because BaseMatrixMut is.
</span>marker: std::marker::PhantomData&lt;T&gt;
}
<span class="doccomment">/// Parity is the fact of being even or odd.
</span><span class="attribute">#[derive(Debug, Copy, Clone, PartialEq, Eq)]
</span><span class="kw">pub enum </span>Parity {
<span class="doccomment">/// Even parity.
</span>Even,
<span class="doccomment">/// Odd parity.
</span>Odd
}
<span class="kw">impl</span>&lt;T&gt; PermutationMatrix&lt;T&gt; {
<span class="doccomment">/// The identity permutation.
</span><span class="kw">pub fn </span>identity(n: usize) -&gt; <span class="self">Self </span>{
PermutationMatrix {
perm: (<span class="number">0 </span>.. n).collect(),
marker: std::marker::PhantomData
}
}
<span class="doccomment">/// Swaps rows i and j in the permutation matrix.
</span><span class="kw">pub fn </span>swap_rows(<span class="kw-2">&amp;mut </span><span class="self">self</span>, i: usize, j: usize) {
<span class="self">self</span>.perm.swap(i, j);
}
<span class="doccomment">/// The inverse of the permutation matrix.
</span><span class="kw">pub fn </span>inverse(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; PermutationMatrix&lt;T&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>inv: Vec&lt;usize&gt; = <span class="macro">vec!</span>[<span class="number">0</span>; <span class="self">self</span>.size()];
<span class="kw">for </span>(source, target) <span class="kw">in </span><span class="self">self</span>.perm.iter().cloned().enumerate() {
inv[target] = source;
}
PermutationMatrix {
perm: inv,
marker: std::marker::PhantomData
}
}
<span class="doccomment">/// The size of the permutation matrix.
///
/// A permutation matrix is a square matrix, so `size()` is equal
/// to both the number of rows, as well as the number of columns.
</span><span class="kw">pub fn </span>size(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<span class="self">self</span>.perm.len()
}
<span class="doccomment">/// Constructs a `PermutationMatrix` from an array.
///
/// # Errors
/// The supplied N-length array must satisfy the following:
///
/// - Each element must be in the half-open range [0, N).
/// - Each element must be unique.
</span><span class="kw">pub fn </span>from_array&lt;A: Into&lt;Vec&lt;usize&gt;&gt;&gt;(array: A) -&gt; <span class="prelude-ty">Result</span>&lt;PermutationMatrix&lt;T&gt;, Error&gt; {
<span class="kw">let </span>p = PermutationMatrix {
perm: array.into(),
marker: std::marker::PhantomData
};
validate_permutation(<span class="kw-2">&amp;</span>p.perm).map(|<span class="kw">_</span>| p)
}
<span class="doccomment">/// Constructs a `PermutationMatrix` from an array, without checking the validity of
/// the supplied permutation.
///
/// # Safety
/// The supplied N-length array must satisfy the following:
///
/// - Each element must be in the half-open range [0, N).
/// - Each element must be unique.
///
/// Note that while this function *itself* is technically safe
/// regardless of the input array, passing an incorrect permutation matrix
/// may cause undefined behavior in other methods of `PermutationMatrix`.
/// As such, it may be difficult to debug. The user is strongly
/// encouraged to use the safe function `from_array`, which for
/// most real world applications only incurs a minor
/// or even insignificant performance hit as a result of the
/// extra validation.
</span><span class="kw">pub unsafe fn </span>from_array_unchecked&lt;A: Into&lt;Vec&lt;usize&gt;&gt;&gt;(array: A) -&gt; PermutationMatrix&lt;T&gt; {
<span class="kw">let </span>p = PermutationMatrix {
perm: array.into(),
marker: std::marker::PhantomData
};
p
}
<span class="doccomment">/// Maps the given row index into the resulting row index in the permuted matrix.
///
/// More specifically, if the permutation sends row `i` to `j`, then
/// `map_row(i)` returns `j`.
///
/// # Examples
///
/// ```rust
/// use rulinalg::matrix::PermutationMatrix;
/// let mut p = PermutationMatrix::&lt;u32&gt;::identity(3);
/// p.swap_rows(1, 2);
/// assert_eq!(p.map_row(1), 2);
/// ```
</span><span class="kw">pub fn </span>map_row(<span class="kw-2">&amp;</span><span class="self">self</span>, row_index: usize) -&gt; usize {
<span class="self">self</span>.perm[row_index]
}
<span class="doccomment">/// Computes the parity of the permutation (even- or oddness).
</span><span class="kw">pub fn </span>parity(<span class="kw-2">mut </span><span class="self">self</span>) -&gt; Parity {
<span class="comment">// As it happens, permute_by_swap effectively decomposes
// each disjoint cycle in the permutation into a series
// of transpositions. The result is that the whole permutation
// is effectively decomposed into a series of
// transpositions.
// Hence, if we start out by assuming that the permutation
// is even and simply flip this variable every time a swap
// (transposition) is performed, we&#39;ll have the result by
// the end of the procedure.
</span><span class="kw">let </span><span class="kw-2">mut </span>is_even = <span class="bool-val">true</span>;
permute_by_swap(<span class="kw-2">&amp;mut </span><span class="self">self</span>.perm, |<span class="kw">_</span>, <span class="kw">_</span>| is_even = !is_even);
<span class="kw">if </span>is_even {
Parity::Even
} <span class="kw">else </span>{
Parity::Odd
}
}
}
<span class="kw">impl</span>&lt;T: Num&gt; PermutationMatrix&lt;T&gt; {
<span class="doccomment">/// The permutation matrix in an equivalent full matrix representation.
</span><span class="kw">pub fn </span>as_matrix(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; Matrix&lt;T&gt; {
Matrix::from_fn(<span class="self">self</span>.size(), <span class="self">self</span>.size(), |i, j|
<span class="kw">if </span><span class="self">self</span>.perm[i] == j {
T::one()
} <span class="kw">else </span>{
T::zero()
}
)
}
<span class="doccomment">/// Computes the determinant of the permutation matrix.
///
/// The determinant of a permutation matrix is always
/// +1 (if the permutation is even) or
/// -1 (if the permutation is odd).
</span><span class="kw">pub fn </span>det(<span class="self">self</span>) -&gt; T {
<span class="kw">let </span>parity = <span class="self">self</span>.parity();
<span class="kw">match </span>parity {
Parity::Even =&gt; T::one(),
Parity::Odd =&gt; T::zero() - T::one()
}
}
}
<span class="kw">impl</span>&lt;T&gt; PermutationMatrix&lt;T&gt; {
<span class="doccomment">/// Permutes the rows of the given matrix in-place.
///
/// # Panics
///
/// - The number of rows in the matrix is not equal to
/// the size of the permutation matrix.
</span><span class="kw">pub fn </span>permute_rows_in_place&lt;M&gt;(<span class="kw-2">mut </span><span class="self">self</span>, matrix: <span class="kw-2">&amp;mut </span>M) <span class="kw">where </span>M: BaseMatrixMut&lt;T&gt; {
validate_permutation_left_mul_dimensions(<span class="kw-2">&amp;</span><span class="self">self</span>, matrix);
permute_by_swap(<span class="kw-2">&amp;mut </span><span class="self">self</span>.perm, |i, j| matrix.swap_rows(i, j));
}
<span class="doccomment">/// Permutes the columns of the given matrix in-place.
///
/// # Panics
///
/// - The number of columns in the matrix is not equal to
/// the size of the permutation matrix.
</span><span class="kw">pub fn </span>permute_cols_in_place&lt;M&gt;(<span class="kw-2">mut </span><span class="self">self</span>, matrix: <span class="kw-2">&amp;mut </span>M) <span class="kw">where </span>M: BaseMatrixMut&lt;T&gt; {
validate_permutation_right_mul_dimensions(matrix, <span class="kw-2">&amp;</span><span class="self">self</span>);
<span class="comment">// Note: it _may_ be possible to increase cache efficiency
// of this routine by swapping elements in each row individually
// (since matrices are row major), but this would mean augmenting
// permute_by_swap in such a way that the original permutation can
// be recovered, which includes a little bit of additional work.
// Moreover, it would mean having to work with signed indices
// instead of unsigned (although temporarily casting would be sufficient),
// which may or may not complicate matters.
// For now, it was deemed significantly simpler and probably good enough
// to just swap whole columns instead.
</span>permute_by_swap(<span class="kw-2">&amp;mut </span><span class="self">self</span>.perm, |i, j| matrix.swap_cols(i, j));
}
<span class="doccomment">/// Permutes the elements of the given vector in-place.
///
/// # Panics
///
/// - The size of the vector is not equal to the size of
/// the permutation matrix.
</span><span class="kw">pub fn </span>permute_vector_in_place(<span class="kw-2">mut </span><span class="self">self</span>, vector: <span class="kw-2">&amp;mut </span>Vector&lt;T&gt;) {
validate_permutation_vector_dimensions(<span class="kw-2">&amp;</span><span class="self">self</span>, vector);
permute_by_swap(<span class="kw-2">&amp;mut </span><span class="self">self</span>.perm, |i, j| vector.mut_data().swap(i, j));
}
}
<span class="kw">impl</span>&lt;T: Clone&gt; PermutationMatrix&lt;T&gt; {
<span class="doccomment">/// Permutes the rows of the given `source_matrix` and stores the
/// result in `buffer`.
///
/// # Panics
///
/// - The number of rows in the source matrix is not equal to
/// the size of the permutation matrix.
/// - The dimensions of the source matrix and the buffer
/// are not identical.
</span><span class="kw">pub fn </span>permute_rows_into_buffer&lt;X, Y&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, source_matrix: <span class="kw-2">&amp;</span>X, buffer: <span class="kw-2">&amp;mut </span>Y)
<span class="kw">where </span>X: BaseMatrix&lt;T&gt;, Y: BaseMatrixMut&lt;T&gt; {
<span class="macro">assert!</span>(source_matrix.rows() == buffer.rows()
&amp;&amp; source_matrix.cols() == buffer.cols(),
<span class="string">&quot;Source and target matrix must have equal dimensions.&quot;</span>);
validate_permutation_left_mul_dimensions(<span class="self">self</span>, source_matrix);
<span class="kw">for </span>(source_row, target_row_index) <span class="kw">in </span>source_matrix.row_iter()
.zip(<span class="self">self</span>.perm.iter()
.cloned()) {
buffer.row_mut(target_row_index)
.raw_slice_mut()
.clone_from_slice(source_row.raw_slice());
}
}
<span class="doccomment">/// Permutes the columns of the given `source_matrix` and stores the
/// result in `buffer`.
///
/// # Panics
///
/// - The number of columns in the source matrix is not equal to
/// the size of the permutation matrix.
/// - The dimensions of the source matrix and the buffer
/// are not identical.
</span><span class="kw">pub fn </span>permute_cols_into_buffer&lt;X, Y&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, source_matrix: <span class="kw-2">&amp;</span>X, target_matrix: <span class="kw-2">&amp;mut </span>Y)
<span class="kw">where </span>X: BaseMatrix&lt;T&gt;, Y: BaseMatrixMut&lt;T&gt; {
<span class="macro">assert!</span>(source_matrix.rows() == target_matrix.rows()
&amp;&amp; source_matrix.cols() == target_matrix.cols(),
<span class="string">&quot;Source and target matrix must have equal dimensions.&quot;</span>);
validate_permutation_right_mul_dimensions(source_matrix, <span class="self">self</span>);
<span class="comment">// Permute columns in one row at a time for (presumably) better cache performance
</span><span class="kw">for </span>(row_index, source_row) <span class="kw">in </span>source_matrix.row_iter()
.map(|r| r.raw_slice())
.enumerate() {
<span class="kw">let </span>target_row = target_matrix.row_mut(row_index).raw_slice_mut();
<span class="kw">for </span>(source_element, target_col) <span class="kw">in </span>source_row.iter().zip(<span class="self">self</span>.perm.iter().cloned()) {
target_row[target_col] = source_element.clone();
}
}
}
<span class="doccomment">/// Permutes the elements of the given `source_vector` and stores the
/// result in `buffer`.
///
/// # Panics
///
/// - The size of the source vector is not equal to the
/// size of the permutation matrix.
/// - The dimensions of the source vector and the buffer
/// are not identical.
</span><span class="kw">pub fn </span>permute_vector_into_buffer(
<span class="kw-2">&amp;</span><span class="self">self</span>,
source_vector: <span class="kw-2">&amp;</span>Vector&lt;T&gt;,
buffer: <span class="kw-2">&amp;mut </span>Vector&lt;T&gt;
) {
<span class="macro">assert!</span>(source_vector.size() == buffer.size(),
<span class="string">&quot;Source and target vector must have equal dimensions.&quot;</span>);
validate_permutation_vector_dimensions(<span class="self">self</span>, buffer);
<span class="kw">for </span>(source_element, target_index) <span class="kw">in </span>source_vector.data()
.iter()
.zip(<span class="self">self</span>.perm.iter().cloned()) {
buffer[target_index] = source_element.clone();
}
}
<span class="doccomment">/// Computes the composition of `self` with the given `source_perm`
/// and stores the result in `buffer`.
///
/// # Panics
///
/// - The size of the permutation matrix (self) is not equal to the
/// size of the source permutation matrix.
</span><span class="kw">pub fn </span>compose_into_buffer(
<span class="kw-2">&amp;</span><span class="self">self</span>,
source_perm: <span class="kw-2">&amp;</span>PermutationMatrix&lt;T&gt;,
buffer: <span class="kw-2">&amp;mut </span>PermutationMatrix&lt;T&gt;
) {
<span class="macro">assert!</span>(source_perm.size() == buffer.size(),
<span class="string">&quot;Source and target permutation matrix must have equal dimensions.&quot;</span>);
<span class="kw">let </span>left = <span class="self">self</span>;
<span class="kw">let </span>right = source_perm;
<span class="kw">for </span>i <span class="kw">in </span><span class="number">0 </span>.. <span class="self">self</span>.perm.len() {
buffer.perm[i] = left.perm[right.perm[i]];
}
}
}
<span class="kw">impl</span>&lt;T&gt; From&lt;PermutationMatrix&lt;T&gt;&gt; <span class="kw">for </span>Vec&lt;usize&gt; {
<span class="kw">fn </span>from(p: PermutationMatrix&lt;T&gt;) -&gt; Vec&lt;usize&gt; {
p.perm
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>, T&gt; Into&lt;<span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>[usize]&gt; <span class="kw">for </span><span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>PermutationMatrix&lt;T&gt; {
<span class="kw">fn </span>into(<span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>[usize] {
<span class="kw-2">&amp;</span><span class="self">self</span>.perm
}
}
<span class="kw">fn </span>validate_permutation_vector_dimensions&lt;T&gt;(p: <span class="kw-2">&amp;</span>PermutationMatrix&lt;T&gt;, v: <span class="kw-2">&amp;</span>Vector&lt;T&gt;) {
<span class="macro">assert!</span>(p.size() == v.size(),
<span class="string">&quot;Permutation matrix and Vector dimensions are not compatible.&quot;</span>);
}
<span class="kw">fn </span>validate_permutation_left_mul_dimensions&lt;T, M&gt;(p: <span class="kw-2">&amp;</span>PermutationMatrix&lt;T&gt;, rhs: <span class="kw-2">&amp;</span>M)
<span class="kw">where </span>M: BaseMatrix&lt;T&gt; {
<span class="macro">assert!</span>(p.size() == rhs.rows(),
<span class="string">&quot;Permutation matrix and right-hand side matrix dimensions
are not compatible.&quot;</span>);
}
<span class="kw">fn </span>validate_permutation_right_mul_dimensions&lt;T, M&gt;(lhs: <span class="kw-2">&amp;</span>M, p: <span class="kw-2">&amp;</span>PermutationMatrix&lt;T&gt;)
<span class="kw">where </span>M: BaseMatrix&lt;T&gt; {
<span class="macro">assert!</span>(lhs.cols() == p.size(),
<span class="string">&quot;Left-hand side matrix and permutation matrix dimensions
are not compatible.&quot;</span>);
}
<span class="kw">fn </span>validate_permutation(perm: <span class="kw-2">&amp;</span>[usize]) -&gt; <span class="prelude-ty">Result</span>&lt;(), Error&gt; {
<span class="comment">// Recall that a permutation array of size n is valid if:
// 1. All elements are in the range [0, n)
// 2. All elements are unique
</span><span class="kw">let </span>n = perm.len();
<span class="comment">// Here we use a vector of boolean. If memory usage or performance
// is ever an issue, we could replace the vector with a bit vector
// (from e.g. the bit-vec crate), which would cut memory usage
// to 1/8, and likely improve performance due to more data
// fitting in cache.
</span><span class="kw">let </span><span class="kw-2">mut </span>visited = <span class="macro">vec!</span>[<span class="bool-val">false</span>; n];
<span class="kw">for </span>p <span class="kw">in </span>perm.iter().cloned() {
<span class="kw">if </span>p &lt; n {
visited[p] = <span class="bool-val">true</span>;
}
<span class="kw">else </span>{
<span class="kw">return </span><span class="prelude-val">Err</span>(Error::new(ErrorKind::InvalidPermutation,
<span class="string">&quot;Supplied permutation array contains elements out of bounds.&quot;</span>));
}
}
<span class="kw">let </span>all_unique = visited.iter().all(|x| x.clone());
<span class="kw">if </span>all_unique {
<span class="prelude-val">Ok</span>(())
} <span class="kw">else </span>{
<span class="prelude-val">Err</span>(Error::new(ErrorKind::InvalidPermutation,
<span class="string">&quot;Supplied permutation array contains duplicate elements.&quot;</span>))
}
}
<span class="doccomment">/// Applies the permutation by swapping elements in an abstract
/// container.
///
/// The permutation is applied by calls to `swap(i, j)` for indices
/// `i` and `j`.
///
/// # Complexity
///
/// - O(1) memory usage.
/// - O(n) worst case number of calls to `swap`.
</span><span class="kw">fn </span>permute_by_swap&lt;S&gt;(perm: <span class="kw-2">&amp;mut </span>[usize], <span class="kw-2">mut </span>swap: S) <span class="kw">where </span>S: FnMut(usize, usize) -&gt; () {
<span class="comment">// Please see https://en.wikipedia.org/wiki/Cyclic_permutation
// for some explanation to the terminology used here.
// Some useful resources I found on the internet:
//
// https://blog.merovius.de/2014/08/12/applying-permutation-in-constant.html
// http://stackoverflow.com/questions/16501424/algorithm-to-apply-permutation-in-constant-memory-space
//
// A fundamental property of permutations on finite sets is that
// any such permutation can be decomposed into a collection of
// cycles on disjoint orbits.
//
// An observation is thus that given a permutation P,
// we can trace out the cycle that includes index i
// by starting at i and moving to P[i] recursively.
</span><span class="kw">for </span>i <span class="kw">in </span><span class="number">0 </span>.. perm.len() {
<span class="kw">let </span><span class="kw-2">mut </span>target = perm[i];
<span class="kw">while </span>i != target {
<span class="comment">// When resolving a cycle, we resolve each index in the cycle
// by repeatedly moving the current item into the target position,
// and item in the target position into the current position.
// By repeating this until we hit the start index,
// we effectively resolve the entire cycle.
</span><span class="kw">let </span>new_target = perm[target];
swap(i, target);
perm[target] = target;
target = new_target;
}
perm[i] = i;
}
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use </span>matrix::Matrix;
<span class="kw">use </span>vector::Vector;
<span class="kw">use super</span>::{PermutationMatrix, Parity};
<span class="kw">use super</span>::{permute_by_swap, validate_permutation};
<span class="kw">use </span>itertools::Itertools;
<span class="attribute">#[test]
</span><span class="kw">fn </span>swap_rows() {
<span class="kw">let </span><span class="kw-2">mut </span>p = PermutationMatrix::&lt;u64&gt;::identity(<span class="number">4</span>);
p.swap_rows(<span class="number">0</span>, <span class="number">3</span>);
p.swap_rows(<span class="number">1</span>, <span class="number">3</span>);
<span class="kw">let </span>expected_permutation = PermutationMatrix::from_array(<span class="macro">vec!</span>[<span class="number">3</span>, <span class="number">0</span>, <span class="number">2</span>, <span class="number">1</span>]).unwrap();
<span class="macro">assert_eq!</span>(p, expected_permutation);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>as_matrix() {
<span class="kw">let </span>p = PermutationMatrix::from_array(<span class="macro">vec!</span>[<span class="number">2</span>, <span class="number">1</span>, <span class="number">0</span>, <span class="number">3</span>]).unwrap();
<span class="kw">let </span>expected_matrix: Matrix&lt;u32&gt; = <span class="macro">matrix!</span>[<span class="number">0</span>, <span class="number">0</span>, <span class="number">1</span>, <span class="number">0</span>;
<span class="number">0</span>, <span class="number">1</span>, <span class="number">0</span>, <span class="number">0</span>;
<span class="number">1</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>;
<span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">1</span>];
<span class="macro">assert_matrix_eq!</span>(expected_matrix, p.as_matrix());
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>from_array() {
<span class="kw">let </span>array = <span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">0</span>, <span class="number">3</span>, <span class="number">2</span>];
<span class="kw">let </span>p = PermutationMatrix::&lt;u32&gt;::from_array(array.clone()).unwrap();
<span class="kw">let </span>p_as_array: Vec&lt;usize&gt; = p.into();
<span class="macro">assert_eq!</span>(p_as_array, array);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>from_array_unchecked() {
<span class="kw">let </span>array = <span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">0</span>, <span class="number">3</span>, <span class="number">2</span>];
<span class="kw">let </span>p = <span class="kw">unsafe </span>{ PermutationMatrix::&lt;u32&gt;::from_array_unchecked(array.clone()) };
<span class="kw">let </span>p_as_array: Vec&lt;usize&gt; = p.into();
<span class="macro">assert_eq!</span>(p_as_array, array);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>from_array_invalid() {
<span class="macro">assert!</span>(PermutationMatrix::&lt;u32&gt;::from_array(<span class="macro">vec!</span>[<span class="number">0</span>, <span class="number">1</span>, <span class="number">3</span>]).is_err());
<span class="macro">assert!</span>(PermutationMatrix::&lt;u32&gt;::from_array(<span class="macro">vec!</span>[<span class="number">0</span>, <span class="number">0</span>]).is_err());
<span class="macro">assert!</span>(PermutationMatrix::&lt;u32&gt;::from_array(<span class="macro">vec!</span>[<span class="number">3</span>, <span class="number">0</span>, <span class="number">1</span>]).is_err());
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>vec_from_permutation() {
<span class="kw">let </span>source_vec = <span class="macro">vec!</span>[<span class="number">0</span>, <span class="number">2</span>, <span class="number">1</span>];
<span class="kw">let </span>p = PermutationMatrix::&lt;u32&gt;::from_array(source_vec.clone()).unwrap();
<span class="kw">let </span>vec = Vec::from(p);
<span class="macro">assert_eq!</span>(<span class="kw-2">&amp;</span>source_vec, <span class="kw-2">&amp;</span>vec);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>into_slice_ref() {
<span class="kw">let </span>source_vec = <span class="macro">vec!</span>[<span class="number">0</span>, <span class="number">2</span>, <span class="number">1</span>];
<span class="kw">let </span><span class="kw-2">ref </span>p = PermutationMatrix::&lt;u32&gt;::from_array(source_vec.clone()).unwrap();
<span class="kw">let </span>p_as_slice_ref: <span class="kw-2">&amp;</span>[usize] = p.into();
<span class="macro">assert_eq!</span>(source_vec.as_slice(), p_as_slice_ref);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>map_row() {
<span class="kw">let </span>p = PermutationMatrix::&lt;u32&gt;::from_array(<span class="macro">vec!</span>[<span class="number">0</span>, <span class="number">2</span>, <span class="number">1</span>]).unwrap();
<span class="macro">assert_eq!</span>(p.map_row(<span class="number">0</span>), <span class="number">0</span>);
<span class="macro">assert_eq!</span>(p.map_row(<span class="number">1</span>), <span class="number">2</span>);
<span class="macro">assert_eq!</span>(p.map_row(<span class="number">2</span>), <span class="number">1</span>);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>inverse() {
<span class="kw">let </span>p = PermutationMatrix::&lt;u32&gt;::from_array(<span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">0</span>]).unwrap();
<span class="kw">let </span>expected_inverse = PermutationMatrix::&lt;u32&gt;::from_array(<span class="macro">vec!</span>[<span class="number">2</span>, <span class="number">0</span>, <span class="number">1</span>]).unwrap();
<span class="macro">assert_eq!</span>(p.inverse(), expected_inverse);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>parity() {
{
<span class="kw">let </span>p = PermutationMatrix::&lt;u32&gt;::from_array(<span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">0</span>, <span class="number">3</span>, <span class="number">2</span>]).unwrap();
<span class="macro">assert_eq!</span>(p.parity(), Parity::Even);
}
{
<span class="kw">let </span>p = PermutationMatrix::&lt;u32&gt;::from_array(<span class="macro">vec!</span>[<span class="number">4</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">1</span>, <span class="number">0</span>, <span class="number">5</span>]).unwrap();
<span class="macro">assert_eq!</span>(p.parity(), Parity::Odd);
}
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>det() {
{
<span class="kw">let </span>p = PermutationMatrix::&lt;i32&gt;::from_array(<span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">0</span>, <span class="number">3</span>, <span class="number">2</span>]).unwrap();
<span class="macro">assert_eq!</span>(p.det(), <span class="number">1</span>);
}
{
<span class="kw">let </span>p = PermutationMatrix::&lt;i32&gt;::from_array(<span class="macro">vec!</span>[<span class="number">4</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">1</span>, <span class="number">0</span>, <span class="number">5</span>]).unwrap();
<span class="macro">assert_eq!</span>(p.det(), -<span class="number">1</span>);
}
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>permute_by_swap_on_empty_array() {
<span class="kw">let </span><span class="kw-2">mut </span>x = Vec::&lt;char&gt;::new();
<span class="kw">let </span><span class="kw-2">mut </span>permutation_array = Vec::new();
permute_by_swap(<span class="kw-2">&amp;mut </span>permutation_array, |i, j| x.swap(i, j));
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>permute_by_swap_on_arbitrary_array() {
<span class="kw">let </span><span class="kw-2">mut </span>x = <span class="macro">vec!</span>[<span class="string">&#39;a&#39;</span>, <span class="string">&#39;b&#39;</span>, <span class="string">&#39;c&#39;</span>, <span class="string">&#39;d&#39;</span>];
<span class="kw">let </span><span class="kw-2">mut </span>permutation_array = <span class="macro">vec!</span>[<span class="number">0</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">1</span>];
permute_by_swap(<span class="kw-2">&amp;mut </span>permutation_array, |i, j| x.swap(i, j));
<span class="macro">assert_eq!</span>(x, <span class="macro">vec!</span>[<span class="string">&#39;a&#39;</span>, <span class="string">&#39;d&#39;</span>, <span class="string">&#39;b&#39;</span>, <span class="string">&#39;c&#39;</span>]);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>permute_by_swap_identity_on_arbitrary_array() {
<span class="kw">let </span><span class="kw-2">mut </span>x = <span class="macro">vec!</span>[<span class="string">&#39;a&#39;</span>, <span class="string">&#39;b&#39;</span>, <span class="string">&#39;c&#39;</span>, <span class="string">&#39;d&#39;</span>];
<span class="kw">let </span><span class="kw-2">mut </span>permutation_array = <span class="macro">vec!</span>[<span class="number">0</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>];
permute_by_swap(<span class="kw-2">&amp;mut </span>permutation_array, |i, j| x.swap(i, j));
<span class="macro">assert_eq!</span>(x, <span class="macro">vec!</span>[<span class="string">&#39;a&#39;</span>, <span class="string">&#39;b&#39;</span>, <span class="string">&#39;c&#39;</span>, <span class="string">&#39;d&#39;</span>]);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>compose_into_buffer() {
<span class="kw">let </span>p = PermutationMatrix::&lt;u32&gt;::from_array(<span class="macro">vec!</span>[<span class="number">2</span>, <span class="number">1</span>, <span class="number">0</span>]).unwrap();
<span class="kw">let </span>q = PermutationMatrix::&lt;u32&gt;::from_array(<span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">0</span>, <span class="number">2</span>]).unwrap();
<span class="kw">let </span>pq_expected = PermutationMatrix::&lt;u32&gt;::from_array(<span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">0</span>]).unwrap();
<span class="kw">let </span>qp_expected = PermutationMatrix::&lt;u32&gt;::from_array(<span class="macro">vec!</span>[<span class="number">2</span>, <span class="number">0</span>, <span class="number">1</span>]).unwrap();
{
<span class="kw">let </span><span class="kw-2">mut </span>pq = PermutationMatrix::identity(<span class="number">3</span>);
p.compose_into_buffer(<span class="kw-2">&amp;</span>q, <span class="kw-2">&amp;mut </span>pq);
<span class="macro">assert_eq!</span>(pq, pq_expected);
}
{
<span class="kw">let </span><span class="kw-2">mut </span>qp = PermutationMatrix::identity(<span class="number">3</span>);
q.compose_into_buffer(<span class="kw-2">&amp;</span>p, <span class="kw-2">&amp;mut </span>qp);
<span class="macro">assert_eq!</span>(qp, qp_expected);
}
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>compose_regression() {
<span class="comment">// At some point during development, this example failed to
// give the expected results
</span><span class="kw">let </span>p = PermutationMatrix::&lt;u32&gt;::from_array(<span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">0</span>]).unwrap();
<span class="kw">let </span>q = PermutationMatrix::&lt;u32&gt;::from_array(<span class="macro">vec!</span>[<span class="number">2</span>, <span class="number">0</span>, <span class="number">1</span>]).unwrap();
<span class="kw">let </span>pq_expected = PermutationMatrix::&lt;u32&gt;::from_array(<span class="macro">vec!</span>[<span class="number">0</span>, <span class="number">1</span>, <span class="number">2</span>]).unwrap();
<span class="kw">let </span><span class="kw-2">mut </span>pq = PermutationMatrix::identity(<span class="number">3</span>);
p.compose_into_buffer(<span class="kw-2">&amp;</span>q, <span class="kw-2">&amp;mut </span>pq);
<span class="macro">assert_eq!</span>(pq, pq_expected);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>permute_rows_into_buffer() {
<span class="kw">let </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="kw">let </span>p = PermutationMatrix::from_array(<span class="macro">vec!</span>[<span class="number">2</span>, <span class="number">1</span>, <span class="number">3</span>, <span class="number">0</span>]).unwrap();
<span class="kw">let </span><span class="kw-2">mut </span>output = Matrix::zeros(<span class="number">4</span>, <span class="number">1</span>);
p.permute_rows_into_buffer(<span class="kw-2">&amp;</span>x, <span class="kw-2">&amp;mut </span>output);
<span class="macro">assert_matrix_eq!</span>(output, <span class="macro">matrix!</span>[ <span class="number">3</span>; <span class="number">1</span>; <span class="number">0</span>; <span class="number">2</span>]);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>permute_rows_in_place() {
<span class="kw">let </span><span class="kw-2">mut </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="kw">let </span>p = PermutationMatrix::from_array(<span class="macro">vec!</span>[<span class="number">2</span>, <span class="number">1</span>, <span class="number">3</span>, <span class="number">0</span>]).unwrap();
p.permute_rows_in_place(<span class="kw-2">&amp;mut </span>x);
<span class="macro">assert_matrix_eq!</span>(x, <span class="macro">matrix!</span>[ <span class="number">3</span>; <span class="number">1</span>; <span class="number">0</span>; <span class="number">2</span>]);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>permute_cols_into_buffer() {
<span class="kw">let </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="kw">let </span>p = PermutationMatrix::from_array(<span class="macro">vec!</span>[<span class="number">2</span>, <span class="number">1</span>, <span class="number">3</span>, <span class="number">0</span>]).unwrap();
<span class="kw">let </span><span class="kw-2">mut </span>output = Matrix::zeros(<span class="number">1</span>, <span class="number">4</span>);
p.permute_cols_into_buffer(<span class="kw-2">&amp;</span>x, <span class="kw-2">&amp;mut </span>output);
<span class="macro">assert_matrix_eq!</span>(output, <span class="macro">matrix!</span>[ <span class="number">3</span>, <span class="number">1</span>, <span class="number">0</span>, <span class="number">2</span>]);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>permute_cols_in_place() {
<span class="kw">let </span><span class="kw-2">mut </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="kw">let </span>p = PermutationMatrix::from_array(<span class="macro">vec!</span>[<span class="number">2</span>, <span class="number">1</span>, <span class="number">3</span>, <span class="number">0</span>]).unwrap();
p.permute_cols_in_place(<span class="kw-2">&amp;mut </span>x);
<span class="macro">assert_matrix_eq!</span>(x, <span class="macro">matrix!</span>[ <span class="number">3</span>, <span class="number">1</span>, <span class="number">0</span>, <span class="number">2</span>]);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>permute_vector_into_buffer() {
<span class="kw">let </span>x = <span class="macro">vector!</span>[ <span class="number">0</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>];
<span class="kw">let </span>p = PermutationMatrix::from_array(<span class="macro">vec!</span>[<span class="number">2</span>, <span class="number">1</span>, <span class="number">3</span>, <span class="number">0</span>]).unwrap();
<span class="kw">let </span><span class="kw-2">mut </span>output = Vector::zeros(<span class="number">4</span>);
p.permute_vector_into_buffer(<span class="kw-2">&amp;</span>x, <span class="kw-2">&amp;mut </span>output);
<span class="macro">assert_vector_eq!</span>(output, <span class="macro">vector!</span>[ <span class="number">3</span>, <span class="number">1</span>, <span class="number">0</span>, <span class="number">2</span>]);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>permute_vector_in_place() {
<span class="kw">let </span><span class="kw-2">mut </span>x = <span class="macro">vector!</span>[ <span class="number">0</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>];
<span class="kw">let </span>p = PermutationMatrix::from_array(<span class="macro">vec!</span>[<span class="number">2</span>, <span class="number">1</span>, <span class="number">3</span>, <span class="number">0</span>]).unwrap();
p.permute_vector_in_place(<span class="kw-2">&amp;mut </span>x);
<span class="macro">assert_vector_eq!</span>(x, <span class="macro">vector!</span>[ <span class="number">3</span>, <span class="number">1</span>, <span class="number">0</span>, <span class="number">2</span>]);
}
<span class="kw">use </span>quickcheck::{Arbitrary, Gen};
<span class="comment">// In order to write property tests for the validation of a permutation,
// we need to be able to generate arbitrary (valid) permutations.
</span><span class="attribute">#[derive(Debug, Clone, PartialEq, Eq)]
</span><span class="kw">struct </span>ValidPermutationArray(<span class="kw">pub </span>Vec&lt;usize&gt;);
<span class="kw">impl </span>Arbitrary <span class="kw">for </span>ValidPermutationArray {
<span class="kw">fn </span>arbitrary&lt;G: Gen&gt;(g: <span class="kw-2">&amp;mut </span>G) -&gt; <span class="self">Self </span>{
<span class="kw">let </span>upper_bound = g.size();
<span class="kw">let </span><span class="kw-2">mut </span>array = (<span class="number">0 </span>.. upper_bound).collect::&lt;Vec&lt;usize&gt;&gt;();
g.shuffle(<span class="kw-2">&amp;mut </span>array);
ValidPermutationArray(array)
}
}
<span class="comment">// We also want to be able to generate invalid permutations for
// the same reasons
</span><span class="attribute">#[derive(Debug, Clone, PartialEq, Eq)]
</span><span class="kw">struct </span>InvalidPermutationArray(<span class="kw">pub </span>Vec&lt;usize&gt;);
<span class="kw">impl </span>Arbitrary <span class="kw">for </span>InvalidPermutationArray {
<span class="kw">fn </span>arbitrary&lt;G: Gen&gt;(g: <span class="kw-2">&amp;mut </span>G) -&gt; <span class="self">Self </span>{
<span class="comment">// Take an arbitrary valid permutation and mutate it so that
// it is invalid
</span><span class="kw">let </span><span class="kw-2">mut </span>permutation_array = ValidPermutationArray::arbitrary(g).<span class="number">0</span>;
<span class="kw">let </span>n = permutation_array.len();
<span class="comment">// There are two essential sources of invalidity:
// 1. Duplicate elements
// 2. Indices out of bounds
// We want to have either or both
</span><span class="kw">let </span>should_have_duplicates = g.gen::&lt;bool&gt;();
<span class="kw">let </span>should_have_out_of_bounds = !should_have_duplicates || g.gen::&lt;bool&gt;();
<span class="macro">assert!</span>(should_have_duplicates || should_have_out_of_bounds);
<span class="kw">if </span>should_have_out_of_bounds {
<span class="kw">let </span>num_out_of_bounds_rounds = g.gen_range::&lt;usize&gt;(<span class="number">1</span>, n);
<span class="kw">for _ in </span><span class="number">0 </span>.. num_out_of_bounds_rounds {
<span class="kw">let </span>interior_index = g.gen_range::&lt;usize&gt;(<span class="number">0</span>, n);
<span class="kw">let </span>exterior_index = n + g.gen::&lt;usize&gt;();
permutation_array[interior_index] = exterior_index;
}
}
<span class="kw">if </span>should_have_duplicates {
<span class="kw">let </span>num_duplicates = g.gen_range::&lt;usize&gt;(<span class="number">1</span>, n);
<span class="kw">for _ in </span><span class="number">0 </span>.. num_duplicates {
<span class="kw">let </span>interior_index = g.gen_range::&lt;usize&gt;(<span class="number">0</span>, n);
<span class="kw">let </span>duplicate_value = permutation_array[interior_index];
permutation_array.push(duplicate_value);
}
}
<span class="comment">// The duplicates are placed at the end, so we perform
// an additional shuffle to end up with a more or less
// arbitrary invalid permutation
</span>g.shuffle(<span class="kw-2">&amp;mut </span>permutation_array);
InvalidPermutationArray(permutation_array)
}
}
<span class="kw">impl</span>&lt;T: Send + Clone + <span class="lifetime">&#39;static</span>&gt; Arbitrary <span class="kw">for </span>PermutationMatrix&lt;T&gt; {
<span class="kw">fn </span>arbitrary&lt;G: Gen&gt;(g: <span class="kw-2">&amp;mut </span>G) -&gt; <span class="self">Self </span>{
<span class="kw">let </span>ValidPermutationArray(array) = ValidPermutationArray::arbitrary(g);
PermutationMatrix::from_array(array)
.expect(<span class="string">&quot;The generated permutation array should always be valid.&quot;</span>)
}
}
<span class="macro">quickcheck! </span>{
<span class="kw">fn </span>property_validate_permutation_is_ok_for_valid_input(array: ValidPermutationArray) -&gt; bool {
validate_permutation(<span class="kw-2">&amp;</span>array.<span class="number">0</span>).is_ok()
}
}
<span class="macro">quickcheck! </span>{
<span class="kw">fn </span>property_validate_permutation_is_err_for_invalid_input(array: InvalidPermutationArray) -&gt; bool {
validate_permutation(<span class="kw-2">&amp;</span>array.<span class="number">0</span>).is_err()
}
}
<span class="macro">quickcheck! </span>{
<span class="kw">fn </span>property_identity_has_identity_array(size: usize) -&gt; bool {
<span class="kw">let </span>p = PermutationMatrix::&lt;u64&gt;::identity(size);
<span class="kw">let </span>p_as_array: Vec&lt;usize&gt; = p.into();
<span class="kw">let </span>expected = (<span class="number">0 </span>.. size).collect::&lt;Vec&lt;usize&gt;&gt;();
p_as_array == expected
}
}
<span class="macro">quickcheck! </span>{
<span class="kw">fn </span>property_dim_is_equal_to_array_dimensions(array: ValidPermutationArray) -&gt; bool {
<span class="kw">let </span>ValidPermutationArray(array) = array;
<span class="kw">let </span>n = array.len();
<span class="kw">let </span>p = PermutationMatrix::&lt;u32&gt;::from_array(array).unwrap();
p.size() == n
}
}
<span class="macro">quickcheck! </span>{
<span class="kw">fn </span>property_inverse_of_inverse_is_original(p: PermutationMatrix&lt;u32&gt;) -&gt; bool {
p == p.inverse().inverse()
}
}
<span class="macro">quickcheck! </span>{
<span class="kw">fn </span>property_inverse_composes_to_identity(p: PermutationMatrix&lt;u32&gt;) -&gt; bool {
<span class="comment">// Recall that P * P_inv = I and P_inv * P = I
</span><span class="kw">let </span>n = p.size();
<span class="kw">let </span>pinv = p.inverse();
<span class="kw">let </span><span class="kw-2">mut </span>p_pinv_composition = PermutationMatrix::identity(n);
<span class="kw">let </span><span class="kw-2">mut </span>pinv_p_composition = PermutationMatrix::identity(n);
p.compose_into_buffer(<span class="kw-2">&amp;</span>pinv, <span class="kw-2">&amp;mut </span>p_pinv_composition);
pinv.compose_into_buffer(<span class="kw-2">&amp;</span>p, <span class="kw-2">&amp;mut </span>pinv_p_composition);
<span class="macro">assert_eq!</span>(p_pinv_composition, PermutationMatrix::identity(n));
<span class="macro">assert_eq!</span>(pinv_p_composition, PermutationMatrix::identity(n));
<span class="bool-val">true
</span>}
}
<span class="macro">quickcheck! </span>{
<span class="kw">fn </span>property_identity_parity_is_even(n: usize) -&gt; bool {
<span class="kw">let </span>p = PermutationMatrix::&lt;u32&gt;::identity(n);
p.parity() == Parity::Even
}
}
<span class="macro">quickcheck! </span>{
<span class="kw">fn </span>property_parity_agrees_with_parity_of_inversions(p: PermutationMatrix&lt;u32&gt;) -&gt; bool {
<span class="kw">let </span>array: <span class="kw-2">&amp;</span>[usize] = (<span class="kw-2">&amp;</span>p).into();
<span class="kw">let </span>num_inversions = array.iter().cloned().enumerate()
.cartesian_product(array.iter().cloned().enumerate())
.filter(|<span class="kw-2">&amp;</span>((i, permuted_i), (j, permuted_j))|
<span class="comment">// This is simply the definition of an inversion
</span>i &lt; j &amp;&amp; permuted_i &gt; permuted_j
)
.count();
<span class="comment">// Recall that the parity of the number of inversions in the
// permutation is equal to the parity of the permutation
</span><span class="kw">let </span>parity = <span class="kw">if </span>num_inversions % <span class="number">2 </span>== <span class="number">0 </span>{
Parity::Even
} <span class="kw">else </span>{
Parity::Odd
};
parity == p.clone().parity()
}
}
}
</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>