Header menu logo FSharp.Core.Fluent

Array2DExtensions Module

Fluent extension operations on 2D arrays.

Type extensions

Type extension Description

this.base1 ()

Full Usage: this.base1 ()

Parameters:
    () : unit

Returns: int The base-index of the first dimension of the array.
Modifiers: inline

Fetches the base-index for the first dimension of the array.

Extended Type: [,]

() : unit
Returns: int

The base-index of the first dimension of the array.

this.base1

Full Usage: this.base1

Returns: int The base-index of the first dimension of the array.
Modifiers: inline

Fetches the base-index for the first dimension of the array.

Extended Type: [,]

Returns: int

The base-index of the first dimension of the array.

this.base2 ()

Full Usage: this.base2 ()

Parameters:
    () : unit

Returns: int The base-index of the second dimension of the array.
Modifiers: inline

Fetches the base-index for the second dimension of the array.

Extended Type: [,]

() : unit
Returns: int

The base-index of the second dimension of the array.

this.base2

Full Usage: this.base2

Returns: int The base-index of the second dimension of the array.
Modifiers: inline

Fetches the base-index for the second dimension of the array.

Extended Type: [,]

Returns: int

The base-index of the second dimension of the array.

this.copy ()

Full Usage: this.copy ()

Parameters:
    () : unit

Returns: 'T[,] A copy of the input array.
Modifiers: inline

Builds a new array whose elements are the same as the input array.

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

Extended Type: [,]

() : unit
Returns: 'T[,]

A copy of the input array.

this.iter action

Full Usage: this.iter action

Parameters:
    action : 'T -> unit - A function to apply to each element of the array.

Modifiers: inline

Applies the given function to each element of the array.

Extended Type: [,]

action : 'T -> unit

A function to apply to each element of the array.

this.iteri action

Full Usage: this.iteri action

Parameters:
    action : int -> int -> 'T -> unit - A function to apply to each element of the array with the indices available as an argument.

Modifiers: inline

Applies the given function to each element of the array. The integer indices passed to the function indicates the index of element.

Extended Type: [,]

action : int -> int -> 'T -> unit

A function to apply to each element of the array with the indices available as an argument.

this.length1 ()

Full Usage: this.length1 ()

Parameters:
    () : unit

Returns: int The length of the array in the first dimension.
Modifiers: inline

Returns the length of an array in the first dimension.

Extended Type: [,]

() : unit
Returns: int

The length of the array in the first dimension.

this.length1

Full Usage: this.length1

Returns: int The length of the array in the first dimension.
Modifiers: inline

Returns the length of an array in the first dimension.

Extended Type: [,]

Returns: int

The length of the array in the first dimension.

this.length2 ()

Full Usage: this.length2 ()

Parameters:
    () : unit

Returns: int The length of the array in the second dimension.
Modifiers: inline

Returns the length of an array in the second dimension.

Extended Type: [,]

() : unit
Returns: int

The length of the array in the second dimension.

this.length2

Full Usage: this.length2

Returns: int The length of the array in the second dimension.
Modifiers: inline

Returns the length of an array in the second dimension.

Extended Type: [,]

Returns: int

The length of the array in the second dimension.

this.map mapping

Full Usage: this.map mapping

Parameters:
    mapping : 'T -> 'U - A function that is applied to transform each item of the input array.

Returns: 'U[,] An array whose elements have been transformed by the given mapping.
Modifiers: inline
Type parameters: 'U

Builds a new array whose elements are the results of applying the given function to each of the elements of the array.

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

Extended Type: [,]

mapping : 'T -> 'U

A function that is applied to transform each item of the input array.

Returns: 'U[,]

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

this.mapi mapping

Full Usage: this.mapi mapping

Parameters:
    mapping : 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.

Returns: 'U[,] An array whose elements have been transformed by the given mapping.
Modifiers: inline
Type parameters: 'U

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.

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

Extended Type: [,]

mapping : 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.

Returns: 'U[,]

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

this.rebase ()

Full Usage: this.rebase ()

Parameters:
    () : unit

Returns: 'T[,] The zero-based output array.
Modifiers: inline

Builds a new array whose elements are the same as the input array but where a non-zero-based input array generates a corresponding zero-based output array.

Extended Type: [,]

() : unit
Returns: 'T[,]

The zero-based output array.

Type something to start searching.