<!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/arraytraits.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>arraytraits.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>
</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::hash</span>;
<span class="kw">use</span> <span class="ident">std::iter::FromIterator</span>;
<span class="kw">use</span> <span class="ident">std::iter::IntoIterator</span>;
<span class="kw">use</span> <span class="ident">std::ops</span>::{
<span class="ident">Index</span>,
<span class="ident">IndexMut</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">iter</span>::{
<span class="ident">Iter</span>,
<span class="ident">IterMut</span>,
};
<span class="kw">use</span> {
<span class="ident">NdIndex</span>,
};
<span class="kw">use</span> <span class="ident">numeric_util</span>;
<span class="kw">use</span> {<span class="ident">Zip</span>, <span class="ident">FoldWhile</span>};
<span class="attribute">#[<span class="ident">cold</span>]</span>
<span class="attribute">#[<span class="ident">inline</span>(<span class="ident">never</span>)]</span>
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn</span> <span class="ident">array_out_of_bounds</span>() <span class="op">-</span><span class="op">></span> <span class="op">!</span> {
<span class="macro">panic!</span>(<span class="string">"ndarray: index out of bounds"</span>);
}
<span class="attribute">#[<span class="ident">inline</span>(<span class="ident">always</span>)]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">debug_bounds_check</span><span class="op"><</span><span class="ident">S</span>, <span class="ident">D</span>, <span class="ident">I</span><span class="op">></span>(<span class="ident">_a</span>: <span class="kw-2">&</span><span class="ident">ArrayBase</span><span class="op"><</span><span class="ident">S</span>, <span class="ident">D</span><span class="op">></span>, <span class="ident">_index</span>: <span class="kw-2">&</span><span class="ident">I</span>)
<span class="kw">where</span> <span class="ident">D</span>: <span class="ident">Dimension</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">S</span>: <span class="ident">Data</span>,
{
<span class="macro">debug_bounds_check!</span>(<span class="ident">_a</span>, <span class="kw-2">*</span><span class="ident">_index</span>);
}
<span class="doccomment">/// Access the element at **index**.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// **Panics** if index is out of bounds.</span>
<span class="kw">impl</span><span class="op"><</span><span class="ident">S</span>, <span class="ident">D</span>, <span class="ident">I</span><span class="op">></span> <span class="ident">Index</span><span class="op"><</span><span class="ident">I</span><span class="op">></span> <span class="kw">for</span> <span class="ident">ArrayBase</span><span class="op"><</span><span class="ident">S</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="ident">I</span>: <span class="ident">NdIndex</span><span class="op"><</span><span class="ident">D</span><span class="op">></span>,
<span class="ident">S</span>: <span class="ident">Data</span>,
{
<span class="kw">type</span> <span class="ident">Output</span> <span class="op">=</span> <span class="ident">S::Elem</span>;
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">index</span>(<span class="kw-2">&</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="ident">S::Elem</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">ptr</span>.<span class="ident">offset</span>(<span class="ident">index</span>.<span class="ident">index_checked</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">dim</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">strides</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="doccomment">/// Access the element at **index** mutably.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// **Panics** if index is out of bounds.</span>
<span class="kw">impl</span><span class="op"><</span><span class="ident">S</span>, <span class="ident">D</span>, <span class="ident">I</span><span class="op">></span> <span class="ident">IndexMut</span><span class="op"><</span><span class="ident">I</span><span class="op">></span> <span class="kw">for</span> <span class="ident">ArrayBase</span><span class="op"><</span><span class="ident">S</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="ident">I</span>: <span class="ident">NdIndex</span><span class="op"><</span><span class="ident">D</span><span class="op">></span>,
<span class="ident">S</span>: <span class="ident">DataMut</span>,
{
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">index_mut</span>(<span class="kw-2">&</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="kw-2">mut</span> <span class="ident">S::Elem</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">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_checked</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">dim</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">strides</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="doccomment">/// Return `true` if the array shapes and all elements of `self` and</span>
<span class="doccomment">/// `rhs` are equal. Return `false` otherwise.</span>
<span class="kw">impl</span><span class="op"><</span><span class="ident">S</span>, <span class="ident">S2</span>, <span class="ident">D</span><span class="op">></span> <span class="ident">PartialEq</span><span class="op"><</span><span class="ident">ArrayBase</span><span class="op"><</span><span class="ident">S2</span>, <span class="ident">D</span><span class="op">></span><span class="op">></span> <span class="kw">for</span> <span class="ident">ArrayBase</span><span class="op"><</span><span class="ident">S</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="ident">S</span>: <span class="ident">Data</span>,
<span class="ident">S2</span>: <span class="ident">Data</span><span class="op"><</span><span class="ident">Elem</span> <span class="op">=</span> <span class="ident">S::Elem</span><span class="op">></span>,
<span class="ident">S::Elem</span>: <span class="ident">PartialEq</span>
{
<span class="kw">fn</span> <span class="ident">eq</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">rhs</span>: <span class="kw-2">&</span><span class="ident">ArrayBase</span><span class="op"><</span><span class="ident">S2</span>, <span class="ident">D</span><span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="ident">bool</span> {
<span class="kw">if</span> <span class="self">self</span>.<span class="ident">shape</span>() <span class="op">!</span><span class="op">=</span> <span class="ident">rhs</span>.<span class="ident">shape</span>() {
<span class="kw">return</span> <span class="bool-val">false</span>;
}
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">self_s</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">as_slice</span>() {
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">rhs_s</span>) <span class="op">=</span> <span class="ident">rhs</span>.<span class="ident">as_slice</span>() {
<span class="kw">return</span> <span class="ident">numeric_util::unrolled_eq</span>(<span class="ident">self_s</span>, <span class="ident">rhs_s</span>);
}
}
<span class="ident">Zip::from</span>(<span class="self">self</span>)
.<span class="ident">and</span>(<span class="ident">rhs</span>)
.<span class="ident">fold_while</span>(<span class="bool-val">true</span>, <span class="op">|</span><span class="kw">_</span>, <span class="ident">a</span>, <span class="ident">b</span><span class="op">|</span>
<span class="kw">if</span> <span class="ident">a</span> <span class="op">!</span><span class="op">=</span> <span class="ident">b</span> {
<span class="ident">FoldWhile::Done</span>(<span class="bool-val">false</span>)
} <span class="kw">else</span> {
<span class="ident">FoldWhile::Continue</span>(<span class="bool-val">true</span>)
}).<span class="ident">into_inner</span>()
}
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">S</span>, <span class="ident">D</span><span class="op">></span> <span class="ident">Eq</span> <span class="kw">for</span> <span class="ident">ArrayBase</span><span class="op"><</span><span class="ident">S</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="ident">S</span>: <span class="ident">Data</span>,
<span class="ident">S::Elem</span>: <span class="ident">Eq</span>,
{ }
<span class="kw">impl</span><span class="op"><</span><span class="ident">A</span>, <span class="ident">S</span><span class="op">></span> <span class="ident">FromIterator</span><span class="op"><</span><span class="ident">A</span><span class="op">></span> <span class="kw">for</span> <span class="ident">ArrayBase</span><span class="op"><</span><span class="ident">S</span>, <span class="ident">Ix1</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">S</span>: <span class="ident">DataOwned</span><span class="op"><</span><span class="ident">Elem</span><span class="op">=</span><span class="ident">A</span><span class="op">></span>
{
<span class="kw">fn</span> <span class="ident">from_iter</span><span class="op"><</span><span class="ident">I</span><span class="op">></span>(<span class="ident">iterable</span>: <span class="ident">I</span>) <span class="op">-</span><span class="op">></span> <span class="ident">ArrayBase</span><span class="op"><</span><span class="ident">S</span>, <span class="ident">Ix1</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">I</span>: <span class="ident">IntoIterator</span><span class="op"><</span><span class="ident">Item</span><span class="op">=</span><span class="ident">A</span><span class="op">></span>,
{
<span class="ident">ArrayBase::from_iter</span>(<span class="ident">iterable</span>)
}
}
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">S</span>, <span class="ident">D</span><span class="op">></span> <span class="ident">IntoIterator</span> <span class="kw">for</span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">ArrayBase</span><span class="op"><</span><span class="ident">S</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="ident">S</span>: <span class="ident">Data</span>,
{
<span class="kw">type</span> <span class="ident">Item</span> <span class="op">=</span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">S::Elem</span>;
<span class="kw">type</span> <span class="ident">IntoIter</span> <span class="op">=</span> <span class="ident">Iter</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">S::Elem</span>, <span class="ident">D</span><span class="op">></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="self">Self</span><span class="ident">::IntoIter</span> {
<span class="self">self</span>.<span class="ident">iter</span>()
}
}
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">S</span>, <span class="ident">D</span><span class="op">></span> <span class="ident">IntoIterator</span> <span class="kw">for</span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="kw-2">mut</span> <span class="ident">ArrayBase</span><span class="op"><</span><span class="ident">S</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="ident">S</span>: <span class="ident">DataMut</span>
{
<span class="kw">type</span> <span class="ident">Item</span> <span class="op">=</span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="kw-2">mut</span> <span class="ident">S::Elem</span>;
<span class="kw">type</span> <span class="ident">IntoIter</span> <span class="op">=</span> <span class="ident">IterMut</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">S::Elem</span>, <span class="ident">D</span><span class="op">></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="self">Self</span><span class="ident">::IntoIter</span> {
<span class="self">self</span>.<span class="ident">iter_mut</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">IntoIterator</span> <span class="kw">for</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="kw">type</span> <span class="ident">Item</span> <span class="op">=</span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">A</span>;
<span class="kw">type</span> <span class="ident">IntoIter</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="kw">fn</span> <span class="ident">into_iter</span>(<span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span><span class="ident">::IntoIter</span> {
<span class="self">self</span>.<span class="ident">into_iter_</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">IntoIterator</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">D</span>: <span class="ident">Dimension</span>
{
<span class="kw">type</span> <span class="ident">Item</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="kw">type</span> <span class="ident">IntoIter</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="kw">fn</span> <span class="ident">into_iter</span>(<span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span><span class="ident">::IntoIter</span> {
<span class="self">self</span>.<span class="ident">into_iter_</span>()
}
}
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">S</span>, <span class="ident">D</span><span class="op">></span> <span class="ident">hash::Hash</span> <span class="kw">for</span> <span class="ident">ArrayBase</span><span class="op"><</span><span class="ident">S</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="ident">S</span>: <span class="ident">Data</span>,
<span class="ident">S::Elem</span>: <span class="ident">hash::Hash</span>
{
<span class="comment">// Note: elements are hashed in the logical order</span>
<span class="kw">fn</span> <span class="ident">hash</span><span class="op"><</span><span class="ident">H</span>: <span class="ident">hash::Hasher</span><span class="op">></span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">state</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">H</span>) {
<span class="self">self</span>.<span class="ident">shape</span>().<span class="ident">hash</span>(<span class="ident">state</span>);
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">self_s</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">as_slice</span>() {
<span class="ident">hash::Hash::hash_slice</span>(<span class="ident">self_s</span>, <span class="ident">state</span>);
} <span class="kw">else</span> {
<span class="kw">for</span> <span class="ident">row</span> <span class="kw">in</span> <span class="self">self</span>.<span class="ident">inner_rows</span>() {
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">row_s</span>) <span class="op">=</span> <span class="ident">row</span>.<span class="ident">as_slice</span>() {
<span class="ident">hash::Hash::hash_slice</span>(<span class="ident">row_s</span>, <span class="ident">state</span>);
} <span class="kw">else</span> {
<span class="kw">for</span> <span class="ident">elt</span> <span class="kw">in</span> <span class="ident">row</span> {
<span class="ident">elt</span>.<span class="ident">hash</span>(<span class="ident">state</span>)
}
}
}
}
}
}
<span class="comment">// NOTE: ArrayBase keeps an internal raw pointer that always</span>
<span class="comment">// points into the storage. This is Sync & Send as long as we</span>
<span class="comment">// follow the usual inherited mutability rules, as we do with</span>
<span class="comment">// Vec, &[] and &mut []</span>
<span class="doccomment">/// `ArrayBase` is `Sync` when the storage type is.</span>
<span class="kw">unsafe</span> <span class="kw">impl</span><span class="op"><</span><span class="ident">S</span>, <span class="ident">D</span><span class="op">></span> <span class="ident">Sync</span> <span class="kw">for</span> <span class="ident">ArrayBase</span><span class="op"><</span><span class="ident">S</span>, <span class="ident">D</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">S</span>: <span class="ident">Sync</span> <span class="op">+</span> <span class="ident">Data</span>, <span class="ident">D</span>: <span class="ident">Sync</span>
{ }
<span class="doccomment">/// `ArrayBase` is `Send` when the storage type is.</span>
<span class="kw">unsafe</span> <span class="kw">impl</span><span class="op"><</span><span class="ident">S</span>, <span class="ident">D</span><span class="op">></span> <span class="ident">Send</span> <span class="kw">for</span> <span class="ident">ArrayBase</span><span class="op"><</span><span class="ident">S</span>, <span class="ident">D</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">S</span>: <span class="ident">Send</span> <span class="op">+</span> <span class="ident">Data</span>, <span class="ident">D</span>: <span class="ident">Send</span>
{ }
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">any</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rustc-serialize"</span>, <span class="ident">feature</span> <span class="op">=</span> <span class="string">"serde"</span>))]</span>
<span class="comment">// Use version number so we can add a packed format later.</span>
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">ARRAY_FORMAT_VERSION</span>: <span class="ident">u8</span> <span class="op">=</span> <span class="number">1u8</span>;
<span class="comment">// use "raw" form instead of type aliases here so that they show up in docs</span>
<span class="doccomment">/// Implementation of `ArrayView::from(&S)` where `S` is a slice or slicable.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Create a one-dimensional read-only array view of the data in `slice`.</span>
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">A</span>, <span class="ident">Slice</span>: <span class="question-mark">?</span><span class="ident">Sized</span><span class="op">></span> <span class="ident">From</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">Slice</span><span class="op">></span> <span class="kw">for</span> <span class="ident">ArrayView</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">A</span>, <span class="ident">Ix1</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">Slice</span>: <span class="ident">AsRef</span><span class="op"><</span>[<span class="ident">A</span>]<span class="op">></span>
{
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">slice</span>: <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">Slice</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
<span class="kw">let</span> <span class="ident">xs</span> <span class="op">=</span> <span class="ident">slice</span>.<span class="ident">as_ref</span>();
<span class="kw">unsafe</span> {
<span class="self">Self</span><span class="ident">::from_shape_ptr</span>(<span class="ident">xs</span>.<span class="ident">len</span>(), <span class="ident">xs</span>.<span class="ident">as_ptr</span>())
}
}
}
<span class="doccomment">/// Implementation of `ArrayView::from(&A)` where `A` is an array.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Create a read-only array view of the array.</span>
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">A</span>, <span class="ident">S</span>, <span class="ident">D</span><span class="op">></span> <span class="ident">From</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">ArrayBase</span><span class="op"><</span><span class="ident">S</span>, <span class="ident">D</span><span class="op">></span><span class="op">></span> <span class="kw">for</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">S</span>: <span class="ident">Data</span><span class="op"><</span><span class="ident">Elem</span><span class="op">=</span><span class="ident">A</span><span class="op">></span>,
<span class="ident">D</span>: <span class="ident">Dimension</span>,
{
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">array</span>: <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">ArrayBase</span><span class="op"><</span><span class="ident">S</span>, <span class="ident">D</span><span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
<span class="ident">array</span>.<span class="ident">view</span>()
}
}
<span class="doccomment">/// Implementation of `ArrayViewMut::from(&mut S)` where `S` is a slice or slicable.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Create a one-dimensional read-write array view of the data in `slice`.</span>
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">A</span>, <span class="ident">Slice</span>: <span class="question-mark">?</span><span class="ident">Sized</span><span class="op">></span> <span class="ident">From</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'a</span> <span class="kw-2">mut</span> <span class="ident">Slice</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">Ix1</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">Slice</span>: <span class="ident">AsMut</span><span class="op"><</span>[<span class="ident">A</span>]<span class="op">></span>
{
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">slice</span>: <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="kw-2">mut</span> <span class="ident">Slice</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
<span class="kw">let</span> <span class="ident">xs</span> <span class="op">=</span> <span class="ident">slice</span>.<span class="ident">as_mut</span>();
<span class="kw">unsafe</span> {
<span class="self">Self</span><span class="ident">::from_shape_ptr</span>(<span class="ident">xs</span>.<span class="ident">len</span>(), <span class="ident">xs</span>.<span class="ident">as_mut_ptr</span>())
}
}
}
<span class="doccomment">/// Implementation of `ArrayViewMut::from(&mut A)` where `A` is an array.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Create a read-write array view of the array.</span>
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">A</span>, <span class="ident">S</span>, <span class="ident">D</span><span class="op">></span> <span class="ident">From</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'a</span> <span class="kw-2">mut</span> <span class="ident">ArrayBase</span><span class="op"><</span><span class="ident">S</span>, <span class="ident">D</span><span class="op">></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">S</span>: <span class="ident">DataMut</span><span class="op"><</span><span class="ident">Elem</span><span class="op">=</span><span class="ident">A</span><span class="op">></span>,
<span class="ident">D</span>: <span class="ident">Dimension</span>,
{
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">array</span>: <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="kw-2">mut</span> <span class="ident">ArrayBase</span><span class="op"><</span><span class="ident">S</span>, <span class="ident">D</span><span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
<span class="ident">array</span>.<span class="ident">view_mut</span>()
}
}
<span class="doccomment">/// Argument conversion into an array view</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The trait is parameterized over `A`, the element type, and `D`, the</span>
<span class="doccomment">/// dimensionality of the array. `D` defaults to one-dimensional.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Use `.into()` to do the conversion.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// use ndarray::AsArray;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// fn sum<'a, V: AsArray<'a, f64>>(data: V) -> f64 {</span>
<span class="doccomment">/// let array_view = data.into();</span>
<span class="doccomment">/// array_view.scalar_sum()</span>
<span class="doccomment">/// }</span>
<span class="doccomment">///</span>
<span class="doccomment">/// assert_eq!(</span>
<span class="doccomment">/// sum(&[1., 2., 3.]),</span>
<span class="doccomment">/// 6.</span>
<span class="doccomment">/// );</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">AsArray</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">A</span>: <span class="lifetime">'a</span>, <span class="ident">D</span> <span class="op">=</span> <span class="ident">Ix1</span><span class="op">></span> : <span class="ident">Into</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="op">></span> <span class="kw">where</span> <span class="ident">D</span>: <span class="ident">Dimension</span> { }
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">A</span>: <span class="lifetime">'a</span>, <span class="ident">D</span>, <span class="ident">T</span><span class="op">></span> <span class="ident">AsArray</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">for</span> <span class="ident">T</span>
<span class="kw">where</span> <span class="ident">T</span>: <span class="ident">Into</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="op">></span>,
<span class="ident">D</span>: <span class="ident">Dimension</span>,
{ }
<span class="doccomment">/// Create an owned array with a default state.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The array is created with dimension `D::default()`, which results</span>
<span class="doccomment">/// in for example dimensions `0` and `(0, 0)` with zero elements for the</span>
<span class="doccomment">/// one-dimensional and two-dimensional cases respectively.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The default dimension for `IxDyn` is `IxDyn(&[0])` (array has zero</span>
<span class="doccomment">/// elements). And the default for the dimension `()` is `()` (array has</span>
<span class="doccomment">/// one element).</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Since arrays cannot grow, the intention is to use the default value as</span>
<span class="doccomment">/// placeholder.</span>
<span class="kw">impl</span><span class="op"><</span><span class="ident">A</span>, <span class="ident">S</span>, <span class="ident">D</span><span class="op">></span> <span class="ident">Default</span> <span class="kw">for</span> <span class="ident">ArrayBase</span><span class="op"><</span><span class="ident">S</span>, <span class="ident">D</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">S</span>: <span class="ident">DataOwned</span><span class="op"><</span><span class="ident">Elem</span><span class="op">=</span><span class="ident">A</span><span class="op">></span>,
<span class="ident">D</span>: <span class="ident">Dimension</span>,
<span class="ident">A</span>: <span class="ident">Default</span>,
{
<span class="comment">// NOTE: We can implement Default for non-zero dimensional array views by</span>
<span class="comment">// using an empty slice, however we need a trait for nonzero Dimension.</span>
<span class="kw">fn</span> <span class="ident">default</span>() <span class="op">-</span><span class="op">></span> <span class="self">Self</span> {
<span class="ident">ArrayBase::default</span>(<span class="ident">D::default</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>