Struct ArrayView 

pub struct ArrayView<'a, T, D>
where
    T: Element,
    D: Dimension,
{ /* private fields */ }

An immutable, borrowed view into an existing array’s data.

This is a zero-copy slice — no data is cloned. The lifetime 'a ties this view to the source array.

Implementations

impl<'a, T, D> ArrayView<'a, T, D>

where T: Element, D: Dimension,

pub fn broadcast_to( &self, target_shape: &[usize], ) -> Result<ArrayView<'a, T, IxDyn>, FerrayError>

Broadcast this view to the given shape, returning a dynamic-rank view.

Errors

Returns FerrayError::BroadcastFailure if the view cannot be broadcast.

impl<T, D> ArrayView<'_, T, D>

where T: Element, D: Dimension,

pub const fn itemsize(&self) -> usize

Size in bytes of a single element.

pub fn nbytes(&self) -> usize

Total size in bytes of all elements.

pub fn dtype(&self) -> DType

Runtime dtype tag.

pub fn t(&self) -> ArrayView<'_, T, D>

Transposed view (zero-copy).

impl<T, D> ArrayView<'_, T, D>

where T: Element, D: Dimension,

pub fn iter(&self) -> impl Iterator<Item = &T>

Iterate over all elements in logical order.

pub fn flat(&self) -> impl Iterator<Item = &T>

Flat iterator.

pub fn indexed_iter(&self) -> impl Iterator<Item = (Vec<usize>, &T)>

Iterate with multi-dimensional indices. See Array::indexed_iter.

impl<T, D> ArrayView<'_, T, D>

where T: Element, D: Dimension,

pub fn mapv(&self, f: impl Fn(T) -> T) -> Array<T, D>

Apply a closure to every element, returning a new owned array.

pub fn fold_axis( &self, axis: Axis, init: T, fold: impl FnMut(&T, &T) -> T, ) -> Result<Array<T, IxDyn>, FerrayError>

where <D as Dimension>::NdarrayDim: RemoveAxis,

Fold along an axis.

impl<T, D> ArrayView<'_, T, D>

where T: Element + Copy, D: Dimension,

pub fn sum(&self) -> T

where T: Add<Output = T>,

Sum of all elements. See Array::sum.

pub fn prod(&self) -> T

where T: Mul<Output = T>,

Product of all elements. See Array::prod.

impl<T, D> ArrayView<'_, T, D>

where T: Element + Copy + PartialOrd, D: Dimension,

pub fn min(&self) -> Option<T>

Minimum value. See Array::min.

pub fn max(&self) -> Option<T>

Maximum value. See Array::max.

impl<T, D> ArrayView<'_, T, D>

where T: Element + Float, D: Dimension,

pub fn mean(&self) -> Option<T>

Mean. See Array::mean.

impl<'a, T, D> ArrayView<'a, T, D>

where T: Element, D: Dimension,

pub fn shape(&self) -> &[usize]

Shape as a slice.

pub fn ndim(&self) -> usize

Number of dimensions.

pub fn size(&self) -> usize

Total number of elements.

pub fn is_empty(&self) -> bool

Whether the view has zero elements.

pub fn strides(&self) -> &[isize]

Strides as a slice.

pub fn as_ptr(&self) -> *const T

Raw pointer to the first element.

pub fn as_slice(&self) -> Option<&[T]>

Try to get a contiguous slice.

pub fn layout(&self) -> MemoryLayout

Memory layout.

pub const fn dim(&self) -> &D

Return a reference to the internal dimension descriptor.

pub fn to_owned(&self) -> Array<T, D>

Convert this view into an owned array by cloning all elements.

pub fn to_vec_flat(&self) -> Vec<T>

Convert to a flat Vec<T> in logical (row-major) order.

Unlike as_slice() which requires contiguous memory, this works on strided/non-contiguous views by iterating elements in logical order.

pub fn flags(&self) -> ArrayFlags

Array flags for this view.

impl<T> ArrayView<'_, T, IxDyn>

where T: Element,

pub unsafe fn from_shape_ptr( ptr: *const T, shape: &[usize], strides: &[usize], ) -> ArrayView<'_, T, IxDyn>

Construct a dynamic-rank view from a raw pointer, shape, and strides.

This is the primary escape hatch for crates that need to build views with custom stride patterns (e.g., ferray-stride-tricks).

Safety

The caller must ensure:

• ptr is valid for reads for the entire region described by shape and strides.
• The lifetime 'a does not outlive the allocation that ptr points into.
• No mutable reference to the same memory region exists for the duration of 'a.
• strides are given in units of elements (not bytes).

impl<T, D> ArrayView<'_, T, D>

where T: Element, D: Dimension,

pub fn index_select( &self, axis: Axis, indices: &[isize], ) -> Result<Array<T, IxDyn>, FerrayError>

Select elements along an axis using an array of indices (copy).

pub fn boolean_index( &self, mask: &Array<bool, D>, ) -> Result<Array<T, Ix1>, FerrayError>

Select elements using a boolean mask (copy).

impl<'a, T, D> ArrayView<'a, T, D>

where T: Element, D: Dimension,

pub fn index_axis( &self, axis: Axis, index: isize, ) -> Result<ArrayView<'a, T, <D as Dimension>::Smaller>, FerrayError>

where <D as Dimension>::NdarrayDim: RemoveAxis<Smaller = <<D as Dimension>::Smaller as Dimension>::NdarrayDim>,

Index into the view along a given axis, removing that axis. Returns a view with rank one less than Self (#349).

pub fn slice_axis( &self, axis: Axis, spec: SliceSpec, ) -> Result<ArrayView<'a, T, IxDyn>, FerrayError>

Slice the view along a given axis.

pub fn insert_axis( &self, axis: Axis, ) -> Result<ArrayView<'a, T, <D as Dimension>::Larger>, FerrayError>

where <D as Dimension>::NdarrayDim: Dimension<Larger = <<D as Dimension>::Larger as Dimension>::NdarrayDim>,

Insert a new axis of length 1 at the given position. Returns a view with rank one greater than Self (#349).

pub fn remove_axis( &self, axis: Axis, ) -> Result<ArrayView<'a, T, <D as Dimension>::Smaller>, FerrayError>

where <D as Dimension>::NdarrayDim: RemoveAxis<Smaller = <<D as Dimension>::Smaller as Dimension>::NdarrayDim>,

Remove an axis of length 1. Returns a view with rank one less than Self (#349).

pub fn get(&self, indices: &[isize]) -> Result<&'a T, FerrayError>

Get a reference to a single element by multi-dimensional index.

Trait Implementations

impl<'a, T, D> AsRawBuffer for ArrayView<'a, T, D>

where T: Element, D: Dimension,

fn raw_ptr(&self) -> *const u8

Raw pointer to the first element.

fn raw_shape(&self) -> &[usize]

Shape as a slice of dimension sizes.

fn raw_strides_bytes(&self) -> Vec<isize>

Strides in bytes (not elements).

fn raw_dtype(&self) -> DType

Runtime dtype descriptor.

fn is_c_contiguous(&self) -> bool

Whether the data is C-contiguous.

fn is_f_contiguous(&self) -> bool

Whether the data is Fortran-contiguous.

fn buffer_descriptor(&self) -> BufferDescriptor<'_>

Build a BufferDescriptor aggregating every field above into a single FFI-safe struct (#358). Default impl composes the other trait methods so concrete types don’t need to override.

impl<T, D> Clone for ArrayView<'_, T, D>

where T: Element, D: Dimension,

fn clone(&self) -> ArrayView<'_, T, D>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T, D> Debug for ArrayView<'_, T, D>

where T: Element, D: Dimension,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<T, D> Display for ArrayView<'_, T, D>

where T: Element, D: Dimension,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'a, T, D> From<ArrayView<'a, T, D>> for CowArray<'a, T, D>

where T: Element, D: Dimension,

fn from(view: ArrayView<'a, T, D>) -> CowArray<'a, T, D>

Converts to this type from the input type.