Array2D.get<'T> Function (F#)

  • Article

Fetches an element from a 2D array. You can also use the syntax array.[index1,index2].

Namespace/Module Path: Microsoft.FSharp.Collections.Array2D

Assembly: FSharp.Core (in FSharp.Core.dll)

// Signature:
Array2D.get : 'T [,] -> int -> int -> 'T

// Usage:
Array2D.get array index1 index2

Parameters

  • array
    Type: 'T [,]

    The input array.

  • index1
    Type: int

    The index along the first dimension.

  • index2
    Type: int

    The index along the second dimension.

Exceptions

Exception

Condition

ArgumentException

Thrown when the indices are negative or exceed the bounds of the array.

Return Value

The value of the array at the given index.

Remarks

This function is named Get in compiled assemblies. If you are accessing the member from a language other than F#, or through reflection, use this name.

Platforms

Windows 7, Windows Vista SP2, Windows XP SP3, Windows XP x64 SP2, Windows Server 2008 R2, Windows Server 2008 SP2, Windows Server 2003 SP2

Version Information

F# Runtime

Supported in: 2.0, 4.0

Silverlight

Supported in: 3

See Also

Reference

Collections.Array2D Module (F#)

Microsoft.FSharp.Collections Namespace (F#)