IIndexIterator Interface

ILNumerics Ultimate VS Documentation

ILNumerics - Technical Application Development

Interface for objects usable as index iterators in subarray expressions.

[ILNumerics Core Module]

Namespace: ILNumerics
Assembly: ILNumerics.Core (in ILNumerics.Core.dll) Version: 5.5.0.0 (5.5.7503.3146)

Syntax

public interface IIndexIterator : IEnumerable<long>, 
	IEnumerable, IEnumerator<long>, IDisposable, IEnumerator

Public Interface IIndexIterator
	Inherits IEnumerable(Of Long), IEnumerable, IEnumerator(Of Long), 
	IDisposable, IEnumerator

Dim instance As IIndexIterator

The IIndexIterator type exposes the following members.

Methods

	Name	Description
	GetLastDimensionIndex	Gets the index of the last element of the dimension this iterator is working along. This must be provided by such iterators, capable of storing negative indices only. [ILNumerics Core Module]
	GetLength	Gives the number of elements addressed by this object. [ILNumerics Core Module]
	GetMaximum	Gives the maximum index addressed by this iterator, if such value exists. [ILNumerics Core Module]
	GetMinimum	Gives the minimum index addressed by this iterator, if such value exists. [ILNumerics Core Module]
	GetStepSize	Gives the step size of the range, in case that this iterator object represents a simple (un-/stepped) range. Otherwise: null. [ILNumerics Core Module]

Top

Remarks

Index iterators provide a safe and (reasonable) fast way of iterating the indices addressed by subarray expressions for each dimension. All checks are performed at the creation time of the iterator. This includes the checks for all indices being inside the valid range of an array.

[ILNumerics Core Module]

Reference

ILNumerics Namespace