| <!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/registry/src/github.com-1ecc6299db9ec823/num-traits-0.2.15/src/int.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>int.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="../../num_traits/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="../../num_traits/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> |
| </pre><pre class="rust"><code><span class="kw">use </span>core::ops::{BitAnd, BitOr, BitXor, Not, Shl, Shr}; |
| |
| <span class="kw">use </span>bounds::Bounded; |
| <span class="kw">use </span>ops::checked::<span class="kw-2">*</span>; |
| <span class="kw">use </span>ops::saturating::Saturating; |
| <span class="kw">use </span>{Num, NumCast}; |
| |
| <span class="doccomment">/// Generic trait for primitive integers. |
| /// |
| /// The `PrimInt` trait is an abstraction over the builtin primitive integer types (e.g., `u8`, |
| /// `u32`, `isize`, `i128`, ...). It inherits the basic numeric traits and extends them with |
| /// bitwise operators and non-wrapping arithmetic. |
| /// |
| /// The trait explicitly inherits `Copy`, `Eq`, `Ord`, and `Sized`. The intention is that all |
| /// types implementing this trait behave like primitive types that are passed by value by default |
| /// and behave like builtin integers. Furthermore, the types are expected to expose the integer |
| /// value in binary representation and support bitwise operators. The standard bitwise operations |
| /// (e.g., bitwise-and, bitwise-or, right-shift, left-shift) are inherited and the trait extends |
| /// these with introspective queries (e.g., `PrimInt::count_ones()`, `PrimInt::leading_zeros()`), |
| /// bitwise combinators (e.g., `PrimInt::rotate_left()`), and endianness converters (e.g., |
| /// `PrimInt::to_be()`). |
| /// |
| /// All `PrimInt` types are expected to be fixed-width binary integers. The width can be queried |
| /// via `T::zero().count_zeros()`. The trait currently lacks a way to query the width at |
| /// compile-time. |
| /// |
| /// While a default implementation for all builtin primitive integers is provided, the trait is in |
| /// no way restricted to these. Other integer types that fulfil the requirements are free to |
| /// implement the trait was well. |
| /// |
| /// This trait and many of the method names originate in the unstable `core::num::Int` trait from |
| /// the rust standard library. The original trait was never stabilized and thus removed from the |
| /// standard library. |
| </span><span class="kw">pub trait </span>PrimInt: |
| Sized |
| + Copy |
| + Num |
| + NumCast |
| + Bounded |
| + PartialOrd |
| + Ord |
| + Eq |
| + Not<Output = <span class="self">Self</span>> |
| + BitAnd<Output = <span class="self">Self</span>> |
| + BitOr<Output = <span class="self">Self</span>> |
| + BitXor<Output = <span class="self">Self</span>> |
| + Shl<usize, Output = <span class="self">Self</span>> |
| + Shr<usize, Output = <span class="self">Self</span>> |
| + CheckedAdd<Output = <span class="self">Self</span>> |
| + CheckedSub<Output = <span class="self">Self</span>> |
| + CheckedMul<Output = <span class="self">Self</span>> |
| + CheckedDiv<Output = <span class="self">Self</span>> |
| + Saturating |
| { |
| <span class="doccomment">/// Returns the number of ones in the binary representation of `self`. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use num_traits::PrimInt; |
| /// |
| /// let n = 0b01001100u8; |
| /// |
| /// assert_eq!(n.count_ones(), 3); |
| /// ``` |
| </span><span class="kw">fn </span>count_ones(<span class="self">self</span>) -> u32; |
| |
| <span class="doccomment">/// Returns the number of zeros in the binary representation of `self`. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use num_traits::PrimInt; |
| /// |
| /// let n = 0b01001100u8; |
| /// |
| /// assert_eq!(n.count_zeros(), 5); |
| /// ``` |
| </span><span class="kw">fn </span>count_zeros(<span class="self">self</span>) -> u32; |
| |
| <span class="doccomment">/// Returns the number of leading ones in the binary representation |
| /// of `self`. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use num_traits::PrimInt; |
| /// |
| /// let n = 0xF00Du16; |
| /// |
| /// assert_eq!(n.leading_ones(), 4); |
| /// ``` |
| </span><span class="kw">fn </span>leading_ones(<span class="self">self</span>) -> u32 { |
| (!<span class="self">self</span>).leading_zeros() |
| } |
| |
| <span class="doccomment">/// Returns the number of leading zeros in the binary representation |
| /// of `self`. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use num_traits::PrimInt; |
| /// |
| /// let n = 0b0101000u16; |
| /// |
| /// assert_eq!(n.leading_zeros(), 10); |
| /// ``` |
| </span><span class="kw">fn </span>leading_zeros(<span class="self">self</span>) -> u32; |
| |
| <span class="doccomment">/// Returns the number of trailing ones in the binary representation |
| /// of `self`. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use num_traits::PrimInt; |
| /// |
| /// let n = 0xBEEFu16; |
| /// |
| /// assert_eq!(n.trailing_ones(), 4); |
| /// ``` |
| </span><span class="kw">fn </span>trailing_ones(<span class="self">self</span>) -> u32 { |
| (!<span class="self">self</span>).trailing_zeros() |
| } |
| |
| <span class="doccomment">/// Returns the number of trailing zeros in the binary representation |
| /// of `self`. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use num_traits::PrimInt; |
| /// |
| /// let n = 0b0101000u16; |
| /// |
| /// assert_eq!(n.trailing_zeros(), 3); |
| /// ``` |
| </span><span class="kw">fn </span>trailing_zeros(<span class="self">self</span>) -> u32; |
| |
| <span class="doccomment">/// Shifts the bits to the left by a specified amount, `n`, wrapping |
| /// the truncated bits to the end of the resulting integer. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use num_traits::PrimInt; |
| /// |
| /// let n = 0x0123456789ABCDEFu64; |
| /// let m = 0x3456789ABCDEF012u64; |
| /// |
| /// assert_eq!(n.rotate_left(12), m); |
| /// ``` |
| </span><span class="kw">fn </span>rotate_left(<span class="self">self</span>, n: u32) -> <span class="self">Self</span>; |
| |
| <span class="doccomment">/// Shifts the bits to the right by a specified amount, `n`, wrapping |
| /// the truncated bits to the beginning of the resulting integer. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use num_traits::PrimInt; |
| /// |
| /// let n = 0x0123456789ABCDEFu64; |
| /// let m = 0xDEF0123456789ABCu64; |
| /// |
| /// assert_eq!(n.rotate_right(12), m); |
| /// ``` |
| </span><span class="kw">fn </span>rotate_right(<span class="self">self</span>, n: u32) -> <span class="self">Self</span>; |
| |
| <span class="doccomment">/// Shifts the bits to the left by a specified amount, `n`, filling |
| /// zeros in the least significant bits. |
| /// |
| /// This is bitwise equivalent to signed `Shl`. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use num_traits::PrimInt; |
| /// |
| /// let n = 0x0123456789ABCDEFu64; |
| /// let m = 0x3456789ABCDEF000u64; |
| /// |
| /// assert_eq!(n.signed_shl(12), m); |
| /// ``` |
| </span><span class="kw">fn </span>signed_shl(<span class="self">self</span>, n: u32) -> <span class="self">Self</span>; |
| |
| <span class="doccomment">/// Shifts the bits to the right by a specified amount, `n`, copying |
| /// the "sign bit" in the most significant bits even for unsigned types. |
| /// |
| /// This is bitwise equivalent to signed `Shr`. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use num_traits::PrimInt; |
| /// |
| /// let n = 0xFEDCBA9876543210u64; |
| /// let m = 0xFFFFEDCBA9876543u64; |
| /// |
| /// assert_eq!(n.signed_shr(12), m); |
| /// ``` |
| </span><span class="kw">fn </span>signed_shr(<span class="self">self</span>, n: u32) -> <span class="self">Self</span>; |
| |
| <span class="doccomment">/// Shifts the bits to the left by a specified amount, `n`, filling |
| /// zeros in the least significant bits. |
| /// |
| /// This is bitwise equivalent to unsigned `Shl`. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use num_traits::PrimInt; |
| /// |
| /// let n = 0x0123456789ABCDEFi64; |
| /// let m = 0x3456789ABCDEF000i64; |
| /// |
| /// assert_eq!(n.unsigned_shl(12), m); |
| /// ``` |
| </span><span class="kw">fn </span>unsigned_shl(<span class="self">self</span>, n: u32) -> <span class="self">Self</span>; |
| |
| <span class="doccomment">/// Shifts the bits to the right by a specified amount, `n`, filling |
| /// zeros in the most significant bits. |
| /// |
| /// This is bitwise equivalent to unsigned `Shr`. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use num_traits::PrimInt; |
| /// |
| /// let n = -8i8; // 0b11111000 |
| /// let m = 62i8; // 0b00111110 |
| /// |
| /// assert_eq!(n.unsigned_shr(2), m); |
| /// ``` |
| </span><span class="kw">fn </span>unsigned_shr(<span class="self">self</span>, n: u32) -> <span class="self">Self</span>; |
| |
| <span class="doccomment">/// Reverses the byte order of the integer. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use num_traits::PrimInt; |
| /// |
| /// let n = 0x0123456789ABCDEFu64; |
| /// let m = 0xEFCDAB8967452301u64; |
| /// |
| /// assert_eq!(n.swap_bytes(), m); |
| /// ``` |
| </span><span class="kw">fn </span>swap_bytes(<span class="self">self</span>) -> <span class="self">Self</span>; |
| |
| <span class="doccomment">/// Reverses the order of bits in the integer. |
| /// |
| /// The least significant bit becomes the most significant bit, second least-significant bit |
| /// becomes second most-significant bit, etc. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use num_traits::PrimInt; |
| /// |
| /// let n = 0x12345678u32; |
| /// let m = 0x1e6a2c48u32; |
| /// |
| /// assert_eq!(n.reverse_bits(), m); |
| /// assert_eq!(0u32.reverse_bits(), 0); |
| /// ``` |
| </span><span class="kw">fn </span>reverse_bits(<span class="self">self</span>) -> <span class="self">Self </span>{ |
| reverse_bits_fallback(<span class="self">self</span>) |
| } |
| |
| <span class="doccomment">/// Convert an integer from big endian to the target's endianness. |
| /// |
| /// On big endian this is a no-op. On little endian the bytes are swapped. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use num_traits::PrimInt; |
| /// |
| /// let n = 0x0123456789ABCDEFu64; |
| /// |
| /// if cfg!(target_endian = "big") { |
| /// assert_eq!(u64::from_be(n), n) |
| /// } else { |
| /// assert_eq!(u64::from_be(n), n.swap_bytes()) |
| /// } |
| /// ``` |
| </span><span class="kw">fn </span>from_be(x: <span class="self">Self</span>) -> <span class="self">Self</span>; |
| |
| <span class="doccomment">/// Convert an integer from little endian to the target's endianness. |
| /// |
| /// On little endian this is a no-op. On big endian the bytes are swapped. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use num_traits::PrimInt; |
| /// |
| /// let n = 0x0123456789ABCDEFu64; |
| /// |
| /// if cfg!(target_endian = "little") { |
| /// assert_eq!(u64::from_le(n), n) |
| /// } else { |
| /// assert_eq!(u64::from_le(n), n.swap_bytes()) |
| /// } |
| /// ``` |
| </span><span class="kw">fn </span>from_le(x: <span class="self">Self</span>) -> <span class="self">Self</span>; |
| |
| <span class="doccomment">/// Convert `self` to big endian from the target's endianness. |
| /// |
| /// On big endian this is a no-op. On little endian the bytes are swapped. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use num_traits::PrimInt; |
| /// |
| /// let n = 0x0123456789ABCDEFu64; |
| /// |
| /// if cfg!(target_endian = "big") { |
| /// assert_eq!(n.to_be(), n) |
| /// } else { |
| /// assert_eq!(n.to_be(), n.swap_bytes()) |
| /// } |
| /// ``` |
| </span><span class="kw">fn </span>to_be(<span class="self">self</span>) -> <span class="self">Self</span>; |
| |
| <span class="doccomment">/// Convert `self` to little endian from the target's endianness. |
| /// |
| /// On little endian this is a no-op. On big endian the bytes are swapped. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use num_traits::PrimInt; |
| /// |
| /// let n = 0x0123456789ABCDEFu64; |
| /// |
| /// if cfg!(target_endian = "little") { |
| /// assert_eq!(n.to_le(), n) |
| /// } else { |
| /// assert_eq!(n.to_le(), n.swap_bytes()) |
| /// } |
| /// ``` |
| </span><span class="kw">fn </span>to_le(<span class="self">self</span>) -> <span class="self">Self</span>; |
| |
| <span class="doccomment">/// Raises self to the power of `exp`, using exponentiation by squaring. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// use num_traits::PrimInt; |
| /// |
| /// assert_eq!(2i32.pow(4), 16); |
| /// ``` |
| </span><span class="kw">fn </span>pow(<span class="self">self</span>, exp: u32) -> <span class="self">Self</span>; |
| } |
| |
| <span class="kw">fn </span>one_per_byte<P: PrimInt>() -> P { |
| <span class="comment">// i8, u8: return 0x01 |
| // i16, u16: return 0x0101 = (0x01 << 8) | 0x01 |
| // i32, u32: return 0x01010101 = (0x0101 << 16) | 0x0101 |
| // ... |
| </span><span class="kw">let </span><span class="kw-2">mut </span>ret = P::one(); |
| <span class="kw">let </span><span class="kw-2">mut </span>shift = <span class="number">8</span>; |
| <span class="kw">let </span><span class="kw-2">mut </span>b = ret.count_zeros() >> <span class="number">3</span>; |
| <span class="kw">while </span>b != <span class="number">0 </span>{ |
| ret = (ret << shift) | ret; |
| shift <<= <span class="number">1</span>; |
| b >>= <span class="number">1</span>; |
| } |
| ret |
| } |
| |
| <span class="kw">fn </span>reverse_bits_fallback<P: PrimInt>(i: P) -> P { |
| <span class="kw">let </span>rep_01: P = one_per_byte(); |
| <span class="kw">let </span>rep_03 = (rep_01 << <span class="number">1</span>) | rep_01; |
| <span class="kw">let </span>rep_05 = (rep_01 << <span class="number">2</span>) | rep_01; |
| <span class="kw">let </span>rep_0f = (rep_03 << <span class="number">2</span>) | rep_03; |
| <span class="kw">let </span>rep_33 = (rep_03 << <span class="number">4</span>) | rep_03; |
| <span class="kw">let </span>rep_55 = (rep_05 << <span class="number">4</span>) | rep_05; |
| |
| <span class="comment">// code above only used to determine rep_0f, rep_33, rep_55; |
| // optimizer should be able to do it in compile time |
| </span><span class="kw">let </span><span class="kw-2">mut </span>ret = i.swap_bytes(); |
| ret = ((ret & rep_0f) << <span class="number">4</span>) | ((ret >> <span class="number">4</span>) & rep_0f); |
| ret = ((ret & rep_33) << <span class="number">2</span>) | ((ret >> <span class="number">2</span>) & rep_33); |
| ret = ((ret & rep_55) << <span class="number">1</span>) | ((ret >> <span class="number">1</span>) & rep_55); |
| ret |
| } |
| |
| <span class="macro">macro_rules! </span>prim_int_impl { |
| (<span class="macro-nonterminal">$T</span>:ty, <span class="macro-nonterminal">$S</span>:ty, <span class="macro-nonterminal">$U</span>:ty) => { |
| <span class="kw">impl </span>PrimInt <span class="kw">for </span><span class="macro-nonterminal">$T </span>{ |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>count_ones(<span class="self">self</span>) -> u32 { |
| <<span class="macro-nonterminal">$T</span>>::count_ones(<span class="self">self</span>) |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>count_zeros(<span class="self">self</span>) -> u32 { |
| <<span class="macro-nonterminal">$T</span>>::count_zeros(<span class="self">self</span>) |
| } |
| |
| <span class="attribute">#[cfg(has_leading_trailing_ones)] |
| #[inline] |
| </span><span class="kw">fn </span>leading_ones(<span class="self">self</span>) -> u32 { |
| <<span class="macro-nonterminal">$T</span>>::leading_ones(<span class="self">self</span>) |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>leading_zeros(<span class="self">self</span>) -> u32 { |
| <<span class="macro-nonterminal">$T</span>>::leading_zeros(<span class="self">self</span>) |
| } |
| |
| <span class="attribute">#[cfg(has_leading_trailing_ones)] |
| #[inline] |
| </span><span class="kw">fn </span>trailing_ones(<span class="self">self</span>) -> u32 { |
| <<span class="macro-nonterminal">$T</span>>::trailing_ones(<span class="self">self</span>) |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>trailing_zeros(<span class="self">self</span>) -> u32 { |
| <<span class="macro-nonterminal">$T</span>>::trailing_zeros(<span class="self">self</span>) |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>rotate_left(<span class="self">self</span>, n: u32) -> <span class="self">Self </span>{ |
| <<span class="macro-nonterminal">$T</span>>::rotate_left(<span class="self">self</span>, n) |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>rotate_right(<span class="self">self</span>, n: u32) -> <span class="self">Self </span>{ |
| <<span class="macro-nonterminal">$T</span>>::rotate_right(<span class="self">self</span>, n) |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>signed_shl(<span class="self">self</span>, n: u32) -> <span class="self">Self </span>{ |
| ((<span class="self">self </span><span class="kw">as </span><span class="macro-nonterminal">$S</span>) << n) <span class="kw">as </span><span class="macro-nonterminal">$T |
| </span>} |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>signed_shr(<span class="self">self</span>, n: u32) -> <span class="self">Self </span>{ |
| ((<span class="self">self </span><span class="kw">as </span><span class="macro-nonterminal">$S</span>) >> n) <span class="kw">as </span><span class="macro-nonterminal">$T |
| </span>} |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>unsigned_shl(<span class="self">self</span>, n: u32) -> <span class="self">Self </span>{ |
| ((<span class="self">self </span><span class="kw">as </span><span class="macro-nonterminal">$U</span>) << n) <span class="kw">as </span><span class="macro-nonterminal">$T |
| </span>} |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>unsigned_shr(<span class="self">self</span>, n: u32) -> <span class="self">Self </span>{ |
| ((<span class="self">self </span><span class="kw">as </span><span class="macro-nonterminal">$U</span>) >> n) <span class="kw">as </span><span class="macro-nonterminal">$T |
| </span>} |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>swap_bytes(<span class="self">self</span>) -> <span class="self">Self </span>{ |
| <<span class="macro-nonterminal">$T</span>>::swap_bytes(<span class="self">self</span>) |
| } |
| |
| <span class="attribute">#[cfg(has_reverse_bits)] |
| #[inline] |
| </span><span class="kw">fn </span>reverse_bits(<span class="self">self</span>) -> <span class="self">Self </span>{ |
| <<span class="macro-nonterminal">$T</span>>::reverse_bits(<span class="self">self</span>) |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>from_be(x: <span class="self">Self</span>) -> <span class="self">Self </span>{ |
| <<span class="macro-nonterminal">$T</span>>::from_be(x) |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>from_le(x: <span class="self">Self</span>) -> <span class="self">Self </span>{ |
| <<span class="macro-nonterminal">$T</span>>::from_le(x) |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>to_be(<span class="self">self</span>) -> <span class="self">Self </span>{ |
| <<span class="macro-nonterminal">$T</span>>::to_be(<span class="self">self</span>) |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>to_le(<span class="self">self</span>) -> <span class="self">Self </span>{ |
| <<span class="macro-nonterminal">$T</span>>::to_le(<span class="self">self</span>) |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>pow(<span class="self">self</span>, exp: u32) -> <span class="self">Self </span>{ |
| <<span class="macro-nonterminal">$T</span>>::pow(<span class="self">self</span>, exp) |
| } |
| } |
| }; |
| } |
| |
| <span class="comment">// prim_int_impl!(type, signed, unsigned); |
| </span><span class="macro">prim_int_impl!</span>(u8, i8, u8); |
| <span class="macro">prim_int_impl!</span>(u16, i16, u16); |
| <span class="macro">prim_int_impl!</span>(u32, i32, u32); |
| <span class="macro">prim_int_impl!</span>(u64, i64, u64); |
| <span class="attribute">#[cfg(has_i128)] |
| </span><span class="macro">prim_int_impl!</span>(u128, i128, u128); |
| <span class="macro">prim_int_impl!</span>(usize, isize, usize); |
| <span class="macro">prim_int_impl!</span>(i8, i8, u8); |
| <span class="macro">prim_int_impl!</span>(i16, i16, u16); |
| <span class="macro">prim_int_impl!</span>(i32, i32, u32); |
| <span class="macro">prim_int_impl!</span>(i64, i64, u64); |
| <span class="attribute">#[cfg(has_i128)] |
| </span><span class="macro">prim_int_impl!</span>(i128, i128, u128); |
| <span class="macro">prim_int_impl!</span>(isize, isize, usize); |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>tests { |
| <span class="kw">use </span>int::PrimInt; |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">pub fn </span>reverse_bits() { |
| <span class="kw">use </span>core::{i16, i32, i64, i8}; |
| |
| <span class="macro">assert_eq!</span>( |
| PrimInt::reverse_bits(<span class="number">0x0123_4567_89ab_cdefu64</span>), |
| <span class="number">0xf7b3_d591_e6a2_c480 |
| </span>); |
| |
| <span class="macro">assert_eq!</span>(PrimInt::reverse_bits(<span class="number">0i8</span>), <span class="number">0</span>); |
| <span class="macro">assert_eq!</span>(PrimInt::reverse_bits(-<span class="number">1i8</span>), -<span class="number">1</span>); |
| <span class="macro">assert_eq!</span>(PrimInt::reverse_bits(<span class="number">1i8</span>), i8::MIN); |
| <span class="macro">assert_eq!</span>(PrimInt::reverse_bits(i8::MIN), <span class="number">1</span>); |
| <span class="macro">assert_eq!</span>(PrimInt::reverse_bits(-<span class="number">2i8</span>), i8::MAX); |
| <span class="macro">assert_eq!</span>(PrimInt::reverse_bits(i8::MAX), -<span class="number">2</span>); |
| |
| <span class="macro">assert_eq!</span>(PrimInt::reverse_bits(<span class="number">0i16</span>), <span class="number">0</span>); |
| <span class="macro">assert_eq!</span>(PrimInt::reverse_bits(-<span class="number">1i16</span>), -<span class="number">1</span>); |
| <span class="macro">assert_eq!</span>(PrimInt::reverse_bits(<span class="number">1i16</span>), i16::MIN); |
| <span class="macro">assert_eq!</span>(PrimInt::reverse_bits(i16::MIN), <span class="number">1</span>); |
| <span class="macro">assert_eq!</span>(PrimInt::reverse_bits(-<span class="number">2i16</span>), i16::MAX); |
| <span class="macro">assert_eq!</span>(PrimInt::reverse_bits(i16::MAX), -<span class="number">2</span>); |
| |
| <span class="macro">assert_eq!</span>(PrimInt::reverse_bits(<span class="number">0i32</span>), <span class="number">0</span>); |
| <span class="macro">assert_eq!</span>(PrimInt::reverse_bits(-<span class="number">1i32</span>), -<span class="number">1</span>); |
| <span class="macro">assert_eq!</span>(PrimInt::reverse_bits(<span class="number">1i32</span>), i32::MIN); |
| <span class="macro">assert_eq!</span>(PrimInt::reverse_bits(i32::MIN), <span class="number">1</span>); |
| <span class="macro">assert_eq!</span>(PrimInt::reverse_bits(-<span class="number">2i32</span>), i32::MAX); |
| <span class="macro">assert_eq!</span>(PrimInt::reverse_bits(i32::MAX), -<span class="number">2</span>); |
| |
| <span class="macro">assert_eq!</span>(PrimInt::reverse_bits(<span class="number">0i64</span>), <span class="number">0</span>); |
| <span class="macro">assert_eq!</span>(PrimInt::reverse_bits(-<span class="number">1i64</span>), -<span class="number">1</span>); |
| <span class="macro">assert_eq!</span>(PrimInt::reverse_bits(<span class="number">1i64</span>), i64::MIN); |
| <span class="macro">assert_eq!</span>(PrimInt::reverse_bits(i64::MIN), <span class="number">1</span>); |
| <span class="macro">assert_eq!</span>(PrimInt::reverse_bits(-<span class="number">2i64</span>), i64::MAX); |
| <span class="macro">assert_eq!</span>(PrimInt::reverse_bits(i64::MAX), -<span class="number">2</span>); |
| } |
| |
| <span class="attribute">#[test] |
| #[cfg(has_i128)] |
| </span><span class="kw">pub fn </span>reverse_bits_i128() { |
| <span class="kw">use </span>core::i128; |
| |
| <span class="macro">assert_eq!</span>(PrimInt::reverse_bits(<span class="number">0i128</span>), <span class="number">0</span>); |
| <span class="macro">assert_eq!</span>(PrimInt::reverse_bits(-<span class="number">1i128</span>), -<span class="number">1</span>); |
| <span class="macro">assert_eq!</span>(PrimInt::reverse_bits(<span class="number">1i128</span>), i128::MIN); |
| <span class="macro">assert_eq!</span>(PrimInt::reverse_bits(i128::MIN), <span class="number">1</span>); |
| <span class="macro">assert_eq!</span>(PrimInt::reverse_bits(-<span class="number">2i128</span>), i128::MAX); |
| <span class="macro">assert_eq!</span>(PrimInt::reverse_bits(i128::MAX), -<span class="number">2</span>); |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="num_traits" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
