Struct zarrs::array_subset::iterators::ContiguousLinearisedIndices

pub struct ContiguousLinearisedIndices { /* private fields */ }

Iterates over contiguous linearised element indices in an array subset.

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

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

0   1   2
3   4   5
6   7   8
9  10  11

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

[(0, 9)]

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

[(7, 2), (10, 2)]

Implementations

impl ContiguousLinearisedIndices

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

Return a new contiguous linearised indices iterator.

Errors

Returns IncompatibleArraySubsetAndShapeError if array_shape does not encapsulate subset.

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

Return a new contiguous linearised 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) -> ContiguousLinearisedIndicesIterator<'_>

Create a new serial iterator.

Trait Implementations

impl<'a> IntoIterator for &'a ContiguousLinearisedIndices

type Item = (u64, u64)

The type of the elements being iterated over.

type IntoIter = ContiguousLinearisedIndicesIterator<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.