Merge pull request #517 from jturner314/macro-use

bluss · web-flow · commit 1b1a5035b25c · 2018-11-27T21:48:27.000+01:00
Bump to Rust 1.30, add macros to preludes, and switch macro_use to use
diff --git a/.travis.yml b/.travis.yml
@@ -4,7 +4,7 @@ sudo: required
 dist: trusty
 matrix:
   include:
-    - rust: 1.27.0
+    - rust: 1.30.0
       env:
        - FEATURES='test docs'
     - rust: stable
diff --git a/benches/bench1.rs b/benches/bench1.rs
@@ -2,7 +2,6 @@
 #![allow(unused_imports)]
 
 extern crate test;
-#[macro_use(s, azip)]
 extern crate ndarray;
 
 use ndarray::{
@@ -13,7 +12,7 @@ use ndarray::{
     Array2,
     Zip,
 };
-use ndarray::{arr0, arr1, arr2};
+use ndarray::{arr0, arr1, arr2, azip, s};
 use ndarray::ShapeBuilder;
 
 use test::black_box;
diff --git a/benches/chunks.rs b/benches/chunks.rs
@@ -3,7 +3,6 @@
 extern crate test;
 use test::Bencher;
 
-#[macro_use(azip)]
 extern crate ndarray;
 use ndarray::prelude::*;
 use ndarray::NdProducer;
diff --git a/benches/construct.rs b/benches/construct.rs
@@ -3,7 +3,6 @@
 extern crate test;
 use test::Bencher;
 
-#[macro_use(s)]
 extern crate ndarray;
 use ndarray::prelude::*;
 
diff --git a/benches/higher-order.rs b/benches/higher-order.rs
@@ -5,7 +5,6 @@ extern crate test;
 use test::Bencher;
 use test::black_box;
 
-#[macro_use(s)]
 extern crate ndarray;
 use ndarray::prelude::*;
 
diff --git a/benches/iter.rs b/benches/iter.rs
@@ -6,7 +6,6 @@ use test::Bencher;
 use test::black_box;
 use rawpointer::PointerExt;
 
-#[macro_use(s, azip)]
 extern crate ndarray;
 use ndarray::prelude::*;
 use ndarray::{Zip, FoldWhile};
diff --git a/blas-tests/tests/oper.rs b/blas-tests/tests/oper.rs
@@ -1,5 +1,5 @@
-#[macro_use] extern crate defmac;
-#[macro_use(s)] extern crate ndarray;
+extern crate defmac;
+extern crate ndarray;
 extern crate num_traits;
 
 use ndarray::prelude::*;
@@ -9,6 +9,7 @@ use ndarray::linalg::general_mat_vec_mul;
 use ndarray::{Ix, Ixs, SliceInfo, SliceOrIndex};
 
 use std::fmt;
+use defmac::defmac;
 use num_traits::Float;
 
 fn assert_approx_eq<F: fmt::Debug + Float>(f: F, g: F, tol: F) -> bool {
diff --git a/examples/axis_ops.rs b/examples/axis_ops.rs
@@ -1,10 +1,6 @@
-
-#[macro_use(s)]
 extern crate ndarray;
 
-use ndarray::Array;
-use ndarray::Dimension;
-use ndarray::Axis;
+use ndarray::prelude::*;
 
 fn regularize<A, D>(a: &mut Array<A, D>) -> Result<(), ()>
     where D: Dimension,
diff --git a/examples/column_standardize.rs b/examples/column_standardize.rs
@@ -1,5 +1,3 @@
-
-#[macro_use]
 extern crate ndarray;
 
 use ndarray::prelude::*;
diff --git a/examples/convo.rs b/examples/convo.rs
@@ -1,5 +1,4 @@
 #![allow(unused)]
-#[macro_use(s)]
 extern crate ndarray;
 extern crate num_traits;
 
diff --git a/examples/life.rs b/examples/life.rs
@@ -1,4 +1,3 @@
-#[macro_use]
 extern crate ndarray;
 
 use ndarray::prelude::*;
diff --git a/examples/rollaxis.rs b/examples/rollaxis.rs
@@ -1,5 +1,3 @@
-
-#[macro_use]
 extern crate ndarray;
 
 use ndarray::prelude::*;
diff --git a/examples/zip_many.rs b/examples/zip_many.rs
@@ -1,5 +1,3 @@
-
-#[macro_use]
 extern crate ndarray;
 
 use ndarray::prelude::*;
diff --git a/numeric-tests/tests/accuracy.rs b/numeric-tests/tests/accuracy.rs
@@ -1,5 +1,3 @@
-
-#[macro_use(s)]
 extern crate ndarray;
 extern crate ndarray_rand;
 extern crate rand;
diff --git a/parallel/benches/rayon.rs b/parallel/benches/rayon.rs
@@ -6,8 +6,8 @@ extern crate test;
 use test::Bencher;
 
 extern crate rayon;
-#[macro_use] extern crate ndarray;
-#[macro_use] extern crate ndarray_parallel;
+extern crate ndarray;
+extern crate ndarray_parallel;
 use ndarray::prelude::*;
 use ndarray_parallel::prelude::*;
 
diff --git a/parallel/src/lib.rs b/parallel/src/lib.rs
@@ -98,8 +98,10 @@
 pub extern crate ndarray;
 pub extern crate rayon;
 
-/// Into- traits for creating parallelized iterators.
+/// Into- traits for creating parallelized iterators and `par_azip` macro.
 pub mod prelude {
+    pub use par_azip;
+
     // happy and insane; ignorance is bluss
     pub use NdarrayIntoParallelIterator;
     pub use NdarrayIntoParallelRefIterator;
diff --git a/parallel/src/zipmacro.rs b/parallel/src/zipmacro.rs
@@ -31,10 +31,10 @@
 ///
 /// ```rust
 /// extern crate ndarray;
-/// #[macro_use(par_azip)]
 /// extern crate ndarray_parallel;
 ///
 /// use ndarray::Array2;
+/// use ndarray_parallel::par_azip;
 ///
 /// type M = Array2<f32>;
 ///
diff --git a/parallel/tests/azip.rs b/parallel/tests/azip.rs
@@ -1,10 +1,10 @@
 
 extern crate ndarray;
-#[macro_use]
 extern crate ndarray_parallel;
 extern crate itertools;
 
 use ndarray::prelude::*;
+use ndarray_parallel::par_azip;
 use itertools::{enumerate};
 use std::sync::atomic::{AtomicUsize, Ordering};
 
diff --git a/parallel/tests/rayon.rs b/parallel/tests/rayon.rs
@@ -1,6 +1,6 @@
 
 extern crate rayon;
-#[macro_use(s)] extern crate ndarray;
+extern crate ndarray;
 extern crate ndarray_parallel;
 
 use ndarray::prelude::*;
diff --git a/serialization-tests/tests/serialize.rs b/serialization-tests/tests/serialize.rs
@@ -1,6 +1,6 @@
 extern crate rustc_serialize as serialize;
 
-#[macro_use] extern crate ndarray;
+extern crate ndarray;
 
 extern crate serde;
 
@@ -14,7 +14,7 @@ extern crate ron;
 use serialize::json;
 
 
-use ndarray::{arr0, arr1, arr2, RcArray, RcArray1, RcArray2, ArrayD, IxDyn};
+use ndarray::{arr0, arr1, arr2, s, RcArray, RcArray1, RcArray2, ArrayD, IxDyn};
 
 #[test]
 fn serial_many_dim()
diff --git a/src/dimension/dimension_trait.rs b/src/dimension/dimension_trait.rs
@@ -11,7 +11,7 @@ use std::fmt::Debug;
 use std::ops::{Index, IndexMut};
 use std::ops::{Add, Sub, Mul, AddAssign, SubAssign, MulAssign};
 
-use itertools::{enumerate, zip};
+use itertools::{enumerate, izip, zip};
 
 use {Ix, Ixs, Ix0, Ix1, Ix2, Ix3, Ix4, Ix5, Ix6, IxDyn, Dim, SliceOrIndex, IxDynImpl};
 use IntoDimension;
diff --git a/src/dimension/mod.rs b/src/dimension/mod.rs
@@ -8,6 +8,7 @@
 
 use {Ix, Ixs};
 use error::{from_kind, ErrorKind, ShapeError};
+use itertools::izip;
 
 pub use self::dim::*;
 pub use self::axis::Axis;
@@ -428,6 +429,7 @@ mod test {
         can_index_slice, can_index_slice_not_custom, max_abs_offset_check_overflow, IntoDimension
     };
     use error::{from_kind, ErrorKind};
+    use quickcheck::quickcheck;
     use {Dimension, Ix0, Ix1, Ix2, Ix3, IxDyn};
 
     #[test]
diff --git a/src/doc/ndarray_for_numpy_users/coord_transform.rs b/src/doc/ndarray_for_numpy_users/coord_transform.rs
@@ -49,7 +49,6 @@
 //! This is a direct translation to `ndarray`:
 //!
 //! ```
-//! #[macro_use]
 //! extern crate ndarray;
 //!
 //! use ndarray::prelude::*;
@@ -97,7 +96,6 @@
 //! this:
 //!
 //! ```
-//! #[macro_use]
 //! extern crate ndarray;
 //!
 //! use ndarray::prelude::*;
diff --git a/src/doc/ndarray_for_numpy_users/mod.rs b/src/doc/ndarray_for_numpy_users/mod.rs
@@ -163,7 +163,6 @@
 //! and `ndarray` like this:
 //!
 //! ```
-//! #[macro_use]
 //! extern crate ndarray;
 //!
 //! use ndarray::prelude::*;
diff --git a/src/doc/ndarray_for_numpy_users/rk_step.rs b/src/doc/ndarray_for_numpy_users/rk_step.rs
@@ -71,7 +71,6 @@
 //! A direct translation to `ndarray` looks like this:
 //!
 //! ```
-//! #[macro_use]
 //! extern crate ndarray;
 //!
 //! use ndarray::prelude::*;
@@ -130,7 +129,6 @@
 //!   some places, but that's not demonstrated in the example below.
 //!
 //! ```
-//! #[macro_use]
 //! extern crate ndarray;
 //!
 //! use ndarray::prelude::*;
diff --git a/src/doc/ndarray_for_numpy_users/simple_math.rs b/src/doc/ndarray_for_numpy_users/simple_math.rs
@@ -23,7 +23,6 @@
 //!
 //!
 //!
-//!
 //! a = np.full((5, 4), 3.)
 //!
 //!
@@ -52,7 +51,6 @@
 //! <td>
 //!
 //! ```
-//! #[macro_use]
 //! extern crate ndarray;
 //!
 //! use ndarray::prelude::*;
diff --git a/src/free_functions.rs b/src/free_functions.rs
@@ -16,9 +16,10 @@ use imp_prelude::*;
 /// three dimensions.
 ///
 /// ```
-/// #[macro_use(array)]
 /// extern crate ndarray;
 ///
+/// use ndarray::array;
+///
 /// fn main() {
 ///     let a1 = array![1, 2, 3, 4];
 ///
@@ -115,10 +116,9 @@ pub fn aview2<A, V: FixedInitializer<Elem=A>>(xs: &[V]) -> ArrayView2<A> {
 /// Create a one-dimensional read-write array view with elements borrowing `xs`.
 ///
 /// ```
-/// #[macro_use(s)]
 /// extern crate ndarray;
 ///
-/// use ndarray::aview_mut1;
+/// use ndarray::{aview_mut1, s};
 ///
 /// // Create an array view over some data, then slice it and modify it.
 /// fn main() {
diff --git a/src/impl_constructors.rs b/src/impl_constructors.rs
@@ -370,10 +370,9 @@ impl<S, A, D> ArrayBase<S, D>
     /// ### Examples
     ///
     /// ```
-    /// #[macro_use(s)]
     /// extern crate ndarray;
     ///
-    /// use ndarray::Array2;
+    /// use ndarray::{s, Array2};
     ///
     /// // Example Task: Let's create a column shifted copy of a in b
     ///
diff --git a/src/impl_methods.rs b/src/impl_methods.rs
@@ -10,7 +10,7 @@ use std::cmp;
 use std::ptr as std_ptr;
 use std::slice;
 
-use itertools::zip;
+use itertools::{izip, zip};
 
 use imp_prelude::*;
 
diff --git a/src/lib.rs b/src/lib.rs
@@ -56,7 +56,7 @@
 //!   + Efficient floating point matrix multiplication even for very large
 //!     matrices; can optionally use BLAS to improve it further.
 //!   + See also the [`ndarray-parallel`] crate for integration with rayon.
-//! - **Requires Rust 1.27**
+//! - **Requires Rust 1.30**
 //!
 //! [`ndarray-parallel`]: https://docs.rs/ndarray-parallel
 //!
@@ -99,12 +99,11 @@ extern crate blas_src;
 
 extern crate matrixmultiply;
 
-#[macro_use(izip)] extern crate itertools;
+extern crate itertools;
 extern crate num_traits as libnum;
 extern crate num_complex;
 
 #[cfg(test)]
-#[macro_use(quickcheck)]
 extern crate quickcheck;
 
 #[cfg(feature = "docs")]
@@ -470,11 +469,9 @@ pub type Ixs = isize;
 /// [`.slice_collapse()`]: #method.slice_collapse
 ///
 /// ```
-/// // import the s![] macro
-/// #[macro_use(s)]
 /// extern crate ndarray;
 ///
-/// use ndarray::{arr2, arr3};
+/// use ndarray::{arr2, arr3, s};
 ///
 /// fn main() {
 ///
@@ -554,9 +551,9 @@ pub type Ixs = isize;
 /// [`.outer_iter_mut()`]: #method.outer_iter_mut
 ///
 /// ```
-/// #[macro_use(s)] extern crate ndarray;
+/// extern crate ndarray;
 ///
-/// use ndarray::{arr3, aview1, aview2, Axis};
+/// use ndarray::{arr3, aview1, aview2, s, Axis};
 ///
 /// # fn main() {
 ///
diff --git a/src/prelude.rs b/src/prelude.rs
@@ -8,8 +8,8 @@
 
 //! ndarray prelude.
 //!
-//! This module contains the most used types, type aliases, traits and
-//! functions that you can import easily as a group.
+//! This module contains the most used types, type aliases, traits, functions,
+//! and macros that you can import easily as a group.
 //!
 //! ```
 //! extern crate ndarray;
@@ -55,6 +55,8 @@ pub use {
     aview_mut1,
 };
 
+pub use {array, azip, s};
+
 #[doc(no_inline)]
 pub use {
     ShapeBuilder,
diff --git a/src/slice.rs b/src/slice.rs
diff --git a/src/stacking.rs b/src/stacking.rs
diff --git a/src/zip/zipmacro.rs b/src/zip/zipmacro.rs
diff --git a/tests/array-construct.rs b/tests/array-construct.rs
diff --git a/tests/array.rs b/tests/array.rs
diff --git a/tests/azip.rs b/tests/azip.rs
diff --git a/tests/dimension.rs b/tests/dimension.rs
diff --git a/tests/iterator_chunks.rs b/tests/iterator_chunks.rs
diff --git a/tests/iterators.rs b/tests/iterators.rs
diff --git a/tests/oper.rs b/tests/oper.rs
diff --git a/tests/s.rs b/tests/s.rs
diff --git a/tests/stacking.rs b/tests/stacking.rs
diff --git a/tests/windows.rs b/tests/windows.rs

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-`
`2`		`-#[macro_use]`
`3`	`1`	`extern crate ndarray;`
`4`	`2`
`5`	`3`	`use ndarray::prelude::*;`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`#![allow(unused)]`
`2`		`-#[macro_use(s)]`
`3`	`2`	`extern crate ndarray;`
`4`	`3`	`extern crate num_traits;`
`5`	`4`