Struct zarrs::array_subset::iterators::LinearisedIndices

pub struct LinearisedIndices { /* private fields */ }

An iterator over the linearised indices in an array subset.

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 corresponding to the lower right 2x2 region will produce [7, 8, 10, 11].

Implementations

impl LinearisedIndices

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

Create a new linearised indices iterator.

Errors

Returns IncompatibleArraySubsetAndShapeError if array_shape does not encapsulate subset.

pub unsafe fn new_unchecked( subset: ArraySubset, array_shape: ArrayShape ) -> Self

Create a new linearised indices iterator.

Safety

array_shape must encapsulate subset.

pub fn len(&self) -> usize

Return the number of indices.

pub fn is_empty(&self) -> bool

Returns true if the number of indices is zero.

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

Create a new serial iterator.

Trait Implementations

impl<'a> IntoIterator for &'a LinearisedIndices

type Item = u64

The type of the elements being iterated over.

type IntoIter = LinearisedIndicesIterator<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.