Lift ndarray compatibility into Buffer<T>

CHANGES.md

@@ -2,6 +2,15 @@
 
 ## Unreleased
 
+- Added ability to convert between `Buffer<T>` and `ndarray::Array2<T>`. 
+- Implemented `IntoIterator`, `Index` and `IndexMut` for `Buffer<T>`. 
+- **Breaking**: `Buffer<T>::size` is now private and accessed via `Buffer<T>::shape().
+- **Breaking**: `Buffer<T>::data` is now private and accessed via `Buffer<T>::data(). 
+- **Breaking**: Removed `Rasterband::read_as_array`, changed signature of `Rasterband::read_block` to return a `Buffer<T>`. 
+- **Breaking**: `Rasterband::write` and `Rasterband::write_block` now require a `&mut Buffer<T>` to handle possible case of drivers temporarily mutating input buffer.
+
+   - <https://github.com/georust/gdal/pull/494>
+
 - Implemented `Feature::set_field_null`
 
   - <https://github.com/georust/gdal/pull/501>
@@ -15,7 +24,7 @@
 
    - <https://github.com/georust/gdal/pull/498>
 
-- Defers the gdal_i.lib missing message until after the pkg-config check and outputs pkg-config metadata in case of a static build.
+- Defers the `gdal_i.lib` missing message until after the `pkg-config` check and outputs `pkg-config` metadata in case of a static build.
 
    - <https://github.com/georust/gdal/pull/492>
 

examples/rasterband.rs

@@ -14,6 +14,6 @@ fn main() {
     println!("rasterband scale: {:?}", rasterband.scale());
     println!("rasterband offset: {:?}", rasterband.offset());
     if let Ok(rv) = rasterband.read_as::<u8>((20, 30), (2, 3), (2, 3), None) {
-        println!("{:?}", rv.data);
+        println!("{:?}", rv.data());
     }
 }

src/raster/buffer.rs

@@ -0,0 +1,304 @@
+use crate::raster::GdalType;
+use std::ops::{Index, IndexMut};
+use std::slice::{Iter, IterMut};
+use std::vec::IntoIter;
+
+#[cfg(feature = "ndarray")]
+use ndarray::Array2;
+
+/// `Buffer<T>` manages cell values in in raster I/O operations.
+///
+/// It conceptually represents a 2-D array backed by a `Vec<T>` with row-major organization
+/// to represent `shape` (cols, rows).
+///
+/// 2-D indexing is available through `Index<(usize, usize)>` and `IndexMut<(usize, usize)>`
+/// implementations. The underlying data can be accessed linearly via [`Buffer<T>::data()`]
+/// and [`Buffer<T>::data_mut()`]. [`IntoIterator`] is also provided.
+///
+/// If the `ndarray` feature is enabled, a `Buffer<T>` can be converted (without copy)
+/// to an `Array2<T>` via [`Buffer<T>::to_array()`].
+///
+/// # Example
+///
+/// ```rust, no_run
+/// # fn main() -> gdal::errors::Result<()> {
+/// use gdal::Dataset;
+/// use gdal::raster::Buffer;
+/// // Read the band:
+/// let ds = Dataset::open("fixtures/dem-hills.tiff")?;
+/// let band = ds.rasterband(1)?;
+/// let buf: Buffer<f64> = band.read_band_as()?;
+///
+/// // Read cell in the middle:
+/// let size = ds.raster_size();
+/// let center = (size.0/2, size.1/2);
+/// let center_value = buf[center];
+/// assert_eq!(center_value.round(), 166.0);
+///
+/// // Gather basic statistics:
+/// fn min_max(b: &Buffer<f64>) -> (f64, f64) {
+///     b.into_iter().fold((f64::MAX, f64::MIN), |a, v| (v.min(a.0), v.max(a.1)))
+/// }
+/// let (min, max) = min_max(&buf);
+/// assert_eq!(min, -999999.0); // <--- data has a sentinel value
+/// assert_eq!(max.round(), 168.0);
+///
+/// // Mutate the buffer and observe the difference:
+/// let mut buf = buf;
+/// buf[center] = 1e10;
+/// let (min, max) = min_max(&buf);
+/// assert_eq!(max, 1e10);
+///
+/// # Ok(())
+/// # }
+/// ```
+#[derive(Debug, Clone, Ord, PartialOrd, Eq, PartialEq)]
+pub struct Buffer<T> {
+    shape: (usize, usize),
+    data: Vec<T>,
+}
+
+impl<T: GdalType> Buffer<T> {
+    /// Construct a new buffer from `size` (`(cols, rows)`) and `Vec<T>`.
+    ///
+    /// # Notes
+    /// The elements of `shape` are in reverse order from what is used in `ndarray`.
+    ///
+    /// # Panics
+    /// Will panic if `size.0 * size.1 != data.len()`.
+    pub fn new(shape: (usize, usize), data: Vec<T>) -> Self {
+        assert_eq!(
+            shape.0 * shape.1,
+            data.len(),
+            "shape {}*{}={} does not match length {}",
+            shape.0,
+            shape.1,
+            shape.0 * shape.1,
+            data.len()
+        );
+        Buffer { shape, data }
+    }
+
+    /// Destructures `self` into constituent parts.
+    pub fn into_shape_and_vec(self) -> ((usize, usize), Vec<T>) {
+        (self.shape, self.data)
+    }
+
+    /// Gets the 2-d shape of the buffer.
+    //
+    /// Returns `(cols, rows)`
+    ///
+    /// # Notes
+    /// The elements of `shape` are in reverse order from what is used in `ndarray`.
+    pub fn shape(&self) -> (usize, usize) {
+        self.shape
+    }
+
+    /// Get a slice over the buffer contents.
+    pub fn data(&self) -> &[T] {
+        self.data.as_slice()
+    }
+
+    /// Get a mutable slice over the buffer contents.
+    pub fn data_mut(&mut self) -> &mut [T] {
+        self.data.as_mut_slice()
+    }
+
+    /// Get the number of elements in the buffer
+    pub fn len(&self) -> usize {
+        self.data.len()
+    }
+
+    /// Determine if the buffer has no elements.
+    pub fn is_empty(&self) -> bool {
+        self.data.is_empty()
+    }
+
+    #[cfg(feature = "ndarray")]
+    #[cfg_attr(docsrs, doc(cfg(feature = "ndarray")))]
+    /// Convert `self` into an [`ndarray::Array2<T>`].
+    pub fn to_array(self) -> crate::errors::Result<Array2<T>> {
+        // Array2 shape is (rows, cols) and Buffer shape is (cols in x-axis, rows in y-axis)
+        Ok(Array2::from_shape_vec(
+            (self.shape.1, self.shape.0),
+            self.data,
+        )?)
+    }
+
+    #[cold]
+    #[inline(never)]
+    #[track_caller]
+    fn panic_bad_index(shape: (usize, usize), coord: (usize, usize)) -> ! {
+        panic!("index out of bounds: buffer has shape `{shape:?}` but coordinate `{coord:?}` was requested");
+    }
+
+    #[inline]
+    #[track_caller]
+    fn vec_index_for(&self, coord: (usize, usize)) -> usize {
+        if coord.0 >= self.shape.0 || coord.1 >= self.shape.1 {
+            Self::panic_bad_index(self.shape, coord);
+        }
+        coord.0 * self.shape.0 + coord.1
+    }
+}
+
+impl<T: GdalType> Index<(usize, usize)> for Buffer<T> {
+    type Output = T;
+    fn index(&self, index: (usize, usize)) -> &Self::Output {
+        &self.data[self.vec_index_for(index)]
+    }
+}
+
+impl<T: GdalType> IndexMut<(usize, usize)> for Buffer<T> {
+    fn index_mut(&mut self, index: (usize, usize)) -> &mut Self::Output {
+        let idx = self.vec_index_for(index);
+        &mut self.data[idx]
+    }
+}
+
+impl<T: GdalType> IntoIterator for Buffer<T> {
+    type Item = T;
+    type IntoIter = IntoIter<T>;
+
+    fn into_iter(self) -> Self::IntoIter {
+        self.data.into_iter()
+    }
+}
+
+impl<'a, T: GdalType> IntoIterator for &'a Buffer<T> {
+    type Item = &'a T;
+    type IntoIter = Iter<'a, T>;
+
+    fn into_iter(self) -> Self::IntoIter {
+        self.data.iter()
+    }
+}
+
+impl<'a, T: GdalType> IntoIterator for &'a mut Buffer<T> {
+    type Item = &'a mut T;
+    type IntoIter = IterMut<'a, T>;
+
+    fn into_iter(self) -> Self::IntoIter {
+        self.data.iter_mut()
+    }
+}
+
+pub type ByteBuffer = Buffer<u8>;
+
+#[cfg(feature = "ndarray")]
+impl<T: GdalType> TryFrom<Buffer<T>> for Array2<T> {
+    type Error = crate::errors::GdalError;
+
+    fn try_from(value: Buffer<T>) -> Result<Self, Self::Error> {
+        value.to_array()
+    }
+}
+
+#[cfg(feature = "ndarray")]
+impl<T: GdalType + Copy> From<Array2<T>> for Buffer<T> {
+    fn from(value: Array2<T>) -> Self {
+        // Array2 shape is (rows, cols) and Buffer shape is (cols in x-axis, rows in y-axis)
+        let shape = value.shape();
+        let (cols, rows) = (shape[1], shape[0]);
+        let data: Vec<T> = if value.is_standard_layout() {
+            value.into_raw_vec()
+        } else {
+            value.iter().copied().collect()
+        };
+
+        Buffer::new((cols, rows), data)
+    }
+}
+
+#[cfg(feature = "ndarray")]
+#[cfg(test)]
+mod tests {
+    use crate::raster::Buffer;
+    use ndarray::{Array2, ShapeBuilder};
+
+    #[test]
+    fn convert_to() {
+        let b = Buffer::new((5, 10), (0..5 * 10).collect());
+        let a = b.clone().to_array().unwrap();
+        let expected = Array2::from_shape_fn((10, 5), |(y, x)| y as i32 * 5 + x as i32);
+        assert_eq!(a, expected);
+        let b2: Buffer<_> = a.into();
+        assert_eq!(b, b2);
+    }
+
+    #[test]
+    fn convert_from() {
+        let a = Array2::from_shape_fn((10, 5), |(y, x)| y as i32 * 5 + x as i32);
+        let b: Buffer<_> = a.clone().into();
+        let expected = Buffer::new((5, 10), (0..5 * 10).collect());
+        assert_eq!(b, expected);
+
+        let a2 = b.to_array().unwrap();
+        assert_eq!(a, a2);
+    }
+
+    #[test]
+    fn shapes() {
+        let s1 = (10, 5).into_shape().set_f(true);
+        let s2 = (10, 5).into_shape().set_f(false);
+
+        let a1 = Array2::from_shape_fn(s1, |(y, x)| y as i32 * 5 + x as i32);
+        let a2 = Array2::from_shape_fn(s2, |(y, x)| y as i32 * 5 + x as i32);
+
+        let expected = Buffer::new((5, 10), (0..5 * 10).collect());
+
+        assert_eq!(a1, expected.clone().to_array().unwrap());
+
+        let b1: Buffer<_> = a1.into();
+        let b2: Buffer<_> = a2.into();
+
+        assert_eq!(b1, expected);
+        assert_eq!(b2, expected);
+    }
+
+    #[test]
+    fn index() {
+        let b = Buffer::new((5, 7), (0..5 * 7).collect());
+        assert_eq!(b[(0, 0)], 0);
+        assert_eq!(b[(1, 1)], 5 + 1);
+        assert_eq!(b[(4, 5)], 4 * 5 + 5);
+
+        let mut b = b;
+        b[(2, 2)] = 99;
+        assert_eq!(b[(2, 1)], 2 * 5 + 1);
+        assert_eq!(b[(2, 2)], 99);
+        assert_eq!(b[(2, 3)], 2 * 5 + 3);
+    }
+
+    #[test]
+    fn iter() {
+        // Iter on ref
+        let b = Buffer::new((5, 7), (0..5 * 7).collect());
+        let mut iter = (&b).into_iter();
+        let _ = iter.next().unwrap();
+        let v = iter.next().unwrap();
+        assert_eq!(*v, b[(0, 1)]);
+
+        // Iter on owned
+        let mut iter = b.clone().into_iter();
+        let _ = iter.next().unwrap();
+        let v = iter.next().unwrap();
+        assert_eq!(v, b[(0, 1)]);
+
+        // Iter on mut
+        let mut b = b;
+        let mut iter = (&mut b).into_iter();
+        let _ = iter.next().unwrap();
+        let v = iter.next().unwrap();
+        *v = 99;
+
+        assert_eq!(99, b[(0, 1)]);
+    }
+
+    #[test]
+    #[should_panic]
+    fn index_bounds_panic() {
+        let b = Buffer::new((5, 7), (0..5 * 7).collect());
+        let _ = b[(5, 0)];
+    }
+}

src/raster/mdarray.rs

@@ -248,7 +248,7 @@ impl<'a> MDArray<'a> {
 
     #[cfg(feature = "ndarray")]
     #[cfg_attr(docsrs, doc(cfg(feature = "array")))]
-    /// Read a 'Array2<T>' from this band. T implements 'GdalType'.
+    /// Read an [`ArrayD<T>`] from this band. T implements [`GdalType`].
     ///
     /// # Arguments
     /// * `window` - the window position from top left