mir.ndslice.iterator

This is a submodule of mir.ndslice.

Iterator is a type with a pointer like behavior. An ndslice can be created on top of an iterator using sliced.

Iterators

Iterator NameUsed By
BytegroupIteratorbytegroup.
CachedIteratorcached, cachedGC.
ChopIteratorchopped
FieldIteratorslicedField, bitwise, ndiota, and others.
FlattenedIteratorflattened
IndexIteratorindexed
IotaIteratoriota
MapIteratormap
MemberIteratormember
NeighboursIteratorwithNeighboursSum
RetroIteratorretro
SliceIteratormap in composition with MapIterator for packed slices.
SlideIteratordiff, pairwise, and slide.
StairsIteratorstairs
StrideIteratorstride
SubSliceIteratorsubSlices
TripletIteratortriplets
ZipIteratorzip

Members

Structs

BytegroupIterator
struct BytegroupIterator(Iterator, size_t count, DestinationType)

BytegroupIterator is used by Bytegroup and bytegroup.

CachedIterator
struct CachedIterator(Iterator, CacheIterator, FlagIterator)
ChopIterator
struct ChopIterator(Iterator, Sliceable)

Iterates chunks in a sliceable using an iterator composed of indices stored consequently.

FieldIterator
struct FieldIterator(Field)

Creates an iterator on top of a field.

FlattenedIterator
struct FlattenedIterator(Iterator, size_t N, SliceKind kind)

Creates an iterator on top of all elements in a slice.

IndexIterator
struct IndexIterator(Iterator, Field)

Iterates a field using an iterator.

IotaIterator
struct IotaIterator(I)

Step counter.

MapIterator
struct MapIterator(Iterator, alias _fun)

MapIterator is used by map.

MemberIterator
struct MemberIterator(Iterator, string member)

MemberIterator is used by member.

NeighboursIterator
struct NeighboursIterator(Iterator, size_t N, alias _fun, bool around)

NeighboursIterator is used by map.

RetroIterator
struct RetroIterator(Iterator)

Reverse directions for an iterator.

SliceIterator
struct SliceIterator(Iterator, size_t N = 1, SliceKind kind = Contiguous)

Iterates on top of another iterator and returns a slice as a multidimensional window at the current position.

SlideIterator
struct SlideIterator(Iterator, size_t params, alias fun)

SlideIterator is used by diff and slide.

StairsIterator
struct StairsIterator(Iterator, string direction)

StairsIterator is used by stairs.

StrideIterator
struct StrideIterator(Iterator)

Iterates an iterator with a fixed strides.

StrideIterator
struct StrideIterator(Iterator, ptrdiff_t factor)

Iterates an iterator with a fixed strides.

SubSliceIterator
struct SubSliceIterator(Iterator, Sliceable)

Iterates chunks in a sliceable using an iterator composed of indices.

Triplet
struct Triplet(Iterator, SliceKind kind = Contiguous)

Element type of TripletIterator.

TripletIterator
struct TripletIterator(Iterator, SliceKind kind = Contiguous)

Iterates triplets position in a slice.

VmapIterator
struct VmapIterator(Iterator, Fun)

VmapIterator is used by map.

ZipIterator
struct ZipIterator(Iterators...)

Iterates multiple iterators in lockstep.

Meta

Authors

Ilia Ki