1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161

use crate::arrays::Array;
use crate::traits::{
    errors::ArrayError,
    types::numeric::Numeric,
};

/// ArrayTrait - Array Stack functions
pub trait ArrayStack<N: Numeric> where Self: Sized + Clone {

    /// Join a sequence of arrays along an existing axis
    ///
    /// # Arguments
    ///
    /// * `arrs` - arrays to concatenate
    /// * `axis` - the axis along which to concat. optional, if None - arrays are flattened
    ///
    /// # Examples
    /// ```
    /// use arr_rs::prelude::*;
    ///
    /// let arr: Array<i32> = array!([1, 2, 3]).unwrap();
    /// let other: Array<i32> = array!([4, 5, 6]).unwrap();
    /// let expected: Array<i32> = array!([1, 2, 3, 4, 5, 6]).unwrap();
    /// assert_eq!(expected, Array::<i32>::concatenate(vec![arr, other], None).unwrap());
    ///
    /// let arr: Array<i32> = array!([[1, 2], [3, 4]]).unwrap();
    /// let other: Array<i32> = array!([[5, 6]]).unwrap();
    /// let expected: Array<i32> = array!([[1, 2], [3, 4], [5, 6]]).unwrap();
    /// assert_eq!(expected, Array::<i32>::concatenate(vec![arr, other], Some(0)).unwrap());
    /// ```
    fn concatenate(arrs: Vec<Array<N>>, axis: Option<usize>) -> Result<Array<N>, ArrayError>;

    /// Join a sequence of arrays along a new axis
    ///
    /// # Arguments
    ///
    /// * `arrs` - arrays to stack
    /// * `axis` - the axis along which to concat. optional, defaults to 0
    ///
    /// # Examples
    /// ```
    /// use arr_rs::prelude::*;
    ///
    /// let arr: Array<i32> = array!([1, 2, 3]).unwrap();
    /// let other: Array<i32> = array!([4, 5, 6]).unwrap();
    /// let expected: Array<i32> = array!([[1, 2, 3], [4, 5, 6]]).unwrap();
    /// assert_eq!(expected, Array::<i32>::stack(vec![arr, other], None).unwrap());
    ///
    /// let arr: Array<i32> = array!([[1, 2], [3, 4]]).unwrap();
    /// let other: Array<i32> = array!([[5, 6], [7, 8]]).unwrap();
    /// let expected: Array<i32> = array!([[[1, 2], [3, 4]], [[5, 6], [7, 8]]]).unwrap();
    /// assert_eq!(expected, Array::<i32>::stack(vec![arr, other], Some(0)).unwrap());
    /// ```
    fn stack(arrs: Vec<Array<N>>, axis: Option<usize>) -> Result<Array<N>, ArrayError>;

    /// Stack arrays in sequence vertically (row wise)
    ///
    /// # Arguments
    ///
    /// * `arrs` - arrays to stack
    ///
    /// # Examples
    /// ```
    /// use arr_rs::prelude::*;
    ///
    /// let arr: Array<i32> = array!([1, 2, 3]).unwrap();
    /// let other: Array<i32> = array!([4, 5, 6]).unwrap();
    /// let expected: Array<i32> = array!([[1, 2, 3], [4, 5, 6]]).unwrap();
    /// assert_eq!(expected, Array::<i32>::vstack(vec![arr, other]).unwrap());
    ///
    /// let arr: Array<i32> = array!([[1], [2], [3]]).unwrap();
    /// let other: Array<i32> = array!([[4], [5], [6]]).unwrap();
    /// let expected: Array<i32> = array!([[1], [2], [3], [4], [5], [6]]).unwrap();
    /// assert_eq!(expected, Array::<i32>::vstack(vec![arr, other]).unwrap());
    /// ```
    fn vstack(arrs: Vec<Array<N>>) -> Result<Array<N>, ArrayError>;

    /// Stack arrays in sequence horizontally (column wise)
    ///
    /// # Arguments
    ///
    /// * `arrs` - arrays to stack
    ///
    /// # Examples
    /// ```
    /// use arr_rs::prelude::*;
    ///
    /// let arr: Array<i32> = array!([1, 2, 3]).unwrap();
    /// let other: Array<i32> = array!([4, 5, 6]).unwrap();
    /// let expected: Array<i32> = array!([1, 2, 3, 4, 5, 6]).unwrap();
    /// assert_eq!(expected, Array::<i32>::hstack(vec![arr, other]).unwrap());
    ///
    /// let arr: Array<i32> = array!([[1], [2], [3]]).unwrap();
    /// let other: Array<i32> = array!([[4], [5], [6]]).unwrap();
    /// let expected: Array<i32> = array!([[1, 4], [2, 5], [3, 6]]).unwrap();
    /// assert_eq!(expected, Array::<i32>::hstack(vec![arr, other]).unwrap());
    /// ```
    fn hstack(arrs: Vec<Array<N>>) -> Result<Array<N>, ArrayError>;

    /// Stack arrays in sequence depth wise (along third axis)
    ///
    /// # Arguments
    ///
    /// * `arrs` - arrays to stack
    ///
    /// # Examples
    /// ```
    /// use arr_rs::prelude::*;
    ///
    /// let arr: Array<i32> = array!([1, 2, 3]).unwrap();
    /// let other: Array<i32> = array!([4, 5, 6]).unwrap();
    /// let expected: Array<i32> = array!([[[1, 4], [2, 5], [3, 6]]]).unwrap();
    /// assert_eq!(expected, Array::<i32>::dstack(vec![arr, other]).unwrap());
    ///
    /// let arr: Array<i32> = array!([[1], [2], [3]]).unwrap();
    /// let other: Array<i32> = array!([[4], [5], [6]]).unwrap();
    /// let expected: Array<i32> = array!([[[1, 4]], [[2, 5]], [[3, 6]]]).unwrap();
    /// assert_eq!(expected, Array::<i32>::dstack(vec![arr, other]).unwrap());
    /// ```
    fn dstack(arrs: Vec<Array<N>>) -> Result<Array<N>, ArrayError>;

    /// Stack 1d or 2d arrays as columns into a 2d array
    /// row_stack is an alias for vstack
    ///
    /// # Arguments
    ///
    /// * `arrs` - arrays to stack
    ///
    /// # Examples
    /// ```
    /// use arr_rs::prelude::*;
    ///
    /// let arr: Array<i32> = array!([1, 2, 3]).unwrap();
    /// let other: Array<i32> = array!([4, 5, 6]).unwrap();
    /// let expected: Array<i32> = array!([[1, 4], [2, 5], [3, 6]]).unwrap();
    /// assert_eq!(expected, Array::<i32>::column_stack(vec![arr, other]).unwrap());
    /// ```
    fn column_stack(arrs: Vec<Array<N>>) -> Result<Array<N>, ArrayError>;

    /// Stack arrays in sequence vertically (row wise)
    ///
    /// # Arguments
    ///
    /// * `arrs` - arrays to stack
    ///
    /// # Examples
    /// ```
    /// use arr_rs::prelude::*;
    ///
    /// let arr: Array<i32> = array!([1, 2, 3]).unwrap();
    /// let other: Array<i32> = array!([4, 5, 6]).unwrap();
    /// let expected: Array<i32> = array!([[1, 2, 3], [4, 5, 6]]).unwrap();
    /// assert_eq!(expected, Array::<i32>::row_stack(vec![arr, other]).unwrap());
    ///
    /// let arr: Array<i32> = array!([[1], [2], [3]]).unwrap();
    /// let other: Array<i32> = array!([[4], [5], [6]]).unwrap();
    /// let expected: Array<i32> = array!([[1], [2], [3], [4], [5], [6]]).unwrap();
    /// assert_eq!(expected, Array::<i32>::row_stack(vec![arr, other]).unwrap());
    /// ```
    fn row_stack(arrs: Vec<Array<N>>) -> Result<Array<N>, ArrayError>;
}