Trait ArraySubsetTraits 

pub trait ArraySubsetTraits: Indexer + Sealed {
    // Required methods
    fn start(&self) -> Cow<'_, [u64]>;
    fn shape(&self) -> Cow<'_, [u64]>;

    // Provided methods
    fn num_elements(&self) -> u64 { ... }
    fn num_elements_usize(&self) -> usize { ... }
    fn end_exc(&self) -> ArrayIndices { ... }
    fn end_inc(&self) -> Option<ArrayIndices> { ... }
    fn to_ranges(&self) -> Vec<Range<u64>> { ... }
    fn contains(&self, indices: &[u64]) -> bool { ... }
    fn inbounds_shape(&self, array_shape: &[u64]) -> bool { ... }
    fn inbounds(&self, other: &dyn ArraySubsetTraits) -> bool { ... }
    fn overlap(
        &self,
        other: &dyn ArraySubsetTraits,
    ) -> Result<ArraySubset, ArraySubsetError> { ... }
    fn relative_to(
        &self,
        offset: &[u64],
    ) -> Result<ArraySubset, ArraySubsetError> { ... }
    fn to_array_subset(&self) -> ArraySubset { ... }
    fn indices(&self) -> Indices { ... }
    fn linearised_indices(
        &self,
        array_shape: &[u64],
    ) -> Result<LinearisedIndices, IndexerError> { ... }
    fn contiguous_indices(
        &self,
        array_shape: &[u64],
    ) -> Result<ContiguousIndices, IndexerError> { ... }
    fn contiguous_linearised_indices(
        &self,
        array_shape: &[u64],
    ) -> Result<ContiguousLinearisedIndices, IndexerError> { ... }
}

Trait for types that represent an array region (start and shape).

This trait enables ergonomic APIs that accept various region representations, including ArraySubset, arrays of ranges like [0..5, 0..10], and slices of ranges.

Required Methods

fn start(&self) -> Cow<'_, [u64]>

Returns the start indices of the subset.

fn shape(&self) -> Cow<'_, [u64]>

Returns the shape (size along each dimension) of the subset.

Provided Methods

fn num_elements(&self) -> u64

Returns the total number of elements.

fn num_elements_usize(&self) -> usize

Returns the number of elements as usize.

Panics

Panics if num_elements() is greater than usize::MAX.

fn end_exc(&self) -> ArrayIndices

Returns exclusive end indices.

fn end_inc(&self) -> Option<ArrayIndices>

Returns inclusive end indices, or None if empty.

fn to_ranges(&self) -> Vec<Range<u64>>

Converts to ranges.

fn contains(&self, indices: &[u64]) -> bool

Returns true if the region contains the given indices.

fn inbounds_shape(&self, array_shape: &[u64]) -> bool

Returns true if the region is within the bounds of an array with the given shape.

fn inbounds(&self, other: &dyn ArraySubsetTraits) -> bool

Returns true if the region is within another region.

fn overlap( &self, other: &dyn ArraySubsetTraits, ) -> Result<ArraySubset, ArraySubsetError>

Return the overlapping subset between this region and other.

Errors

Returns ArraySubsetError if the dimensionality of other does not match.

fn relative_to(&self, offset: &[u64]) -> Result<ArraySubset, ArraySubsetError>

Return the region relative to offset.

Creates an array subset starting at self.start() - offset.

Errors

Returns ArraySubset if the length of offset does not match the dimensionality, or if offset is greater than start in any dimension.

fn to_array_subset(&self) -> ArraySubset

Converts to an owned ArraySubset.

fn indices(&self) -> Indices

Returns an iterator over the indices of elements within the subset.

fn linearised_indices( &self, array_shape: &[u64], ) -> Result<LinearisedIndices, IndexerError>

Returns an iterator over the linearised indices of elements within the subset.

Errors

Returns IndexerError if the array_shape does not encapsulate this array subset.

fn contiguous_indices( &self, array_shape: &[u64], ) -> Result<ContiguousIndices, IndexerError>

Returns an iterator over the indices of contiguous elements within the subset.

Errors

Returns IndexerError if the array_shape does not encapsulate this array subset.

fn contiguous_linearised_indices( &self, array_shape: &[u64], ) -> Result<ContiguousLinearisedIndices, IndexerError>

Returns an iterator over the linearised indices of contiguous elements within the subset.

Errors

Returns IndexerError if the array_shape does not encapsulate this array subset.

Trait Implementations

impl PartialEq<&dyn ArraySubsetTraits> for ArraySubset

fn eq(&self, other: &&dyn ArraySubsetTraits) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<ArraySubset> for &dyn ArraySubsetTraits

fn eq(&self, other: &ArraySubset) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

Implementations on Foreign Types

impl ArraySubsetTraits for &[Range<u64>]

fn start(&self) -> Cow<'_, [u64]>

fn shape(&self) -> Cow<'_, [u64]>

impl ArraySubsetTraits for Vec<Range<u64>>

fn start(&self) -> Cow<'_, [u64]>

fn shape(&self) -> Cow<'_, [u64]>

impl<const N: usize> ArraySubsetTraits for [Range<u64>; N]

fn start(&self) -> Cow<'_, [u64]>

fn shape(&self) -> Cow<'_, [u64]>

Implementors

impl ArraySubsetTraits for ArraySubset