Rename slice_inplace to slice_collapse

Author: jturner314

examples/axis_ops.rs

@@ -47,7 +47,7 @@ fn main() {
     }
     a.swap_axes(0, 1);
     a.swap_axes(0, 2);
-    a.slice_inplace(s![.., ..;-1, ..]);
+    a.slice_collapse(s![.., ..;-1, ..]);
     regularize(&mut a).ok();
 
     let mut b = Array::<u8, _>::zeros((2, 3, 4));
@@ -64,6 +64,6 @@ fn main() {
     for (i, elt) in (0..).zip(&mut a) {
         *elt = i;
     }
-    a.slice_inplace(s![..;-1, ..;2, ..]);
+    a.slice_collapse(s![..;-1, ..;2, ..]);
     regularize(&mut a).ok();
 }

serialization-tests/tests/serialize.rs

@@ -53,7 +53,7 @@ fn serial_many_dim()
     {
         // Test a sliced array.
         let mut a = RcArray::linspace(0., 31., 32).reshape((2, 2, 2, 4));
-        a.slice_inplace(s![..;-1, .., .., ..2]);
+        a.slice_collapse(s![..;-1, .., .., ..2]);
         let serial = json::encode(&a).unwrap();
         println!("Encode {:?} => {:?}", a, serial);
         let res = json::decode::<RcArray<f32, _>>(&serial);
@@ -114,7 +114,7 @@ fn serial_many_dim_serde()
     {
         // Test a sliced array.
         let mut a = RcArray::linspace(0., 31., 32).reshape((2, 2, 2, 4));
-        a.slice_inplace(s![..;-1, .., .., ..2]);
+        a.slice_collapse(s![..;-1, .., .., ..2]);
         let serial = serde_json::to_string(&a).unwrap();
         println!("Encode {:?} => {:?}", a, serial);
         let res = serde_json::from_str::<RcArray<f32, _>>(&serial);
@@ -221,7 +221,7 @@ fn serial_many_dim_serde_msgpack()
     {
         // Test a sliced array.
         let mut a = RcArray::linspace(0., 31., 32).reshape((2, 2, 2, 4));
-        a.slice_inplace(s![..;-1, .., .., ..2]);
+        a.slice_collapse(s![..;-1, .., .., ..2]);
 
         let mut buf = Vec::new();
         serde::Serialize::serialize(&a, &mut rmp_serde::Serializer::new(&mut buf)).ok().unwrap();
@@ -273,7 +273,7 @@ fn serial_many_dim_ron()
     {
         // Test a sliced array.
         let mut a = RcArray::linspace(0., 31., 32).reshape((2, 2, 2, 4));
-        a.slice_inplace(s![..;-1, .., .., ..2]);
+        a.slice_collapse(s![..;-1, .., .., ..2]);
 
         let a_s = ron_serialize(&a).unwrap();
 

src/doc/ndarray_for_numpy_users/mod.rs

@@ -229,7 +229,7 @@
 //!   Only the non-mutable methods that take the array by reference are listed in
 //!   this table. For example, [`.slice()`][.slice()] also has corresponding
 //!   methods [`.slice_mut()`][.slice_mut()], [`.slice_move()`][.slice_move()], and
-//!   [`.slice_inplace()`][.slice_inplace()].
+//!   [`.slice_collapse()`][.slice_collapse()].
 //!
 //! * The behavior of slicing is slightly different from NumPy for slices with
 //!   `step < -1`. See the docs for the [`s![]` macro][s!] for more details.
@@ -618,7 +618,7 @@
 //! [.sum()]: ../../struct.ArrayBase.html#method.sum
 //! [.slice()]: ../../struct.ArrayBase.html#method.slice
 //! [.slice_axis()]: ../../struct.ArrayBase.html#method.slice_axis
-//! [.slice_inplace()]: ../../struct.ArrayBase.html#method.slice_inplace
+//! [.slice_collapse()]: ../../struct.ArrayBase.html#method.slice_collapse
 //! [.slice_move()]: ../../struct.ArrayBase.html#method.slice_move
 //! [.slice_mut()]: ../../struct.ArrayBase.html#method.slice_mut
 //! [.shape()]: ../../struct.ArrayBase.html#method.shape

src/impl_methods.rs

@@ -311,7 +311,7 @@ impl<A, S, D> ArrayBase<S, D> where S: Data<Elem=A>, D: Dimension
         Do: Dimension,
     {
         // Slice and collapse in-place without changing the number of dimensions.
-        self.slice_inplace(&*info);
+        self.slice_collapse(&*info);
 
         let indices: &[SliceOrIndex] = (**info).as_ref();
 
@@ -352,7 +352,7 @@ impl<A, S, D> ArrayBase<S, D> where S: Data<Elem=A>, D: Dimension
     ///
     /// **Panics** if an index is out of bounds or step size is zero.<br>
     /// (**Panics** if `D` is `IxDyn` and `indices` does not match the number of array axes.)
-    pub fn slice_inplace(&mut self, indices: &D::SliceArg) {
+    pub fn slice_collapse(&mut self, indices: &D::SliceArg) {
         let indices: &[SliceOrIndex] = indices.as_ref();
         assert_eq!(indices.len(), self.ndim());
         indices
@@ -369,6 +369,15 @@ impl<A, S, D> ArrayBase<S, D> where S: Data<Elem=A>, D: Dimension
             });
     }
 
+    /// Slice the array in place without changing the number of dimensions.
+    ///
+    /// **Panics** if an index is out of bounds or step size is zero.<br>
+    /// (**Panics** if `D` is `IxDyn` and `indices` does not match the number of array axes.)
+    #[deprecated(note="renamed to `slice_collapse`", since="0.12.1")]
+    pub fn slice_inplace(&mut self, indices: &D::SliceArg) {
+        self.slice_collapse(indices)
+    }
+
     /// Return a view of the array, sliced along the specified axis.
     ///
     /// **Panics** if an index is out of bounds or step size is zero.<br>

src/lib.rs

@@ -444,7 +444,7 @@ pub type Ixs = isize;
 ///
 /// You can use slicing to create a view of a subset of the data in
 /// the array. Slicing methods include [`.slice()`], [`.slice_mut()`],
-/// [`.slice_move()`], and [`.slice_inplace()`].
+/// [`.slice_move()`], and [`.slice_collapse()`].
 ///
 /// The slicing argument can be passed using the macro [`s![]`](macro.s!.html),
 /// which will be used in all examples. (The explicit form is an instance of
@@ -455,13 +455,13 @@ pub type Ixs = isize;
 /// If a range is used, the axis is preserved. If an index is used, that index
 /// is selected and the axis is removed; this selects a subview. See
 /// [*Subviews*](#subviews) for more information about subviews. Note that
-/// [`.slice_inplace()`] behaves like [`.collapse_axis()`] by preserving the
-/// number of dimensions.
+/// [`.slice_collapse()`] behaves like [`.collapse_axis()`] by preserving
+/// the number of dimensions.
 ///
 /// [`.slice()`]: #method.slice
 /// [`.slice_mut()`]: #method.slice_mut
 /// [`.slice_move()`]: #method.slice_move
-/// [`.slice_inplace()`]: #method.slice_inplace
+/// [`.slice_collapse()`]: #method.slice_collapse
 ///
 /// ```
 /// // import the s![] macro

src/slice.rs

@@ -466,7 +466,8 @@ impl_slicenextdim_larger!((), Slice);
 /// ] ]* `]`, where *axis-slice-or-index* is any of the following:
 ///
 /// * *index*: an index to use for taking a subview with respect to that axis.
-///   (The index is selected and the axis is removed.)
+///   (The index is selected. The axis is removed except with
+///   [`.slice_collapse()`].)
 /// * *range*: a range with step size 1 to use for slicing that axis.
 /// * *range* `;` *step*: a range with step size *step* to use for slicing that axis.
 /// * *slice*: a [`Slice`] instance to use for slicing that axis.
@@ -487,12 +488,12 @@ impl_slicenextdim_larger!((), Slice);
 /// the third axis for 1..5 with default step size 1. The input array must have
 /// 3 dimensions. The resulting slice would have shape `[2, 4]` for
 /// [`.slice()`], [`.slice_mut()`], and [`.slice_move()`], and shape
-/// `[2, 1, 4]` for [`.slice_inplace()`].
+/// `[2, 1, 4]` for [`.slice_collapse()`].
 ///
 /// [`.slice()`]: struct.ArrayBase.html#method.slice
 /// [`.slice_mut()`]: struct.ArrayBase.html#method.slice_mut
 /// [`.slice_move()`]: struct.ArrayBase.html#method.slice_move
-/// [`.slice_inplace()`]: struct.ArrayBase.html#method.slice_inplace
+/// [`.slice_collapse()`]: struct.ArrayBase.html#method.slice_collapse
 ///
 /// See also [*Slicing*](struct.ArrayBase.html#slicing).
 ///

tests/array.rs

@@ -173,7 +173,7 @@ fn test_slice_array_fixed() {
     arr.slice(info);
     arr.slice_mut(info);
     arr.view().slice_move(info);
-    arr.view().slice_inplace(info);
+    arr.view().slice_collapse(info);
 }
 
 #[test]
@@ -183,7 +183,7 @@ fn test_slice_dyninput_array_fixed() {
     arr.slice(info);
     arr.slice_mut(info);
     arr.view().slice_move(info);
-    arr.view().slice_inplace(info.as_ref());
+    arr.view().slice_collapse(info.as_ref());
 }
 
 #[test]
@@ -197,7 +197,7 @@ fn test_slice_array_dyn() {
     arr.slice(info);
     arr.slice_mut(info);
     arr.view().slice_move(info);
-    arr.view().slice_inplace(info);
+    arr.view().slice_collapse(info);
 }
 
 #[test]
@@ -211,7 +211,7 @@ fn test_slice_dyninput_array_dyn() {
     arr.slice(info);
     arr.slice_mut(info);
     arr.view().slice_move(info);
-    arr.view().slice_inplace(info.as_ref());
+    arr.view().slice_collapse(info.as_ref());
 }
 
 #[test]
@@ -225,7 +225,7 @@ fn test_slice_dyninput_vec_fixed() {
     arr.slice(info.as_ref());
     arr.slice_mut(info.as_ref());
     arr.view().slice_move(info.as_ref());
-    arr.view().slice_inplace(info.as_ref());
+    arr.view().slice_collapse(info.as_ref());
 }
 
 #[test]
@@ -239,7 +239,7 @@ fn test_slice_dyninput_vec_dyn() {
     arr.slice(info.as_ref());
     arr.slice_mut(info.as_ref());
     arr.view().slice_move(info.as_ref());
-    arr.view().slice_inplace(info.as_ref());
+    arr.view().slice_collapse(info.as_ref());
 }
 
 #[test]
@@ -276,15 +276,15 @@ fn test_slice_with_subview() {
 }
 
 #[test]
-fn test_slice_inplace_with_indices() {
+fn test_slice_collapse_with_indices() {
     let mut arr = RcArray::<usize, _>::zeros((3, 5, 4));
     for (i, elt) in arr.iter_mut().enumerate() {
         *elt = i;
     }
 
     {
         let mut vi = arr.view();
-        vi.slice_inplace(s![1.., 2, ..;2]);
+        vi.slice_collapse(s![1.., 2, ..;2]);
         assert_eq!(vi.shape(), &[2, 1, 2]);
         assert!(
             vi.iter()
@@ -293,7 +293,7 @@ fn test_slice_inplace_with_indices() {
         );
 
         let mut vi = arr.view();
-        vi.slice_inplace(s![1, 2, ..;2]);
+        vi.slice_collapse(s![1, 2, ..;2]);
         assert_eq!(vi.shape(), &[1, 1, 2]);
         assert!(
             vi.iter()
@@ -302,15 +302,15 @@ fn test_slice_inplace_with_indices() {
         );
 
         let mut vi = arr.view();
-        vi.slice_inplace(s![1, 2, 3]);
+        vi.slice_collapse(s![1, 2, 3]);
         assert_eq!(vi.shape(), &[1, 1, 1]);
         assert_eq!(vi, Array3::from_elem((1, 1, 1), arr[(1, 2, 3)]));
     }
 
     // Do it to the RcArray itself
     let elem = arr[(1, 2, 3)];
     let mut vi = arr;
-    vi.slice_inplace(s![1, 2, 3]);
+    vi.slice_collapse(s![1, 2, 3]);
     assert_eq!(vi.shape(), &[1, 1, 1]);
     assert_eq!(vi, Array3::from_elem((1, 1, 1), elem));
 }
@@ -458,7 +458,7 @@ fn test_cow()
     assert_eq!(n[[0, 1]], 0);
     assert_eq!(n.get((0, 1)), Some(&0));
     let mut rev = mat.reshape(4);
-    rev.slice_inplace(s![..;-1]);
+    rev.slice_collapse(s![..;-1]);
     assert_eq!(rev[0], 4);
     assert_eq!(rev[1], 3);
     assert_eq!(rev[2], 2);
@@ -483,7 +483,7 @@ fn test_cow_shrink()
     // mutation shrinks the array and gives it different strides
     //
     let mut mat = RcArray::zeros((2, 3));
-    //mat.slice_inplace(s![.., ..;2]);
+    //mat.slice_collapse(s![.., ..;2]);
     mat[[0, 0]] = 1;
     let n = mat.clone();
     mat[[0, 1]] = 2;
@@ -498,7 +498,7 @@ fn test_cow_shrink()
     assert_eq!(n.get((0, 1)), Some(&0));
     // small has non-C strides this way
     let mut small = mat.reshape(6);
-    small.slice_inplace(s![4..;-1]);
+    small.slice_collapse(s![4..;-1]);
     assert_eq!(small[0], 6);
     assert_eq!(small[1], 5);
     let before = small.clone();
@@ -678,7 +678,7 @@ fn assign()
     let mut a = arr2(&[[1, 2], [3, 4]]);
     {
         let mut v = a.view_mut();
-        v.slice_inplace(s![..1, ..]);
+        v.slice_collapse(s![..1, ..]);
         v.fill(0);
     }
     assert_eq!(a, arr2(&[[0, 0], [3, 4]]));
@@ -995,7 +995,7 @@ fn owned_array_discontiguous_drop() {
         let v: Vec<_> = (0..12).map(|x| InsertOnDrop(set.clone(), Some(x))).collect();
         let mut a = Array::from_shape_vec((2, 6), v).unwrap();
         // discontiguous and non-zero offset
-        a.slice_inplace(s![.., 1..]);
+        a.slice_collapse(s![.., 1..]);
     }
     // each item was dropped exactly once
     itertools::assert_equal(set.borrow().iter().cloned(), 0..12);
@@ -1561,7 +1561,7 @@ fn to_owned_memory_order() {
 fn to_owned_neg_stride() {
     let mut c = arr2(&[[1, 2, 3],
                        [4, 5, 6]]);
-    c.slice_inplace(s![.., ..;-1]);
+    c.slice_collapse(s![.., ..;-1]);
     let co = c.to_owned();
     assert_eq!(c, co);
 }
@@ -1570,7 +1570,7 @@ fn to_owned_neg_stride() {
 fn discontiguous_owned_to_owned() {
     let mut c = arr2(&[[1, 2, 3],
                        [4, 5, 6]]);
-    c.slice_inplace(s![.., ..;2]);
+    c.slice_collapse(s![.., ..;2]);
 
     let co = c.to_owned();
     assert_eq!(c.strides(), &[3, 2]);
@@ -1738,10 +1738,10 @@ fn test_to_vec() {
                        [7, 8, 9],
                        [10,11,12]]);
 
-    a.slice_inplace(s![..;-1, ..]);
+    a.slice_collapse(s![..;-1, ..]);
     assert_eq!(a.row(3).to_vec(), vec![1, 2, 3]);
     assert_eq!(a.column(2).to_vec(), vec![12, 9, 6, 3]);
-    a.slice_inplace(s![.., ..;-1]);
+    a.slice_collapse(s![.., ..;-1]);
     assert_eq!(a.row(3).to_vec(), vec![3, 2, 1]);
 }
 
@@ -1757,7 +1757,7 @@ fn test_array_clone_unalias() {
 #[test]
 fn test_array_clone_same_view() {
     let mut a = Array::from_iter(0..9).into_shape((3, 3)).unwrap();
-    a.slice_inplace(s![..;-1, ..;-1]);
+    a.slice_collapse(s![..;-1, ..;-1]);
     let b = a.clone();
     assert_eq!(a, b);
 }