Struct zarrs::array_subset::iterators::ContiguousIndices

pub struct ContiguousIndices { /* private fields */ }

Iterates over contiguous element indices in an array subset.

The iterator item is a tuple: (indices, # contiguous elements).

Iterates over the last dimension fastest (i.e. C-contiguous order). For example, consider a 4x3 array with element indices

(0, 0)  (0, 1)  (0, 2)
(1, 0)  (1, 1)  (1, 2)
(2, 0)  (2, 1)  (2, 2)
(3, 0)  (3, 1)  (3, 2)

An iterator with an array subset covering the entire array will produce

[((0, 0), 9)]

An iterator with an array subset corresponding to the lower right 2x2 region will produce

[((2, 1), 2), ((3, 1), 2)]

Implementations

impl ContiguousIndices

pub fn new( subset: &ArraySubset, array_shape: &[u64] ) -> Result<Self, IncompatibleArraySubsetAndShapeError>

Create a new contiguous indices iterator.

Errors

Returns IncompatibleArraySubsetAndShapeError if array_shape does not encapsulate subset.

pub unsafe fn new_unchecked(subset: &ArraySubset, array_shape: &[u64]) -> Self

Create a new contiguous indices iterator.

Safety

array_shape must encapsulate subset.

pub fn len(&self) -> usize

Return the number of starting indices (i.e. the length of the iterator).

pub fn is_empty(&self) -> bool

Returns true if the number of starting indices is zero.

pub fn contiguous_elements(&self) -> u64

Return the number of contiguous elements (fixed on each iteration).

pub fn contiguous_elements_usize(&self) -> usize

Return the number of contiguous elements (fixed on each iteration).

Panics

Panics if the number of contiguous elements exceeds usize::MAX.

pub fn iter(&self) -> ContiguousIndicesIterator<'_>

Create a new serial iterator.

Trait Implementations

impl<'a> IntoIterator for &'a ContiguousIndices

type Item = (Vec<u64>, u64)

The type of the elements being iterated over.

type IntoIter = ContiguousIndicesIterator<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.