<!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/stacking.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>stacking.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>
</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">imp_prelude</span>::<span class="kw-2">*</span>;
<span class="kw">use</span> <span class="ident">error</span>::{<span class="ident">ShapeError</span>, <span class="ident">ErrorKind</span>, <span class="ident">from_kind</span>};
<span class="doccomment">/// Stack arrays along the given axis.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ***Errors*** if the arrays have mismatching shapes, apart from along `axis`.</span>
<span class="doccomment">/// (may be made more flexible in the future).<br></span>
<span class="doccomment">/// ***Errors*** if `arrays` is empty, if `axis` is out of bounds,</span>
<span class="doccomment">/// if the result is larger than is possible to represent.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// use ndarray::{arr2, Axis, stack};</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let a = arr2(&[[2., 2.],</span>
<span class="doccomment">/// [3., 3.]]);</span>
<span class="doccomment">/// assert!(</span>
<span class="doccomment">/// stack(Axis(0), &[a.view(), a.view()])</span>
<span class="doccomment">/// == Ok(arr2(&[[2., 2.],</span>
<span class="doccomment">/// [3., 3.],</span>
<span class="doccomment">/// [2., 2.],</span>
<span class="doccomment">/// [3., 3.]]))</span>
<span class="doccomment">/// );</span>
<span class="doccomment">/// ```</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">stack</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">axis</span>: <span class="ident">Axis</span>, <span class="ident">arrays</span>: <span class="kw-2">&</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="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Array</span><span class="op"><</span><span class="ident">A</span>, <span class="ident">D</span><span class="op">></span>, <span class="ident">ShapeError</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">A</span>: <span class="ident">Copy</span>,
<span class="ident">D</span>: <span class="ident">RemoveAxis</span>
{
<span class="kw">if</span> <span class="ident">arrays</span>.<span class="ident">len</span>() <span class="op">=</span><span class="op">=</span> <span class="number">0</span> {
<span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">from_kind</span>(<span class="ident">ErrorKind::Unsupported</span>));
}
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">res_dim</span> <span class="op">=</span> <span class="ident">arrays</span>[<span class="number">0</span>].<span class="ident">raw_dim</span>();
<span class="kw">if</span> <span class="ident">axis</span>.<span class="ident">index</span>() <span class="op">></span><span class="op">=</span> <span class="ident">res_dim</span>.<span class="ident">ndim</span>() {
<span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">from_kind</span>(<span class="ident">ErrorKind::OutOfBounds</span>));
}
<span class="kw">let</span> <span class="ident">common_dim</span> <span class="op">=</span> <span class="ident">res_dim</span>.<span class="ident">remove_axis</span>(<span class="ident">axis</span>);
<span class="kw">if</span> <span class="ident">arrays</span>.<span class="ident">iter</span>().<span class="ident">any</span>(<span class="op">|</span><span class="ident">a</span><span class="op">|</span> <span class="ident">a</span>.<span class="ident">raw_dim</span>().<span class="ident">remove_axis</span>(<span class="ident">axis</span>) <span class="op">!</span><span class="op">=</span> <span class="ident">common_dim</span>) {
<span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">from_kind</span>(<span class="ident">ErrorKind::IncompatibleShape</span>));
}
<span class="kw">let</span> <span class="ident">stacked_dim</span> <span class="op">=</span> <span class="ident">arrays</span>.<span class="ident">iter</span>().<span class="ident">fold</span>(<span class="number">0</span>, <span class="op">|</span><span class="ident">acc</span>, <span class="ident">a</span><span class="op">|</span> <span class="ident">acc</span> <span class="op">+</span> <span class="ident">a</span>.<span class="ident">len_of</span>(<span class="ident">axis</span>));
<span class="ident">res_dim</span>.<span class="ident">set_axis</span>(<span class="ident">axis</span>, <span class="ident">stacked_dim</span>);
<span class="comment">// we can safely use uninitialized values here because they are Copy</span>
<span class="comment">// and we will only ever write to them</span>
<span class="kw">let</span> <span class="ident">size</span> <span class="op">=</span> <span class="ident">res_dim</span>.<span class="ident">size</span>();
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">v</span> <span class="op">=</span> <span class="ident">Vec::with_capacity</span>(<span class="ident">size</span>);
<span class="kw">unsafe</span> {
<span class="ident">v</span>.<span class="ident">set_len</span>(<span class="ident">size</span>);
}
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">res</span> <span class="op">=</span> <span class="macro">try!</span>(<span class="ident">Array::from_shape_vec</span>(<span class="ident">res_dim</span>, <span class="ident">v</span>));
{
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">assign_view</span> <span class="op">=</span> <span class="ident">res</span>.<span class="ident">view_mut</span>();
<span class="kw">for</span> <span class="ident">array</span> <span class="kw">in</span> <span class="ident">arrays</span> {
<span class="kw">let</span> <span class="ident">len</span> <span class="op">=</span> <span class="ident">array</span>.<span class="ident">len_of</span>(<span class="ident">axis</span>);
<span class="kw">let</span> (<span class="kw-2">mut</span> <span class="ident">front</span>, <span class="ident">rest</span>) <span class="op">=</span> <span class="ident">assign_view</span>.<span class="ident">split_at</span>(<span class="ident">axis</span>, <span class="ident">len</span>);
<span class="ident">front</span>.<span class="ident">assign</span>(<span class="ident">array</span>);
<span class="ident">assign_view</span> <span class="op">=</span> <span class="ident">rest</span>;
}
}
<span class="prelude-val">Ok</span>(<span class="ident">res</span>)
}
<span class="doccomment">/// Stack arrays along the given axis.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Uses the [`stack`][1] function, calling `ArrayView::from(&a)` on each</span>
<span class="doccomment">/// argument `a`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// [1]: fn.stack.html</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ***Panics*** if the `stack` function would return an error.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// #[macro_use(stack)]</span>
<span class="doccomment">/// extern crate ndarray;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// use ndarray::{arr2, Axis};</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # fn main() {</span>
<span class="doccomment">///</span>
<span class="doccomment">/// let a = arr2(&[[2., 2.],</span>
<span class="doccomment">/// [3., 3.]]);</span>
<span class="doccomment">/// assert!(</span>
<span class="doccomment">/// stack![Axis(0), a, a]</span>
<span class="doccomment">/// == arr2(&[[2., 2.],</span>
<span class="doccomment">/// [3., 3.],</span>
<span class="doccomment">/// [2., 2.],</span>
<span class="doccomment">/// [3., 3.]])</span>
<span class="doccomment">/// );</span>
<span class="doccomment">/// # }</span>
<span class="doccomment">/// ```</span>
<span class="attribute">#[<span class="ident">macro_export</span>]</span>
<span class="macro">macro_rules!</span> <span class="ident">stack</span> {
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">axis</span>:<span class="ident">expr</span>, $( <span class="macro-nonterminal">$</span><span class="macro-nonterminal">array</span>:<span class="ident">expr</span> ),<span class="op">+</span> ) <span class="op">=</span><span class="op">></span> {
<span class="macro-nonterminal">$</span><span class="kw">crate</span><span class="macro-nonterminal">::stack</span>(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">axis</span>, <span class="kw-2">&</span>[ $(<span class="macro-nonterminal">$</span><span class="kw">crate</span><span class="macro-nonterminal">::ArrayView::from</span>(<span class="kw-2">&</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">array</span>) ),<span class="op">*</span> ]).<span class="ident">unwrap</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>