Share via

Array2D.mapi<'T,'U> Function (F#)

  • Article

Builds a new array whose elements are the results of applying the given function to each of the elements of the array. The integer indices passed to the function indicates the element being transformed.

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

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

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

// Usage:
Array2D.mapi mapping array

Parameters

  • mapping
    Type: int -> int -> 'T -> 'U

    A function that is applied to transform each element of the array. The two integers provide the index of the element.

  • array
    Type: 'T[,]

    The input array.

Return Value

An array whose elements have been transformed by the given mapping.

Remarks

For non-zero-based arrays the basing on an input array will be propagated to the output array.

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

Platforms

Windows 8, Windows 7, Windows Server 2012, Windows Server 2008 R2

Version Information

F# Core Library Versions

Supported in: 2.0, 4.0, Portable

See Also

Reference

Collections.Array2D Module (F#)

Microsoft.FSharp.Collections Namespace (F#)