Struct zarrs::array_subset::iterators::Indices

pub struct Indices { /* private fields */ }

An iterator over the indices in an array subset.

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 corresponding to the lower right 2x2 region will produce [(2, 1), (2, 2), (3, 1), (3, 2)].

Implementations

impl Indices

pub fn new(subset: ArraySubset) -> Self

Create a new indices struct.

pub fn new_with_start_end( subset: ArraySubset, index_front: u64, index_back: u64 ) -> Self

Create a new indices struct spanning an explicit index range.

Panics

Panics if index_back < index_front

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) -> IndicesIterator<'_>

Create a new serial iterator.

Trait Implementations

impl<'a> IntoIterator for &'a Indices

type Item = Vec<u64>

The type of the elements being iterated over.

type IntoIter = IndicesIterator<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoParallelIterator for &'a Indices

type Item = Vec<u64>

The type of item that the parallel iterator will produce.

type Iter = ParIndicesIterator<'a>

The parallel iterator type that will be created.

fn into_par_iter(self) -> Self::Iter

Converts self into a parallel iterator.