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

  • Article

Reads a range of elements from the first array and writes them into the second.

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

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

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

// Usage:
Array2D.blit source sourceIndex1 sourceIndex2 target targetIndex1 targetIndex2 length1 length2

Parameters

  • source
    Type: 'T[,]

    The source array.

  • sourceIndex1
    Type: int

    The first-dimension index to begin copying from in the source array.

  • sourceIndex2
    Type: int

    The second-dimension index to begin copying from in the source array.

  • target
    Type: 'T[,]

    The target array.

  • targetIndex1
    Type: int

    The first-dimension index to begin copying into in the target array.

  • targetIndex2
    Type: int

    The second-dimension index to begin copying into in the target array.

  • length1
    Type: int

    The number of elements to copy across the first dimension of the arrays.

  • length2
    Type: int

    The number of elements to copy across the second dimension of the arrays.

Exceptions

Exception

Condition

ArgumentException

Thrown when any of the indices are negative or if either of the counts are larger than the dimensions of the array allow.

Remarks

This function is named CopyTo in compiled assemblies. If you are accessing the function 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#)