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

  • Article

Creates a based array given the dimensions and a generator function to compute the elements.

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

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

// Signature:
Array2D.initBased : int -> int -> int -> int -> (int -> int -> 'T) -> 'T [,]

// Usage:
Array2D.initBased base1 base2 length1 length2 initializer

Parameters

  • base1
    Type: int

    The base for the first dimension of the array.

  • base2
    Type: int

    The base for the second dimension of the array.

  • length1
    Type: int

    The length of the first dimension of the array.

  • length2
    Type: int

    The length of the second dimension of the array.

  • initializer
    Type: int -> int -> 'T

    A function to produce elements of the array given the two indices.

Exceptions

Exception

Condition

ArgumentException

Thrown when base1, base2, length1, or length2 is negative.

Return Value

The created array.

Remarks

This function is named [InitializeBased] in compiled assemblies. If you are accessing the function 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

Not supported

See Also

Reference

Collections.Array2D Module (F#)

Microsoft.FSharp.Collections Namespace (F#)