Progeneric.Ptl.Iterators

Interface IBaseIter<TIterator>

Type Parameters:

TIterator - The type of iterator that implements this interface.

All Superinterfaces:

IDisposable, IEquatable<TIterator>

All Known Subinterfaces:

IBidIter<T,TIterator>, IFwdIter<T,TIterator>, IInpIter<T,TIterator>, IOutIter<T,TIterator>, IRanIter<T,TIterator>

All Known Implementing Classes:

BackInsertIter, ConstantIter, CountingIter, FilterIter, FIndex32.Iterator, FIndex32.ReverseIterator, FIndex32.UIterator, FIndex32.UReverseIterator, FIndex64.Iterator, FIndex64.ReverseIterator, FIndex64.UIterator, FIndex64.UReverseIterator, FMap32.Iterator, FMap32.ReverseIterator, FMap32.UIterator, FMap32.UReverseIterator, FMap64.Iterator, FMap64.ReverseIterator, FMap64.UIterator, FMap64.UReverseIterator, FrontInsertIter, FSet32.Iterator, FSet32.ReverseIterator, FSet32.UIterator, FSet32.UReverseIterator, FSet64.Iterator, FSet64.ReverseIterator, FSet64.UIterator, FSet64.UReverseIterator, FVector32.Iterator, FVector32.ReverseIterator, FVector32.UIterator, FVector32.UReverseIterator, FVector64.Iterator, FVector64.ReverseIterator, FVector64.UIterator, FVector64.UReverseIterator, InsertIter, LinkedList64.Iterator, LinkedList64.ReverseIterator, LinkedList64.UIterator, LinkedList64.UReverseIterator, Map32.Iterator, Map32.ReverseIterator, Map32.UIterator, Map32.UReverseIterator, Map64.Iterator, Map64.ReverseIterator, Map64.UIterator, Map64.UReverseIterator, Set32.Iterator, Set32.ReverseIterator, Set32.UIterator, Set32.UReverseIterator, Set64.Iterator, Set64.ReverseIterator, Set64.UIterator, Set64.UReverseIterator, TransformIter, Vector.Iterator, Vector.ReverseIterator, Vector.UIterator, Vector.UReverseIterator, Vector32.Iterator, Vector32.ReverseIterator, Vector32.UIterator, Vector32.UReverseIterator, Vector64.Iterator, Vector64.ReverseIterator, Vector64.UIterator, Vector64.UReverseIterator, ZipIter2, ZipIter3

public interface IBaseIter<TIterator>
extends IEquatable<TIterator>, IDisposable

Defines the base requirements for an iterator.

Method Summary

Methods

Modifier and Type	Method and Description
void	Advance(int offset) Adds an offset to an iterator.
void	Advance(long offset) Adds an offset to an iterator.
IteratorCategory	Category() Gets the iterator category.
TIterator	Copy() Creates and returns a copy of the current instance.
long	Distance(TIterator other) Determines the number of increments between this instance and a specified iterator.
void	Increment() Increments the iterator.
void	ResetBegin() Sets the iterator to its initial position, which is before the first element in the container.
void	ResetEnd() Sets the iterator to its final position, which is after the last element in the container.

Methods inherited from interface Progeneric.Ptl.Types.IEquatable

Equals

Methods inherited from interface Progeneric.Ptl.Iterators.IDisposable

Dispose

Method Detail

Category

IteratorCategory Category()

Gets the iterator category.

Returns:

The iterator category.

Copy

TIterator Copy()

Creates and returns a copy of the current instance.

Returns:

A copy of the current instance.

ResetBegin

void ResetBegin()

Sets the iterator to its initial position, which is before the first element in the container.

Remarks: For reverse iterators, the initial position is after the last element in the container.

ResetEnd

void ResetEnd()

Sets the iterator to its final position, which is after the last element in the container.

Remarks: For reverse iterators, the final position is before the first element in the container.

Increment

void Increment()

Increments the iterator.

Remarks: Past-the-end iterators are not incrementable.

Advance

void Advance(int offset)

Adds an offset to an iterator. It is equivalent to executing Increment (offset is positive) or Decrement (offset is negative) offset times.

Parameters:

offset - The number of positions the iterator is to be offset.

Advance

void Advance(long offset)

Adds an offset to an iterator. It is equivalent to executing Increment (offset is positive) or Decrement (offset is negative) offset times.

Parameters:

offset - The number of positions the iterator is to be offset.

Distance

long Distance(TIterator other)

Determines the number of increments between this instance and a specified iterator.

Parameters:

other - An input iterator addressing the position one past the final element in the range [this, other).

Returns:

The number of times that the current iterator must be incremented until it is equal to the specified iterator.