IndexRange function

  • Article

Warning

This documentation refers to the Classic QDK, which has been replaced by the Modern QDK.

Please see https://aka.ms/qdk.api for the API documentation for the Modern QDK.

Namespace: Microsoft.Quantum.Arrays

Package: Microsoft.Quantum.QSharp.Foundation

Given an array, returns a range over the indices of that array, suitable for use in a for loop.

function IndexRange<'TElement> (array : 'TElement[]) : Range

Input

array : 'TElement[]

An array for which a range of indices should be returned.

Output : Range

A range over all indices of the array.

Type Parameters

'TElement

The type of elements of the array.

Example

The following for loops are equivalent:

for (idx in IndexRange(array)) { ... }
for (idx in 0 .. Length(array) - 1) { ... }