Rename subview_inplace to collapse_axis

Author: jturner314

src/impl_methods.rs

@@ -310,7 +310,7 @@ impl<A, S, D> ArrayBase<S, D> where S: Data<Elem=A>, D: Dimension
     where
         Do: Dimension,
     {
-        // Slice and subview in-place without changing the number of dimensions.
+        // Slice and collapse in-place without changing the number of dimensions.
         self.slice_inplace(&*info);
 
         let indices: &[SliceOrIndex] = (**info).as_ref();
@@ -364,7 +364,7 @@ impl<A, S, D> ArrayBase<S, D> where S: Data<Elem=A>, D: Dimension
                 }
                 &SliceOrIndex::Index(index) => {
                     let i_usize = abs_index(self.len_of(Axis(axis)), index);
-                    self.subview_inplace(Axis(axis), i_usize)
+                    self.collapse_axis(Axis(axis), i_usize)
                 }
             });
     }
@@ -542,6 +542,15 @@ impl<A, S, D> ArrayBase<S, D> where S: Data<Elem=A>, D: Dimension
         }
     }
 
+    /// Collapse the axis into length one, selecting the subview at the given
+    /// `index` along the axis.
+    ///
+    /// **Panics** if `index` is past the length of the axis.
+    pub fn collapse_axis(&mut self, axis: Axis, index: usize) {
+        dimension::do_sub(&mut self.dim, &mut self.ptr, &self.strides,
+                          axis.index(), index)
+    }
+
     /// Along `axis`, select the subview `index` and return a
     /// view with that axis removed.
     ///
@@ -605,9 +614,9 @@ impl<A, S, D> ArrayBase<S, D> where S: Data<Elem=A>, D: Dimension
     /// and select the subview of `index` along that axis.
     ///
     /// **Panics** if `index` is past the length of the axis.
+    #[deprecated(note="renamed to `collapse_axis`", since="0.12.1")]
     pub fn subview_inplace(&mut self, axis: Axis, index: Ix) {
-        dimension::do_sub(&mut self.dim, &mut self.ptr, &self.strides,
-                          axis.index(), index)
+        self.collapse_axis(axis, index)
     }
 
     /// Along `axis`, select the subview `index` and return `self`
@@ -617,7 +626,7 @@ impl<A, S, D> ArrayBase<S, D> where S: Data<Elem=A>, D: Dimension
     pub fn into_subview(mut self, axis: Axis, index: Ix) -> ArrayBase<S, D::Smaller>
         where D: RemoveAxis,
     {
-        self.subview_inplace(axis, index);
+        self.collapse_axis(axis, index);
         self.remove_axis(axis)
     }
 
@@ -648,7 +657,7 @@ impl<A, S, D> ArrayBase<S, D> where S: Data<Elem=A>, D: Dimension
     {
         let mut subs = vec![self.view(); indices.len()];
         for (&i, sub) in zip(indices, &mut subs[..]) {
-            sub.subview_inplace(axis, i);
+            sub.collapse_axis(axis, i);
         }
         if subs.is_empty() {
             let mut dim = self.raw_dim();

src/lib.rs

@@ -455,7 +455,7 @@ pub type Ixs = isize;
 /// If a range is used, the axis is preserved. If an index is used, a subview
 /// is taken with respect to the axis. See [*Subviews*](#subviews) for more
 /// information about subviews. Note that [`.slice_inplace()`] behaves like
-/// [`.subview_inplace()`] by preserving the number of dimensions.
+/// [`.collapse_axis()`] by preserving the number of dimensions.
 ///
 /// [`.slice()`]: #method.slice
 /// [`.slice_mut()`]: #method.slice_mut
@@ -521,7 +521,7 @@ pub type Ixs = isize;
 ///
 /// Subview methods allow you to restrict the array view while removing one
 /// axis from the array. Subview methods include [`.subview()`],
-/// [`.subview_mut()`], [`.into_subview()`], and [`.subview_inplace()`]. You
+/// [`.subview_mut()`], [`.into_subview()`], and [`.collapse_axis()`]. You
 /// can also take a subview by using a single index instead of a range when
 /// slicing.
 ///
@@ -530,7 +530,7 @@ pub type Ixs = isize;
 /// [`.subview()`]: #method.subview
 /// [`.subview_mut()`]: #method.subview_mut
 /// [`.into_subview()`]: #method.into_subview
-/// [`.subview_inplace()`]: #method.subview_inplace
+/// [`.collapse_axis()`]: #method.collapse_axis
 ///
 /// ```
 /// #[macro_use(s)] extern crate ndarray;
@@ -574,7 +574,7 @@ pub type Ixs = isize;
 /// # }
 /// ```
 ///
-/// [`.subview_inplace()`] modifies the view in the same way as [`.subview()`],
+/// [`.collapse_axis()`] modifies the view in the same way as [`.subview()`],
 /// but since it is *in place*, it cannot remove the collapsed axis. It becomes
 /// an axis of length 1.
 ///

tests/array.rs

@@ -276,7 +276,7 @@ fn test_slice_with_subview() {
 }
 
 #[test]
-fn test_slice_inplace_with_subview_inplace() {
+fn test_slice_inplace_with_indices() {
     let mut arr = RcArray::<usize, _>::zeros((3, 5, 4));
     for (i, elt) in arr.iter_mut().enumerate() {
         *elt = i;