FSharp.Core

Array Module

Namespace: FSharp.Collections

Assembly: FSharp.Core.dll

Contains operations for working with arrays.

Nested modules

Modules Description

Parallel

Provides parallel operations on arrays

Functions and values

Function or value Description

Array.allPairs array1 array2

Full Usage: Array.allPairs array1 array2

Parameters:
    array1 : 'T1[] - The first input array.
    array2 : 'T2[] - The second input array.

Returns: ('T1 * 'T2)[] The resulting array of pairs.

Returns a new array that contains all pairings of elements from the first and second arrays.

array1 : 'T1[]

The first input array.

array2 : 'T2[]

The second input array.

Returns: ('T1 * 'T2)[]

The resulting array of pairs.

ArgumentNullException Thrown when either of the input arrays is null.

Array.append array1 array2

Full Usage: Array.append array1 array2

Parameters:
    array1 : 'T[] - The first input array.
    array2 : 'T[] - The second input array.

Returns: 'T[] The resulting array.

Builds a new array that contains the elements of the first array followed by the elements of the second array.

array1 : 'T[]

The first input array.

array2 : 'T[]

The second input array.

Returns: 'T[]

The resulting array.

ArgumentNullException Thrown when either of the input arrays is null.

Array.average array

Full Usage: Array.average array

Parameters:
    array : ^T[] - The input array.

Returns: ^T The average of the elements in the array.

Returns the average of the elements in the array.

array : ^T[]

The input array.

Returns: ^T

The average of the elements in the array.

ArgumentException Thrown when array is empty.
ArgumentNullException Thrown when the input array is null.

Array.averageBy projection array

Full Usage: Array.averageBy projection array

Parameters:
    projection : 'T -> ^U - The function to transform the array elements before averaging.
    array : 'T[] - The input array.

Returns: ^U The computed average.

Returns the average of the elements generated by applying the function to each element of the array.

projection : 'T -> ^U

The function to transform the array elements before averaging.

array : 'T[]

The input array.

Returns: ^U

The computed average.

ArgumentException Thrown when array is empty.
ArgumentNullException Thrown when the input array is null.

Array.blit source sourceIndex target targetIndex count

Full Usage: Array.blit source sourceIndex target targetIndex count

Parameters:
    source : 'T[] - The source array.
    sourceIndex : int - The starting index of the source array.
    target : 'T[] - The target array.
    targetIndex : int - The starting index of the target array.
    count : int - The number of elements to copy.

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

source : 'T[]

The source array.

sourceIndex : int

The starting index of the source array.

target : 'T[]

The target array.

targetIndex : int

The starting index of the target array.

count : int

The number of elements to copy.

ArgumentNullException Thrown when either of the input arrays is null.
ArgumentException Thrown when any of sourceIndex, targetIndex or count are negative, or when there aren't enough elements in source or target.

Array.choose chooser array

Full Usage: Array.choose chooser array

Parameters:
    chooser : 'T -> 'U option - The function to generate options from the elements.
    array : 'T[] - The input array.

Returns: 'U[] The array of results.

Applies the given function to each element of the array. Returns the array comprised of the results "x" for each element where the function returns Some(x)

chooser : 'T -> 'U option

The function to generate options from the elements.

array : 'T[]

The input array.

Returns: 'U[]

The array of results.

ArgumentNullException Thrown when the input array is null.

Array.chunkBySize chunkSize array

Full Usage: Array.chunkBySize chunkSize array

Parameters:
    chunkSize : int - The maximum size of each chunk.
    array : 'T[] - The input array.

Returns: 'T[][] The array divided into chunks.

Divides the input array into chunks of size at most chunkSize.

chunkSize : int

The maximum size of each chunk.

array : 'T[]

The input array.

Returns: 'T[][]

The array divided into chunks.

ArgumentNullException Thrown when the input array is null.
ArgumentException Thrown when chunkSize is not positive.

Array.collect mapping array

Full Usage: Array.collect mapping array

Parameters:
    mapping : 'T -> 'U[] - The function to create sub-arrays from the input array elements.
    array : 'T[] - The input array.

Returns: 'U[] The concatenation of the sub-arrays.

For each element of the array, applies the given function. Concatenates all the results and return the combined array.

mapping : 'T -> 'U[]

The function to create sub-arrays from the input array elements.

array : 'T[]

The input array.

Returns: 'U[]

The concatenation of the sub-arrays.

ArgumentNullException Thrown when the input array is null.

Array.compareWith comparer array1 array2

Full Usage: Array.compareWith comparer array1 array2

Parameters:
    comparer : 'T -> 'T -> int - A function that takes an element from each array and returns an int. If it evaluates to a non-zero value iteration is stopped and that value is returned.
    array1 : 'T[] - The first input array.
    array2 : 'T[] - The second input array.

Returns: int Returns the first non-zero result from the comparison function. If the first array has a larger element, the return value is always positive. If the second array has a larger element, the return value is always negative. When the elements are equal in the two arrays, 1 is returned if the first array is longer, 0 is returned if they are equal in length, and -1 is returned when the second array is longer.

Compares two arrays using the given comparison function, element by element.

comparer : 'T -> 'T -> int

A function that takes an element from each array and returns an int. If it evaluates to a non-zero value iteration is stopped and that value is returned.

array1 : 'T[]

The first input array.

array2 : 'T[]

The second input array.

Returns: int

Returns the first non-zero result from the comparison function. If the first array has a larger element, the return value is always positive. If the second array has a larger element, the return value is always negative. When the elements are equal in the two arrays, 1 is returned if the first array is longer, 0 is returned if they are equal in length, and -1 is returned when the second array is longer.

ArgumentNullException Thrown when either of the input arrays is null.

Array.concat arrays

Full Usage: Array.concat arrays

Parameters:
    arrays : seq<'T[]> - The input sequence of arrays.

Returns: 'T[] The concatenation of the sequence of input arrays.

Builds a new array that contains the elements of each of the given sequence of arrays.

arrays : seq<'T[]>

The input sequence of arrays.

Returns: 'T[]

The concatenation of the sequence of input arrays.

ArgumentNullException Thrown when the input sequence is null.

Array.contains value array

Full Usage: Array.contains value array

Parameters:
    value : 'T - The value to locate in the input array.
    array : 'T[] - The input array.

Returns: bool True if the input array contains the specified element; false otherwise.

Tests if the array contains the specified element.

value : 'T

The value to locate in the input array.

array : 'T[]

The input array.

Returns: bool

True if the input array contains the specified element; false otherwise.

ArgumentNullException Thrown when the input array is null.

Array.copy array

Full Usage: Array.copy array

Parameters:
    array : 'T[] - The input array.

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

Builds a new array that contains the elements of the given array.

array : 'T[]

The input array.

Returns: 'T[]

A copy of the input array.

ArgumentNullException Thrown when the input array is null.

Array.countBy projection array

Full Usage: Array.countBy projection array

Parameters:
    projection : 'T -> 'Key - A function transforming each item of the input array into a key to be compared against the others.
    array : 'T[] - The input array.

Returns: ('Key * int)[] The result array.

Applies a key-generating function to each element of an array and returns an array yielding unique keys and their number of occurrences in the original array.

projection : 'T -> 'Key

A function transforming each item of the input array into a key to be compared against the others.

array : 'T[]

The input array.

Returns: ('Key * int)[]

The result array.

ArgumentNullException Thrown when the input array is null.

Array.create count value

Full Usage: Array.create count value

Parameters:
    count : int - The length of the array to create.
    value : 'T - The value for the elements.

Returns: 'T[] The created array.

Creates an array whose elements are all initially the given value.

count : int

The length of the array to create.

value : 'T

The value for the elements.

Returns: 'T[]

The created array.

ArgumentException Thrown when count is negative.

Array.distinct array

Full Usage: Array.distinct array

Parameters:
    array : 'T[] - The input array.

Returns: 'T[] The result array.

Returns an array that contains no duplicate entries according to generic hash and equality comparisons on the entries. If an element occurs multiple times in the array then the later occurrences are discarded.

array : 'T[]

The input array.

Returns: 'T[]

The result array.

ArgumentNullException Thrown when the input array is null.

Array.distinctBy projection array

Full Usage: Array.distinctBy projection array

Parameters:
    projection : 'T -> 'Key - A function transforming the array items into comparable keys.
    array : 'T[] - The input array.

Returns: 'T[] The result array.

Returns an array that contains no duplicate entries according to the generic hash and equality comparisons on the keys returned by the given key-generating function. If an element occurs multiple times in the array then the later occurrences are discarded.

projection : 'T -> 'Key

A function transforming the array items into comparable keys.

array : 'T[]

The input array.

Returns: 'T[]

The result array.

ArgumentNullException Thrown when the input array is null.

Array.empty

Full Usage: Array.empty

Returns: 'T[] The empty array.

Returns an empty array of the given type.

Returns: 'T[]

The empty array.

Array.exactlyOne array

Full Usage: Array.exactlyOne array

Parameters:
    array : 'T[] - The input array.

Returns: 'T The only element of the array.

Returns the only element of the array.

array : 'T[]

The input array.

Returns: 'T

The only element of the array.

ArgumentNullException Thrown when the input array is null.
ArgumentException Thrown when the input does not have precisely one element.

Array.except itemsToExclude array

Full Usage: Array.except itemsToExclude array

Parameters:
    itemsToExclude : seq<'T> - A sequence whose elements that also occur in the input array will cause those elements to be removed from the result.
    array : 'T[] - An array whose elements that are not also in itemsToExclude will be returned.

Returns: 'T[] An array that contains the distinct elements of array that do not appear in itemsToExclude.

Returns a new list with the distinct elements of the input array which do not appear in the itemsToExclude sequence, using generic hash and equality comparisons to compare values.

itemsToExclude : seq<'T>

A sequence whose elements that also occur in the input array will cause those elements to be removed from the result.

array : 'T[]

An array whose elements that are not also in itemsToExclude will be returned.

Returns: 'T[]

An array that contains the distinct elements of array that do not appear in itemsToExclude.

ArgumentNullException Thrown when either itemsToExclude or array is null.

Array.exists predicate array

Full Usage: Array.exists predicate array

Parameters:
    predicate : 'T -> bool - The function to test the input elements.
    array : 'T[] - The input array.

Returns: bool True if any result from predicate is true.

Tests if any element of the array satisfies the given predicate.

The predicate is applied to the elements of the input array. If any application returns true then the overall result is true and no further elements are tested. Otherwise, false is returned.

predicate : 'T -> bool

The function to test the input elements.

array : 'T[]

The input array.

Returns: bool

True if any result from predicate is true.

ArgumentNullException Thrown when the input array is null.

Array.exists2 predicate array1 array2

Full Usage: Array.exists2 predicate array1 array2

Parameters:
    predicate : 'T1 -> 'T2 -> bool - The function to test the input elements.
    array1 : 'T1[] - The first input array.
    array2 : 'T2[] - The second input array.

Returns: bool True if any result from predicate is true.

Tests if any pair of corresponding elements of the arrays satisfies the given predicate.

The predicate is applied to matching elements in the two collections up to the lesser of the two lengths of the collections. If any application returns true then the overall result is true and no further elements are tested. Otherwise, if one collections is longer than the other then the ArgumentException exception is raised. Otherwise, false is returned.

predicate : 'T1 -> 'T2 -> bool

The function to test the input elements.

array1 : 'T1[]

The first input array.

array2 : 'T2[]

The second input array.

Returns: bool

True if any result from predicate is true.

ArgumentNullException Thrown when either of the input arrays is null.
ArgumentException Thrown when the input arrays differ in length.

Array.fill target targetIndex count value

Full Usage: Array.fill target targetIndex count value

Parameters:
    target : 'T[] - The target array.
    targetIndex : int - The index of the first element to set.
    count : int - The number of elements to set.
    value : 'T - The value to set.

Fills a range of elements of the array with the given value.

target : 'T[]

The target array.

targetIndex : int

The index of the first element to set.

count : int

The number of elements to set.

value : 'T

The value to set.

ArgumentNullException Thrown when the input array is null.
ArgumentException Thrown when either targetIndex or count is negative.

Array.filter predicate array

Full Usage: Array.filter predicate array

Parameters:
    predicate : 'T -> bool - The function to test the input elements.
    array : 'T[] - The input array.

Returns: 'T[] An array containing the elements for which the given predicate returns true.

Returns a new collection containing only the elements of the collection for which the given predicate returns "true".

predicate : 'T -> bool

The function to test the input elements.

array : 'T[]

The input array.

Returns: 'T[]

An array containing the elements for which the given predicate returns true.

ArgumentNullException Thrown when the input array is null.

Array.find predicate array

Full Usage: Array.find predicate array

Parameters:
    predicate : 'T -> bool - The function to test the input elements.
    array : 'T[] - The input array.

Returns: 'T The first element for which predicate returns true.

Returns the first element for which the given function returns 'true'. Raise KeyNotFoundException if no such element exists.

predicate : 'T -> bool

The function to test the input elements.

array : 'T[]

The input array.

Returns: 'T

The first element for which predicate returns true.

ArgumentNullException Thrown when the input array is null.
KeyNotFoundException Thrown if predicate never returns true.

Array.findBack predicate array

Full Usage: Array.findBack predicate array

Parameters:
    predicate : 'T -> bool - The function to test the input elements.
    array : 'T[] - The input array.

Returns: 'T The last element for which predicate returns true.

Returns the last element for which the given function returns 'true'. Raise KeyNotFoundException if no such element exists.

predicate : 'T -> bool

The function to test the input elements.

array : 'T[]

The input array.

Returns: 'T

The last element for which predicate returns true.

KeyNotFoundException Thrown if predicate never returns true.
ArgumentNullException Thrown when the input array is null.

Array.findIndex predicate array

Full Usage: Array.findIndex predicate array

Parameters:
    predicate : 'T -> bool - The function to test the input elements.
    array : 'T[] - The input array.

Returns: int The index of the first element in the array that satisfies the given predicate.

Returns the index of the first element in the array that satisfies the given predicate. Raise KeyNotFoundException if none of the elements satisfy the predicate.

predicate : 'T -> bool

The function to test the input elements.

array : 'T[]

The input array.

Returns: int

The index of the first element in the array that satisfies the given predicate.

KeyNotFoundException Thrown if predicate never returns true.
ArgumentNullException Thrown when the input array is null.

Array.findIndexBack predicate array

Full Usage: Array.findIndexBack predicate array

Parameters:
    predicate : 'T -> bool - The function to test the input elements.
    array : 'T[] - The input array.

Returns: int The index of the last element in the array that satisfies the given predicate.

Returns the index of the last element in the array that satisfies the given predicate. Raise KeyNotFoundException if none of the elements satisfy the predicate.

predicate : 'T -> bool

The function to test the input elements.

array : 'T[]

The input array.

Returns: int

The index of the last element in the array that satisfies the given predicate.

KeyNotFoundException Thrown if predicate never returns true.
ArgumentNullException Thrown when the input array is null.

Array.fold folder state array

Full Usage: Array.fold folder state array

Parameters:
    folder : 'State -> 'T -> 'State - The function to update the state given the input elements.
    state : 'State - The initial state.
    array : 'T[] - The input array.

Returns: 'State The final state.

Applies a function to each element of the collection, threading an accumulator argument through the computation. If the input function is f and the elements are i0...iN then computes f (... (f s i0)...) iN

folder : 'State -> 'T -> 'State

The function to update the state given the input elements.

state : 'State

The initial state.

array : 'T[]

The input array.

Returns: 'State

The final state.

ArgumentNullException Thrown when the input array is null.

Array.fold2 folder state array1 array2

Full Usage: Array.fold2 folder state array1 array2

Parameters:
    folder : 'State -> 'T1 -> 'T2 -> 'State - The function to update the state given the input elements.
    state : 'State - The initial state.
    array1 : 'T1[] - The first input array.
    array2 : 'T2[] - The second input array.

Returns: 'State The final state.

Applies a function to pairs of elements drawn from the two collections, left-to-right, threading an accumulator argument through the computation. The two input arrays must have the same lengths, otherwise an ArgumentException is raised.

folder : 'State -> 'T1 -> 'T2 -> 'State

The function to update the state given the input elements.

state : 'State

The initial state.

array1 : 'T1[]

The first input array.

array2 : 'T2[]

The second input array.

Returns: 'State

The final state.

ArgumentNullException Thrown when either of the input arrays is null.
ArgumentException Thrown when the input arrays differ in length.

Array.foldBack folder array state

Full Usage: Array.foldBack folder array state

Parameters:
    folder : 'T -> 'State -> 'State - The function to update the state given the input elements.
    array : 'T[] - The input array.
    state : 'State - The initial state.

Returns: 'State The state object after the folding function is applied to each element of the array.

Applies a function to each element of the array, starting from the end, threading an accumulator argument through the computation. If the input function is f and the elements are i0...iN then computes f i0 (...(f iN s))

folder : 'T -> 'State -> 'State

The function to update the state given the input elements.

array : 'T[]

The input array.

state : 'State

The initial state.

Returns: 'State

The state object after the folding function is applied to each element of the array.

ArgumentNullException Thrown when the input array is null.

Array.foldBack2 folder array1 array2 state

Full Usage: Array.foldBack2 folder array1 array2 state

Parameters:
    folder : 'T1 -> 'T2 -> 'State -> 'State - The function to update the state given the input elements.
    array1 : 'T1[] - The first input array.
    array2 : 'T2[] - The second input array.
    state : 'State - The initial state.

Returns: 'State The final state.

Apply a function to pairs of elements drawn from the two collections, right-to-left, threading an accumulator argument through the computation. The two input arrays must have the same lengths, otherwise an ArgumentException is raised.

folder : 'T1 -> 'T2 -> 'State -> 'State

The function to update the state given the input elements.

array1 : 'T1[]

The first input array.

array2 : 'T2[]

The second input array.

state : 'State

The initial state.

Returns: 'State

The final state.

ArgumentNullException Thrown when either of the input arrays is null.
ArgumentException Thrown when the input arrays differ in length.

Array.forall predicate array

Full Usage: Array.forall predicate array

Parameters:
    predicate : 'T -> bool - The function to test the input elements.
    array : 'T[] - The input array.

Returns: bool True if all of the array elements satisfy the predicate.

Tests if all elements of the array satisfy the given predicate.

The predicate is applied to the elements of the input collection. If any application returns false then the overall result is false and no further elements are tested. Otherwise, true is returned.

predicate : 'T -> bool

The function to test the input elements.

array : 'T[]

The input array.

Returns: bool

True if all of the array elements satisfy the predicate.

ArgumentNullException Thrown when the input array is null.

Array.forall2 predicate array1 array2

Full Usage: Array.forall2 predicate array1 array2

Parameters:
    predicate : 'T1 -> 'T2 -> bool - The function to test the input elements.
    array1 : 'T1[] - The first input array.
    array2 : 'T2[] - The second input array.

Returns: bool True if all of the array elements satisfy the predicate.

Tests if all corresponding elements of the array satisfy the given predicate pairwise.

The predicate is applied to matching elements in the two collections up to the lesser of the two lengths of the collections. If any application returns false then the overall result is false and no further elements are tested. Otherwise, if one collection is longer than the other then the ArgumentException exception is raised. Otherwise, true is returned.

predicate : 'T1 -> 'T2 -> bool

The function to test the input elements.

array1 : 'T1[]

The first input array.

array2 : 'T2[]

The second input array.

Returns: bool

True if all of the array elements satisfy the predicate.

ArgumentNullException Thrown when either of the input arrays is null.
ArgumentException Thrown when the input arrays differ in length.

Array.get array index

Full Usage: Array.get array index

Parameters:
    array : 'T[] - The input array.
    index : int - The input index.

Returns: 'T The value of the array at the given index.

Gets an element from an array.

array : 'T[]

The input array.

index : int

The input index.

Returns: 'T

The value of the array at the given index.

NullReferenceException Thrown when the input array is null.
IndexOutOfRangeException Thrown when the index is negative or the input array does not contain enough elements.

Array.groupBy projection array

Full Usage: Array.groupBy projection array

Parameters:
    projection : 'T -> 'Key - A function that transforms an element of the array into a comparable key.
    array : 'T[] - The input array.

Returns: ('Key * 'T[])[] The result array.

Applies a key-generating function to each element of an array and yields an array of unique keys. Each unique key contains an array of all elements that match to this key.

projection : 'T -> 'Key

A function that transforms an element of the array into a comparable key.

array : 'T[]

The input array.

Returns: ('Key * 'T[])[]

The result array.

ArgumentNullException Thrown when the input array is null.

Array.head array

Full Usage: Array.head array

Parameters:
    array : 'T[] - The input array.

Returns: 'T The first element of the array.

Returns the first element of the array.

array : 'T[]

The input array.

Returns: 'T

The first element of the array.

ArgumentNullException Thrown when the input array is null.
ArgumentException Thrown when the input array is empty.

Array.indexed array

Full Usage: Array.indexed array

Parameters:
    array : 'T[] - The input array.

Returns: (int * 'T)[] The array of indexed elements.

Builds a new array whose elements are the corresponding elements of the input array paired with the integer index (from 0) of each element.

array : 'T[]

The input array.

Returns: (int * 'T)[]

The array of indexed elements.

ArgumentNullException Thrown when the input array is null.

Array.init count initializer

Full Usage: Array.init count initializer

Parameters:
    count : int - The number of elements to initialize.
    initializer : int -> 'T - The function to generate the initial values for each index.

Returns: 'T[] The created array.

Creates an array given the dimension and a generator function to compute the elements.

count : int

The number of elements to initialize.

initializer : int -> 'T

The function to generate the initial values for each index.

Returns: 'T[]

The created array.

ArgumentException Thrown when count is negative.

Array.isEmpty array

Full Usage: Array.isEmpty array

Parameters:
    array : 'T[] - The input array.

Returns: bool True if the array is empty.

Returns true if the given array is empty, otherwise false.

array : 'T[]

The input array.

Returns: bool

True if the array is empty.

ArgumentNullException Thrown when the input array is null.

Array.item index array

Full Usage: Array.item index array

Parameters:
    index : int - The input index.
    array : 'T[] - The input array.

Returns: 'T The value of the array at the given index.

Gets an element from an array.

index : int

The input index.

array : 'T[]

The input array.

Returns: 'T

The value of the array at the given index.

NullReferenceException Thrown when the input array is null.
IndexOutOfRangeException Thrown when the index is negative or the input array does not contain enough elements.

Array.iter action array

Full Usage: Array.iter action array

Parameters:
    action : 'T -> unit - The function to apply.
    array : 'T[] - The input array.

Applies the given function to each element of the array.

action : 'T -> unit

The function to apply.

array : 'T[]

The input array.

ArgumentNullException Thrown when the input array is null.

Array.iter2 action array1 array2

Full Usage: Array.iter2 action array1 array2

Parameters:
    action : 'T1 -> 'T2 -> unit - The function to apply.
    array1 : 'T1[] - The first input array.
    array2 : 'T2[] - The second input array.

Applies the given function to pair of elements drawn from matching indices in two arrays. The two arrays must have the same lengths, otherwise an ArgumentException is raised.

action : 'T1 -> 'T2 -> unit

The function to apply.

array1 : 'T1[]

The first input array.

array2 : 'T2[]

The second input array.

ArgumentNullException Thrown when either of the input arrays is null.
ArgumentException Thrown when the input arrays differ in length.

Array.iteri action array

Full Usage: Array.iteri action array

Parameters:
    action : int -> 'T -> unit - The function to apply to each index and element.
    array : 'T[] - The input array.

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

action : int -> 'T -> unit

The function to apply to each index and element.

array : 'T[]

The input array.

ArgumentNullException Thrown when the input array is null.

Array.iteri2 action array1 array2

Full Usage: Array.iteri2 action array1 array2

Parameters:
    action : int -> 'T1 -> 'T2 -> unit - The function to apply to each index and pair of elements.
    array1 : 'T1[] - The first input array.
    array2 : 'T2[] - The second input array.

Applies the given function to pair of elements drawn from matching indices in two arrays, also passing the index of the elements. The two arrays must have the same lengths, otherwise an ArgumentException is raised.

action : int -> 'T1 -> 'T2 -> unit

The function to apply to each index and pair of elements.

array1 : 'T1[]

The first input array.

array2 : 'T2[]

The second input array.

ArgumentNullException Thrown when either of the input arrays is null.
ArgumentException Thrown when the input arrays differ in length.

Array.last array

Full Usage: Array.last array

Parameters:
    array : 'T[] - The input array.

Returns: 'T The last element of the array.

Returns the last element of the array.

array : 'T[]

The input array.

Returns: 'T

The last element of the array.

ArgumentNullException Thrown when the input array is null.
ArgumentException Thrown when the input does not have any elements.

Array.length array

Full Usage: Array.length array

Parameters:
    array : 'T[] - The input array.

Returns: int The length of the array.

Returns the length of an array. You can also use property arr.Length.

array : 'T[]

The input array.

Returns: int

The length of the array.

NullReferenceException Thrown when the input array is null.

Array.map mapping array

Full Usage: Array.map mapping array

Parameters:
    mapping : 'T -> 'U - The function to transform elements of the array.
    array : 'T[] - The input array.

Returns: 'U[] The array of transformed elements.

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

mapping : 'T -> 'U

The function to transform elements of the array.

array : 'T[]

The input array.

Returns: 'U[]

The array of transformed elements.

ArgumentNullException Thrown when the input array is null.

Array.map2 mapping array1 array2

Full Usage: Array.map2 mapping array1 array2

Parameters:
    mapping : 'T1 -> 'T2 -> 'U - The function to transform the pairs of the input elements.
    array1 : 'T1[] - The first input array.
    array2 : 'T2[] - The second input array.

Returns: 'U[] The array of transformed elements.

Builds a new collection whose elements are the results of applying the given function to the corresponding elements of the two collections pairwise. The two input arrays must have the same lengths, otherwise an ArgumentException is raised.

mapping : 'T1 -> 'T2 -> 'U

The function to transform the pairs of the input elements.

array1 : 'T1[]

The first input array.

array2 : 'T2[]

The second input array.

Returns: 'U[]

The array of transformed elements.

ArgumentException Thrown when the input arrays differ in length.
ArgumentNullException Thrown when either of the input arrays is null.

Array.map3 mapping array1 array2 array3

Full Usage: Array.map3 mapping array1 array2 array3

Parameters:
    mapping : 'T1 -> 'T2 -> 'T3 -> 'U - The function to transform the pairs of the input elements.
    array1 : 'T1[] - The first input array.
    array2 : 'T2[] - The second input array.
    array3 : 'T3[] - The third input array.

Returns: 'U[] The array of transformed elements.

Builds a new collection whose elements are the results of applying the given function to the corresponding triples from the three collections. The three input arrays must have the same length, otherwise an ArgumentException is raised.

mapping : 'T1 -> 'T2 -> 'T3 -> 'U

The function to transform the pairs of the input elements.

array1 : 'T1[]

The first input array.

array2 : 'T2[]

The second input array.

array3 : 'T3[]

The third input array.

Returns: 'U[]

The array of transformed elements.

ArgumentException Thrown when the input arrays differ in length.
ArgumentNullException Thrown when any of the input arrays is null.

Array.mapFold mapping state array

Full Usage: Array.mapFold mapping state array

Parameters:
    mapping : 'State -> 'T -> 'Result * 'State - The function to transform elements from the input array and accumulate the final value.
    state : 'State - The initial state.
    array : 'T[] - The input array.

Returns: 'Result[] * 'State The array of transformed elements, and the final accumulated value.

Combines map and fold. Builds a new array whose elements are the results of applying the given function to each of the elements of the input array. The function is also used to accumulate a final value.

mapping : 'State -> 'T -> 'Result * 'State

The function to transform elements from the input array and accumulate the final value.

state : 'State

The initial state.

array : 'T[]

The input array.

Returns: 'Result[] * 'State

The array of transformed elements, and the final accumulated value.

ArgumentNullException Thrown when the input array is null.

Array.mapFoldBack mapping array state

Full Usage: Array.mapFoldBack mapping array state

Parameters:
    mapping : 'T -> 'State -> 'Result * 'State - The function to transform elements from the input array and accumulate the final value.
    array : 'T[] - The input array.
    state : 'State - The initial state.

Returns: 'Result[] * 'State The array of transformed elements, and the final accumulated value.

Combines map and foldBack. Builds a new array whose elements are the results of applying the given function to each of the elements of the input array. The function is also used to accumulate a final value.

mapping : 'T -> 'State -> 'Result * 'State

The function to transform elements from the input array and accumulate the final value.

array : 'T[]

The input array.

state : 'State

The initial state.

Returns: 'Result[] * 'State

The array of transformed elements, and the final accumulated value.

ArgumentNullException Thrown when the input array is null.

Array.mapi mapping array

Full Usage: Array.mapi mapping array

Parameters:
    mapping : int -> 'T -> 'U - The function to transform elements and their indices.
    array : 'T[] - The input array.

Returns: 'U[] The array of transformed elements.

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

mapping : int -> 'T -> 'U

The function to transform elements and their indices.

array : 'T[]

The input array.

Returns: 'U[]

The array of transformed elements.

ArgumentNullException Thrown when the input array is null.

Array.mapi2 mapping array1 array2

Full Usage: Array.mapi2 mapping array1 array2

Parameters:
    mapping : int -> 'T1 -> 'T2 -> 'U - The function to transform pairs of input elements and their indices.
    array1 : 'T1[] - The first input array.
    array2 : 'T2[] - The second input array.

Returns: 'U[] The array of transformed elements.

Builds a new collection whose elements are the results of applying the given function to the corresponding elements of the two collections pairwise, also passing the index of the elements. The two input arrays must have the same lengths, otherwise an ArgumentException is raised.

mapping : int -> 'T1 -> 'T2 -> 'U

The function to transform pairs of input elements and their indices.

array1 : 'T1[]

The first input array.

array2 : 'T2[]

The second input array.

Returns: 'U[]

The array of transformed elements.

ArgumentNullException Thrown when either of the input arrays is null.
ArgumentException Thrown when the input arrays differ in length.

Array.max array

Full Usage: Array.max array

Parameters:
    array : 'T[] - The input array.

Returns: 'T The maximum element.

Returns the greatest of all elements of the array, compared via Operators.max on the function result.

Throws ArgumentException for empty arrays.

array : 'T[]

The input array.

Returns: 'T

The maximum element.

ArgumentNullException Thrown when the input array is null.
ArgumentException Thrown when the input array is empty.

Array.maxBy projection array

Full Usage: Array.maxBy projection array

Parameters:
    projection : 'T -> 'U - The function to transform the elements into a type supporting comparison.
    array : 'T[] - The input array.

Returns: 'T The maximum element.

Returns the greatest of all elements of the array, compared via Operators.max on the function result.

Throws ArgumentException for empty arrays.

projection : 'T -> 'U

The function to transform the elements into a type supporting comparison.

array : 'T[]

The input array.

Returns: 'T

The maximum element.

ArgumentNullException Thrown when the input array is null.
ArgumentException Thrown when the input array is empty.

Array.min array

Full Usage: Array.min array

Parameters:
    array : 'T[] - The input array.

Returns: 'T The minimum element.

Returns the lowest of all elements of the array, compared via Operators.min.

Throws ArgumentException for empty arrays

array : 'T[]

The input array.

Returns: 'T

The minimum element.

ArgumentNullException Thrown when the input array is null.
ArgumentException Thrown when the input array is empty.

Array.minBy projection array

Full Usage: Array.minBy projection array

Parameters:
    projection : 'T -> 'U - The function to transform the elements into a type supporting comparison.
    array : 'T[] - The input array.

Returns: 'T The minimum element.

Returns the lowest of all elements of the array, compared via Operators.min on the function result.

Throws ArgumentException for empty arrays.

projection : 'T -> 'U

The function to transform the elements into a type supporting comparison.

array : 'T[]

The input array.

Returns: 'T

The minimum element.

ArgumentNullException Thrown when the input array is null.
ArgumentException Thrown when the input array is empty.

Array.ofList list

Full Usage: Array.ofList list

Parameters:
    list : 'T list - The input list.

Returns: 'T[] The array of elements from the list.

Builds an array from the given list.

list : 'T list

The input list.

Returns: 'T[]

The array of elements from the list.

Array.ofSeq source

Full Usage: Array.ofSeq source

Parameters:
    source : seq<'T> - The input sequence.

Returns: 'T[] The array of elements from the sequence.

Builds a new array from the given enumerable object.

source : seq<'T>

The input sequence.

Returns: 'T[]

The array of elements from the sequence.

ArgumentNullException Thrown when the input sequence is null.

Array.pairwise array

Full Usage: Array.pairwise array

Parameters:
    array : 'T[] - The input array.

Returns: ('T * 'T)[] The result array.

Returns an array of each element in the input array and its predecessor, with the exception of the first element which is only returned as the predecessor of the second element.

array : 'T[]

The input array.

Returns: ('T * 'T)[]

The result array.

ArgumentNullException Thrown when the input sequence is null.

Array.partition predicate array

Full Usage: Array.partition predicate array

Parameters:
    predicate : 'T -> bool - The function to test the input elements.
    array : 'T[] - The input array.

Returns: 'T[] * 'T[] A pair of arrays. The first containing the elements the predicate evaluated to true, and the second containing those evaluated to false.

Splits the collection into two collections, containing the elements for which the given predicate returns "true" and "false" respectively.

predicate : 'T -> bool

The function to test the input elements.

array : 'T[]

The input array.

Returns: 'T[] * 'T[]

A pair of arrays. The first containing the elements the predicate evaluated to true, and the second containing those evaluated to false.

ArgumentNullException Thrown when the input array is null.

Array.permute indexMap array

Full Usage: Array.permute indexMap array

Parameters:
    indexMap : int -> int - The function that maps input indices to output indices.
    array : 'T[] - The input array.

Returns: 'T[] The output array.

Returns an array with all elements permuted according to the specified permutation.

indexMap : int -> int

The function that maps input indices to output indices.

array : 'T[]

The input array.

Returns: 'T[]

The output array.

ArgumentNullException Thrown when the input array is null.
ArgumentException Thrown when indexMap does not produce a valid permutation.

Array.pick chooser array

Full Usage: Array.pick chooser array

Parameters:
    chooser : 'T -> 'U option - The function to generate options from the elements.
    array : 'T[] - The input array.

Returns: 'U The first result.

Applies the given function to successive elements, returning the first result where function returns Some(x) for some x. If the function never returns Some(x) then KeyNotFoundException is raised.

chooser : 'T -> 'U option

The function to generate options from the elements.

array : 'T[]

The input array.

Returns: 'U

The first result.

ArgumentNullException Thrown when the input array is null.
KeyNotFoundException Thrown if every result from chooser is None.

Array.reduce reduction array

Full Usage: Array.reduce reduction array

Parameters:
    reduction : 'T -> 'T -> 'T - The function to reduce a pair of elements to a single element.
    array : 'T[] - The input array.

Returns: 'T The final result of the reductions.

Applies a function to each element of the array, threading an accumulator argument through the computation. If the input function is f and the elements are i0...iN then computes f (... (f i0 i1)...) iN. Raises ArgumentException if the array has size zero.

reduction : 'T -> 'T -> 'T

The function to reduce a pair of elements to a single element.

array : 'T[]

The input array.

Returns: 'T

The final result of the reductions.

ArgumentNullException Thrown when the input array is null.
ArgumentException Thrown when the input array is empty.

Array.reduceBack reduction array

Full Usage: Array.reduceBack reduction array

Parameters:
    reduction : 'T -> 'T -> 'T - A function that takes in the next-to-last element of the list and the current accumulated result to produce the next accumulated result.
    array : 'T[] - The input array.

Returns: 'T The final result of the reductions.

Applies a function to each element of the array, starting from the end, threading an accumulator argument through the computation. If the input function is f and the elements are i0...iN then computes f i0 (...(f iN-1 iN)).

reduction : 'T -> 'T -> 'T

A function that takes in the next-to-last element of the list and the current accumulated result to produce the next accumulated result.

array : 'T[]

The input array.

Returns: 'T

The final result of the reductions.

ArgumentNullException Thrown when the input array is null.
ArgumentException Thrown when the input array is empty.

Array.replicate count initial

Full Usage: Array.replicate count initial

Parameters:
    count : int - The number of elements to replicate.
    initial : 'T - The value to replicate

Returns: 'T[] The generated array.

Creates an array by replicating the given initial value.

count : int

The number of elements to replicate.

initial : 'T

The value to replicate

Returns: 'T[]

The generated array.

ArgumentException Thrown when count is negative.

Array.rev array

Full Usage: Array.rev array

Parameters:
    array : 'T[] - The input array.

Returns: 'T[] The reversed array.

Returns a new array with the elements in reverse order.

array : 'T[]

The input array.

Returns: 'T[]

The reversed array.

ArgumentNullException Thrown when the input array is null.

Array.scan folder state array

Full Usage: Array.scan folder state array

Parameters:
    folder : 'State -> 'T -> 'State - The function to update the state given the input elements.
    state : 'State - The initial state.
    array : 'T[] - The input array.

Returns: 'State[] The array of state values.

Like fold, but return the intermediary and final results.

folder : 'State -> 'T -> 'State

The function to update the state given the input elements.

state : 'State

The initial state.

array : 'T[]

The input array.

Returns: 'State[]

The array of state values.

ArgumentNullException Thrown when the input array is null.

Array.scanBack folder array state

Full Usage: Array.scanBack folder array state

Parameters:
    folder : 'T -> 'State -> 'State - The function to update the state given the input elements.
    array : 'T[] - The input array.
    state : 'State - The initial state.

Returns: 'State[] The array of state values.

Like foldBack, but return both the intermediary and final results.

folder : 'T -> 'State -> 'State

The function to update the state given the input elements.

array : 'T[]

The input array.

state : 'State

The initial state.

Returns: 'State[]

The array of state values.

ArgumentNullException Thrown when the input array is null.

Array.set array index value

Full Usage: Array.set array index value

Parameters:
    array : 'T[] - The input array.
    index : int - The input index.
    value : 'T - The input value.

Sets an element of an array.

array : 'T[]

The input array.

index : int

The input index.

value : 'T

The input value.

NullReferenceException Thrown when the input array is null.
IndexOutOfRangeException Thrown when the index is negative or the input array does not contain enough elements.

Array.singleton value

Full Usage: Array.singleton value

Parameters:
    value : 'T - The input item.

Returns: 'T[] The result array of one item.

Returns an array that contains one item only.

value : 'T

The input item.

Returns: 'T[]

The result array of one item.

Array.skip count array

Full Usage: Array.skip count array

Parameters:
    count : int - The number of elements to skip.
    array : 'T[] - The input array.

Returns: 'T[] A copy of the input array, after removing the first N elements.

Builds a new array that contains the elements of the given array, excluding the first N elements.

count : int

The number of elements to skip.

array : 'T[]

The input array.

Returns: 'T[]

A copy of the input array, after removing the first N elements.

ArgumentNullException Thrown when the input array is null.
ArgumentExcepion Thrown when count is negative or exceeds the number of elements in the array.

Array.skipWhile predicate array

Full Usage: Array.skipWhile predicate array

Parameters:
    predicate : 'T -> bool - A function that evaluates an element of the array to a boolean value.
    array : 'T[]

Returns: 'T[] The created sub array.

Bypasses elements in an array while the given predicate returns True, and then returns the remaining elements in a new array.

predicate : 'T -> bool

A function that evaluates an element of the array to a boolean value.

array : 'T[]
Returns: 'T[]

The created sub array.

ArgumentNullException Thrown when the input array is null.

Array.sort array

Full Usage: Array.sort array

Parameters:
    array : 'T[] - The input array.

Returns: 'T[] The sorted array.

Sorts the elements of an array, returning a new array. Elements are compared using Operators.compare.

This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. For a stable sort, consider using Seq.Sort.

array : 'T[]

The input array.

Returns: 'T[]

The sorted array.

ArgumentNullException Thrown when the input array is null.

Array.sortBy projection array

Full Usage: Array.sortBy projection array

Parameters:
    projection : 'T -> 'Key - The function to transform array elements into the type that is compared.
    array : 'T[] - The input array.

Returns: 'T[] The sorted array.

Sorts the elements of an array, using the given projection for the keys and returning a new array. Elements are compared using Operators.compare.

This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. For a stable sort, consider using Seq.Sort.

projection : 'T -> 'Key

The function to transform array elements into the type that is compared.

array : 'T[]

The input array.

Returns: 'T[]

The sorted array.

ArgumentNullException Thrown when the input array is null.

Array.sortByDescending projection array

Full Usage: Array.sortByDescending projection array

Parameters:
    projection : 'T -> 'Key - The function to transform array elements into the type that is compared.
    array : 'T[] - The input array.

Returns: 'T[] The sorted array.

Sorts the elements of an array, in descending order, using the given projection for the keys and returning a new array. Elements are compared using Operators.compare.

This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. For a stable sort, consider using Seq.Sort.

projection : 'T -> 'Key

The function to transform array elements into the type that is compared.

array : 'T[]

The input array.

Returns: 'T[]

The sorted array.

Array.sortDescending array

Full Usage: Array.sortDescending array

Parameters:
    array : 'T[] - The input array.

Returns: 'T[] The sorted array.

Sorts the elements of an array, in descending order, returning a new array. Elements are compared using Operators.compare.

This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. For a stable sort, consider using Seq.Sort.

array : 'T[]

The input array.

Returns: 'T[]

The sorted array.

Array.sortInPlace array

Full Usage: Array.sortInPlace array

Parameters:
    array : 'T[] - The input array.

Sorts the elements of an array by mutating the array in-place, using the given comparison function. Elements are compared using Operators.compare.

array : 'T[]

The input array.

ArgumentNullException Thrown when the input array is null.

Array.sortInPlaceBy projection array

Full Usage: Array.sortInPlaceBy projection array

Parameters:
    projection : 'T -> 'Key - The function to transform array elements into the type that is compared.
    array : 'T[] - The input array.

Sorts the elements of an array by mutating the array in-place, using the given projection for the keys. Elements are compared using Operators.compare.

This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. For a stable sort, consider using Seq.Sort.

projection : 'T -> 'Key

The function to transform array elements into the type that is compared.

array : 'T[]

The input array.

ArgumentNullException Thrown when the input array is null.

Array.sortInPlaceWith comparer array

Full Usage: Array.sortInPlaceWith comparer array

Parameters:
    comparer : 'T -> 'T -> int - The function to compare pairs of array elements.
    array : 'T[] - The input array.

Sorts the elements of an array by mutating the array in-place, using the given comparison function as the order.

comparer : 'T -> 'T -> int

The function to compare pairs of array elements.

array : 'T[]

The input array.

ArgumentNullException Thrown when the input array is null.

Array.sortWith comparer array

Full Usage: Array.sortWith comparer array

Parameters:
    comparer : 'T -> 'T -> int - The function to compare pairs of array elements.
    array : 'T[] - The input array.

Returns: 'T[] The sorted array.

Sorts the elements of an array, using the given comparison function as the order, returning a new array.

This is not a stable sort, i.e. the original order of equal elements is not necessarily preserved. For a stable sort, consider using Seq.Sort.

comparer : 'T -> 'T -> int

The function to compare pairs of array elements.

array : 'T[]

The input array.

Returns: 'T[]

The sorted array.

ArgumentNullException Thrown when the input array is null.

Array.splitAt index array

Full Usage: Array.splitAt index array

Parameters:
    index : int - The index at which the array is split.
    array : 'T[] - The input array.

Returns: 'T[] * 'T[] The two split arrays.

Splits an array into two arrays, at the given index.

index : int

The index at which the array is split.

array : 'T[]

The input array.

Returns: 'T[] * 'T[]

The two split arrays.

ArgumentNullException Thrown when the input array is null.
InvalidOperationException Thrown when split index exceeds the number of elements in the array.

Array.splitInto count array

Full Usage: Array.splitInto count array

Parameters:
    count : int - The maximum number of chunks.
    array : 'T[] - The input array.

Returns: 'T[][] The array split into chunks.

Splits the input array into at most count chunks.

count : int

The maximum number of chunks.

array : 'T[]

The input array.

Returns: 'T[][]

The array split into chunks.

ArgumentNullException Thrown when the input array is null.
ArgumentException Thrown when count is not positive.

Array.sub array startIndex count

Full Usage: Array.sub array startIndex count

Parameters:
    array : 'T[] - The input array.
    startIndex : int - The index of the first element of the sub array.
    count : int - The length of the sub array.

Returns: 'T[] The created sub array.

Builds a new array that contains the given subrange specified by starting index and length.

array : 'T[]

The input array.

startIndex : int

The index of the first element of the sub array.

count : int

The length of the sub array.

Returns: 'T[]

The created sub array.

ArgumentNullException Thrown when the input array is null.
ArgumentException Thrown when either startIndex or count is negative, or when there aren't enough elements in the input array.

Array.sum array

Full Usage: Array.sum array

Parameters:
    array : ^T[] - The input array.

Returns: ^T The resulting sum.

Returns the sum of the elements in the array.

array : ^T[]

The input array.

Returns: ^T

The resulting sum.

ArgumentNullException Thrown when the input array is null.

Array.sumBy projection array

Full Usage: Array.sumBy projection array

Parameters:
    projection : 'T -> ^U - The function to transform the array elements into the type to be summed.
    array : 'T[] - The input array.

Returns: ^U The resulting sum.

Returns the sum of the results generated by applying the function to each element of the array.

projection : 'T -> ^U

The function to transform the array elements into the type to be summed.

array : 'T[]

The input array.

Returns: ^U

The resulting sum.

ArgumentNullException Thrown when the input array is null.

Array.tail array

Full Usage: Array.tail array

Parameters:
    array : 'T[] - The input array.

Returns: 'T[] A new array containing the elements of the original except the first element.

Returns a new array containing the elements of the original except the first element.

array : 'T[]

The input array.

Returns: 'T[]

A new array containing the elements of the original except the first element.

ArgumentException Thrown when the array is empty.
ArgumentNullException Thrown when the input array is null.

Array.take count array

Full Usage: Array.take count array

Parameters:
    count : int - The number of items to take.
    array : 'T[] - The input array.

Returns: 'T[] The result array.

Returns the first N elements of the array.

Throws InvalidOperationException if the count exceeds the number of elements in the array. Array.truncate returns as many items as the array contains instead of throwing an exception.

count : int

The number of items to take.

array : 'T[]

The input array.

Returns: 'T[]

The result array.

ArgumentNullException Thrown when the input array is null.
ArgumentException Thrown when the input array is empty.
InvalidOperationException Thrown when count exceeds the number of elements in the list.

Array.takeWhile predicate array

Full Usage: Array.takeWhile predicate array

Parameters:
    predicate : 'T -> bool - A function that evaluates to false when no more items should be returned.
    array : 'T[] - The input array.

Returns: 'T[] The result array.

Returns an array that contains all elements of the original array while the given predicate returns True, and then returns no further elements.

predicate : 'T -> bool

A function that evaluates to false when no more items should be returned.

array : 'T[]

The input array.

Returns: 'T[]

The result array.

ArgumentNullException Thrown when the input array is null.

Array.toList array

Full Usage: Array.toList array

Parameters:
    array : 'T[] - The input array.

Returns: 'T list The list of array elements.

Builds a list from the given array.

array : 'T[]

The input array.

Returns: 'T list

The list of array elements.

ArgumentNullException Thrown when the input array is null.

Array.toSeq array

Full Usage: Array.toSeq array

Parameters:
    array : 'T[] - The input array.

Returns: seq<'T> The sequence of array elements.

Views the given array as a sequence.

array : 'T[]

The input array.

Returns: seq<'T>

The sequence of array elements.

ArgumentNullException Thrown when the input array is null.

Array.transpose arrays

Full Usage: Array.transpose arrays

Parameters:
    arrays : seq<'T[]> - The input sequence of arrays.

Returns: 'T[][] The transposed array.

Returns the transpose of the given sequence of arrays.

arrays : seq<'T[]>

The input sequence of arrays.

Returns: 'T[][]

The transposed array.

ArgumentNullException Thrown when the input sequence is null.
ArgumentException Thrown when the input arrays differ in length.

Array.truncate count array

Full Usage: Array.truncate count array

Parameters:
    count : int - The maximum number of items to return.
    array : 'T[] - The input array.

Returns: 'T[] The result array.

Returns at most N elements in a new array.

count : int

The maximum number of items to return.

array : 'T[]

The input array.

Returns: 'T[]

The result array.

ArgumentNullException Thrown when the input array is null.

Array.tryExactlyOne array

Full Usage: Array.tryExactlyOne array

Parameters:
    array : 'T[] - The input array.

Returns: 'T option The only element of the array or None.

Returns the only element of the array or None if array is empty or contains more than one element.

array : 'T[]

The input array.

Returns: 'T option

The only element of the array or None.

ArgumentNullException Thrown when the input array is null.

Array.tryFind predicate array

Full Usage: Array.tryFind predicate array

Parameters:
    predicate : 'T -> bool - The function to test the input elements.
    array : 'T[] - The input array.

Returns: 'T option The first element that satisfies the predicate, or None.

Returns the first element for which the given function returns True. Return None if no such element exists.

predicate : 'T -> bool

The function to test the input elements.

array : 'T[]

The input array.

Returns: 'T option

The first element that satisfies the predicate, or None.

ArgumentNullException Thrown when the input array is null.

Array.tryFindBack predicate array

Full Usage: Array.tryFindBack predicate array

Parameters:
    predicate : 'T -> bool - The function to test the input elements.
    array : 'T[] - The input array.

Returns: 'T option The last element that satisfies the predicate, or None.

Returns the last element for which the given function returns True. Return None if no such element exists.

predicate : 'T -> bool

The function to test the input elements.

array : 'T[]

The input array.

Returns: 'T option

The last element that satisfies the predicate, or None.

ArgumentNullException Thrown when the input array is null.

Array.tryFindIndex predicate array

Full Usage: Array.tryFindIndex predicate array

Parameters:
    predicate : 'T -> bool - The function to test the input elements.
    array : 'T[] - The input array.

Returns: int option The index of the first element that satisfies the predicate, or None.

Returns the index of the first element in the array that satisfies the given predicate.

predicate : 'T -> bool

The function to test the input elements.

array : 'T[]

The input array.

Returns: int option

The index of the first element that satisfies the predicate, or None.

ArgumentNullException Thrown when the input array is null.

Array.tryFindIndexBack predicate array

Full Usage: Array.tryFindIndexBack predicate array

Parameters:
    predicate : 'T -> bool - The function to test the input elements.
    array : 'T[] - The input array.

Returns: int option The index of the last element that satisfies the predicate, or None.

Returns the index of the last element in the array that satisfies the given predicate.

predicate : 'T -> bool

The function to test the input elements.

array : 'T[]

The input array.

Returns: int option

The index of the last element that satisfies the predicate, or None.

ArgumentNullException Thrown when the input array is null.

Array.tryHead array

Full Usage: Array.tryHead array

Parameters:
    array : 'T[] - The input array.

Returns: 'T option The first element of the array or None.

Returns the first element of the array, or None if the array is empty.

array : 'T[]

The input array.

Returns: 'T option

The first element of the array or None.

ArgumentNullException Thrown when the input array is null.

Array.tryItem index array

Full Usage: Array.tryItem index array

Parameters:
    index : int - The index of element to retrieve.
    array : 'T[]

Returns: 'T option The nth element of the array or None.

Tries to find the nth element in the array. Returns None if index is negative or the input array does not contain enough elements.

index : int

The index of element to retrieve.

array : 'T[]
Returns: 'T option

The nth element of the array or None.

ArgumentNullException Thrown when the input array is null.

Array.tryLast array

Full Usage: Array.tryLast array

Parameters:
    array : 'T[] - The input array.

Returns: 'T option The last element of the array or None.

Returns the last element of the array. Return None if no such element exists.

array : 'T[]

The input array.

Returns: 'T option

The last element of the array or None.

ArgumentNullException Thrown when the input sequence is null.

Array.tryPick chooser array

Full Usage: Array.tryPick chooser array

Parameters:
    chooser : 'T -> 'U option - The function to transform the array elements into options.
    array : 'T[] - The input array.

Returns: 'U option The first transformed element that is Some(x).

Applies the given function to successive elements, returning the first result where function returns Some(x) for some x. If the function never returns Some(x) then None is returned.

chooser : 'T -> 'U option

The function to transform the array elements into options.

array : 'T[]

The input array.

Returns: 'U option

The first transformed element that is Some(x).

ArgumentNullException Thrown when the input array is null.

Array.unfold generator state

Full Usage: Array.unfold generator state

Parameters:
    generator : 'State -> ('T * 'State) option - A function that takes in the current state and returns an option tuple of the next element of the array and the next state value.
    state : 'State - The initial state value.

Returns: 'T[] The result array.

Returns an array that contains the elements generated by the given computation. The given initial state argument is passed to the element generator.

generator : 'State -> ('T * 'State) option

A function that takes in the current state and returns an option tuple of the next element of the array and the next state value.

state : 'State

The initial state value.

Returns: 'T[]

The result array.

Array.unzip array

Full Usage: Array.unzip array

Parameters:
    array : ('T1 * 'T2)[] - The input array.

Returns: 'T1[] * 'T2[] The two arrays.

Splits an array of pairs into two arrays.

array : ('T1 * 'T2)[]

The input array.

Returns: 'T1[] * 'T2[]

The two arrays.

ArgumentNullException Thrown when the input array is null.

Array.unzip3 array

Full Usage: Array.unzip3 array

Parameters:
    array : ('T1 * 'T2 * 'T3)[] - The input array.

Returns: 'T1[] * 'T2[] * 'T3[] The tuple of three arrays.

Splits an array of triples into three arrays.

array : ('T1 * 'T2 * 'T3)[]

The input array.

Returns: 'T1[] * 'T2[] * 'T3[]

The tuple of three arrays.

ArgumentNullException Thrown when the input array is null.

Array.where predicate array

Full Usage: Array.where predicate array

Parameters:
    predicate : 'T -> bool - The function to test the input elements.
    array : 'T[] - The input array.

Returns: 'T[] An array containing the elements for which the given predicate returns true.

Returns a new array containing only the elements of the array for which the given predicate returns "true".

predicate : 'T -> bool

The function to test the input elements.

array : 'T[]

The input array.

Returns: 'T[]

An array containing the elements for which the given predicate returns true.

ArgumentNullException Thrown when the input array is null.

Array.windowed windowSize array

Full Usage: Array.windowed windowSize array

Parameters:
    windowSize : int - The number of elements in each window.
    array : 'T[] - The input array.

Returns: 'T[][] The result array.

Returns an array of sliding windows containing elements drawn from the input array. Each window is returned as a fresh array.

windowSize : int

The number of elements in each window.

array : 'T[]

The input array.

Returns: 'T[][]

The result array.

ArgumentNullException Thrown when the input array is null.
ArgumentException Thrown when windowSize is not positive.

Array.zeroCreate count

Full Usage: Array.zeroCreate count

Parameters:
    count : int - The length of the array to create.

Returns: 'T[] The created array.

Creates an array where the entries are initially the default value Unchecked.defaultof<'T>.

count : int

The length of the array to create.

Returns: 'T[]

The created array.

ArgumentException Thrown when count is negative.

Array.zip array1 array2

Full Usage: Array.zip array1 array2

Parameters:
    array1 : 'T1[] - The first input array.
    array2 : 'T2[] - The second input array.

Returns: ('T1 * 'T2)[] The array of tupled elements.

Combines the two arrays into an array of pairs. The two arrays must have equal lengths, otherwise an ArgumentException is raised.

array1 : 'T1[]

The first input array.

array2 : 'T2[]

The second input array.

Returns: ('T1 * 'T2)[]

The array of tupled elements.

ArgumentNullException Thrown when either of the input arrays is null.
ArgumentException Thrown when the input arrays differ in length.

Array.zip3 array1 array2 array3

Full Usage: Array.zip3 array1 array2 array3

Parameters:
    array1 : 'T1[] - The first input array.
    array2 : 'T2[] - The second input array.
    array3 : 'T3[] - The third input array.

Returns: ('T1 * 'T2 * 'T3)[] The array of tupled elements.

Combines three arrays into an array of pairs. The three arrays must have equal lengths, otherwise an ArgumentException is raised.

array1 : 'T1[]

The first input array.

array2 : 'T2[]

The second input array.

array3 : 'T3[]

The third input array.

Returns: ('T1 * 'T2 * 'T3)[]

The array of tupled elements.

ArgumentNullException Thrown when any of the input arrays are null.
ArgumentException Thrown when the input arrays differ in length.