<!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 `/home/sangenya/.cargo/registry/src/github.com-1ecc6299db9ec823/ndarray-0.10.14/src/impl_views.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>impl_views.rs - source</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><script src="../../crates.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></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"><div class="sidebar-menu" role="button">☰</div><a href='../../ndarray/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img src="../../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img src="../../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><div class="example-wrap"><pre class="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>
</pre><pre class="rust">
<span class="comment">// Copyright 2014-2016 bluss and ndarray developers.</span>
<span class="comment">//</span>
<span class="comment">// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or</span>
<span class="comment">// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license</span>
<span class="comment">// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your</span>
<span class="comment">// option. This file may not be copied, modified, or distributed</span>
<span class="comment">// except according to those terms.</span>
<span class="kw">use</span> <span class="ident">std::slice</span>;
<span class="kw">use</span> <span class="ident">imp_prelude</span>::<span class="kw-2">*</span>;
<span class="kw">use</span> <span class="ident">dimension</span>::{<span class="self">self</span>, <span class="ident">stride_offset</span>};
<span class="kw">use</span> <span class="ident">error::ShapeError</span>;
<span class="kw">use</span> <span class="ident">NdIndex</span>;
<span class="kw">use</span> <span class="ident">arraytraits::array_out_of_bounds</span>;
<span class="kw">use</span> <span class="ident">StrideShape</span>;
<span class="kw">use</span> {
<span class="ident">ElementsBase</span>,
<span class="ident">ElementsBaseMut</span>,
<span class="ident">Iter</span>,
<span class="ident">IterMut</span>,
<span class="ident">Baseiter</span>,
};
<span class="kw">use</span> <span class="ident">iter</span>;
<span class="kw">use</span> <span class="ident">iterators</span>;
<span class="doccomment">/// Methods for read-only array views.</span>
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">A</span>, <span class="ident">D</span><span class="op">></span> <span class="ident">ArrayView</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">A</span>, <span class="ident">D</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">D</span>: <span class="ident">Dimension</span>,
{
<span class="doccomment">/// Create a read-only array view borrowing its data from a slice.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Checks whether `shape` are compatible with the slice's</span>
<span class="doccomment">/// length, returning an `Err` if not compatible.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// use ndarray::ArrayView;</span>
<span class="doccomment">/// use ndarray::arr3;</span>
<span class="doccomment">/// use ndarray::ShapeBuilder;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let s = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12];</span>
<span class="doccomment">/// let a = ArrayView::from_shape((2, 3, 2).strides((1, 4, 2)),</span>
<span class="doccomment">/// &s).unwrap();</span>
<span class="doccomment">///</span>
<span class="doccomment">/// assert!(</span>
<span class="doccomment">/// a == arr3(&[[[0, 2],</span>
<span class="doccomment">/// [4, 6],</span>
<span class="doccomment">/// [8, 10]],</span>
<span class="doccomment">/// [[1, 3],</span>
<span class="doccomment">/// [5, 7],</span>
<span class="doccomment">/// [9, 11]]])</span>
<span class="doccomment">/// );</span>
<span class="doccomment">/// assert!(a.strides() == &[1, 4, 2]);</span>
<span class="doccomment">/// ```</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">from_shape</span><span class="op"><</span><span class="ident">Sh</span><span class="op">></span>(<span class="ident">shape</span>: <span class="ident">Sh</span>, <span class="ident">xs</span>: <span class="kw-2">&</span><span class="lifetime">'a</span> [<span class="ident">A</span>])
<span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="self">Self</span>, <span class="ident">ShapeError</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">Sh</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">StrideShape</span><span class="op"><</span><span class="ident">D</span><span class="op">></span><span class="op">></span>,
{
<span class="kw">let</span> <span class="ident">shape</span> <span class="op">=</span> <span class="ident">shape</span>.<span class="ident">into</span>();
<span class="kw">let</span> <span class="ident">dim</span> <span class="op">=</span> <span class="ident">shape</span>.<span class="ident">dim</span>;
<span class="kw">let</span> <span class="ident">strides</span> <span class="op">=</span> <span class="ident">shape</span>.<span class="ident">strides</span>;
<span class="ident">dimension::can_index_slice</span>(<span class="ident">xs</span>, <span class="kw-2">&</span><span class="ident">dim</span>, <span class="kw-2">&</span><span class="ident">strides</span>).<span class="ident">map</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> {
<span class="kw">unsafe</span> {
<span class="self">Self</span><span class="ident">::new_</span>(<span class="ident">xs</span>.<span class="ident">as_ptr</span>(), <span class="ident">dim</span>, <span class="ident">strides</span>)
}
})
}
<span class="doccomment">/// Create an `ArrayView<A, D>` from shape information and a</span>
<span class="doccomment">/// raw pointer to the elements.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Unsafe because caller is responsible for ensuring that the pointer is</span>
<span class="doccomment">/// valid, not mutably aliased and coherent with the dimension and stride information.</span>
<span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">from_shape_ptr</span><span class="op"><</span><span class="ident">Sh</span><span class="op">></span>(<span class="ident">shape</span>: <span class="ident">Sh</span>, <span class="ident">ptr</span>: <span class="kw-2">*</span><span class="kw">const</span> <span class="ident">A</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span>
<span class="kw">where</span> <span class="ident">Sh</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">StrideShape</span><span class="op"><</span><span class="ident">D</span><span class="op">></span><span class="op">></span>
{
<span class="kw">let</span> <span class="ident">shape</span> <span class="op">=</span> <span class="ident">shape</span>.<span class="ident">into</span>();
<span class="kw">let</span> <span class="ident">dim</span> <span class="op">=</span> <span class="ident">shape</span>.<span class="ident">dim</span>;
<span class="kw">let</span> <span class="ident">strides</span> <span class="op">=</span> <span class="ident">shape</span>.<span class="ident">strides</span>;
<span class="ident">ArrayView::new_</span>(<span class="ident">ptr</span>, <span class="ident">dim</span>, <span class="ident">strides</span>)
}
<span class="doccomment">/// Split the array view along `axis` and return one view strictly before the</span>
<span class="doccomment">/// split and one view after the split.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// **Panics** if `axis` or `index` is out of bounds.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Below, an illustration of `.split_at(Axis(2), 2)` on</span>
<span class="doccomment">/// an array with shape 3 × 5 × 5.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// <img src="https://bluss.github.io/ndarray/images/split_at.svg" width="300px" height="271px"></span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">split_at</span>(<span class="self">self</span>, <span class="ident">axis</span>: <span class="ident">Axis</span>, <span class="ident">index</span>: <span class="ident">Ix</span>)
<span class="op">-</span><span class="op">></span> (<span class="self">Self</span>, <span class="self">Self</span>)
{
<span class="comment">// NOTE: Keep this in sync with the ArrayViewMut version</span>
<span class="macro">assert!</span>(<span class="ident">index</span> <span class="op"><</span><span class="op">=</span> <span class="self">self</span>.<span class="ident">len_of</span>(<span class="ident">axis</span>));
<span class="kw">let</span> <span class="ident">left_ptr</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">ptr</span>;
<span class="kw">let</span> <span class="ident">right_ptr</span> <span class="op">=</span> <span class="kw">if</span> <span class="ident">index</span> <span class="op">=</span><span class="op">=</span> <span class="self">self</span>.<span class="ident">len_of</span>(<span class="ident">axis</span>) {
<span class="self">self</span>.<span class="ident">ptr</span>
} <span class="kw">else</span> {
<span class="kw">let</span> <span class="ident">offset</span> <span class="op">=</span> <span class="ident">stride_offset</span>(<span class="ident">index</span>, <span class="self">self</span>.<span class="ident">strides</span>.<span class="ident">axis</span>(<span class="ident">axis</span>));
<span class="kw">unsafe</span> {
<span class="self">self</span>.<span class="ident">ptr</span>.<span class="ident">offset</span>(<span class="ident">offset</span>)
}
};
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">dim_left</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">dim</span>.<span class="ident">clone</span>();
<span class="ident">dim_left</span>.<span class="ident">set_axis</span>(<span class="ident">axis</span>, <span class="ident">index</span>);
<span class="kw">let</span> <span class="ident">left</span> <span class="op">=</span> <span class="kw">unsafe</span> {
<span class="self">Self</span><span class="ident">::new_</span>(<span class="ident">left_ptr</span>, <span class="ident">dim_left</span>, <span class="self">self</span>.<span class="ident">strides</span>.<span class="ident">clone</span>())
};
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">dim_right</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">dim</span>;
<span class="kw">let</span> <span class="ident">right_len</span> <span class="op">=</span> <span class="ident">dim_right</span>.<span class="ident">axis</span>(<span class="ident">axis</span>) <span class="op">-</span> <span class="ident">index</span>;
<span class="ident">dim_right</span>.<span class="ident">set_axis</span>(<span class="ident">axis</span>, <span class="ident">right_len</span>);
<span class="kw">let</span> <span class="ident">right</span> <span class="op">=</span> <span class="kw">unsafe</span> {
<span class="self">Self</span><span class="ident">::new_</span>(<span class="ident">right_ptr</span>, <span class="ident">dim_right</span>, <span class="self">self</span>.<span class="ident">strides</span>)
};
(<span class="ident">left</span>, <span class="ident">right</span>)
}
<span class="doccomment">/// Return the array’s data as a slice, if it is contiguous and in standard order.</span>
<span class="doccomment">/// Return `None` otherwise.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">into_slice</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'a</span> [<span class="ident">A</span>]<span class="op">></span> {
<span class="kw">if</span> <span class="self">self</span>.<span class="ident">is_standard_layout</span>() {
<span class="kw">unsafe</span> {
<span class="prelude-val">Some</span>(<span class="ident">slice::from_raw_parts</span>(<span class="self">self</span>.<span class="ident">ptr</span>, <span class="self">self</span>.<span class="ident">len</span>()))
}
} <span class="kw">else</span> {
<span class="prelude-val">None</span>
}
}
}
<span class="doccomment">/// Extra indexing methods for array views</span>
<span class="doccomment">///</span>
<span class="doccomment">/// These methods are very similar to regular indexing or calling of the</span>
<span class="doccomment">/// `get`/`get_mut` methods that we can use on any array or array view. The</span>
<span class="doccomment">/// difference here is in the length of lifetime in the resulting reference.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// **Note** that the `ArrayView` (read-only) and `ArrayViewMut` (read-write) differ</span>
<span class="doccomment">/// in how they are allowed implement this trait -- `ArrayView`'s implementation</span>
<span class="doccomment">/// is usual. If you put in a `ArrayView<'a, T, D>` here, you get references</span>
<span class="doccomment">/// `&'a T` out.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// For `ArrayViewMut` to obey the borrowing rules we have to consume the</span>
<span class="doccomment">/// view if we call any of these methods. (The equivalent of reborrow is</span>
<span class="doccomment">/// `.view_mut()` for read-write array views, but if you can use that,</span>
<span class="doccomment">/// then the regular indexing / `get_mut` should suffice, too.)</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// use ndarray::IndexLonger;</span>
<span class="doccomment">/// use ndarray::ArrayView;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let data = [0.; 256];</span>
<span class="doccomment">/// let long_life_ref = {</span>
<span class="doccomment">/// // make a 16 × 16 array view</span>
<span class="doccomment">/// let view = ArrayView::from(&data[..]).into_shape((16, 16)).unwrap();</span>
<span class="doccomment">///</span>
<span class="doccomment">/// // index the view and with `IndexLonger`.</span>
<span class="doccomment">/// // Note here that we get a reference with a life that is derived from</span>
<span class="doccomment">/// // `data`, the base data, instead of being derived from the view</span>
<span class="doccomment">/// IndexLonger::index(&view, [0, 1])</span>
<span class="doccomment">/// };</span>
<span class="doccomment">///</span>
<span class="doccomment">/// // view goes out of scope</span>
<span class="doccomment">///</span>
<span class="doccomment">/// assert_eq!(long_life_ref, &0.);</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">IndexLonger</span><span class="op"><</span><span class="ident">I</span><span class="op">></span> {
<span class="doccomment">/// The type of the reference to the element that is produced, including</span>
<span class="doccomment">/// its lifetime.</span>
<span class="kw">type</span> <span class="ident">Output</span>;
<span class="doccomment">/// Get a reference of a element through the view.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This method is like `Index::index` but with a longer lifetime (matching</span>
<span class="doccomment">/// the array view); which we can only do for the array view and not in the</span>
<span class="doccomment">/// `Index` trait.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// See also [the `get` method][1] which works for all arrays and array</span>
<span class="doccomment">/// views.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [1]: struct.ArrayBase.html#method.get</span>
<span class="doccomment">///</span>
<span class="doccomment">/// **Panics** if index is out of bounds.</span>
<span class="kw">fn</span> <span class="ident">index</span>(<span class="self">self</span>, <span class="ident">index</span>: <span class="ident">I</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span><span class="ident">::Output</span>;
<span class="doccomment">/// Get a reference of a element through the view.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This method is like `ArrayBase::get` but with a longer lifetime (matching</span>
<span class="doccomment">/// the array view); which we can only do for the array view and not in the</span>
<span class="doccomment">/// `Index` trait.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// See also [the `get` method][1] (and [`get_mut`][2]) which works for all arrays and array</span>
<span class="doccomment">/// views.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [1]: struct.ArrayBase.html#method.get</span>
<span class="doccomment">/// [2]: struct.ArrayBase.html#method.get_mut</span>
<span class="doccomment">///</span>
<span class="doccomment">/// **Panics** if index is out of bounds.</span>
<span class="kw">fn</span> <span class="ident">get</span>(<span class="self">self</span>, <span class="ident">index</span>: <span class="ident">I</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="self">Self</span><span class="ident">::Output</span><span class="op">></span>;
<span class="doccomment">/// Get a reference of a element through the view without boundary check</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This method is like `elem` with a longer lifetime (matching the array</span>
<span class="doccomment">/// view); which we can't do for general arrays.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// See also [the `uget` method][1] which works for all arrays and array</span>
<span class="doccomment">/// views.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [1]: struct.ArrayBase.html#method.uget</span>
<span class="doccomment">///</span>
<span class="doccomment">/// **Note:** only unchecked for non-debug builds of ndarray.</span>
<span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">uget</span>(<span class="self">self</span>, <span class="ident">index</span>: <span class="ident">I</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span><span class="ident">::Output</span>;
}
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="lifetime">'b</span>, <span class="ident">I</span>, <span class="ident">A</span>, <span class="ident">D</span><span class="op">></span> <span class="ident">IndexLonger</span><span class="op"><</span><span class="ident">I</span><span class="op">></span> <span class="kw">for</span> <span class="kw-2">&</span><span class="lifetime">'b</span> <span class="ident">ArrayView</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">A</span>, <span class="ident">D</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">I</span>: <span class="ident">NdIndex</span><span class="op"><</span><span class="ident">D</span><span class="op">></span>,
<span class="ident">D</span>: <span class="ident">Dimension</span>,
{
<span class="kw">type</span> <span class="ident">Output</span> <span class="op">=</span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">A</span>;
<span class="doccomment">/// Get a reference of a element through the view.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This method is like `Index::index` but with a longer lifetime (matching</span>
<span class="doccomment">/// the array view); which we can only do for the array view and not in the</span>
<span class="doccomment">/// `Index` trait.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// See also [the `get` method][1] which works for all arrays and array</span>
<span class="doccomment">/// views.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [1]: struct.ArrayBase.html#method.get</span>
<span class="doccomment">///</span>
<span class="doccomment">/// **Panics** if index is out of bounds.</span>
<span class="kw">fn</span> <span class="ident">index</span>(<span class="self">self</span>, <span class="ident">index</span>: <span class="ident">I</span>) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">A</span>
{
<span class="macro">debug_bounds_check!</span>(<span class="self">self</span>, <span class="ident">index</span>);
<span class="kw">unsafe</span> {
<span class="kw-2">&</span><span class="kw-2">*</span><span class="self">self</span>.<span class="ident">get_ptr</span>(<span class="ident">index</span>).<span class="ident">unwrap_or_else</span>(<span class="op">|</span><span class="op">|</span> <span class="ident">array_out_of_bounds</span>())
}
}
<span class="kw">fn</span> <span class="ident">get</span>(<span class="self">self</span>, <span class="ident">index</span>: <span class="ident">I</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">A</span><span class="op">></span>
{
<span class="kw">unsafe</span> {
<span class="self">self</span>.<span class="ident">get_ptr</span>(<span class="ident">index</span>).<span class="ident">map</span>(<span class="op">|</span><span class="ident">ptr</span><span class="op">|</span> <span class="kw-2">&</span><span class="kw-2">*</span><span class="ident">ptr</span>)
}
}
<span class="doccomment">/// Get a reference of a element through the view without boundary check</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This method is like `elem` with a longer lifetime (matching the array</span>
<span class="doccomment">/// view); which we can't do for general arrays.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// See also [the `uget` method][1] which works for all arrays and array</span>
<span class="doccomment">/// views.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [1]: struct.ArrayBase.html#method.uget</span>
<span class="doccomment">///</span>
<span class="doccomment">/// **Note:** only unchecked for non-debug builds of ndarray.</span>
<span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">uget</span>(<span class="self">self</span>, <span class="ident">index</span>: <span class="ident">I</span>) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">A</span>
{
<span class="macro">debug_bounds_check!</span>(<span class="self">self</span>, <span class="ident">index</span>);
<span class="kw-2">&</span><span class="kw-2">*</span><span class="self">self</span>.<span class="ident">as_ptr</span>().<span class="ident">offset</span>(<span class="ident">index</span>.<span class="ident">index_unchecked</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">strides</span>))
}
}
<span class="doccomment">/// Methods for read-write array views.</span>
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">A</span>, <span class="ident">D</span><span class="op">></span> <span class="ident">ArrayViewMut</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">A</span>, <span class="ident">D</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">D</span>: <span class="ident">Dimension</span>,
{
<span class="doccomment">/// Create a read-write array view borrowing its data from a slice.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Checks whether `dim` and `strides` are compatible with the slice's</span>
<span class="doccomment">/// length, returning an `Err` if not compatible.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// use ndarray::ArrayViewMut;</span>
<span class="doccomment">/// use ndarray::arr3;</span>
<span class="doccomment">/// use ndarray::ShapeBuilder;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let mut s = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12];</span>
<span class="doccomment">/// let mut a = ArrayViewMut::from_shape((2, 3, 2).strides((1, 4, 2)),</span>
<span class="doccomment">/// &mut s).unwrap();</span>
<span class="doccomment">///</span>
<span class="doccomment">/// a[[0, 0, 0]] = 1;</span>
<span class="doccomment">/// assert!(</span>
<span class="doccomment">/// a == arr3(&[[[1, 2],</span>
<span class="doccomment">/// [4, 6],</span>
<span class="doccomment">/// [8, 10]],</span>
<span class="doccomment">/// [[1, 3],</span>
<span class="doccomment">/// [5, 7],</span>
<span class="doccomment">/// [9, 11]]])</span>
<span class="doccomment">/// );</span>
<span class="doccomment">/// assert!(a.strides() == &[1, 4, 2]);</span>
<span class="doccomment">/// ```</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">from_shape</span><span class="op"><</span><span class="ident">Sh</span><span class="op">></span>(<span class="ident">shape</span>: <span class="ident">Sh</span>, <span class="ident">xs</span>: <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="kw-2">mut</span> [<span class="ident">A</span>])
<span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="self">Self</span>, <span class="ident">ShapeError</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">Sh</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">StrideShape</span><span class="op"><</span><span class="ident">D</span><span class="op">></span><span class="op">></span>,
{
<span class="kw">let</span> <span class="ident">shape</span> <span class="op">=</span> <span class="ident">shape</span>.<span class="ident">into</span>();
<span class="kw">let</span> <span class="ident">dim</span> <span class="op">=</span> <span class="ident">shape</span>.<span class="ident">dim</span>;
<span class="kw">let</span> <span class="ident">strides</span> <span class="op">=</span> <span class="ident">shape</span>.<span class="ident">strides</span>;
<span class="ident">dimension::can_index_slice</span>(<span class="ident">xs</span>, <span class="kw-2">&</span><span class="ident">dim</span>, <span class="kw-2">&</span><span class="ident">strides</span>).<span class="ident">map</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> {
<span class="kw">unsafe</span> {
<span class="self">Self</span><span class="ident">::new_</span>(<span class="ident">xs</span>.<span class="ident">as_mut_ptr</span>(), <span class="ident">dim</span>, <span class="ident">strides</span>)
}
})
}
<span class="doccomment">/// Create an `ArrayViewMut<A, D>` from shape information and a</span>
<span class="doccomment">/// raw pointer to the elements.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Unsafe because caller is responsible for ensuring that the pointer is</span>
<span class="doccomment">/// valid, not aliased and coherent with the dimension and stride information.</span>
<span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">from_shape_ptr</span><span class="op"><</span><span class="ident">Sh</span><span class="op">></span>(<span class="ident">shape</span>: <span class="ident">Sh</span>, <span class="ident">ptr</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">A</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span>
<span class="kw">where</span> <span class="ident">Sh</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">StrideShape</span><span class="op"><</span><span class="ident">D</span><span class="op">></span><span class="op">></span>
{
<span class="kw">let</span> <span class="ident">shape</span> <span class="op">=</span> <span class="ident">shape</span>.<span class="ident">into</span>();
<span class="kw">let</span> <span class="ident">dim</span> <span class="op">=</span> <span class="ident">shape</span>.<span class="ident">dim</span>;
<span class="kw">let</span> <span class="ident">strides</span> <span class="op">=</span> <span class="ident">shape</span>.<span class="ident">strides</span>;
<span class="ident">ArrayViewMut::new_</span>(<span class="ident">ptr</span>, <span class="ident">dim</span>, <span class="ident">strides</span>)
}
<span class="doccomment">/// Split the array view along `axis` and return one mutable view strictly</span>
<span class="doccomment">/// before the split and one mutable view after the split.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// **Panics** if `axis` or `index` is out of bounds.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">split_at</span>(<span class="self">self</span>, <span class="ident">axis</span>: <span class="ident">Axis</span>, <span class="ident">index</span>: <span class="ident">Ix</span>)
<span class="op">-</span><span class="op">></span> (<span class="self">Self</span>, <span class="self">Self</span>)
{
<span class="comment">// NOTE: Keep this in sync with the ArrayView version</span>
<span class="macro">assert!</span>(<span class="ident">index</span> <span class="op"><</span><span class="op">=</span> <span class="self">self</span>.<span class="ident">len_of</span>(<span class="ident">axis</span>));
<span class="kw">let</span> <span class="ident">left_ptr</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">ptr</span>;
<span class="kw">let</span> <span class="ident">right_ptr</span> <span class="op">=</span> <span class="kw">if</span> <span class="ident">index</span> <span class="op">=</span><span class="op">=</span> <span class="self">self</span>.<span class="ident">len_of</span>(<span class="ident">axis</span>) {
<span class="self">self</span>.<span class="ident">ptr</span>
} <span class="kw">else</span> {
<span class="kw">let</span> <span class="ident">offset</span> <span class="op">=</span> <span class="ident">stride_offset</span>(<span class="ident">index</span>, <span class="self">self</span>.<span class="ident">strides</span>.<span class="ident">axis</span>(<span class="ident">axis</span>));
<span class="kw">unsafe</span> {
<span class="self">self</span>.<span class="ident">ptr</span>.<span class="ident">offset</span>(<span class="ident">offset</span>)
}
};
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">dim_left</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">dim</span>.<span class="ident">clone</span>();
<span class="ident">dim_left</span>.<span class="ident">set_axis</span>(<span class="ident">axis</span>, <span class="ident">index</span>);
<span class="kw">let</span> <span class="ident">left</span> <span class="op">=</span> <span class="kw">unsafe</span> {
<span class="self">Self</span><span class="ident">::new_</span>(<span class="ident">left_ptr</span>, <span class="ident">dim_left</span>, <span class="self">self</span>.<span class="ident">strides</span>.<span class="ident">clone</span>())
};
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">dim_right</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">dim</span>;
<span class="kw">let</span> <span class="ident">right_len</span> <span class="op">=</span> <span class="ident">dim_right</span>.<span class="ident">axis</span>(<span class="ident">axis</span>) <span class="op">-</span> <span class="ident">index</span>;
<span class="ident">dim_right</span>.<span class="ident">set_axis</span>(<span class="ident">axis</span>, <span class="ident">right_len</span>);
<span class="kw">let</span> <span class="ident">right</span> <span class="op">=</span> <span class="kw">unsafe</span> {
<span class="self">Self</span><span class="ident">::new_</span>(<span class="ident">right_ptr</span>, <span class="ident">dim_right</span>, <span class="self">self</span>.<span class="ident">strides</span>)
};
(<span class="ident">left</span>, <span class="ident">right</span>)
}
<span class="doccomment">/// Return the array’s data as a slice, if it is contiguous and in standard order.</span>
<span class="doccomment">/// Return `None` otherwise.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">into_slice</span>(<span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'a</span> <span class="kw-2">mut</span> [<span class="ident">A</span>]<span class="op">></span> {
<span class="self">self</span>.<span class="ident">into_slice_</span>().<span class="ident">ok</span>()
}
}
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">I</span>, <span class="ident">A</span>, <span class="ident">D</span><span class="op">></span> <span class="ident">IndexLonger</span><span class="op"><</span><span class="ident">I</span><span class="op">></span> <span class="kw">for</span> <span class="ident">ArrayViewMut</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">A</span>, <span class="ident">D</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">I</span>: <span class="ident">NdIndex</span><span class="op"><</span><span class="ident">D</span><span class="op">></span>,
<span class="ident">D</span>: <span class="ident">Dimension</span>,
{
<span class="kw">type</span> <span class="ident">Output</span> <span class="op">=</span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="kw-2">mut</span> <span class="ident">A</span>;
<span class="doccomment">/// Convert a mutable array view to a mutable reference of a element.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This method is like `IndexMut::index_mut` but with a longer lifetime</span>
<span class="doccomment">/// (matching the array view); which we can only do for the array view and</span>
<span class="doccomment">/// not in the `Index` trait.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// See also [the `get_mut` method][1] which works for all arrays and array</span>
<span class="doccomment">/// views.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [1]: struct.ArrayBase.html#method.get_mut</span>
<span class="doccomment">///</span>
<span class="doccomment">/// **Panics** if index is out of bounds.</span>
<span class="kw">fn</span> <span class="ident">index</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">index</span>: <span class="ident">I</span>) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="kw-2">mut</span> <span class="ident">A</span> {
<span class="macro">debug_bounds_check!</span>(<span class="self">self</span>, <span class="ident">index</span>);
<span class="kw">unsafe</span> {
<span class="kw">match</span> <span class="self">self</span>.<span class="ident">get_ptr_mut</span>(<span class="ident">index</span>) {
<span class="prelude-val">Some</span>(<span class="ident">ptr</span>) <span class="op">=</span><span class="op">></span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="kw-2">*</span><span class="ident">ptr</span>,
<span class="prelude-val">None</span> <span class="op">=</span><span class="op">></span> <span class="ident">array_out_of_bounds</span>(),
}
}
}
<span class="doccomment">/// Convert a mutable array view to a mutable reference of a element, with</span>
<span class="doccomment">/// checked access.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// See also [the `get_mut` method][1] which works for all arrays and array</span>
<span class="doccomment">/// views.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [1]: struct.ArrayBase.html#method.get_mut</span>
<span class="doccomment">///</span>
<span class="kw">fn</span> <span class="ident">get</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">index</span>: <span class="ident">I</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'a</span> <span class="kw-2">mut</span> <span class="ident">A</span><span class="op">></span> {
<span class="macro">debug_bounds_check!</span>(<span class="self">self</span>, <span class="ident">index</span>);
<span class="kw">unsafe</span> {
<span class="kw">match</span> <span class="self">self</span>.<span class="ident">get_ptr_mut</span>(<span class="ident">index</span>) {
<span class="prelude-val">Some</span>(<span class="ident">ptr</span>) <span class="op">=</span><span class="op">></span> <span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="kw-2">*</span><span class="ident">ptr</span>),
<span class="prelude-val">None</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">None</span>,
}
}
}
<span class="doccomment">/// Convert a mutable array view to a mutable reference of a element without</span>
<span class="doccomment">/// boundary check.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// See also [the `uget_mut` method][1] which works for all arrays and array</span>
<span class="doccomment">/// views.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [1]: struct.ArrayBase.html#method.uget_mut</span>
<span class="doccomment">///</span>
<span class="doccomment">/// **Note:** only unchecked for non-debug builds of ndarray.</span>
<span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">uget</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">index</span>: <span class="ident">I</span>) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="kw-2">mut</span> <span class="ident">A</span> {
<span class="macro">debug_bounds_check!</span>(<span class="self">self</span>, <span class="ident">index</span>);
<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="kw-2">*</span><span class="self">self</span>.<span class="ident">as_mut_ptr</span>().<span class="ident">offset</span>(<span class="ident">index</span>.<span class="ident">index_unchecked</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">strides</span>))
}
}
<span class="doccomment">/// Private array view methods</span>
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">A</span>, <span class="ident">D</span><span class="op">></span> <span class="ident">ArrayView</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">A</span>, <span class="ident">D</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">D</span>: <span class="ident">Dimension</span>,
{
<span class="doccomment">/// Create a new `ArrayView`</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Unsafe because: `ptr` must be valid for the given dimension and strides.</span>
<span class="attribute">#[<span class="ident">inline</span>(<span class="ident">always</span>)]</span>
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">new_</span>(<span class="ident">ptr</span>: <span class="kw-2">*</span><span class="kw">const</span> <span class="ident">A</span>, <span class="ident">dim</span>: <span class="ident">D</span>, <span class="ident">strides</span>: <span class="ident">D</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
<span class="ident">ArrayView</span> {
<span class="ident">data</span>: <span class="ident">ViewRepr::new</span>(),
<span class="ident">ptr</span>: <span class="ident">ptr</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">A</span>,
<span class="ident">dim</span>: <span class="ident">dim</span>,
<span class="ident">strides</span>: <span class="ident">strides</span>,
}
}
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">into_base_iter</span>(<span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">Baseiter</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">A</span>, <span class="ident">D</span><span class="op">></span> {
<span class="kw">unsafe</span> {
<span class="ident">Baseiter::new</span>(<span class="self">self</span>.<span class="ident">ptr</span>, <span class="self">self</span>.<span class="ident">dim</span>, <span class="self">self</span>.<span class="ident">strides</span>)
}
}
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">into_elements_base</span>(<span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">ElementsBase</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">A</span>, <span class="ident">D</span><span class="op">></span> {
<span class="ident">ElementsBase</span> { <span class="ident">inner</span>: <span class="self">self</span>.<span class="ident">into_base_iter</span>() }
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">into_iter_</span>(<span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">Iter</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">A</span>, <span class="ident">D</span><span class="op">></span> {
<span class="ident">Iter::new</span>(<span class="self">self</span>)
}
<span class="doccomment">/// Return an outer iterator for this view.</span>
<span class="attribute">#[<span class="ident">doc</span>(<span class="ident">hidden</span>)]</span> <span class="comment">// not official</span>
<span class="attribute">#[<span class="ident">deprecated</span>(<span class="ident">note</span><span class="op">=</span><span class="string">"This method will be replaced."</span>)]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">into_outer_iter</span>(<span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">iter::AxisIter</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">A</span>, <span class="ident">D::Smaller</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">D</span>: <span class="ident">RemoveAxis</span>,
{
<span class="ident">iterators::new_outer_iter</span>(<span class="self">self</span>)
}
}
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">A</span>, <span class="ident">D</span><span class="op">></span> <span class="ident">ArrayViewMut</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">A</span>, <span class="ident">D</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">D</span>: <span class="ident">Dimension</span>,
{
<span class="doccomment">/// Create a new `ArrayView`</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Unsafe because: `ptr` must be valid for the given dimension and strides.</span>
<span class="attribute">#[<span class="ident">inline</span>(<span class="ident">always</span>)]</span>
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">new_</span>(<span class="ident">ptr</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">A</span>, <span class="ident">dim</span>: <span class="ident">D</span>, <span class="ident">strides</span>: <span class="ident">D</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
<span class="ident">ArrayViewMut</span> {
<span class="ident">data</span>: <span class="ident">ViewRepr::new</span>(),
<span class="ident">ptr</span>: <span class="ident">ptr</span>,
<span class="ident">dim</span>: <span class="ident">dim</span>,
<span class="ident">strides</span>: <span class="ident">strides</span>,
}
}
<span class="comment">// Convert into a read-only view</span>
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">into_view</span>(<span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">ArrayView</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">A</span>, <span class="ident">D</span><span class="op">></span> {
<span class="kw">unsafe</span> {
<span class="ident">ArrayView::new_</span>(<span class="self">self</span>.<span class="ident">ptr</span>, <span class="self">self</span>.<span class="ident">dim</span>, <span class="self">self</span>.<span class="ident">strides</span>)
}
}
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">into_base_iter</span>(<span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">Baseiter</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">A</span>, <span class="ident">D</span><span class="op">></span> {
<span class="kw">unsafe</span> {
<span class="ident">Baseiter::new</span>(<span class="self">self</span>.<span class="ident">ptr</span>, <span class="self">self</span>.<span class="ident">dim</span>, <span class="self">self</span>.<span class="ident">strides</span>)
}
}
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">into_elements_base</span>(<span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">ElementsBaseMut</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">A</span>, <span class="ident">D</span><span class="op">></span> {
<span class="ident">ElementsBaseMut</span> { <span class="ident">inner</span>: <span class="self">self</span>.<span class="ident">into_base_iter</span>() }
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">into_slice_</span>(<span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'a</span> <span class="kw-2">mut</span> [<span class="ident">A</span>], <span class="self">Self</span><span class="op">></span> {
<span class="kw">if</span> <span class="self">self</span>.<span class="ident">is_standard_layout</span>() {
<span class="kw">unsafe</span> {
<span class="prelude-val">Ok</span>(<span class="ident">slice::from_raw_parts_mut</span>(<span class="self">self</span>.<span class="ident">ptr</span>, <span class="self">self</span>.<span class="ident">len</span>()))
}
} <span class="kw">else</span> {
<span class="prelude-val">Err</span>(<span class="self">self</span>)
}
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">into_iter_</span>(<span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">IterMut</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">A</span>, <span class="ident">D</span><span class="op">></span> {
<span class="ident">IterMut::new</span>(<span class="self">self</span>)
}
<span class="doccomment">/// Return an outer iterator for this view.</span>
<span class="attribute">#[<span class="ident">doc</span>(<span class="ident">hidden</span>)]</span> <span class="comment">// not official</span>
<span class="attribute">#[<span class="ident">deprecated</span>(<span class="ident">note</span><span class="op">=</span><span class="string">"This method will be replaced."</span>)]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">into_outer_iter</span>(<span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">iter::AxisIterMut</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">A</span>, <span class="ident">D::Smaller</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">D</span>: <span class="ident">RemoveAxis</span>,
{
<span class="ident">iterators::new_outer_iter_mut</span>(<span class="self">self</span>)
}
}
</pre></div>
</section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="ndarray" data-search-index-js="../../search-index.js" data-search-js="../../search.js"></div><script src="../../main.js"></script><script src="../../source-script.js"></script><script src="../../source-files.js"></script></body></html>