Merge branch '0.15.x'

Author: jturner314

Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 
 name = "ndarray"
-version = "0.15.5"
+version = "0.15.6"
 edition = "2018"
 rust-version = "1.51"
 authors = [

RELEASES.md

@@ -1,3 +1,32 @@
+Version 0.15.6 (2022-07-30)
+===========================
+
+New features
+------------
+
+- Add `get_ptr` and `get_mut_ptr` methods for getting an element's pointer from
+  an index, by [@adamreichold].
+
+  https://github.com/rust-ndarray/ndarray/pull/1151
+
+Other changes
+-------------
+
+- Various fixes to resolve compiler and Clippy warnings/errors, by [@aganders3]
+  and [@jturner314].
+
+  https://github.com/rust-ndarray/ndarray/pull/1171
+
+- Fix description of `stack!` in quick start docs, by [@jturner314]. Thanks to
+  [@HyeokSuLee] for pointing out the issue.
+
+  https://github.com/rust-ndarray/ndarray/pull/1156
+
+- Add MSRV to `Cargo.toml`.
+
+  https://github.com/rust-ndarray/ndarray/pull/1191
+
+
 Version 0.15.5 (2022-07-30)
 ===========================
 
@@ -1561,6 +1590,8 @@ Earlier releases
   - Starting point for evolution to come
 
 
+[@adamreichold]: https://github.com/adamreichold
+[@aganders3]: https://github.com/aganders3
 [@bluss]: https://github.com/bluss
 [@jturner314]: https://github.com/jturner314
 [@LukeMathWalker]: https://github.com/LukeMathWalker
@@ -1575,6 +1606,7 @@ Earlier releases
 [@ethanhs]: https://github.com/ethanhs
 [@d-dorazio]: https://github.com/d-dorazio
 [@Eijebong]: https://github.com/Eijebong
+[@HyeokSuLee]: https://github.com/HyeokSuLee
 [@insideoutclub]: https://github.com/insideoutclub
 [@JP-Ellis]: https://github.com/JP-Ellis
 [@jimblandy]: https://github.com/jimblandy

src/impl_methods.rs

@@ -732,13 +732,26 @@ where
     /// ```
     pub fn get<I>(&self, index: I) -> Option<&A>
     where
-        I: NdIndex<D>,
         S: Data,
+        I: NdIndex<D>,
     {
         unsafe { self.get_ptr(index).map(|ptr| &*ptr) }
     }
 
-    pub(crate) fn get_ptr<I>(&self, index: I) -> Option<*const A>
+    /// Return a raw pointer to the element at `index`, or return `None`
+    /// if the index is out of bounds.
+    ///
+    /// ```
+    /// use ndarray::arr2;
+    ///
+    /// let a = arr2(&[[1., 2.], [3., 4.]]);
+    ///
+    /// let v = a.raw_view();
+    /// let p = a.get_ptr((0, 1)).unwrap();
+    ///
+    /// assert_eq!(unsafe { *p }, 2.);
+    /// ```
+    pub fn get_ptr<I>(&self, index: I) -> Option<*const A>
     where
         I: NdIndex<D>,
     {
@@ -755,10 +768,27 @@ where
         S: DataMut,
         I: NdIndex<D>,
     {
-        unsafe { self.get_ptr_mut(index).map(|ptr| &mut *ptr) }
+        unsafe { self.get_mut_ptr(index).map(|ptr| &mut *ptr) }
     }
 
-    pub(crate) fn get_ptr_mut<I>(&mut self, index: I) -> Option<*mut A>
+    /// Return a raw pointer to the element at `index`, or return `None`
+    /// if the index is out of bounds.
+    ///
+    /// ```
+    /// use ndarray::arr2;
+    ///
+    /// let mut a = arr2(&[[1., 2.], [3., 4.]]);
+    ///
+    /// let v = a.raw_view_mut();
+    /// let p = a.get_mut_ptr((0, 1)).unwrap();
+    ///
+    /// unsafe {
+    ///     *p = 5.;
+    /// }
+    ///
+    /// assert_eq!(a.get((0, 1)), Some(&5.));
+    /// ```
+    pub fn get_mut_ptr<I>(&mut self, index: I) -> Option<*mut A>
     where
         S: RawDataMut,
         I: NdIndex<D>,

src/impl_views/indexing.rs

@@ -164,7 +164,7 @@ where
     fn index(mut self, index: I) -> &'a mut A {
         debug_bounds_check!(self, index);
         unsafe {
-            match self.get_ptr_mut(index) {
+            match self.get_mut_ptr(index) {
                 Some(ptr) => &mut *ptr,
                 None => array_out_of_bounds(),
             }
@@ -182,7 +182,7 @@ where
     fn get(mut self, index: I) -> Option<&'a mut A> {
         debug_bounds_check!(self, index);
         unsafe {
-            match self.get_ptr_mut(index) {
+            match self.get_mut_ptr(index) {
                 Some(ptr) => Some(&mut *ptr),
                 None => None,
             }