Interface PyArrayMethods

src/array.rs:724–1336

/// Implementation of functionality for [`PyArray<T, D>`].
#[doc(alias = "PyArray")]
pub trait PyArrayMethods<'py, T, D>: PyUntypedArrayMethods<'py> + Sized {
    /// Access an untyped representation of this array.
    fn as_untyped(&self) -> &Bound<'py, PyUntypedArray>;

    /// Returns a pointer to the first element of the array.
    fn data(&self) -> *mut T;

    /// Same as [`shape`][PyUntypedArrayMethods::shape], but returns `D` instead of `&[usize]`.
    #[inline(always)]
    fn dims(&self) -> D
    where
        D: Dimension,
    {
        D::from_dimension(&Dim(self.shape())).expect(DIMENSIONALITY_MISMATCH_ERR)
    }

    /// Returns an immutable view of the internal data as a slice.
    ///
    /// # Safety
    ///
    /// Calling this method is undefined behaviour if the underlying array
    /// is aliased mutably by other instances of `PyArray`
    /// or concurrently modified by Python or other native code.
    ///
    /// Please consider the safe alternative [`PyReadonlyArray::as_slice`].
    unsafe fn as_slice(&self) -> Result<&[T], AsSliceError>
    where
        T: Element,
        D: Dimension,
    {
        let len = self.len();
        if len == 0 {
            // We can still produce a slice over zero objects regardless of whether
            // the underlying pointer is aligned or not.
            Ok(&[])
        } else if self.is_aligned() && self.is_contiguous() {
            Ok(slice::from_raw_parts(self.data(), len))
        } else {
            Err(AsSliceError)
        }
    }

    /// Returns a mutable view of the internal data as a slice.
    ///
    /// # Safety
    ///
    /// Calling this method is undefined behaviour if the underlying array
    /// is aliased immutably or mutably by other instances of [`PyArray`]
    /// or concurrently modified by Python or other native code.
    ///
    /// Please consider the safe alternative [`PyReadwriteArray::as_slice_mut`].
    #[allow(clippy::mut_from_ref)]
    unsafe fn as_slice_mut(&self) -> Result<&mut [T], AsSliceError>
    where
        T: Element,
        D: Dimension,
    {
        let len = self.len();