From 28e887e70fae39bc724b351c6eca642a7e3067f8 Mon Sep 17 00:00:00 2001
From: roblabla <unfiltered@roblab.la>
Date: Fri, 14 Oct 2022 10:21:27 +0200
Subject: [PATCH] Impl a lifetime-relaxed broadcast for ArrayView

ArrayView::broadcast has a lifetime that depends on &self instead of its
internal buffer. This prevents writing some types of functions in an
allocation-free way. For instance, take the numpy `meshgrid` function:
It could be implemented like so:

```rust
fn meshgrid_2d<'a, 'b>(coords_x: ArrayView1<'a, X>, coords_y: ArrayView1<'b, X>) -> (ArrayView2<'a, X>, ArrayView2<'b, X>) {
    let x_len = coords_x.shape()[0];
    let y_len = coords_y.shape()[0];

    let coords_x_s = coords_x.into_shape((1, y_len)).unwrap();
    let coords_x_b = coords_x_s.broadcast((x_len, y_len)).unwrap();
    let coords_y_s = coords_y.into_shape((x_len, 1)).unwrap();
    let coords_y_b = coords_y_s.broadcast((x_len, y_len)).unwrap();

    (coords_x_b, coords_y_b)
}
```

Unfortunately, this doesn't work, because `coords_x_b` is bound to the
lifetime of `coord_x_s`, instead of being bound to 'a.

This commit introduces a new function, broadcast_ref, that does just
that.
---
 src/impl_views/methods.rs | 34 ++++++++++++++++++++++++++++++++++
 src/impl_views/mod.rs     |  1 +
 2 files changed, 35 insertions(+)
 create mode 100644 src/impl_views/methods.rs

diff --git a/src/impl_views/methods.rs b/src/impl_views/methods.rs
new file mode 100644
index 000000000..a34247165
--- /dev/null
+++ b/src/impl_views/methods.rs
@@ -0,0 +1,34 @@
+// Copyright 2014-2016 bluss and ndarray developers.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+use crate::imp_prelude::*;
+use crate::dimension::IntoDimension;
+use crate::dimension::broadcast::upcast;
+
+impl<'a, A, D> ArrayView<'a, A, D>
+where
+    D: Dimension,
+{
+    /// Broadcasts an `ArrayView`. See [`ArrayBase::broadcast`].
+    ///
+    /// This is a specialized version of [`ArrayBase::broadcast`] that transfers
+    /// the view's lifetime to the output.
+    pub fn broadcast_ref<E>(&self, dim: E) -> Option<ArrayView<'a, A, E::Dim>>
+    where
+        E: IntoDimension,
+    {
+        let dim = dim.into_dimension();
+
+        // Note: zero strides are safe precisely because we return an read-only view
+        let broadcast_strides = match upcast(&dim, &self.dim, &self.strides) {
+            Some(st) => st,
+            None => return None,
+        };
+        unsafe { Some(ArrayView::new(self.ptr, dim, broadcast_strides)) }
+    }
+}
diff --git a/src/impl_views/mod.rs b/src/impl_views/mod.rs
index 487cc3cb2..fda58242a 100644
--- a/src/impl_views/mod.rs
+++ b/src/impl_views/mod.rs
@@ -1,6 +1,7 @@
 mod constructors;
 mod conversions;
 mod indexing;
+mod methods;
 mod splitting;
 
 pub use constructors::*;