DOC: In Docs and signatures, change RcArray to ArcArray

These are equivalent type aliases, but the former will be deprecated.

Also, while ArcArray is not in the prelude, have it in the imp_prelude.

Author: bluss

src/free_functions.rs

@@ -36,7 +36,7 @@ use imp_prelude::*;
 /// This macro uses `vec![]`, and has the same ownership semantics;
 /// elements are moved into the resulting `Array`.
 ///
-/// Use `array![...].into_shared()` to create an `RcArray`.
+/// Use `array![...].into_shared()` to create an `ArcArray`.
 #[macro_export]
 macro_rules! array {
     ($([$([$($x:expr),* $(,)*]),+ $(,)*]),+ $(,)*) => {{
@@ -62,7 +62,7 @@ pub fn arr1<A: Clone>(xs: &[A]) -> Array1<A> {
 }
 
 /// Create a one-dimensional array with elements from `xs`.
-pub fn rcarr1<A: Clone>(xs: &[A]) -> RcArray<A, Ix1> {
+pub fn rcarr1<A: Clone>(xs: &[A]) -> ArcArray<A, Ix1> {
     arr1(xs).into_shared()
 }
 
@@ -256,7 +256,7 @@ impl<A, V, U> From<Vec<V>> for Array3<A>
 
 /// Create a two-dimensional array with elements from `xs`.
 ///
-pub fn rcarr2<A: Clone, V: Clone + FixedInitializer<Elem = A>>(xs: &[V]) -> RcArray<A, Ix2> {
+pub fn rcarr2<A: Clone, V: Clone + FixedInitializer<Elem = A>>(xs: &[V]) -> ArcArray<A, Ix2> {
     arr2(xs).into_shared()
 }
 
@@ -287,7 +287,7 @@ pub fn arr3<A: Clone, V: FixedInitializer<Elem=U>, U: FixedInitializer<Elem=A>>(
 
 /// Create a three-dimensional array with elements from `xs`.
 pub fn rcarr3<A: Clone, V: FixedInitializer<Elem=U>, U: FixedInitializer<Elem=A>>(xs: &[V])
-    -> RcArray<A, Ix3>
+    -> ArcArray<A, Ix3>
     where V: Clone, U: Clone,
 {
     arr3(xs).into_shared()

src/impl_constructors.rs

@@ -23,7 +23,7 @@ use iterators::{to_vec, to_vec_mapped};
 
 /// # Constructor Methods for Owned Arrays
 ///
-/// Note that the constructor methods apply to `Array` and `RcArray`,
+/// Note that the constructor methods apply to `Array` and `ArcArray`,
 /// the two array types that have owned storage.
 ///
 /// ## Constructor methods for one-dimensional arrays.

src/impl_methods.rs

@@ -161,10 +161,10 @@ impl<A, S, D> ArrayBase<S, D> where S: Data<Elem=A>, D: Dimension
     }
 
     /// Return a shared ownership (copy on write) array.
-    pub fn to_shared(&self) -> RcArray<A, D>
+    pub fn to_shared(&self) -> ArcArray<A, D>
         where A: Clone
     {
-        // FIXME: Avoid copying if it’s already an RcArray.
+        // FIXME: Avoid copying if it’s already an ArcArray.
         self.to_owned().into_shared()
     }
 
@@ -178,7 +178,7 @@ impl<A, S, D> ArrayBase<S, D> where S: Data<Elem=A>, D: Dimension
 
     /// Turn the array into a shared ownership (copy on write) array,
     /// without any copying.
-    pub fn into_shared(self) -> RcArray<A, D>
+    pub fn into_shared(self) -> ArcArray<A, D>
         where S: DataOwned,
     {
         let data = self.data.into_shared();
@@ -487,7 +487,7 @@ impl<A, S, D> ArrayBase<S, D> where S: Data<Elem=A>, D: Dimension
     /// Return a mutable reference to the element at `index`.
     ///
     /// **Note:** Only unchecked for non-debug builds of ndarray.<br>
-    /// **Note:** (For `RcArray`) The array must be uniquely held when mutating it.
+    /// **Note:** (For `ArcArray`) The array must be uniquely held when mutating it.
     #[inline]
     pub unsafe fn uget_mut<I>(&mut self, index: I) -> &mut A
         where S: DataMut,
@@ -520,7 +520,7 @@ impl<A, S, D> ArrayBase<S, D> where S: Data<Elem=A>, D: Dimension
     /// Indices may be equal.
     ///
     /// **Note:** only unchecked for non-debug builds of ndarray.<br>
-    /// **Note:** (For `RcArray`) The array must be uniquely held.
+    /// **Note:** (For `ArcArray`) The array must be uniquely held.
     pub unsafe fn uswap<I>(&mut self, index1: I, index2: I)
         where S: DataMut,
               I: NdIndex<D>,
@@ -1173,7 +1173,7 @@ impl<A, S, D> ArrayBase<S, D> where S: Data<Elem=A>, D: Dimension
         }
     }
 
-    /// *Note: Reshape is for `RcArray` only. Use `.into_shape()` for
+    /// *Note: Reshape is for `ArcArray` only. Use `.into_shape()` for
     /// other arrays and array views.*
     ///
     /// Transform the array into `shape`; any shape with the same number of

src/impl_ops.rs

@@ -55,7 +55,7 @@ macro_rules! impl_binary_op(
 /// between `self` and `rhs`,
 /// and return the result (based on `self`).
 ///
-/// `self` must be an `Array` or `RcArray`.
+/// `self` must be an `Array` or `ArcArray`.
 ///
 /// If their shapes disagree, `rhs` is broadcast to the shape of `self`.
 ///
@@ -126,7 +126,7 @@ impl<'a, A, S, S2, D, E> $trt<&'a ArrayBase<S2, E>> for &'a ArrayBase<S, D>
 /// between `self` and the scalar `x`,
 /// and return the result (based on `self`).
 ///
-/// `self` must be an `Array` or `RcArray`.
+/// `self` must be an `Array` or `ArcArray`.
 impl<A, S, D, B> $trt<B> for ArrayBase<S, D>
     where A: Clone + $trt<B, Output=A>,
           S: DataOwned<Elem=A> + DataMut,

src/lib.rs

@@ -186,6 +186,7 @@ pub use layout::Layout;
 /// Implementation's prelude. Common types used everywhere.
 mod imp_prelude {
     pub use prelude::*;
+    pub use ArcArray;
     pub use {
         RemoveAxis,
         Data,