Struct zarrs::array_subset::iterators::Chunks

pub struct Chunks { /* private fields */ }

Iterates over the regular sized chunks overlapping this array subset.

Iterates over the last dimension fastest (i.e. C-contiguous order). All chunks have the same size, and may extend over the bounds of the array subset since the start of the first chunk is aligned to the chunk size.

The iterator item is a (ArrayIndices, ArraySubset) tuple corresponding to the chunk indices and array subset.

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 2x2 chunks iterator with an array subset covering the entire array will produce

[
    ((0, 0), ArraySubset{offset: (0,0), shape: (2, 2)}),
    ((0, 1), ArraySubset{offset: (0,2), shape: (2, 2)}),
    ((1, 0), ArraySubset{offset: (2,0), shape: (2, 2)}),
    ((1, 1), ArraySubset{offset: (2,2), shape: (2, 2)}),
]

Implementations

impl Chunks

pub fn new( subset: &ArraySubset, chunk_shape: &[NonZeroU64], ) -> Result<Self, IncompatibleDimensionalityError>

Create a new chunks iterator.

Errors

Returns IncompatibleDimensionalityError if chunk_shape does not match the dimensionality of subset.

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

Create a new chunks iterator.

Safety

The dimensionality of chunk_shape must match the dimensionality of subset.

pub fn len(&self) -> usize

Return the number of chunks.

pub fn is_empty(&self) -> bool

Returns true if the number of chunks is zero.

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

Create a new serial iterator.

Trait Implementations

impl<'a> IntoIterator for &'a Chunks

type Item = (Vec<u64>, ArraySubset)

The type of the elements being iterated over.

type IntoIter = ChunksIterator<'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 Chunks

type Item = (Vec<u64>, ArraySubset)

The type of item that the parallel iterator will produce.

type Iter = ParChunksIterator<'a>

The parallel iterator type that will be created.

fn into_par_iter(self) -> Self::Iter

Converts self into a parallel iterator.